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
| Name | Type(s) | Description |
|---|---|---|
options (optional) | array, string | Optional settings to override defaults, or string for
|
Return value
Hooking $mail->new(…)
You can add your own hook events that are executed either before or after the $mail 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 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 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;
});API reference based on ProcessWire core version 3.0.137