$mail apivar
Provides an API interface to email and WireMail.
wireMail($to = '', string $from = '', string $subject = '', $body = '', $options = array) function
Send an email or get a WireMail object to populate before send
WireMail class
A module type that handles sending of email in ProcessWire
wireMail($key = '', $value = null) apivar.method
$mail->new($options = []) apivar.method
Get a new WireMail instance for sending email
$mail->to($email, string $name = null) apivar.method
Return new WireMail instance populated with “to” email
$mail->from(string $email, $name = null) apivar.method
Return new WireMail instance populated with “from” email
$mail->subject(string $subject) apivar.method
Return new WireMail instance populated with subject
$m->get(string $key) function.method
Get property
$m->set(string $key, mixed $value) function.method
Set property
$m->to($email = null, string $name = null) function.method
Set the email to address
$m->toName(string $name) function.method
Set the 'to' name
$m->from(string $email, $name = null) function.method
Set the email 'from' address and optionally name
$m->fromName(string $name) function.method
Set the 'from' name
$m->replyTo(string $email, $name = null) function.method
Set the 'reply-to' email address and optionally name (where supported)
$m->replyToName(string $name) function.method
Set the 'reply-to' name (where supported)
$m->subject(string $subject) function.method
Set the email subject
$m->body(string $body) function.method
Set the email message body (text only)
$m->bodyHTML(string $body) function.method
Set the email message body (HTML only)
$m->header($key, string $value) function.method
Set any email header
$m->headers(array $headers) function.method
Set multiple email headers using associative array
$m->param(string $value) function.method
Set any email param
$m->attachment(string $value, string $filename = '') function.method
Add a file to be attached to the email
$m->send() function.method
Send the email
$m->encodeSubject(string $subject) function.method
Encode a subject, use mbstring if available