Constructors

Extends "Constructors" in Mail::Transport::Receive.

Mail::Transport::POP3->new(%options)

Create a new pop3 server connection. One object can only handle one connection: for a single user to one single server. If the server could not be reached, or when the login fails, this instantiating "new" will return "undef".

 -Option      --Defined in     --Default
  authenticate                   'AUTO'
  executable    Mail::Transport  undef
  hostname      Mail::Transport  'localhost'
  interval      Mail::Transport  30
  log           Mail::Reporter   'WARNINGS'
  password      Mail::Transport  undef
  port          Mail::Transport  110
  proxy         Mail::Transport  undef
  retry         Mail::Transport  <false>
  timeout       Mail::Transport  120
  trace         Mail::Reporter   'WARNINGS'
  use_ssl                        <false>
  username      Mail::Transport  undef
  via           Mail::Transport  'sendmail'
    

Attributes

$obj->useSSL()

Returns "true" when SSL must be used.

Receiving mail

Extends "Receiving mail" in Mail::Transport::Receive.

$obj->receive( [$unique_message_id] )

Inherited, see "Receiving mail" in Mail::Transport::Receive

Exchanging information

$obj->deleteFetched()

Mark all messages that have been fetched with message() for deletion. See fetched().

$obj->deleted(BOOLEAN, @ids)

Either mark the specified message(s) to be deleted on the remote server or unmark them for deletion (if the first parameter is false). Deletion of messages will take place only when the connection is specifically disconnected or the last reference to the object goes out of scope.

$obj->disconnect()

Break contact with the server, if that (still) exists. Returns true if successful. Please note that even if the disconnect was not successful, all knowledge of messages etc. will be removed from the object: the object basically has reverted to the state in which it was before anything was done with the mail box.

$obj->fetched()

Returns a reference to a list of ID's that have been fetched using message(). This can be used to update a database of messages that were fetched (but maybe not yet deleted) from the mailbox.

Please note that if the POP3 server did not support the UIDL command, this method will always return undef because it is not possibly to reliably identify messages between sessions (other than looking at the contents of the messages themselves).

See also deleteFetched().

$obj->folderSize()

Returns the total number of octets used by the mailbox on the remote server.

$obj->header( $id, [$bodylines] )

Returns a reference to an array which contains the header of the message with the specified $id. "undef" is returned if something has gone wrong.

The optional integer $bodylines specifies the number of lines from the body which should be added, by default none.

example:

 my $ref_lines = $pop3->header($uidl);
 print @$ref_lines;
    

$obj->id2n($id)

Translates the unique $id of a message into a sequence number which represents the message as long a this connection to the POP3 server exists. When the message has been deleted for some reason, "undef" is returned.

$obj->ids()

Returns a list (in list context) or a reference to a list (in scalar context) of all IDs which are known by the server on this moment.

$obj->message($id)

Returns a reference to an array which contains the lines of the message with the specified $id. Returns "undef" if something has gone wrong.

example:

 my $ref_lines = $pop3->message($uidl);
 print @$ref_lines;
    

$obj->messageSize($id)

Returns the size of the message which is indicated by the $id, in octets. If the message has been deleted on the remote server, this will return "undef".

$obj->messages()

Returns (in scalar context only) the number of messages that are known to exist in the mailbox.

Protocol internals

The follow methods handle protocol internals, and should not be used by a normal user of this class.

$obj->login()

Establish a new connection to the POP3 server, using username and password.

$obj->send($socket, $data)

Send $data to the indicated socket and return the first line read from that socket. Logs an error if either writing to or reading from socket failed.

This method does not attempt to reconnect or anything: if reading or writing the socket fails, something is very definitely wrong.

$obj->sendList($socket, $command)

Sends the indicated $command to the specified socket, and retrieves the response. It returns a reference to an array with all the lines that were reveived after the first "+OK" line and before the end-of-message delimiter (a single dot on a line). Returns "undef" whenever something has gone wrong.

$obj->socket()

Returns a connection to the POP3 server. If there was no connection yet, it will be created transparently. If the connection with the POP3 server was lost, it will be reconnected and the assures that internal state information (STAT and UIDL) is up-to-date in the object.

If the contact to the server was still present, or could be established, an IO::Socket::INET object is returned. Else, "undef" is returned and no further actions should be tried on the object.

$obj->status($socket)

Update the current status of folder on the remote POP3 server.

Server connection

Extends "Server connection" in Mail::Transport::Receive.

$obj->findBinary( $name, [@directories] )

Inherited, see "Server connection" in Mail::Transport

$obj->remoteHost()

Inherited, see "Server connection" in Mail::Transport

$obj->retry()

Inherited, see "Server connection" in Mail::Transport

$obj->url()

Represent this pop3 connection as URL.

Error handling

Extends "Error handling" in Mail::Transport::Receive.

$obj->AUTOLOAD()

Inherited, see "Error handling" in Mail::Reporter

$obj->addReport($object)

Inherited, see "Error handling" in Mail::Reporter

$obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )

Mail::Transport::POP3->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )

Inherited, see "Error handling" in Mail::Reporter

$obj->errors()

Inherited, see "Error handling" in Mail::Reporter

$obj->log( [$level, [$strings]] )

Mail::Transport::POP3->log( [$level, [$strings]] )

Inherited, see "Error handling" in Mail::Reporter

$obj->logPriority($level)

Mail::Transport::POP3->logPriority($level)

Inherited, see "Error handling" in Mail::Reporter

$obj->logSettings()

Inherited, see "Error handling" in Mail::Reporter

$obj->notImplemented()

Inherited, see "Error handling" in Mail::Reporter

$obj->report( [$level] )

Inherited, see "Error handling" in Mail::Reporter

$obj->reportAll( [$level] )

Inherited, see "Error handling" in Mail::Reporter

$obj->trace( [$level] )

Inherited, see "Error handling" in Mail::Reporter

$obj->warnings()

Inherited, see "Error handling" in Mail::Reporter

Cleanup

Extends "Cleanup" in Mail::Transport::Receive.

$obj->DESTROY()

Inherited, see "Cleanup" in Mail::Reporter