Documentation

Email

in package

• Application

CodeIgniter Email Class

Table of Contents

$altMessage  : string

Alternative message (for HTML messages only)

$archive  : array<string|int, mixed>|null

Properties from the last successful send.

$BCCBatchMode  : bool

Whether to send messages to BCC recipients in batches.

$BCCBatchSize  : int|string

BCC Batch max number size.

$charset  : string

Character set (default: utf-8)

$CRLF  : string

CRLF character sequence

$DSN  : bool

Whether to use Delivery Status Notification.

$fromEmail  : string

$fromName  : string

$mailPath  : string

Path to the Sendmail binary.

$mailType  : string

Message format.

$newline  : string

Newline character sequence.

$priority  : int

X-Priority header value.

$protocol  : string

Which method to use for sending e-mails.

$sendMultipart  : bool

Whether to send multipart alternatives.

$SMTPCrypto  : string

SMTP Encryption

$SMTPHost  : string

STMP Server host

$SMTPKeepAlive  : bool

SMTP persistent connection

$SMTPPass  : string

SMTP Password

$SMTPPort  : int

SMTP Server port

$SMTPTimeout  : int

SMTP connection timeout in seconds

$SMTPUser  : string

SMTP Username

$userAgent  : string

Used as the User-Agent and X-Mailer headers' value.

$validate  : bool

Whether to validate e-mail addresses.

$wordWrap  : bool

Whether to apply word-wrapping to the message body.

$wrapChars  : int

Number of characters to wrap at.

$attachments  : array<string|int, mixed>

Attachment data

$baseCharsets  : array<string|int, mixed>

Base charsets

$BCCArray  : array<string|int, mixed>

BCC Recipients

$bitDepths  : array<string|int, mixed>

Bit depths

$body  : string

Message body

$CCArray  : array<string|int, mixed>

CC Recipients

$debugMessage  : array<string|int, mixed>

Debug messages

$encoding  : string

Mail encoding

$finalBody  : string

Final message body to be sent.

$func_overload  : bool

mbstring.func_overload flag

$headers  : array<string|int, mixed>

Message headers

$headerStr  : string

Final headers to send

$priorities  : array<string|int, mixed>

$priority translations

$protocols  : array<string|int, mixed>

Valid $protocol values

$recipients  : array<string|int, mixed>|string

Recipients

$replyToFlag  : bool

Whether to send a Reply-To header

$SMTPAuth  : bool

Whether to perform SMTP authentication

$SMTPConnect  : resource|null

SMTP Connection socket placeholder

$subject  : string

Subject header

$tmpArchive  : array<string|int, mixed>

Properties to be added to the next archive.

__construct()  : mixed

Constructor - Sets Email Preferences

__destruct()  : mixed

Destructor

attach()  : Email|bool

Assign file attachments

batchBCCSend()  : mixed

Batch Bcc Send. Sends groups of BCCs in batches

cleanEmail()  : array<string|int, mixed>|string

Clean Extended Email Address: Joe Smith <joe@smith.com>

clear()  : Email

Initialize the Email Data

initialize()  : Email

Initialize preferences

isValidEmail()  : bool

Email Validation

printDebugger()  : string

Get Debug Message

send()  : bool

Send Email

setAltMessage()  : Email

Set Multipart Value

setAttachmentCID()  : string|bool

Set and return attachment Content-ID

setBCC()  : Email

Set BCC

setCC()  : Email

Set CC

setCRLF()  : Email

Set CRLF

setFrom()  : Email

Set FROM

setHeader()  : Email

Add a Header Item

setMailType()  : Email

Set Mailtype

setMessage()  : Email

Set Body

setNewline()  : Email

Set Newline Character

setPriority()  : Email

Set Priority

setProtocol()  : Email

Set Protocol

setReplyTo()  : Email

Set Reply-to

setSubject()  : Email

Set Email Subject

setTo()  : Email

Set Recipients

setWordWrap()  : Email

Set Wordwrap

validateEmail()  : bool

Validate Email Address

wordWrap()  : string

Word Wrap

appendAttachments()  : void

Prepares attachment string

attachmentsHaveMultipart()  : bool

buildHeaders()  : mixed

Build final headers

buildMessage()  : mixed

Build Final Body and attachments

getAltMessage()  : string

Build alternative plain text message

getContentType()  : string

Get content type (text/html/attachment)

getEncoding()  : string

Get Mail Encoding

getHostname()  : string

Get Hostname

getMessageID()  : string

Get the Message ID

getMimeMessage()  : string

Mime message

getProtocol()  : string

Get Mail Protocol

getSMTPData()  : string

Get SMTP data

mimeTypes()  : string

Mime Types

prepQEncoding()  : string

Prep Q Encoding

prepQuotedPrintable()  : string

Prep Quoted Printable

removeNLCallback()  : string

Strip line-breaks via callback

sendCommand()  : bool

Send SMTP command

sendData()  : bool

Send SMTP data

sendWithMail()  : bool

Send using mail()

sendWithSendmail()  : bool

Send using Sendmail

sendWithSmtp()  : bool

Send using SMTP

setArchiveValues()  : array<string|int, mixed>

Determines the values that should be stored in $archive.

setDate()  : string

Set RFC 822 Date

setErrorMessage()  : mixed

Set Message

SMTPAuthenticate()  : bool

SMTP Authenticate

SMTPConnect()  : string|bool

SMTP Connect

SMTPEnd()  : mixed

SMTP End

spoolEmail()  : bool

Spool mail to the mail server

stringToArray()  : array<string|int, mixed>

Convert a String to an Array

strlen()  : int

Byte-safe strlen()

substr()  : string

Byte-safe substr()

unwrapSpecials()  : mixed

Unwrap special elements

validateEmailForShell()  : bool

Validate email for shell

writeHeaders()  : mixed

Write Headers as a string