$mail

Provides an API interface to email and WireMail.

// Simple usage example
$message = $mail->new();
$message->subject('Hello world')
  ->to('user@domain.com')
  ->from('you@company.com')
  ->body('Hello there big world')
  ->bodyHTML('<h2>Hello there big world</h2>');
$numSent = $message->send();

// ProcessWire 3.0.113 lets you skip the $mail->new() call if you want:
$numSent = $mail->subject('Hello world')
  ->to('user@domain.com')
  ->from('you@company.com')
  ->body('Hello there big world')
  ->bodyHTML('<h2>Hello there big world</h2>')
  ->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 WireMailTools class also inherits all the methods and properties of: Wire.

Show $var?     Show args?       Only hookable?    

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.252

Latest news

  • ProcessWire Weekly #597
    The 597 issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 18 October 2025
  • Best practices for using API variables
    ProcessWire’s API is accessible through API variables and it provides multiple ways to access them. There are benefits and drawbacks to each approach and this post aims to cover them all.
    Blog / 17 October 2025
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer