Documentation

Email extends BaseConfig
in package

Table of Contents

Properties

$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
$SMTPCrypto  : string
SMTP Encryption.
$SMTPHost  : string
SMTP Server Hostname
$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

Properties

$BCCBatchMode

Enable BCC Batch Mode.

public bool $BCCBatchMode = false

$BCCBatchSize

Number of emails in each BCC batch

public int $BCCBatchSize = 200

$charset

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

public string $charset = 'UTF-8'

$CRLF

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

public string $CRLF = "\r\n"

$DSN

Enable notify message from server

public bool $DSN = false

$fromEmail

public string $fromEmail = ''

$fromName

public string $fromName = ''

$mailPath

The server path to Sendmail.

public string $mailPath = '/usr/sbin/sendmail'

$mailType

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

public string $mailType = 'text'

$newline

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

public string $newline = "\r\n"

$priority

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

public int $priority = 3

$protocol

The mail sending protocol: mail, sendmail, smtp

public string $protocol = 'mail'

$recipients

public string $recipients = ''

$SMTPCrypto

SMTP Encryption.

public string $SMTPCrypto = 'tls'

'', 'tls' or 'ssl'. 'tls' will issue a STARTTLS command to the server. 'ssl' means implicit SSL. Connection on port 465 should set this to ''.

$SMTPHost

SMTP Server Hostname

public string $SMTPHost = ''

$SMTPKeepAlive

Enable persistent SMTP connections

public bool $SMTPKeepAlive = false

$SMTPPass

SMTP Password

public string $SMTPPass = ''

$SMTPPort

SMTP Port

public int $SMTPPort = 25

$SMTPTimeout

SMTP Timeout (in seconds)

public int $SMTPTimeout = 5

$SMTPUser

SMTP Username

public string $SMTPUser = ''

$userAgent

The "user agent"

public string $userAgent = 'CodeIgniter'

$validate

Whether to validate the email address

public bool $validate = false

$wordWrap

Enable word-wrap

public bool $wordWrap = true

$wrapChars

Character count to wrap at

public int $wrapChars = 76 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results