Methods summary
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
Charcoal\Email\EmailLog
|
#
setType( string $type )
Set the type of log.
Parameters
- $type
- The log type. (e.g., "email").
Returns
Throws
InvalidArgumentException If the log type is not a string.
|
public
string
|
#
type( )
Get the log type.
Returns
string
|
public
Charcoal\Email\EmailLog
|
#
setAction( string $action )
Set the logged action.
Parameters
- $action
- The log action (e.g., "send").
Returns
Throws
InvalidArgumentException If the action is not a string.
|
public
string
|
#
action( )
Get the logged action.
Returns
string
|
public
Charcoal\Email\EmailLog
|
#
setRawResponse( mixed $res )
Set the raw response from the mailer.
Set the raw response from the mailer.
Parameters
- $res
- The response object or array.
Returns
|
public
mixed
|
#
rawResponse( )
Get the raw response from the mailer.
Get the raw response from the mailer.
Returns
mixed
|
public
Charcoal\Email\EmailLog
|
#
setMessageId( string $messageId )
Set the Message-ID.
Parameters
- $messageId
- The Message-ID.
Returns
Throws
InvalidArgumentException If the Message-ID is not a string.
|
public
string
|
|
public
Charcoal\Email\EmailInterface
|
#
setCampaign( string $campaign )
Set the campaign ID.
Parameters
- $campaign
- The campaign identifier.
Returns
Throws
InvalidArgumentException If the campaign is invalid.
|
public
string
|
#
campaign( )
Get the campaign identifier.
Get the campaign identifier.
Returns
string
|
public
Charcoal\Email\EmailLog
|
#
setFrom( string|array $email )
Set the sender's email address.
Set the sender's email address.
Parameters
Returns
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\EmailLog
|
#
setTo( string|array $email )
Set the recipient's email address.
Set the recipient's email address.
Parameters
Returns
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\EmailLog
|
#
setSubject( string $subject )
Set the email subject.
Parameters
- $subject
- The email subject.
Returns
Throws
InvalidArgumentException If the subject is not a string.
|
public
string
|
#
subject( )
Get the email subject.
Returns
string
|
public
Charcoal\Email\EmailLog
|
#
setSendDate( null|string|DateTime $ts )
Parameters
- $ts
- The "send date" datetime value.
Returns
Throws
InvalidArgumentException If the ts is not a valid datetime value.
|
public
null|DateTimeInterface
|
|
public
Charcoal\Email\EmailLog
|
|
public
mixed
|
|
public
Charcoal\Email\EmailLog
|
#
setSessionId( string $sessionId )
Parameters
- $sessionId
- The session identifier.
Returns
|
public
string
|
|
public
boolean
|
#
preSave( )
Returns
boolean
See
StorableTrait::preSave()
|