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

Class: Swift_Mailer

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/Mailer.php

Class Overview


Swift Mailer class.


Author(s):

  • Chris Corbyn

Methods



Class Details

[line 16]
Swift Mailer class.



Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


static method newInstance [line 38]

static Swift_Mailer newInstance( Swift_Transport $transport)

Create a new Mailer instance.



Tags:

access:  public


Parameters:

Swift_Transport   $transport  

[ Top ]

constructor __construct [line 26]

Swift_Mailer __construct( Swift_Transport $transport)

Create a new Mailer using $transport for delivery.



Tags:

access:  public


Parameters:

Swift_Transport   $transport  

[ Top ]

method createMessage [line 52]

object createMessage( [string $service = 'message'])

Create a new class instance of one of the message services.

For example 'mimepart' would create a 'message.mimepart' instance




Tags:

access:  public


Parameters:

string   $service  

[ Top ]

method getTransport [line 110]

Swift_Transport getTransport( )

The Transport used to send messages.



Tags:

access:  public


[ Top ]

method registerPlugin [line 100]

void registerPlugin( Swift_Events_EventListener $plugin)

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



Tags:

access:  public


Parameters:

Swift_Events_EventListener   $plugin  

[ Top ]

method send [line 74]

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.

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

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




Tags:

return:  The number of successful recipients. Can be 0 which indicates failure
access:  public


Parameters:

Swift_Mime_Message   $message  
array   $failedRecipients   An array of failures by-reference
   &$failedRecipients  

[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:52:04 +0000 by phpDocumentor 1.4.3