ProMailerQueues::pause()

Pause the queue item

Usage

// basic usage
$bool = $proMailerQueues->pause($item);

// usage with all arguments
$bool = $proMailerQueues->pause($item, bool $resume = false);

Arguments

NameType(s)Description
$itemProMailerQueue ProMailerMessage
$resume (optional)bool

Specify true to resume a paused item

Return value

bool

Exceptions

Method can throw exceptions on error:

  • WireException


ProMailerQueues methods and properties

API reference based on ProcessWire core version 3.0.253