PHP Класс nineinchnick\nfy\components\MailQueue

Subscriptions are tracked using a different queue.

Наследование: extends nineinchnick\nfy\components\Queue

Открытые свойства

Свойство	Тип	Описание
$composeCallback		a callable to compose a new email using the message body
$mailer		mailer through which messages are sent and which credentials are used to check email
$recipientCallback		a callable to fetch recipients email using a subscriber id
$sendToSubscriptionQueue		set to true to also send the message to the subscription queue
$subscriptionQueue		queue used to track subscriptions

Открытые методы

Метод	Описание
delete ( $message_id, $subscriber_id = null )
getSubscriptions ( $subscriber_id = null )
init ( )
isSubscribed ( $subscriber_id, $category = null )
peek ( $subscriber_id = null, $limit, $status = Message::AVAILABLE )
receive ( $subscriber_id = null, $limit )
release ( $message_id, $subscriber_id = null )
releaseTimedout ( )
reserve ( $subscriber_id = null, $limit )
send ( $message, $category = null )
subscribe ( $subscriber_id, $label = null, $categories = null, $exceptions = null )
unsubscribe ( $subscriber_id, $categories = null )

Защищенные методы

Метод	Описание
createMessage ( string $body ) : yii\mail\MessageInterface	Creates an instance of a Message.

Описание методов

createMessage() защищенный Метод

This method may be overriden in extending classes.

protected createMessage ( string $body ) : yii\mail\MessageInterface
$body	string	message body
Результат	yii\mail\MessageInterface

delete() публичный Метод

public delete ( $message_id, $subscriber_id = null )

getSubscriptions() публичный Метод

public getSubscriptions ( $subscriber_id = null )

init() публичный Метод

public init ( )

isSubscribed() публичный Метод

public isSubscribed ( $subscriber_id, $category = null )

peek() публичный Метод

public peek ( $subscriber_id = null, $limit, $status = Message::AVAILABLE )

receive() публичный Метод

public receive ( $subscriber_id = null, $limit )

release() публичный Метод

public release ( $message_id, $subscriber_id = null )

releaseTimedout() публичный Метод

public releaseTimedout ( )

reserve() публичный Метод

public reserve ( $subscriber_id = null, $limit )

send() публичный Метод

public send ( $message, $category = null )

unsubscribe() публичный Метод

public unsubscribe ( $subscriber_id, $categories = null )

Описание свойств

$composeCallback публичное свойство

a callable to compose a new email using the message body

public $composeCallback

$mailer публичное свойство

mailer through which messages are sent and which credentials are used to check email

public $mailer

$recipientCallback публичное свойство

a callable to fetch recipients email using a subscriber id

public $recipientCallback

$sendToSubscriptionQueue публичное свойство

set to true to also send the message to the subscription queue

public $sendToSubscriptionQueue

$subscriptionQueue публичное свойство

queue used to track subscriptions

public $subscriptionQueue