ProMailerQueues class

Copyright 2023 by Ryan Cramer

This is a commercial module, do not distribute.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the ProMailerQueues class also inherits all the methods and properties of: ProMailerTypeManager and Wire.

Common

Name	Return	Summary
ProMailerQueues::add() ProMailerQueues::add($item) ProMailerQueues::add($item)	`bool`	Add item to queue
ProMailerQueues::get() ProMailerQueues::get($messageId) ProMailerQueues::get($messageId)	`ProMailerQueue` `null`	Get queue item for given message
ProMailerQueues::getAll() ProMailerQueues::getAll() ProMailerQueues::getAll($messageId = 0)	`ProMailerQueue`	Get all queued items
ProMailerQueues::install() ProMailerQueues::install() ProMailerQueues::install()	`bool`	Install
ProMailerQueues::pause() ProMailerQueues::pause($item) ProMailerQueues::pause($item, bool $resume = false)	`bool`	Pause the queue item
ProMailerQueues::process() ProMailerQueues::process() ProMailerQueues::process(bool $forceRun = false)	`int`	Process sending any messages in the queue for this request
ProMailerQueues::processQueue() ProMailerQueues::processQueue(ProMailerQueue $queue) ProMailerQueues::processQueue(ProMailerQueue $queue)	`bool`	Process individual item in the queue
ProMailerQueues::remove() ProMailerQueues::remove($item) ProMailerQueues::remove($item)	`bool`	Remove a message from the sending queue
ProMailerQueues::resume() ProMailerQueues::resume($item) ProMailerQueues::resume($item)	`bool`	Resume a paused queue item
ProMailerQueues::save() ProMailerQueues::save(ProMailerQueue $queue) ProMailerQueues::save(ProMailerQueue $queue, bool $add = false)	`bool`	Save a queue item
ProMailerQueues::table() ProMailerQueues::table() ProMailerQueues::table()	`string`	Get queues table
ProMailerQueues::upgrade() ProMailerQueues::upgrade($fromVersion, $toVersion) ProMailerQueues::upgrade($fromVersion, $toVersion)	`bool`	Upgrade

Additional methods and properties

In addition to the methods and properties above, ProMailerQueues also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.255