WireMail class

A module type that handles sending of email in ProcessWire

Below are 2 different ways you can get a new instance of WireMail.

$m = $mail->new(); // option A: use $mail API variable
$m = wireMail(); // option B: use wireMail() function

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('Optional message body in plain text')
  ->bodyHTML('<html><body><p>Optional message body in HTML</p></body></html>')
  ->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->fromName('Mary Jane');
$m->toName('John Smith');
$m->replyTo('somebody@somewhere.com');
$m->replyToName('Joe Somebody');
$m->attachment('/path/to/file.ext');
$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.209

Twitter updates

  • Adding custom actions to ProcessWire image fields in the admin, part of this week’s dev branch additions: More
    27 January 2023
  • ProcessWire 3.0.210 new main/master version released— More
    6 January 2023
  • ProcessWire 3.0.209: Core updates and an interesting AI that knows ProcessWire– More
    30 December 2022

Latest news

  • ProcessWire Weekly #455
    In the 455th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new third party module called JkPublishPages, and more. Read on!
    Weekly.pw / 28 January 2023
  • ProcessWire 3.0.210 new main/master version
    140 commits, 55 resolved issues, dozens of new features, eight contributors, and five new pull requests make yet another great new version of ProcessWire.
    Blog / 6 January 2023
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits