Path

ez components / documentation / api reference / 2007.1.1 / mail

eZ Components 2007.1.1

Mail: ezcMailDeliveryStatus

[ Tutorial ] [ Display example ] [ Mail listing example ] [ Rfcs ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcMailDeliveryStatus

Mail part used for sending delivery status message. [source]
Multipart/Report: RFC 3462 http://tools.ietf.org/html/rfc3462 Delivery Status Notifications: RFC 3464 http://tools.ietf.org/html/rfc3464
This mail part consists of only headers. The headers are organized into section. There is a per-message section ($message), and several per-recipient sections ($recipients).
To access the headers of this part, look at the following example: 
1.  // $delivery is an object of type ezcMailDeliveryStatus
2.   $reportingMta = $delivery->message["Reporting-MTA"];
3.  $date = $delivery->message["Arrival-Date"];
4.  // get the status received from the first recipient
5.   $status1 = $delivery->recipients[0]["Status"];
6.  // get the status received from the second recipient
7.   $status2 = $delivery->recipients[1]["Status"];

Parents

ezcMailPart
   |
   --ezcMailDeliveryStatus

Properties

ezcMailHeadersHolder read/write  $message
Holds the per-message headers of the delivery-status message.
ArrayObject(ezcMailHeadersHolder) read/write  $recipients
Holds the recipients of the delivery-status message.

Method Summary

public ezcMailDeliveryStatus __construct( )
Constructs a new DeliveryStatus part.
public int createRecipient( )
Adds a new recipient to this delivery-status message and returns the index of the last added recipient.
public string generateBody( )
Returns the generated text body of this part as a string.
public string generateHeaders( )
Returns the headers set for this part as a RFC822 compliant string.

Inherited Methods

From ezcMailPart :
public ezcMailPart ezcMailPart::__construct()
Constructs a new mail part.
public void ezcMailPart::appendExcludeHeaders()
The array $headers will be excluded when the headers are generated.
public string ezcMailPart::generate()
Returns the complete mail part including both the header and the body as a string.
public abstract string ezcMailPart::generateBody()
Returns the body of this part as a string.
public string ezcMailPart::generateHeaders()
Returns the headers set for this part as a RFC 822 string.
public string ezcMailPart::getHeader()
Returns the RAW value of the header $name.
public void ezcMailPart::setHeader()
Sets the header $name to the value $value.
public void ezcMailPart::setHeaders()
Adds the headers $headers.

Methods

__construct

ezcMailDeliveryStatus __construct( )
Constructs a new DeliveryStatus part.

Redefinition of

Method Description
ezcMailPart::__construct() Constructs a new mail part.

createRecipient

int createRecipient( )
Adds a new recipient to this delivery-status message and returns the index of the last added recipient.

generateBody

string generateBody( )
Returns the generated text body of this part as a string.

Redefinition of

Method Description
ezcMailPart::generateBody() Returns the body of this part as a string.

generateHeaders

string generateHeaders( )
Returns the headers set for this part as a RFC822 compliant string.
This method does not add the required two lines of space to separate the headers from the body of the part.

See also:

ezcMailPart::setHeader().

Redefinition of

Method Description
ezcMailPart::generateHeaders() Returns the headers set for this part as a RFC 822 string.

Last updated: Wed, 28 Nov 2007