Class EmailQueueItem

Email queue item.

Charcoal\Model\AbstractModel

Charcoal\Email\EmailQueueItem implements Charcoal\Queue\QueueItemInterface uses Charcoal\Queue\QueueItemTrait (not available) Charcoal\Email\EmailAwareTrait

Namespace: Charcoal\Email
Located at Charcoal/Email/EmailQueueItem.php

Methods summary
`public`	# `setDependencies( Pimple\Container $container )` Parameters `$container` Pimple DI container.
`protected Charcoal\Email\EmailQueueItem`	# `setEmailFactory( Charcoal\Factory\FactoryInterface $factory )` Parameters `$factory` The factory to create email objects. Returns `Charcoal\Email\EmailQueueItem` Chainable
`protected Charcoal\Factory\FactoryInterface`	# `emailFactory( )` Returns Charcoal\Factory\FactoryInterface
`public string`	# `key( )` Get the primary key that uniquely identifies each queue item. Get the primary key that uniquely identifies each queue item. Returns string
`public AbstractMessage`	# `setIdent( string\|null $ident )` Set the queue item's ID. Set the queue item's ID. Parameters `$ident` The unique queue item identifier. Returns AbstractMessage Chainable Throws InvalidArgumentException If the identifier is not a string.
`public string`	# `ident( )` Get the queue item's ID. Get the queue item's ID. Returns string
`public Charcoal\Email\EmailQueueItem`	# `setTo( string\|array $email )` Set the recipient's email address. Set the recipient's email address. Parameters `$email` An email address. Returns `Charcoal\Email\EmailQueueItem` Chainable Throws InvalidArgumentException If the email address is invalid.
`public string`	# `to( )` Get the recipient's email address. Get the recipient's email address. Returns string
`public Charcoal\Email\EmailQueueItem`	# `setFrom( string\|array $email )` Set the sender's email address. Set the sender's email address. Parameters `$email` An email address. Returns `Charcoal\Email\EmailQueueItem` Chainable Throws InvalidArgumentException If the email address is invalid.
`public string`	# `from( )` Get the sender's email address. Get the sender's email address. Returns string
`public Charcoal\Email\EmailQueueItem`	# `setSubject( string $subject )` Set the email subject. Set the email subject. Parameters `$subject` The email subject. Returns `Charcoal\Email\EmailQueueItem` Chainable Throws InvalidArgumentException If the subject is not a string.
`public string`	# `subject( )` Get the email subject. Get the email subject. Returns string
`public Charcoal\Email\EmailQueueItem`	# `setMsgHtml( string $body )` Set the email's HTML message body. Set the email's HTML message body. Parameters `$body` The HTML message body. Returns `Charcoal\Email\EmailQueueItem` Chainable Throws InvalidArgumentException If the message is not a string.
`public string`	# `msgHtml( )` Get the email's HTML message body. Get the email's HTML message body. Returns string
`public Charcoal\Email\EmailQueueItem`	# `setMsgTxt( string $body )` Set the email's plain-text message body. Set the email's plain-text message body. Parameters `$body` The plain-text mesage body. Returns `Charcoal\Email\EmailQueueItem` Chainable Throws InvalidArgumentException If the message is not a string.
`public string`	# `msgTxt( )` Get the email's plain-text message body. Get the email's plain-text message body. Returns string
`public Charcoal\Email\EmailQueueItem`	# `setCampaign( string $campaign )` Set the campaign ID. Set the campaign ID. Parameters `$campaign` The campaign identifier. Returns `Charcoal\Email\EmailQueueItem` Chainable Throws InvalidArgumentException If the campaign is not a string.
`public string`	# `campaign( )` Get the campaign ID. Get the campaign ID. If it has not been explicitely set, it will be auto-generated (with uniqid). Returns string
`public boolean`	# `process( callable $callback = null, callable $successCallback = null, callable $failureCallback = null )` Process the item. Process the item. Parameters `$callback` An optional callback routine executed after the item is processed. `$successCallback` An optional callback routine executed when the item is resolved. `$failureCallback` An optional callback routine executed when the item is rejected. Returns boolean Success / Failure
`public boolean`	# `preSave( )` Hook called before saving the item. Hook called before saving the item. Returns boolean See \Charcoal\Email\Queue\QueueItemTrait::preSaveQueueItem()

Methods used from Charcoal\Email\EmailAwareTrait
`emailFromArray(), emailToArray()`

Namespaces

Classes

Interfaces

Traits

Class EmailQueueItem

Parameters

Parameters

Returns

Returns

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns

Returns

See