Zeta Components - high quality PHP components

The implementation supports most of the commands specified in:

• http://www.faqs.org/rfcs/rfc1939.html (POP3)
• http://www.faqs.org/rfcs/rfc1734.html (POP3 AUTH)

The POP3 transport class allows developers to interface with a POP3 server.

Basic commands:

• connect to a POP3 server (__construct())
• authenticate a user with a username and password (authenticate())
• disconnect from the POP3 server (disconnect())

• get the message numbers and sizes of all the messages (listMessages())
• get the message numbers and IDs of all the messages (listUniqueIdentifiers())
• get the headers of a certain message (top())
• delete a message (delete())

• create a set from all messages (fetchAll())
• create a set from a certain message (fetchByMessageNr())
• create a set from a range of messages (fetchFromOffset())

• get the status of messages on the server (status())
• issue a NOOP command to keep the connection alive (noop())

1.  // create a new POP3 transport object by specifying the server name, optional
2.  // port and optional SSL mode
3.  $options = new ezcMailPop3TransportOptions();
4.  $options->ssl = true;
5.  
6.  $pop3 = new ezcMailPop3Transport( 'pop3.example.com', null, $options );
7.  
8.  // Authenticate to the POP3 server
9.  $pop3->authenticate( 'username', 'password' );
10.  
11.  // issue commands to the POP3 server
12.  // for example get the headers of the first message, which can be
13.  // parsed with ezcMailVariableSet and ezcMailParser
14.  $headers = $pop3->top( 1 );
15.  
16.  // see the above list of commands or consult the online documentation for
17.  // the full list of commands you can issue to an POP3 server and examples
18.  
19.  // disconnect from the POP3 server
20.  $pop3->disconnect();

See ezcMailPop3TransportOptions for options you can specify for POP3.

You can specify the $port if the POP3 server is not on the default port 995 (for SSL connections) or 110 (for plain connections). Use the $options parameter to specify an SSL connection.

For options you can specify for POP3 see ezcMailPop3TransportOptions.

Example of creating a POP3 transport:

1.  // replace with your POP3 server address
2.  $pop3 = new ezcMailPop3Transport( 'pop3.example.com' );
3.  
4.  // if you want to use SSL:
5.  $options = new ezcMailPop3TransportOptions();
6.  $options->ssl = true;
7.  
8.  $pop3 = new ezcMailPop3Transport( 'pop3.example.com', null, $options );

If there is an open connection to the POP3 server it is closed.

You can choose the authentication method with the $method parameter. The default is to use plaintext username and password (specified in the ezcMailPop3TransportOptions class).

This method should be called directly after the construction of this object.

Example:

1.  // replace with your POP3 server address
2.  $pop3 = new ezcMailPop3Transport( 'pop3.example.com' );
3.  
4.  // replace the values with your username and password for the POP3 server
5.  $pop3->authenticate( 'username', 'password' );

The message number must be a valid identifier fetched with (example) listMessages().

Any future reference to the message-number associated with the message in a command generates an error.

Before calling this method, a connection to the POP3 server must be established and a user must be authenticated successfully.

If $deleteFromServer is set to true the mail will be removed from the server after retrieval. If not it will be left.

Before calling this method, a connection to the POP3 server must be established and a user must be authenticated successfully.

Example:

1.  $pop3 = new ezcMailPop3Transport( 'pop3.example.com' );
2.  $pop3->authenticate( 'username', 'password' );
3.  
4.  $set = $pop3->fetchAll();
5.  
6.  // parse $set with ezcMailParser
7.  $parser = new ezcMailParser();
8.  $mails = $parser->parseMail( $set );
9.  foreach ( $mails as $mail )
10.  {
11.      // process $mail which is an ezcMail object
12.  }

If $deleteFromServer is set to true the mail will be removed from the server after retrieval. If not it will be left.

Note: for POP3 the first message is 1 (so for $number = 0 the exception will be thrown).

Before calling this method, a connection to the POP3 server must be established and a user must be authenticated successfully.

Example:

1.  $pop3 = new ezcMailPop3Transport( 'pop3.example.com' );
2.  $pop3->authenticate( 'username', 'password' );
3.  
4.  $set = $pop3->fetchByMessageNr( 1 );
5.  
6.  // $set can be parsed with ezcMailParser

Fetches $count messages starting from the $offset and returns them as a ezcMailPop3Set. If $count is not specified or if it is 0, it fetches all messages starting from the $offset.

Before calling this method, a connection to the POP3 server must be established and a user must be authenticated successfully.

Example:

1.  $pop3 = new ezcMailPop3Transport( 'pop3.example.com' );
2.  $pop3->authenticate( 'username', 'password' );
3.  
4.  $set = $pop3->fetchFromOffset( 1, 10 );
5.  
6.  // $set can be parsed with ezcMailParser

The format of the returned array is:

1.    array( message_id => message_size );

Example:

1.    array( 2 => 1700, 5 => 1450, 6 => 21043 );

Before calling this method, a connection to the POP3 server must be established and a user must be authenticated successfully.

You can fetch the unique identifier for a specific message by providing the $msgNum parameter.

The unique identifier can be used to recognize mail from servers between requests. In contrast to the message numbers the unique numbers assigned to an email usually never changes.

Note: POP3 servers are not required to support this command and it may fail.

The format of the returned array is:

1.    array( message_num => unique_id );

Before calling this method, a connection to the POP3 server must be established and a user must be authenticated successfully.

Example:

1.    array( 1 => '000001fc4420e93a', 2 => '000001fd4420e93a' );

Before calling this method, a connection to the POP3 server must be established and a user must be authenticated successfully.

The information returned through the parameters is:

• $numMessages = number of messages
• $sizeMessages = sum of the messages sizes

Example of returning the status of messages on the server:

1.  $pop3 = new ezcMailPop3Transport( 'pop3.example.com' );
2.  $pop3->authenticate( 'username', 'password' );
3.  
4.  $pop3->status( $numMessages, $sizeMessages );

After running the above code, $numMessages and $sizeMessages will be populated with values.

If the command failed or if it was not supported by the server an empty string is returned.

Note: POP3 servers are not required to support this command and it may fail.

Before calling this method, a connection to the POP3 server must be established and a user must be authenticated successfully.

Example of listing the mail headers of all the messages from the server:

1.  $pop3 = new ezcMailPop3Transport( 'pop3.example.com' );
2.  $pop3->authenticate( 'username', 'password' );
3.  
4.  $parser = new ezcMailParser();
5.  $messages = $pop3->listMessages();
6.  foreach ( $messages as $messageNr => $size )
7.  {
8.      $set = new ezcMailVariableSet( $pop3->top( $messageNr ) );
9.      $mail = $parser->parseMail( $set );
10.      $mail = $mail[0];
11.      echo "From: {$mail->from}, Subject: {$mail->subject}, Size: {$size}\n";
12.  }