Methods summary
public
Charcoal\Email\Email
|
#
setData( array $data )
Set the email's data.
Parameters
Returns
|
public
Charcoal\Email\EmailInterface
|
#
setCampaign( string $campaign )
Set the campaign ID.
Parameters
- $campaign
- The campaign identifier.
Returns
|
public
string
|
#
campaign( )
Get the campaign identifier.
Get the campaign identifier.
Returns
string
|
public
Charcoal\Email\EmailInterface
|
#
setTo( string|array $email )
Set the recipient email address(es).
Set the recipient email address(es).
Parameters
- $email
- The recipient email address(es).
Returns
|
public
Charcoal\Email\EmailInterface
|
#
addTo( mixed $email )
Add a recipient email address.
Add a recipient email address.
Parameters
- $email
- The recipient email address to add.
Returns
|
public
string[]
|
#
to( )
Get the recipient's email address.
Get the recipient's email address.
Returns
string[]
|
public
Charcoal\Email\EmailInterface
|
#
setCc( string|array $email )
Set the carbon copy (CC) recipient email address(es).
Set the carbon copy (CC) recipient email address(es).
Parameters
- $email
- The CC recipient email address(es).
Returns
|
public
Charcoal\Email\EmailInterface
|
#
addCc( mixed $email )
Add a CC recipient email address.
Add a CC recipient email address.
Parameters
- $email
- The CC recipient email address to add.
Returns
|
public
string[]
|
#
cc( )
Get the CC recipient's email address.
Get the CC recipient's email address.
Returns
string[]
|
public
Charcoal\Email\EmailInterface
|
#
setBcc( string|array $email )
Set the blind carbon copy (BCC) recipient email address(es).
Set the blind carbon copy (BCC) recipient email address(es).
Parameters
- $email
- The BCC recipient email address(es).
Returns
|
public
Charcoal\Email\EmailInterface
|
#
addBcc( mixed $email )
Add a BCC recipient email address.
Add a BCC recipient email address.
Parameters
- $email
- The BCC recipient email address to add.
Returns
|
public
string[]
|
#
bcc( )
Get the BCC recipient's email address.
Get the BCC recipient's email address.
Returns
string[]
|
public
Charcoal\Email\EmailInterface
|
#
setFrom( string|array $email )
Set the sender's email address.
Set the sender's email address.
Parameters
Returns
|
public
string
|
#
from( )
Get the sender's email address.
Get the sender's email address.
Returns
string
|
public
Charcoal\Email\EmailInterface
|
#
setReplyTo( mixed $email )
Set email address to reply to the message.
Set email address to reply to the message.
Parameters
- $email
- The sender's "Reply-To" email address.
Returns
|
public
string
|
#
replyTo( )
Get email address to reply to the message.
Get email address to reply to the message.
Returns
string
|
public
Charcoal\Email\EmailInterface
|
#
setSubject( string $subject )
Set the email subject.
Parameters
- $subject
- The email subject.
Returns
|
public
string
|
#
subject( )
Get the email subject.
Returns
string
The emails' subject.
|
public
Charcoal\Email\EmailInterface
|
#
setMsgHtml( string $body )
Set the email's HTML message body.
Set the email's HTML message body.
Parameters
- $body
- The HTML message body.
Returns
|
public
string
|
#
msgHtml( )
Get the email's HTML message body.
Get the email's HTML message body.
Returns
string
|
public
Charcoal\Email\EmailInterface
|
#
setMsgTxt( string $body )
Set the email's plain-text message body.
Set the email's plain-text message body.
Parameters
- $body
- The message's text body.
Returns
|
public
string
|
#
msgTxt( )
Get the email's plain-text message body.
Get the email's plain-text message body.
Returns
string
|
public
Charcoal\Email\EmailInterface
|
#
setAttachments( array $attachments )
Set the email's attachments.
Set the email's attachments.
Parameters
- $attachments
- The file attachments.
Returns
|
public
Charcoal\Email\EmailInterface
|
#
addAttachment( mixed $attachment )
Add an attachment to the email.
Add an attachment to the email.
Parameters
- $attachment
- A single file attachment.
Returns
|
public
array
|
#
attachments( )
Get the email's attachments.
Get the email's attachments.
Returns
array
|
public
Charcoal\Email\EmailInterface
|
#
setLog( boolean $log )
Enable or disable logging for this particular email.
Enable or disable logging for this particular email.
Parameters
Returns
|
public
boolean
|
#
log( )
Determine if logging is enabled for this particular email.
Determine if logging is enabled for this particular email.
Returns
boolean
|
public
Charcoal\Email\EmailInterface
|
#
setTrack( boolean $track )
Enable or disable tracking for this particular email.
Enable or disable tracking for this particular email.
Parameters
Returns
|
public
boolean
|
#
track( )
Determine if tracking is enabled for this particular email.
Determine if tracking is enabled for this particular email.
Returns
boolean
|
public
boolean
|
#
send( )
Send the email to all recipients.
Send the email to all recipients.
Returns
boolean
Success / Failure.
|
public
boolean
|
#
queue( mixed $ts = null )
Enqueue the email for each recipient.
Enqueue the email for each recipient.
Parameters
- $ts
- A date/time to initiate the queue processing.
Returns
boolean
Success / Failure.
|