Send the email
Call this method only after you have specified at least the subject
, to
and body
.
Usage
$int = $m->send();
Return value
int
Returns a positive number (indicating number of addresses emailed) or 0 on failure.
Hooking $m->send()
You can add your own hook events that are executed either before or after the $m->send()
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 $m->send()
method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('WireMail::send', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$WireMail = $event->object;
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
});
Hooking after
The 'after' hooks are called immediately after each $m->send()
method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.
$this->addHookAfter('WireMail::send', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$WireMail = $event->object;
// An 'after' hook can retrieve and/or modify the return value
$return = $event->return;
/* 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.236