PHP Class Swift_Mailer, Halite

Author: Chris Corbyn
Afficher le fichier Open project: HaliteChallenge/Halite Class Usage Examples

Méthodes publiques

Méthode Description
__construct ( Swift_Transport $transport ) Create a new Mailer using $transport for delivery.
createMessage ( string $service = 'message' ) : object Create a new class instance of one of the message services.
getTransport ( ) : Swift_Transport The Transport used to send messages.
newInstance ( Swift_Transport $transport ) : Swift_Mailer Create a new Mailer instance.
registerPlugin ( Swift_Events_EventListener $plugin ) Register a plugin using a known unique key (e.g. myPlugin).
send ( Swift_Mime_Message $message, array &$failedRecipients = null ) : integer Send the given Message like it would be sent in a mail client.

Method Details

__construct() public méthode

Create a new Mailer using $transport for delivery.
public __construct ( Swift_Transport $transport )
$transport Swift_Transport

createMessage() public méthode

For example 'mimepart' would create a 'message.mimepart' instance
public createMessage ( string $service = 'message' ) : object
$service string
Résultat object

getTransport() public méthode

The Transport used to send messages.
public getTransport ( ) : Swift_Transport
Résultat Swift_Transport

newInstance() public static méthode

Create a new Mailer instance.
public static newInstance ( Swift_Transport $transport ) : Swift_Mailer
$transport Swift_Transport
Résultat Swift_Mailer

registerPlugin() public méthode

Register a plugin using a known unique key (e.g. myPlugin).
public registerPlugin ( Swift_Events_EventListener $plugin )
$plugin Swift_Events_EventListener

send() public méthode

All recipients (with the exception of Bcc) will be able to see the other recipients this message was sent to. Recipient/sender data will be retrieved from the Message object. The return value is the number of recipients who were accepted for delivery.
public send ( Swift_Mime_Message $message, array &$failedRecipients = null ) : integer
$message Swift_Mime_Message
$failedRecipients array An array of failures by-reference
Résultat integer The number of successful recipients. Can be 0 which indicates failure