You can use ezcMail together with the other classes derived from ezcMailPart to build email messages. When the mail is built, use the Transport classes to send the mail.

This example builds and sends a simple text mail message:

 1.  $mail = new ezcMail;
 2.  $mail->from = new ezcMailAddress( 'sender@example.com', 'Adrian Ripburger' );
 3.  $mail->addTo( new ezcMailAddress( 'receiver@example.com', 'Maureen Corley' ) );
 4.  $mail->subject = "Hi";
 5.  $mail->body = new ezcMailText( "I just mail to say I love you!" );
 6.  $transport = new ezcMailMtaTransport();
 7.  $transport->send( $mail );

You can also derive your own mail classes from this class if you have special requirements. An example of this is the ezcMailComposer class which is a convenience class to send simple mail structures and HTML mail.

There are several headers you can set on the mail object to achieve various effects:

• Reply-To - Set this to an email address if you want people to reply to an address other than the from address.
• Errors-To - If the mail can not be delivered the error message will be sent to this address.

ezcMailPart
   |
   --ezcMail

Constructs an empty ezcMail object.

Adds the ezcMailAddress $address to the list of 'bcc' recipients.

Adds the ezcMailAddress $address to the list of 'cc' recipients.

Adds the ezcMailAddress $address to the list of 'to' recipients.

Saves $mail in the $context object.

This function is used as a callback in the fetchParts() method.

Returns an array of mail parts from the current mail.

The array returned contains objects of classes:

• ezcMailText
• ezcMailFile
• ezcMailRfc822Digest

If the method is called with $includeDigests as true, then the returned array will not contain ezcMailRfc822Digest objects, but instead the mail parts inside the digests. The parameter $filter can be used to restrict the returned mail parts, eg. $filter = array( 'ezcMailFile' ) to return only file mail parts.

A typical use for this function is to get a list of attachments from a mail. Example:

 1.  // $mail is an ezcMail object
 2.  $parts = $mail->fetchParts();
 3.  // after the above line is executed, $parts will contain an array of mail parts objects,
 4.  // for example one ezcMailText object ($parts[0]) and two ezcMailRfc822Digest objects ($parts[1] and $parts[2]).
 5.  // the ezcMailText object will be used to render the mail text, and the
 6.  // other two objects will be displayed as links ("view attachment")
 7.  
 8.  // when user clicks on one of the two attachments, the parts of that attachment
 9.  // must be retrieved in order to render the attached digest:
10.  $subparts = $parts[1]->mail->fetchParts();
11.  // after the above line is executed, $subparts will contain an array of mail parts objects,
12.  // for example one ezcMailText object and one ezcMailFile object

Returns the generated body part of this mail.

Returns an empty string if no body has been set.

Returns the generated headers for the mail.

This method is called automatically when the mail message is built. You can re-implement this method in subclasses if you wish to set different mail headers than ezcMail.

Walks recursively through the mail parts in the specified mail object.

$context is an object of class ezcMailPartWalkContext, which must contain a valid callback function name to be applied to all mail parts. You can use the collectPart() method, or create your own callback function which can for example save the mail parts to disk or to a database.

For the properties you can set to the walk context see: ezcMailPartWalkContext

Example:

 1.  class App
 2.  {
 3.      public static function saveMailPart( $context, $mailPart )
 4.      {
 5.          // code to save the $mailPart object to disk
 6.      }
 7.  }
 8.  
 9.  // use the saveMailPart() function as a callback in walkParts()
10.  // where $mail is an ezcMail object.
11.  $context = new ezcMailPartWalkContext( array( 'App', 'saveMailPart' ) );
12.  $context->includeDigests = true; // if you want to go through the digests in the mail
13.  $mail->walkParts( $context, $mail );