A Message (RFC 2822) object.
| package | Swift |
|---|---|
| subpackage | Mime |
| author | Chris Corbyn |
charsetChanged(string $charset)
| inherited_from | \Swift_Mime_CharsetObserver::charsetChanged() |
|---|---|
| inherited_from | \Swift_Mime_MimeEntity::charsetChanged() |
string
generateId() : string
stringgetBcc() : string[]
This method always returns an associative array, whereby the keys provide the actual email addresses.
string[]getBody() : string
Returns NULL if no body has been set.
| inherited_from | \Swift_Mime_MimeEntity::getBody() |
|---|
stringgetCc() : string[]
This method always returns an associative array, whereby the keys provide the actual email addresses.
string[]getChildren() : \Swift_Mime_MimeEntity[]
These are not just the immediate children, but all children.
| inherited_from | \Swift_Mime_MimeEntity::getChildren() |
|---|
getContentType() : string
| inherited_from | \Swift_Mime_MimeEntity::getContentType() |
|---|
stringgetDate() : int
intgetFrom() : string[]
This method always returns an associative array where the keys are the addresses.
string[]getId() : string
For most entities this will likely be the Content-ID, though it has no explicit semantic meaning and can be considered an identifier for programming logic purposes. If a Content-ID header is present, this value SHOULD match the value of the header.
| inherited_from | \Swift_Mime_MimeEntity::getId() |
|---|
stringgetNestingLevel() : int
The lower the value, the more outermost the entity will be nested.
| see | LEVEL_MIXED, LEVEL_RELATED, LEVEL_ALTERNATIVE |
|---|---|
| inherited_from | \Swift_Mime_MimeEntity::getNestingLevel() |
intgetReplyTo() : string[]
This method always returns an associative array where the keys provide the email addresses.
string[]getReturnPath() : string
stringgetSender() : string
This has a higher significance than the From address.
stringgetSubject() : string
stringgetTo() : string[]
This method always returns an associative array, whereby the keys provide the actual email addresses.
string[]setBcc(mixed $addresses, string $name)
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.
mixed
stringoptional
setBody(string $body, string $contentType)
| inherited_from | \Swift_Mime_MimeEntity::setBody() |
|---|
string
stringoptional
setCc(mixed $addresses, string $name)
setChildren(array $children)
This includes grandchildren.
| inherited_from | \Swift_Mime_MimeEntity::setChildren() |
|---|
\Swift_Mime_MimeEntity[]
setDate(int $date)
int
setFrom(mixed $addresses, string $name)
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.
mixed
stringoptional
setReplyTo(mixed $addresses, string $name)
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 setFrom() and setTo().
If the second parameter is provided and the first is a string, then $name is associated with the address.
mixed
stringoptional
setReturnPath(string $address)
string
setSender(mixed $address, string $name)
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.
mixed
stringoptional
setSubject(string $subject)
string
setTo(mixed $addresses, string $name)
toByteStream(\Swift_InputByteStream $is)
| inherited_from | \Swift_Mime_MimeEntity::toByteStream() |
|---|
toString() : string
| inherited_from | \Swift_Mime_MimeEntity::toString() |
|---|
stringLEVEL_ALTERNATIVE
| inherited_from | \Swift_Mime_MimeEntity::LEVEL_ALTERNATIVE |
|---|
LEVEL_MIXED
| inherited_from | \Swift_Mime_MimeEntity::LEVEL_MIXED |
|---|
LEVEL_RELATED
| inherited_from | \Swift_Mime_MimeEntity::LEVEL_RELATED |
|---|
LEVEL_TOP
| inherited_from | \Swift_Mime_MimeEntity::LEVEL_TOP |
|---|