ProMailerEmail::subscriberMessageFail() method

Message failed to send to subscriber

Usage

$proMailerEmail->subscriberMessageFail(array $data);

Arguments

NameType(s)Description
dataarray

Receives a copy of data for the send:

  • subscriber (ProMailerSubscriber)
  • message (ProMailerMessage)
  • mailer (WireMail)
  • bodyText (string)
  • bodyHtml (string)
  • subject (string)
  • success (bool)
  • error (string)

Hooking ProMailerEmail::subscriberMessageFail(…)

You can add your own hook events that are executed either before or after the ProMailerEmail::subscriberMessageFail(…) 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 ProMailerEmail::subscriberMessageFail(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each ProMailerEmail::subscriberMessageFail(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('ProMailerEmail::subscriberMessageFail', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $ProMailerEmail = $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)
  $data = $event->arguments(0);

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

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

ProMailerEmail methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #553
    In the 553rd issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module called Text Synthesis, and more. Read on!
    Weekly.pw / 14 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH