Mailer
in package

Table of Contents

filterContentType()  : string
Filter email content type.
filterFromEmail()  : string
Filter the from address for outgoing emails.
filterFromName()  : string
Filter the from name for outgoing emails.
send()  : bool
Send an email.

Methods

filterContentType()

Filter email content type.

public filterContentType(string $contentType) : string
Parameters
$contentType : string
Return values
string —

filterFromEmail()

Filter the from address for outgoing emails.

public filterFromEmail(string $fromAddress) : string
Parameters
$fromAddress : string
Return values
string —

filterFromName()

Filter the from name for outgoing emails.

public filterFromName(string $fromName) : string
Parameters
$fromName : string
Return values
string —

send()

Send an email.

public send(string|array<string|int, mixed> $to, string $subject, string $message[, array<string|int, mixed>|string $headers = '' ][, array<string|int, mixed>|string $attachments = array() ]) : bool
Parameters
$to : string|array<string|int, mixed>

Array or comma-separated list of email addresses to send message.

$subject : string
$message : string
$headers : array<string|int, mixed>|string = ''

Optional. Additional headers.

$attachments : array<string|int, mixed>|string = array()

Optional. Files to attach.

Tags
since
3.7.1

added actions "mphb_before_send_mail" and "mphb_after_send_mail".

since
3.8.6

actions "mphb_before_send_mail" and "mphb_after_send_mail" moved to AbstractEmail::send().

Return values
bool —

success

Search results