Interface Swift_Mime_Message

A Message (RFC 2822) object.

Swift_Mime_Message implements Swift_Mime_MimeEntity

Direct known implementers

Swift_Mime_SimpleMessage

Indirect known implementers

Package: Swift\Mime
Author: Chris Corbyn
Located at classes/swiftmailer/lib/classes/Swift/Mime/Message.php

Methods summary
`public string`	# `generateId( )` Generates a valid Message-ID and switches to it. Generates a valid Message-ID and switches to it. Returns string
`public`	# `setSubject( string $subject )` Set the subject of the message. Set the subject of the message. Parameters `$subject`
`public string`	# `getSubject( )` Get the subject of the message. Get the subject of the message. Returns string
`public`	# `setDate( integer $date )` Set the origination date of the message as a UNIX timestamp. Set the origination date of the message as a UNIX timestamp. Parameters `$date`
`public integer`	# `getDate( )` Get the origination date of the message as a UNIX timestamp. Get the origination date of the message as a UNIX timestamp. Returns integer
`public`	# `setReturnPath( string $address )` Set the return-path (bounce-detect) address. Set the return-path (bounce-detect) address. Parameters `$address`
`public string`	# `getReturnPath( )` Get the return-path (bounce-detect) address. Get the return-path (bounce-detect) address. Returns string
`public`	# `setSender( mixed $address, string $name = null )` Set the sender of this message. 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. Parameters `$address` `$name` optional
`public string`	# `getSender( )` Get the sender address for this message. Get the sender address for this message. This has a higher significance than the From address. Returns string
`public`	# `setFrom( mixed $addresses, string $name = null )` Set the From address of this message. 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. Parameters `$addresses` `$name` optional
`public string[]`	# `getFrom( )` Get the From address(es) of this message. Get the From address(es) of this message. This method always returns an associative array where the keys are the addresses. Returns string[]
`public`	# `setReplyTo( mixed $addresses, string $name = null )` Set the Reply-To address(es). 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 `Swift_Mime_Message::setFrom()` and `Swift_Mime_Message::setTo()`. If the second parameter is provided and the first is a string, then $name is associated with the address. Parameters `$addresses` `$name` optional
`public string[]`	# `getReplyTo( )` Get the Reply-To addresses for this message. Get the Reply-To addresses for this message. This method always returns an associative array where the keys provide the email addresses. Returns string[]
`public`	# `setTo( mixed $addresses, string $name = null )` Set the To address(es). Set the To address(es). Recipients set in this field will receive a copy of this message. This method has the same synopsis as `Swift_Mime_Message::setFrom()` and `Swift_Mime_Message::setCc()`. If the second parameter is provided and the first is a string, then $name is associated with the address. Parameters `$addresses` `$name` optional
`public string[]`	# `getTo( )` Get the To addresses for this message. Get the To addresses for this message. This method always returns an associative array, whereby the keys provide the actual email addresses. Returns string[]
`public`	# `setCc( mixed $addresses, string $name = null )` Set the Cc address(es). 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 `Swift_Mime_Message::setFrom()` and `Swift_Mime_Message::setTo()`. Parameters `$addresses` `$name` optional
`public string[]`	# `getCc( )` Get the Cc addresses for this message. Get the Cc addresses for this message. This method always returns an associative array, whereby the keys provide the actual email addresses. Returns string[]
`public`	# `setBcc( mixed $addresses, string $name = null )` Set the Bcc address(es). 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 `Swift_Mime_Message::setFrom()` and `Swift_Mime_Message::setTo()`. Parameters `$addresses` `$name` optional
`public string[]`	# `getBcc( )` Get the Bcc addresses for this message. Get the Bcc addresses for this message. This method always returns an associative array, whereby the keys provide the actual email addresses. Returns string[]

Methods inherited from Swift_Mime_MimeEntity
`getBody(), getChildren(), getContentType(), getHeaders(), getId(), getNestingLevel(), setBody(), setChildren(), toByteStream(), toString()`

Methods inherited from Swift_Mime_EncodingObserver
`encoderChanged()`

Methods inherited from Swift_Mime_CharsetObserver
`charsetChanged()`

Constants inherited from Swift_Mime_MimeEntity
`LEVEL_ALTERNATIVE, LEVEL_MIXED, LEVEL_RELATED, LEVEL_TOP`