$mail->new() method

Get a new WireMail instance for sending email

Note: The $options argument added in 3.0.123, previous versions had no $options argument.

Example

$message = $mail->new();
$message->to('user@domain.com')->from('you@company.com');
$message->subject('Mail Subject')->body('Mail Body Text')->bodyHTML('Body HTML');
$numSent = $message->send();

Usage

// basic usage
$wireMail = $mail->new();

// usage with all arguments
$wireMail = $mail->new($options = []);

Arguments

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

Optional settings to override defaults, or string for module option:

  • module (string): Class name of WireMail module you want to use rather than auto detect, or 'WireMail' to force using default PHP mail. If requested module is not available, it will fall-back to one that is (or PHP mail), so check class name of returned value if there is any doubt about what WireMail module is being used.
  • You may also specify: subject, from, fromName, to, toName, subject or any other WireMail property and it will be populated.

Return value


Hooking $mail->new(…)

You can add your own hook events that are executed either before or after the $mail->new(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each $mail->new(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('WireMailTools::new', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $mail = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $options = $event->arguments(0);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $options);
});

Hooking after

The 'after' hooks are called immediately after each $mail->new(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('WireMailTools::new', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $mail = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $options = $event->arguments(0);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

$mail methods and properties

API reference based on ProcessWire core version 3.0.130

Twitter updates

  • New post: Quietly and without interruption this week, the ProcessWire.com website (and all subdomains) moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before— More
    19 April 2019
  • New post: With ProcessWire 3.0.130, this week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each—More
    12 April 2019
  • New post: This week ProcessWire ProMailer has been released, plus we’ve got a nice upgrade in our community support forum, and more— More
    15 March 2019

Latest news

  • ProcessWire Weekly #258
    In the 258th issue of ProcessWire Weekly we'll cover a hosting upgrade for the processwire.com site and it's subdomains, introduce PW Review and Terminal module, and feature the new site of O'Neil Cinema. Read on!
    Weekly.pw / 20 April 2019
  • ProcessWire.com website hosting upgrades
    Quietly and without interruption this week, our whole website moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before.
    Blog / 19 April 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