Swift
[ class tree: Swift ] [ index: Swift ] [ all elements ]

Class: Swift_Mailer

Source Location: /vendors/swift/classes/Swift/Mailer.php

Class Overview


Swift Mailer class.


Author(s):

  • Chris Corbyn

Methods



Class Details

[line 22]
Swift Mailer class.



Tags:

author:  Chris Corbyn
filesource:  Source Code for this file


[ Top ]


Class Methods


static method newInstance [line 44]

static Swift_Mailer newInstance( Swift_Transport $transport)

Create a new Mailer instance.



Tags:

access:  public


Parameters:

Swift_Transport   $transport  

[ Top ]

constructor __construct [line 33]

Swift_Mailer __construct( Swift_Transport $transport)

Create a new Mailer using $transport for delivery.



Tags:

access:  public


Parameters:

Swift_Transport   $transport  

[ Top ]

method batchSend [line 102]

int batchSend( Swift_Mime_Message $message, [ &$failedRecipients = null], [Swift_Mailer_RecipientIterator $it = null], array &$failedRecipients,, Swift_Mailer_RecipientIterator $it,)

Send the given Message to all recipients individually.

This differs from send() in the way headers are presented to the recipient. The only recipient in the "To:" field will be the individual recipient it was sent to.

If an iterator is provided, recipients will be read from the iterator one-by-one, otherwise recipient data will be retreived from the Message object.

Sender information is always read from the Message object.

The return value is the number of recipients who were accepted for delivery.




Tags:

see:  Swift_Mailer::send()
access:  public


Parameters:

Swift_Mime_Message   $message  
array   &$failedRecipients,   optional
Swift_Mailer_RecipientIterator   $it,   optional
   &$failedRecipients  
Swift_Mailer_RecipientIterator   $it  

[ Top ]

method getTransport [line 169]

Swift_Transport getTransport( )

The Transport used to send messages.



Tags:

access:  public


[ Top ]

method registerPlugin [line 160]

void registerPlugin( Swift_Events_EventListener $plugin, string $key)

Register a plugin using a known unique key (e.g. myPlugin).



Tags:

access:  public


Parameters:

Swift_Events_EventListener   $plugin  
string   $key  

[ Top ]

method send [line 68]

int send( Swift_Mime_Message $message, [ &$failedRecipients = null], array &$failedRecipients,)

Send the given Message like it would be sent in a mail client.

All recipients (with the exception of Bcc) will be able to see the other recipients this message was sent to.

If you need to send to each recipient without disclosing details about the other recipients see batchSend().

Recipient/sender data will be retreived from the Message object.

The return value is the number of recipients who were accepted for delivery.




Tags:

see:  Swift_Mailer::batchSend()
access:  public


Parameters:

Swift_Mime_Message   $message  
array   &$failedRecipients,   optional
   &$failedRecipients  

[ Top ]


Documentation generated on Mon, 05 Sep 2011 20:33:40 -0500 by phpDocumentor 1.4.3