• Home
  • Swift_Mime_Message

PHP Interface Swift_Mime_Message, Halite

Author: Chris Corbyn
Inheritance: extends Swift_Mime_MimeEntity
Show file Open project: HaliteChallenge/Halite Interface Usage Examples

Public Methods

Method Description
generateId ( ) : string Generates a valid Message-ID and switches to it.
getBcc ( ) : string[] Get the Bcc addresses for this message.
getCc ( ) : string[] Get the Cc addresses for this message.
getDate ( ) : integer Get the origination date of the message as a UNIX timestamp.
getFrom ( ) : string[] Get the From address(es) of this message.
getReplyTo ( ) : string[] Get the Reply-To addresses for this message.
getReturnPath ( ) : string Get the return-path (bounce-detect) address.
getSender ( ) : string Get the sender address for this message.
getSubject ( ) : string Get the subject of the message.
getTo ( ) : string[] Get the To addresses for this message.
setBcc ( mixed $addresses, string $name = null ) Set the Bcc address(es).
setCc ( mixed $addresses, string $name = null ) Set the Cc address(es).
setDate ( integer $date ) Set the origination date of the message as a UNIX timestamp.
setFrom ( mixed $addresses, string $name = null ) Set the From address of this message.
setReplyTo ( mixed $addresses, string $name = null ) Set the Reply-To address(es).
setReturnPath ( string $address ) Set the return-path (bounce-detect) address.
setSender ( mixed $address, string $name = null ) Set the sender of this message.
setSubject ( string $subject ) Set the subject of the message.
setTo ( mixed $addresses, string $name = null ) Set the To address(es).

Method Details

generateId() public method

Generates a valid Message-ID and switches to it.
public generateId ( ) : string
return string

getBcc() public method

This method always returns an associative array, whereby the keys provide the actual email addresses.
public getBcc ( ) : string[]
return string[]

getCc() public method

This method always returns an associative array, whereby the keys provide the actual email addresses.
public getCc ( ) : string[]
return string[]

getDate() public method

Get the origination date of the message as a UNIX timestamp.
public getDate ( ) : integer
return integer

getFrom() public method

This method always returns an associative array where the keys are the addresses.
public getFrom ( ) : string[]
return string[]

getReplyTo() public method

This method always returns an associative array where the keys provide the email addresses.
public getReplyTo ( ) : string[]
return string[]

getReturnPath() public method

Get the return-path (bounce-detect) address.
public getReturnPath ( ) : string
return string

getSender() public method

This has a higher significance than the From address.
public getSender ( ) : string
return string

getSubject() public method

Get the subject of the message.
public getSubject ( ) : string
return string

getTo() public method

This method always returns an associative array, whereby the keys provide the actual email addresses.
public getTo ( ) : string[]
return string[]

setBcc() public method

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 setBcc ( mixed $addresses, string $name = null )
$addresses mixed
$name string optional

setCc() public method

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 setCc ( mixed $addresses, string $name = null )
$addresses mixed
$name string optional

setDate() public method

Set the origination date of the message as a UNIX timestamp.
public setDate ( integer $date )
$date integer

setFrom() public method

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 protected]' => 'Real Name'). If the second parameter is provided and the first is a string, then $name is associated with the address.
public setFrom ( mixed $addresses, string $name = null )
$addresses mixed
$name string optional

setReplyTo() public method

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 setReplyTo ( mixed $addresses, string $name = null )
$addresses mixed
$name string optional

setReturnPath() public method

Set the return-path (bounce-detect) address.
public setReturnPath ( string $address )
$address string

setSender() public method

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 setSender ( mixed $address, string $name = null )
$address mixed
$name string optional

setSubject() public method

Set the subject of the message.
public setSubject ( string $subject )
$subject string

setTo() public method

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 setTo ( mixed $addresses, string $name = null )
$addresses mixed
$name string optional