CodeIgniter v4.6 API

Email

in package

• Application

CodeIgniter Email Class

Tags

see

EmailTest

Table of Contents

Properties

$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  : " "|"n"

CRLF character sequence

$DSN  : bool

Whether to use Delivery Status Notification.

$fromEmail  : string

$fromName  : string

$mailPath  : string

Path to the Sendmail binary.

$mailType  : "html"|"text"

Message format.

$newline  : " "|"n"

Newline character sequence.

$priority  : int<1, 5>

X-Priority header value.

$protocol  : "mail"|"sendmail"|"smtp"

Which method to use for sending e-mails.

$sendMultipart  : bool

Whether to send multipart alternatives.

$SMTPCrypto  : ""|"ssl"|"tls"

SMTP Encryption

$SMTPHost  : string

STMP Server Hostname

$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<int, string>

Character sets valid for 7-bit encoding, excluding language suffix.

$BCCArray  : array<string|int, mixed>

BCC Recipients

$bitDepths  : array<int, string>

Bit depths

$body  : string

Message body

$CCArray  : array<string|int, mixed>

CC Recipients

$debugMessage  : array<string|int, mixed>

Debug messages

$encoding  : "7bit"|"8bit"

Mail encoding

$finalBody  : string

Final message body to be sent.

$func_overload  : bool|null

mbstring.func_overload flag

$headers  : array<string|int, mixed>

Message headers

$headerStr  : string

Final headers to send

$priorities  : array<int, string>

$priority translations

$protocols  : array<int, string>

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.

$debugMessageRaw  : array<int, string>

Raw debug messages

Methods

__construct()  : mixed

__destruct()  : mixed

attach()  : bool|Email

batchBCCSend()  : void

Batch Bcc Send. Sends groups of BCCs in batches

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

clear()  : $this

initialize()  : $this

Initialize preferences

isValidEmail()  : bool

printDebugger()  : string

send()  : bool

setAltMessage()  : $this

setAttachmentCID()  : bool|string

Set and return attachment Content-ID Useful for attached inline pictures

setBCC()  : $this

setCC()  : $this

setCRLF()  : $this

setFrom()  : $this

setHeader()  : $this

setMailType()  : $this

setMessage()  : $this

setNewline()  : $this

setPriority()  : $this

setProtocol()  : $this

setReplyTo()  : $this

setSubject()  : $this

setTo()  : $this

setWordWrap()  : $this

validateEmail()  : bool

wordWrap()  : string

appendAttachments()  : void

attachmentsHaveMultipart()  : bool

buildHeaders()  : void

Build final headers

buildMessage()  : void

Build Final Body and attachments

getAltMessage()  : string

Build alternative plain text message

getContentType()  : string

getEncoding()  : string

getHostname()  : string

There are only two legal types of hostname - either a fully qualified domain name (eg: "mail.example.com") or an IP literal (eg: "[1.2.3.4]").

getMessageID()  : string

getMimeMessage()  : string

getProtocol()  : string

getSMTPData()  : string

mimeTypes()  : string

Mime Types

prepQEncoding()  : string

Performs "Q Encoding" on a string for use in email headers.

prepQuotedPrintable()  : string

Prepares string for Quoted-Printable Content-Transfer-Encoding Refer to RFC 2045 http://www.ietf.org/rfc/rfc2045.txt

removeNLCallback()  : string

Strip line-breaks via callback

sendCommand()  : bool

sendData()  : bool

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()  : void

SMTPAuthenticate()  : bool

SMTPConnect()  : bool|string

SMTPEnd()  : void

Shortcut to send RSET or QUIT depending on keep-alive

spoolEmail()  : bool

Spool mail to the mail server

stringToArray()  : array<int, string>

strlen()  : int

Byte-safe strlen()

substr()  : string

Byte-safe substr()

unwrapSpecials()  : void

Unwrap special elements

validateEmailForShell()  : bool

Validate email for shell

writeHeaders()  : void

Write Headers as a string

printDebuggerRaw()  : string

Returns raw debug messages