Documentation

Email extends BaseConfig

in package

• Application

Class BaseConfig

Table of Contents

$BCCBatchMode  : bool

Enable BCC Batch Mode.

$BCCBatchSize  : int

Number of emails in each BCC batch

$charset  : string

Character set (utf-8, iso-8859-1, etc.)

$CRLF  : string

Newline character. (Use “\r\n” to comply with RFC 822)

$DSN  : bool

Enable notify message from server

$fromEmail  : string

$fromName  : string

$mailPath  : string

The server path to Sendmail.

$mailType  : string

Type of mail, either 'text' or 'html'

$newline  : string

Newline character. (Use “\r\n” to comply with RFC 822)

$priority  : int

Email Priority. 1 = highest. 5 = lowest. 3 = normal

$protocol  : string

The mail sending protocol: mail, sendmail, smtp

$recipients  : string

$registrars  : array<string|int, mixed>

An optional array of classes that will act as Registrars for rapidly setting config class properties.

$SMTPCrypto  : string

SMTP Encryption. Either tls or ssl

$SMTPHost  : string

SMTP Server Address

$SMTPKeepAlive  : bool

Enable persistent SMTP connections

$SMTPPass  : string

SMTP Password

$SMTPPort  : int

SMTP Port

$SMTPTimeout  : int

SMTP Timeout (in seconds)

$SMTPUser  : string

SMTP Username

$userAgent  : string

The "user agent"

$validate  : bool

Whether to validate the email address

$wordWrap  : bool

Enable word-wrap

$wrapChars  : int

Character count to wrap at

$didDiscovery  : bool

Has module discovery happened yet?

$moduleConfig  : Modules

The modules configuration.

__construct()  : mixed

Will attempt to get environment variables with names that match the properties of the child class.

getEnvValue()  : mixed

Retrieve an environment-specific configuration setting

initEnvValue()  : mixed

Initialization an environment-specific configuration setting

registerProperties()  : mixed

Provides external libraries a simple way to register one or more options into a config file.