\apex\app\interfaces\msgEmailerInterface

E-Mailer Interface

Summary

Methods
Constants
dispatch()
process_emails()
send()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

process_emails()

process_emails(string  $controller,integer  $userid,array  $condition = array(),array  $data = array())

Processes any necessary notifications. Takes in the type of notifications, and additional variables. Checks each notification against the condition, and sends any that match.

Parameters

string $controller

The notification controller / type alias of which to check.

integer $userid

The user ID# for which notifications are being processed against.

array $condition

Associative array containing details on the current request, and is checked against the condition notifications were created with.

array $data

Associatve array that is passed to the notification controller, and contains any additional information to retrieve merge variables (eg. transaction ID#, support ticket ID#, etc.)

send()

send(string  $to_email,string  $to_name,string  $from_email,string  $from_name,string  $subject,string  $message,string  $content_type = 'text/plain',string  $reply_to = '',string  $cc = '',string  $bcc = '',array  $attachments = array())

Send single e-mail message.

Send a single e-mail message vir rotating SMTP servers, or if not SMTP servers available via phpmail(). Dispatches the e-mail to a listener to take advantage of horizontal scaling with RabbitMQ.

Parameters

string $to_email

E-mail address of the recipient.

string $to_name

Full name of the recipient.

string $from_email

E-mail address of the sender.

string $from_name

Full name of the sender.

string $subject

The subject of the e-mail message.

string $message

The contents of the e-mail message to send.

string $content_type

Optional, and the content type of the e-mail message. Defaults to "text/plain".

string $reply_to

Optional, the the Reply-To e-mail address.

string $cc

Optional, and the e-mail address to CC the message to.

string $bcc

Optional, and the e-mail address to BCC the message to.

array $attachments

Optional, and associative array of file attachments to include, keys are the filename and value is contents of file.