WireMail class

A module type that handles sending of email in ProcessWire

Below are 3 different ways you can get a new instance of WireMail. When possible we recommend using option A or B below.

$m = $mail->new(); // option A
$m = wireMail(); // option B
$m = new WireMail(); // option C

Once you have an instance of WireMail ($m), you can use it to send email like in these examples below.

// chained (fluent) method call usage
$m->to('user@domain.com')
  ->from('you@company.com')
  ->subject('Message Subject')
  ->body('Message Body')
  ->send();

// separate method call usage
$m->to('user@domain.com'); // specify CSV string or array for multiple addresses
$m->from('you@company.com');
$m->subject('Message Subject');
$m->body('Message Body');
$m->send();

// optionally specify “from” or “to” names as 2nd argument
$m->to('user@domain.com', 'John Smith');
$m->from('you@company.com', 'Mary Jane');

// other methods or properties you might set (or get)
$m->bodyHTML('<html><body><h1>Message Body</h1></body></html>');
$m->attachment('/path/to/file.ext');
$m->fromName('Mary Jane');
$m->toName('John Smith');
$m->header('X-Mailer', 'ProcessWire');
$m->param('-f you@company.com'); // PHP mail() param (envelope from example)

// note that the send() function always returns the quantity of messages sent
$numSent = $m->send();

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the WireMail class also inherits all the methods and properties of: WireData and Wire.

Show $var?             Show args?        

Common

NameReturnSummary 
$m->body(string $body)
$thisSet the email message body (text only)
Can also be used as property: $m->body
 
$m->bodyHTML(string $body)
$thisSet the email message body (HTML only)
Can also be used as property: $m->bodyHTML
 
$m->from(string $email)
$thisSet the email 'from' address and optionally name
Can also be used as property: $m->from
 
$m->fromName(string $name)
$thisSet the 'from' name
Can also be used as property: $m->fromName
 
$m->get(string $key)
mixed nullGet property 
$m->headers(array $headers)
$thisSet multiple email headers using associative array
Can also be used as property: $m->headers
 
$m->htmlToText($html)
stringConvert HTML email body to TEXT email body.
$m->replyTo(string $email)
$thisSet the 'reply-to' email address and optionally name (where supported)
Can also be used as property: $m->replyTo
 
$m->replyToName(string $name)
$thisSet the 'reply-to' name (where supported)
Can also be used as property: $m->replyToName
 
$m->send()
intSend the email
$m->set(string $key, mixed $value)
this WireDataSet property 
$m->subject(string $subject)
$thisSet the email subject
Can also be used as property: $m->subject
 
$m->to()
$thisSet the email to address
Can also be used as property: $m->to
 
$m->toName(string $name)
$thisSet the 'to' name
Can also be used as property: $m->toName
 

Advanced

NameReturnSummary 
$m->attachment(string $value)
$thisAdd a file to be attached to the email 
$m->attachments array Array of file attachments (if populated and where supported)  
$m->encodeSubject(string $subject)
stringEncode a subject, use mbstring if available 
$m->header($key, string $value)
$thisSet any email header
Can also be used as property: $m->header
 
$m->newline string Newline character, populated only if different from CRLF.  
$m->param(string $value)
$thisSet any email param
Can also be used as property: $m->param
 
$m->quotedPrintableString(string $text)
stringReturn the text quoted-printable encoded 

Additional methods and properties

In addition to the methods and properties above, WireMail also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.137

Twitter updates

  • ProcessWire 3.0.144 and 3.0.145 add improved field template context override settings and include a new Inputfields API, along with numerous other issue fixes, optimizations and improvements to the core. More
    8 November 2019
  • ProcessWire 3.0.144 core updates: Upgraded overrides section in the field editor, a new Inputfields JS API, and more— More
    1 November 2019
  • ProcessWire 3.0.143 core updates — 26 commits and 18 resolved issue reports, plus some other useful improvements and additions. More here: More
    25 October 2019

Latest news

  • ProcessWire Weekly #288
    In the 288th issue of ProcessWire Weekly we'll cover the latest core updates, introduce WireMailSendGrid, host a new weekly poll, and showcase a new site of the week. Read on!
    Weekly.pw / 16 November 2019
  • ProcessWire 3.0.145 core updates
    ProcessWire 3.0.144 and 3.0.145 add improved field template context override settings and include a new Inputfields API, along with numerous other issue fixes, optimizations and improvements to the core.
    Blog / 8 November 2019
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer