PHP Class Mailer

Since: 5.0.0
Author: Al Brookbanks
Inheritance: extends PHPMailer
Show file Open project: openeyes/openeyes Class Usage Examples

Public Properties

Property Type Description
$divert array Addresses to which we should divert emails to. If empty then no diversion.
$host Configuration for SMTP.
$mode string Can be mail, smtp, sendmail. If empty then mail is disabled and messages are dropped silently.
$password
$port
$security SSL or TLS.
$sendmail_command
$username

Protected Properties

Property Type Description
$_mailer
$_transport

Public Methods

Method Description
init ( ) Initialise the component by pulling in the appropriate SwiftMailer classes.
mail ( array $to, string $subject, string $body, array $from ) : boolean Mailer:mail is intended as a more robust simple replacement for php mail(),.
newMessage ( ) : Swift_Message Instantiate an appropriate SwiftMailer email message object.
sendMessage ( Swift_Message $message ) : boolean Send an email.

Protected Methods

Method Description
censorMessage ( Swift_Message $message ) : Swift_Message If we deem a mail address to be insecure, we should censor the message, otherwise returns intact.
directlySendMessage ( Swift_Message $message ) : boolean Sends a message to the recipient, censors if they are forbidden.
divertMessage ( Swift_Message $message ) : boolean Diverts an email from its original destination. Useful for testing things in nearlive.
getMailer ( ) : Swift_Mailer Get the SwiftMailer object with the configured transport.
getTransport ( ) : Transport return the transport object for the configured mail type.
recipientForbidden ( Swift_Message $message ) : boolean Checks the email recipients are in domains that are allowed.

Method Details

censorMessage() protected method

If we deem a mail address to be insecure, we should censor the message, otherwise returns intact.
protected censorMessage ( Swift_Message $message ) : Swift_Message
$message Swift_Message
return Swift_Message

directlySendMessage() protected method

Sends a message to the recipient, censors if they are forbidden.
protected directlySendMessage ( Swift_Message $message ) : boolean
$message Swift_Message
return boolean

divertMessage() protected method

Diverts an email from its original destination. Useful for testing things in nearlive.
protected divertMessage ( Swift_Message $message ) : boolean
$message Swift_Message
return boolean

getMailer() protected method

Get the SwiftMailer object with the configured transport.
protected getMailer ( ) : Swift_Mailer
return Swift_Mailer

getTransport() protected method

return the transport object for the configured mail type.
protected getTransport ( ) : Transport
return Transport object

init() public method

Initialise the component by pulling in the appropriate SwiftMailer classes.
public init ( )

mail() public static method

Mailer:mail is intended as a more robust simple replacement for php mail(),.
public static mail ( array $to, string $subject, string $body, array $from ) : boolean
$to array address eg array('[email protected]'=>'OpenEyes')
$subject string
$body string
$from array address eg array('[email protected]'=>'OpenEyes')
return boolean mail sent without error

newMessage() public method

Instantiate an appropriate SwiftMailer email message object.
public newMessage ( ) : Swift_Message
return Swift_Message

recipientForbidden() protected method

Checks the email recipients are in domains that are allowed.
protected recipientForbidden ( Swift_Message $message ) : boolean
$message Swift_Message
return boolean

sendMessage() public method

Send an email.
public sendMessage ( Swift_Message $message ) : boolean
$message Swift_Message
return boolean

Property Details

$_mailer protected property

protected $_mailer

$_transport protected property

protected $_transport

$divert public property

Addresses to which we should divert emails to. If empty then no diversion.
public array $divert
return array

$host public property

Configuration for SMTP.
public $host

$mode public property

Can be mail, smtp, sendmail. If empty then mail is disabled and messages are dropped silently.
public string $mode
return string

$password public property

public $password

$port public property

public $port

$security public property

SSL or TLS.
public $security

$sendmail_command public property

public $sendmail_command

$username public property

public $username