Send an email or get a WireMail object to populate before send

  • Please note that the order of arguments is different from PHP’s mail() function.
  • If no arguments are specified it simply returns a WireMail object (see #4 below).
  • This is a procedural version of functions provided by the $mail API variable (see that for more options).
  • This function will attempt to use an installed module that extends WireMail.
  • If no other WireMail module is installed, the default WireMail (which uses PHP mail) will be used instead.

// Default usage:
wireMail($to, $from, $subject, $body, $options);

// Specify body and/or bodyHTML in $options array (perhaps with other options):
$options = [ 'body' => $body, 'bodyHTML' => $bodyHTML ];
wireMail($to, $from, $subject, $options);

// Specify both $body and $bodyHTML as arguments, but no $options:
wireMail($to, $from, $subject, $body, $bodyHTML);

// Specify a blank call to wireMail() to get the WireMail sending object. This can
// be either WireMail() or a class descending from it. If a WireMail descending
// module is installed, it will be returned rather than WireMail():
$mail = wireMail();
$mail->to('user

Usage

// basic usage
$int = wireMail();

// usage with all arguments
$int = wireMail($to = '', string $from = '', string $subject = '', $body = '', $options = array);

Arguments

NameType(s)Description
to (optional)string, array

Email address TO. For multiple, specify CSV string or array.

from (optional)string

Email address FROM. This may be an email address, or a combined name and email address. Example of combined name and email: `Karen Cramer <karen

subject (optional)string

Email subject

body (optional)string, array

Email body or omit to move straight to $options array

options (optional)array, string

Array of options OR the $bodyHTML string. Array $options are:

  • bodyHTML (string): Email body as HTML.
  • body (string): Email body as plain text. This is created automatically if you only provide $bodyHTML.
  • headers (array): Associative array of ['header name' => 'header value']
    • Any additional options you provide will be sent along to the WireMail module or class, in tact.

Return value

int WireMail

Returns number of messages sent or WireMail object if no arguments specified.


Functions methods and properties

API reference based on ProcessWire core version 3.0.160

Twitter updates

  • ProcessWire 3.0.161 adds support for selector operator stacking, enabling you automatically broaden searches in a single pages.find() call— More
    26 June 2020
  • ProcessWire 3.0.160 adds powerful new text-searching operators, bringing a new level of power to page-finding API calls, especially when it comes to search engine type queries. Post also includes a demo search engine where you can test it all out live— More
    19 June 2020
  • Preview of ProcessWire 3.0.160 with auto-enable of two-factor authentication, new version of TfaEmail and TfaTotp, and new selector operators coming next week. More
    12 June 2020

Latest news

  • ProcessWire Weekly #320
    In the 320th issue of ProcessWire Weekly we're going to check out the latest core updates (ProcessWire 3.0.161), a new third party module called Fieldtype Runtime only, an IndieWeb themed article from Francesco Schwarz, and more. Read on!
    Weekly.pw / 27 June 2020
  • Powerful new text-searching abilities in 3.0.160
    In ProcessWire 3.0.160 we’ve got some major upgrades and additions to our text-search abilities. This brings a whole new level of power to $pages->find() and similar API calls, especially when it comes to search engine type queries.
    Blog / 19 June 2020
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer