Overview

Namespaces

  • Charcoal
    • Email
      • Script
      • ServiceProvider

Classes

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

Interfaces

  • EmailInterface

Traits

  • EmailAwareTrait
  • Overview
  • Namespace
  • Class

Trait EmailAwareTrait

For objects that are or interact with emails.

Direct Known Users

Charcoal\Email\Email, Charcoal\Email\EmailConfig, Charcoal\Email\EmailLog, Charcoal\Email\EmailQueueItem
Namespace: Charcoal\Email
Located at Charcoal/Email/EmailAwareTrait.php
Methods summary
protected string
# emailToArray( mixed $var )

Convert an email address (RFC822) into a proper array notation.

Convert an email address (RFC822) into a proper array notation.

Parameters

$var
An email array (containing an "email" key and optionally a "name" key).

Returns

string

Throws

InvalidArgumentException
If the email is invalid.
protected string
# emailFromArray( array $arr )

Convert an email address array to a RFC-822 string notation.

Convert an email address array to a RFC-822 string notation.

Parameters

$arr
An email array (containing an "email" key and optionally a "name" key).

Returns

string

Throws

InvalidArgumentException
If the email array is invalid.
API documentation generated by ApiGen