Overview

Namespaces

  • Charcoal
    • Email
      • Script
      • ServiceProvider

Classes

  • Email
  • EmailConfig
  • EmailLog
  • EmailQueueItem
  • EmailQueueManager
  • GenericEmailTemplate

Interfaces

  • EmailInterface

Traits

  • EmailAwareTrait
  • Overview
  • Namespace
  • Class

Class EmailLog

Email log

Charcoal\Model\AbstractModel
Extended by Charcoal\Email\EmailLog uses Charcoal\Email\EmailAwareTrait
Namespace: Charcoal\Email
Located at Charcoal/Email/EmailLog.php
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.

Set the type of log.

Parameters

$type
The log type. (e.g., "email").

Returns

Charcoal\Email\EmailLog
Chainable

Throws

InvalidArgumentException
If the log type is not a string.
public string
# type( )

Get the log type.

Get the log type.

Returns

string
public Charcoal\Email\EmailLog
# setAction( string $action )

Set the logged action.

Set the logged action.

Parameters

$action
The log action (e.g., "send").

Returns

Charcoal\Email\EmailLog
Chainable

Throws

InvalidArgumentException
If the action is not a string.
public string
# action( )

Get the logged 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

Charcoal\Email\EmailLog
Chainable
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.

Set the Message-ID.

Parameters

$messageId
The Message-ID.

Returns

Charcoal\Email\EmailLog
Chainable

Throws

InvalidArgumentException
If the Message-ID is not a string.
public string
# messageId( )

Get the Message-ID.

Get the Message-ID.

Returns

string
public Charcoal\Email\EmailInterface
# setCampaign( string $campaign )

Set the campaign ID.

Set the campaign ID.

Parameters

$campaign
The campaign identifier.

Returns

Charcoal\Email\EmailInterface
Chainable

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

$email
An email address.

Returns

Charcoal\Email\EmailLog
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\EmailLog
# setTo( string|array $email )

Set the recipient's email address.

Set the recipient's email address.

Parameters

$email
An email address.

Returns

Charcoal\Email\EmailLog
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\EmailLog
# setSubject( string $subject )

Set the email subject.

Set the email subject.

Parameters

$subject
The email subject.

Returns

Charcoal\Email\EmailLog
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\EmailLog
# setSendDate( null|string|DateTime $ts )

Parameters

$ts
The "send date" datetime value.

Returns

Charcoal\Email\EmailLog
Chainable

Throws

InvalidArgumentException
If the ts is not a valid datetime value.
public null|DateTimeInterface
# sendDate( )

Returns

null|DateTimeInterface
public Charcoal\Email\EmailLog
# setIp( mixed $ip )

Parameters

$ip
The IP adress.

Returns

Charcoal\Email\EmailLog
Chainable
public mixed
# ip( )

Returns

mixed
public Charcoal\Email\EmailLog
# setSessionId( string $sessionId )

Parameters

$sessionId
The session identifier.

Returns

Charcoal\Email\EmailLog
Chainable
public string
# sessionId( )

Returns

string
public boolean
# preSave( )

Returns

boolean

See

StorableTrait::preSave()
Methods used from Charcoal\Email\EmailAwareTrait
emailFromArray(), emailToArray()
API documentation generated by ApiGen