ProMailerQueues::sendMessage()

Send message

To use a hook to skip sending a message to particular subscriber

This protected method is for hooks to monitor and it is likely not intended to be called directly.

Example

$wire->addHookBefore('ProMailerQueues::sendMessage', function($event) {
  $message = $event->arguments(0);
  $list = $event->arguments(1);
  $subscriber = $event->arguments(2);

  if(condition where you want to skip this particular send) {
    $event->return = 'skip';
    $event->replace = true;
  }
});

Internal usage

$array = $proMailerQueues->sendMessage(ProMailerMessage $message, ProMailerList $list, ProMailerSubscriber $subscriber);

Arguments

Name	Type(s)	Description
`$message`	`ProMailerMessage`
`$list`	`ProMailerList`
`$subscriber`	`ProMailerSubscriber`

Return value

array bool string

Hooking ProMailerQueues::sendMessage(…)

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

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

  // Get values of arguments sent to hook (and optionally modify them)
  $message = $event->arguments(0);
  $list = $event->arguments(1);
  $subscriber = $event->arguments(2);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $message);
  $event->arguments(1, $list);
  $event->arguments(2, $subscriber);
});

Hooking after

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

$this->addHookAfter('ProMailerQueues::sendMessage', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $ProMailerQueues = $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)
  $message = $event->arguments(0);
  $list = $event->arguments(1);
  $subscriber = $event->arguments(2);

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

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

ProMailerQueues methods and properties

API reference based on ProcessWire core version 3.0.255