Property | Type | Description | |
---|---|---|---|
$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 |
Method | Description | |
---|---|---|
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 ) |
Method | Description | |
---|---|---|
createMessage ( string $body ) : yii\mail\MessageInterface | Creates an instance of a Message. |
protected createMessage ( string $body ) : yii\mail\MessageInterface | ||
$body | string | message body |
return | yii\mail\MessageInterface |
public subscribe ( $subscriber_id, $label = null, $categories = null, $exceptions = null ) |
public $composeCallback |
public $mailer |
public $recipientCallback |
public $sendToSubscriptionQueue |