Interface Swift_Mime_Message
| Extends | Swift_Mime_MimeEntity |
|---|---|
| Implemented by | Swift_Message, Swift_Mime_SimpleMessage, Swift_SignedMessage |
A Message (RFC 2822) object.
Public Methods
| Method | Description | Defined By |
|---|---|---|
| charsetChanged() | Notify this observer that the entity's charset has changed. | Swift_Mime_CharsetObserver |
| encoderChanged() | Notify this observer that the observed entity's ContentEncoder has changed. | Swift_Mime_EncodingObserver |
| generateId() | Generates a valid Message-ID and switches to it. | Swift_Mime_Message |
| getBcc() | Get the Bcc addresses for this message. | Swift_Mime_Message |
| getBody() | Get the body content of this entity as a string. | Swift_Mime_MimeEntity |
| getCc() | Get the Cc addresses for this message. | Swift_Mime_Message |
| getChildren() | Get all children nested inside this entity. | Swift_Mime_MimeEntity |
| getContentType() | Get the qualified content-type of this mime entity. | Swift_Mime_MimeEntity |
| getDate() | Get the origination date of the message as a UNIX timestamp. | Swift_Mime_Message |
| getFrom() | Get the From address(es) of this message. | Swift_Mime_Message |
| getHeaders() | Get the collection of Headers in this Mime entity. | Swift_Mime_MimeEntity |
| getId() | Returns a unique ID for this entity. | Swift_Mime_MimeEntity |
| getNestingLevel() | Get the level at which this entity shall be nested in final document. | Swift_Mime_MimeEntity |
| getReplyTo() | Get the Reply-To addresses for this message. | Swift_Mime_Message |
| getReturnPath() | Get the return-path (bounce-detect) address. | Swift_Mime_Message |
| getSender() | Get the sender address for this message. | Swift_Mime_Message |
| getSubject() | Get the subject of the message. | Swift_Mime_Message |
| getTo() | Get the To addresses for this message. | Swift_Mime_Message |
| setBcc() | Set the Bcc address(es). | Swift_Mime_Message |
| setBody() | Set the body content of this entity as a string. | Swift_Mime_MimeEntity |
| setCc() | Set the Cc address(es). | Swift_Mime_Message |
| setChildren() | Set all children nested inside this entity. | Swift_Mime_MimeEntity |
| setDate() | Set the origination date of the message as a UNIX timestamp. | Swift_Mime_Message |
| setFrom() | Set the From address of this message. | Swift_Mime_Message |
| setReplyTo() | Set the Reply-To address(es). | Swift_Mime_Message |
| setReturnPath() | Set the return-path (bounce-detect) address. | Swift_Mime_Message |
| setSender() | Set the sender of this message. | Swift_Mime_Message |
| setSubject() | Set the subject of the message. | Swift_Mime_Message |
| setTo() | Set the To address(es). | Swift_Mime_Message |
| toByteStream() | Get this entire entity as a ByteStream. | Swift_Mime_MimeEntity |
| toString() | Get this entire entity in its string form. | Swift_Mime_MimeEntity |
Method Details
Generates a valid Message-ID and switches to it.
| public abstract string generateId ( ) |
Get the Bcc addresses for this message.
This method always returns an associative array, whereby the keys provide the actual email addresses.
| public abstract string[] getBcc ( ) |
Get the Cc addresses for this message.
This method always returns an associative array, whereby the keys provide the actual email addresses.
| public abstract string[] getCc ( ) |
Get the origination date of the message as a UNIX timestamp.
| public abstract int getDate ( ) |
Get the From address(es) of this message.
This method always returns an associative array where the keys are the addresses.
| public abstract string[] getFrom ( ) |
Get the Reply-To addresses for this message.
This method always returns an associative array where the keys provide the email addresses.
| public abstract string[] getReplyTo ( ) |
Get the return-path (bounce-detect) address.
| public abstract string getReturnPath ( ) |
Get the sender address for this message.
This has a higher significance than the From address.
| public abstract string getSender ( ) |
Get the subject of the message.
| public abstract string getSubject ( ) |
Get the To addresses for this message.
This method always returns an associative array, whereby the keys provide the actual email addresses.
| public abstract string[] getTo ( ) |
Set the Bcc address(es).
Recipients set in this field will receive a 'blind-carbon-copy' of this message.
In other words, they will get the message, but any other recipients of the message will have no such knowledge of their receipt of it.
This method has the same synopsis as {@link setFrom()} and {@link setTo()}.
| public abstract void setBcc ( $addresses, $name = null ) | ||
| $addresses | mixed | |
| $name | string | Optional |
Set the Cc address(es).
Recipients set in this field will receive a 'carbon-copy' of this message.
This method has the same synopsis as {@link setFrom()} and {@link setTo()}.
| public abstract void setCc ( $addresses, $name = null ) | ||
| $addresses | mixed | |
| $name | string | Optional |
Set the origination date of the message as a UNIX timestamp.
| public abstract void setDate ( $date ) | ||
| $date | int | |
Set the From address of this message.
It is permissible for multiple From addresses to be set using an array.
If multiple From addresses are used, you SHOULD set the Sender address and according to RFC 2822, MUST set the sender address.
An array can be used if display names are to be provided: i.e. array('email@address.com' => 'Real Name').
If the second parameter is provided and the first is a string, then $name is associated with the address.
| public abstract void setFrom ( $addresses, $name = null ) | ||
| $addresses | mixed | |
| $name | string | Optional |
Set the Reply-To address(es).
Any replies from the receiver will be sent to this address.
It is permissible for multiple reply-to addresses to be set using an array.
This method has the same synopsis as {@link setFrom()} and {@link setTo()}.
If the second parameter is provided and the first is a string, then $name is associated with the address.
| public abstract void setReplyTo ( $addresses, $name = null ) | ||
| $addresses | mixed | |
| $name | string | Optional |
Set the return-path (bounce-detect) address.
| public abstract void setReturnPath ( $address ) | ||
| $address | string | |
Set the sender of this message.
If multiple addresses are present in the From field, this SHOULD be set.
According to RFC 2822 it is a requirement when there are multiple From addresses, but Swift itself does not require it directly.
An associative array (with one element!) can be used to provide a display- name: i.e. array('email@address' => 'Real Name').
If the second parameter is provided and the first is a string, then $name is associated with the address.
| public abstract void setSender ( $address, $name = null ) | ||
| $address | mixed | |
| $name | string | Optional |
Set the subject of the message.
| public abstract void setSubject ( $subject ) | ||
| $subject | string | |
Set the To address(es).
Recipients set in this field will receive a copy of this message.
This method has the same synopsis as {@link setFrom()} and {@link setCc()}.
If the second parameter is provided and the first is a string, then $name is associated with the address.
| public abstract void setTo ( $addresses, $name = null ) | ||
| $addresses | mixed | |
| $name | string | Optional |