A module type that handles sending of email in ProcessWire
Below are 2 different ways you can get a new instance of Wire Once you have an instance of Wire Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the In addition to the methods and properties above, Wire$m = $mail->new(); // option A: use $mail API variable
$m = wireMail(); // option B: use wireMail() function$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();Wire class also inherits all the methods and properties of: WireData and Wire.Common
Name Return Summary $thisSet the email message body (text only)
Can also be used as property: $m->body $thisSet the email message body (HTML only)
Can also be used as property: $m->bodyHTML $thisSet the email 'from' address and optionally name
Can also be used as property: $m->from $thisSet the 'from' name
Can also be used as property: $m->fromName mixed nullGet property $thisSet multiple email headers using associative array
Can also be used as property: $m->headers stringConvert HTML email body to TEXT email body. $thisSet the 'reply-to' email address and optionally name (where supported)
Can also be used as property: $m->replyTo $thisSet the 'reply-to' name (where supported)
Can also be used as property: $m->replyToName intSend the email this WireDataSet property $thisSet the email subject
Can also be used as property: $m->subject $thisSet the email to address
Can also be used as property: $m->to $thisSet the 'to' name
Can also be used as property: $m->toName Advanced
Name Return Summary $thisAdd a file to be attached to the email $m->attachments array Array of file attachments (if populated and where supported) stringEncode a subject, use mbstring if available $thisSet any email header
Can also be used as property: $m->header $m->newline string Newline character, populated only if different from CRLF. $thisSet any email param
Can also be used as property: $m->param stringReturn the text quoted-printable encoded Additional methods and properties
API reference based on ProcessWire core version 3.0.236