Zeta Components - high quality PHP components

The implementation supports most of the commands specified in:

• RFC821 - SMTP
• RFC2554 - SMTP Authentication
• RFC2831 - DIGEST-MD5 Authentication
• RFC2195 - CRAM-MD5 Authentication
• NTLM Authentication

If the preferred method is specified via options, only that authentication method will be attempted on the SMTP server. If it fails, an exception will be thrown.

Supported authentication methods (from strongest to weakest):

• DIGEST-MD5
• CRAM-MD5
• NTLM (requires the PHP mcrypt extension)
• LOGIN
• PLAIN

Example send mail:

1.  $mail = new ezcMailComposer();
2.  
3.  $mail->from = new ezcMailAddress( 'sender@example.com', 'Adrian Ripburger' );
4.  $mail->addTo( new ezcMailAddress( 'receiver@example.com', 'Maureen Corley' ) );
5.  $mail->subject = "This is the subject of the example mail";
6.  $mail->plainText = "This is the body of the example mail.";
7.  $mail->build();
8.  
9.  // Create a new SMTP transport object with an SSLv3 connection.
10.  // The port will be 465 by default, use the 4th argument to change it.
11.  // Username and password (2nd and 3rd arguments) are left blank, which means
12.  // the mail host does not need authentication.
13.  // The 5th parameter is the optional $options object.
14.  $options = new ezcMailSmtpTransportOptions();
15.  $options->connectionType = ezcMailSmtpTransport::CONNECTION_SSLV3;
16.  
17.  $transport = new ezcMailSmtpTransport( 'mailhost.example.com', '', '', null, $options );
18.  
19.  // Use the SMTP transport to send the created mail object
20.  $transport->send( $mail );

Example require NTLM authentication:

1.  // Create an SMTP transport and demand NTLM authentication.
2.  // Username and password must be specified, otherwise no authentication
3.  // will be attempted.
4.  // If NTLM authentication fails, an exception will be thrown.
5.  $options = new ezcMailSmtpTransportOptions();
6.  $options->preferredAuthMethod = ezcMailSmtpTransport::AUTH_NTLM;
7.  
8.  $transport = new ezcMailSmtpTransport( 'mailhost.example.com', 'username', 'password', null, $options );
9.  
10.  // The option can also be specified via the option property:
11.  $transport->options->preferredAuthMethod = ezcMailSmtpTransport::AUTH_NTLM;

See ezcMailSmtpTransportOptions for options you can specify for SMTP.

The returned array has the methods sorted by their relative strengths, so stronger methods are first in the array.

The structure of the security buffer is:

• a short containing the length of the buffer content in bytes (may be zero).
• a short containing the allocated space for the buffer in bytes (greater than or equal to the length; typically the same as the length).
• a long containing the offset to the start of the buffer in bytes (from the beginning of the NTLM message).

• buffer content length: 1234 bytes (0xd204 in hexa)
• allocated space: 1234 bytes( 0xd204 in hexa)
• offset: 4321 bytes (0xe1100000 in hexa)

The constructor expects, at least, the hostname $host of the SMTP server.

The username $user will be used for authentication if provided. If it is left blank no authentication will be performed.

The password $password will be used for authentication if provided. Use this parameter always in combination with the $user parameter.

The value $port specifies on which port to connect to $host. By default it is 25 for plain connections and 465 for TLS/SSL/SSLv2/SSLv3.

Note: The ssl option from ezcMailTransportOptions doesn't apply to SMTP. If you want to connect to SMTP using TLS/SSL/SSLv2/SSLv3 use the connectionType option in ezcMailSmtpTransportOptions.

For options you can specify for SMTP see ezcMailSmtpTransportOptions.

Closes the connection if it is still open.

This method must be called once to tell the server the sender address.

The sender's mail address $from may be enclosed in angle brackets.

This method must be called once for each recipient of the mail including cc and bcc recipients. The RCPT TO commands control where the mail is actually sent. It does not affect the headers of the email.

The recipient mail address $email may be enclosed in angle brackets.

If $email is already enclosed within '< >' it is returned unmodified.

Used in the DIGEST-MD5 authentication method.

$line contains the complete data retrieved from the stream. This can be used to retrieve the error message in case of an error.

This method should be called prior to the first call to send().

Keeping the connection open is useful if you are sending a lot of mail. It removes the overhead of opening the connection after each mail is sent.

Use disconnect() to close the connection if you have requested to keep it open.

If you want to send several emails use keepConnection() to leave the connection to the server open between each mail.

This method appends one line-break at the end of $data.

For example, if the server supports:

1.    $methods = array( 'PLAIN', 'LOGIN', 'CRAM-MD5' );

then this method will return:

1.    $methods = array( 'CRAM-MD5', 'LOGIN', 'PLAIN' );