CodeIgniter v3.0.0 API
\

\CI_Email

CodeIgniter Email Class

Permits email to be sent using Mail, Sendmail, or SMTP.

Summary

Methods
Properties
Constants
__construct()
initialize()
clear()
from()
reply_to()
to()
cc()
bcc()
subject()
message()
attach()
attachment_cid()
set_header()
set_alt_message()
set_mailtype()
set_wordwrap()
set_protocol()
set_priority()
set_newline()
set_crlf()
validate_email()
valid_email()
clean_email()
word_wrap()
send()
batch_bcc_send()
print_debugger()
__destruct()
$useragent
$mailpath
$protocol
$smtp_host
$smtp_user
$smtp_pass
$smtp_port
$smtp_timeout
$smtp_keepalive
$smtp_crypto
$wordwrap
$wrapchars
$mailtype
$charset
$alt_message
$validate
$priority
$newline
$crlf
$dsn
$send_multipart
$bcc_batch_mode
$bcc_batch_size
No constants found
_str_to_array()
_get_message_id()
_get_protocol()
_get_encoding()
_get_content_type()
_set_date()
_get_mime_message()
_get_alt_message()
_build_headers()
_write_headers()
_build_message()
_attachments_have_multipart()
_append_attachments()
_prep_quoted_printable()
_prep_q_encoding()
_unwrap_specials()
_remove_nl_callback()
_spool_email()
_validate_email_for_shell()
_send_with_mail()
_send_with_sendmail()
_send_with_smtp()
_smtp_end()
_smtp_connect()
_send_command()
_smtp_authenticate()
_send_data()
_get_smtp_data()
_get_hostname()
_set_error_message()
_mime_types()
strlen()
substr()
$_subject
$_body
$_finalbody
$_header_str
$_smtp_connect
$_encoding
$_smtp_auth
$_replyto_flag
$_debug_msg
$_recipients
$_cc_array
$_bcc_array
$_headers
$_attachments
$_protocols
$_base_charsets
$_bit_depths
$_priorities
$func_overload
N/A
No private methods found
No private properties found
N/A

Properties

$useragent

$useragent : string

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

Type

string

$mailpath

$mailpath : string

Path to the Sendmail binary.

Type

string

$protocol

$protocol : string

Which method to use for sending e-mails.

Type

string — 'mail', 'sendmail' or 'smtp'

$smtp_host

$smtp_host : string

STMP Server host

Type

string

$smtp_user

$smtp_user : string

SMTP Username

Type

string

$smtp_pass

$smtp_pass : string

SMTP Password

Type

string

$smtp_port

$smtp_port : integer

SMTP Server port

Type

integer

$smtp_timeout

$smtp_timeout : integer

SMTP connection timeout in seconds

Type

integer

$smtp_keepalive

$smtp_keepalive : boolean

SMTP persistent connection

Type

boolean

$smtp_crypto

$smtp_crypto : string

SMTP Encryption

Type

string — empty, 'tls' or 'ssl'

$wordwrap

$wordwrap : boolean

Whether to apply word-wrapping to the message body.

Type

boolean

$wrapchars

$wrapchars : integer

Number of characters to wrap at.

Type

integer

$mailtype

$mailtype : string

Message format.

Type

string — 'text' or 'html'

$charset

$charset : string

Character set (default: utf-8)

Type

string

$alt_message

$alt_message : string

Alternative message (for HTML messages only)

Type

string

$validate

$validate : boolean

Whether to validate e-mail addresses.

Type

boolean

$priority

$priority : integer

X-Priority header value.

Type

integer — 1-5

$newline

$newline : string

Newline character sequence.

Use "\r\n" to comply with RFC 822.

Type

string — "\r\n" or "\n"

$crlf

$crlf : string

CRLF character sequence

RFC 2045 specifies that for 'quoted-printable' encoding, "\r\n" must be used. However, it appears that some servers (even on the receiving end) don't handle it properly and switching to "\n", while improper, is the only solution that seems to work for all environments.

Type

string

$dsn

$dsn : boolean

Whether to use Delivery Status Notification.

Type

boolean

$send_multipart

$send_multipart : boolean

Whether to send multipart alternatives.

Yahoo! doesn't seem to like these.

Type

boolean

$bcc_batch_mode

$bcc_batch_mode : boolean

Whether to send messages to BCC recipients in batches.

Type

boolean

$bcc_batch_size

$bcc_batch_size : integer

BCC Batch max number size.

Type

integer

$_subject

$_subject : string

Subject header

Type

string

$_body

$_body : string

Message body

Type

string

$_finalbody

$_finalbody : string

Final message body to be sent.

Type

string

$_header_str

$_header_str : string

Final headers to send

Type

string

$_smtp_connect

$_smtp_connect : resource

SMTP Connection socket placeholder

Type

resource

$_encoding

$_encoding : string

Mail encoding

Type

string — '8bit' or '7bit'

$_smtp_auth

$_smtp_auth : boolean

Whether to perform SMTP authentication

Type

boolean

$_replyto_flag

$_replyto_flag : boolean

Whether to send a Reply-To header

Type

boolean

$_debug_msg

$_debug_msg : string

Debug messages

Type

string

$_recipients

$_recipients : array<mixed,string>

Recipients

Type

array<mixed,string>

$_cc_array

$_cc_array : array<mixed,string>

CC Recipients

Type

array<mixed,string>

$_bcc_array

$_bcc_array : array<mixed,string>

BCC Recipients

Type

array<mixed,string>

$_headers

$_headers : array<mixed,string>

Message headers

Type

array<mixed,string>

$_attachments

$_attachments : array

Attachment data

Type

array

$_protocols

$_protocols : array<mixed,string>

Valid $protocol values

Type

array<mixed,string>

$_base_charsets

$_base_charsets : array<mixed,string>

Base charsets

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

Type

array<mixed,string>

$_bit_depths

$_bit_depths : array<mixed,string>

Bit depths

Valid mail encodings

Type

array<mixed,string>

$_priorities

$_priorities : array<mixed,string>

$priority translations

Actual values to send with the X-Priority header

Type

array<mixed,string>

$func_overload

$func_overload : boolean

mbstring.func_overload flag

Type

boolean

Methods

__construct()

__construct(array  $config = array()) : void

Constructor - Sets Email Preferences

The constructor can be passed an array of config values

Parameters

array $config

= array()

initialize()

initialize(array  $config = array()) : \CI_Email

Initialize preferences

Parameters

array $config

Returns

\CI_Email

clear()

clear(  $clear_attachments = FALSE) : \CI_Email

Initialize the Email Data

Parameters

$clear_attachments

Returns

\CI_Email

from()

from(string  $from, string  $name = '', string  $return_path = NULL) : \CI_Email

Set FROM

Parameters

string $from
string $name
string $return_path

= NULL Return-Path

Returns

\CI_Email

reply_to()

reply_to(  $replyto,   $name = '') : \CI_Email

Set Reply-to

Parameters

$replyto
$name

Returns

\CI_Email

to()

to(  $to) : \CI_Email

Set Recipients

Parameters

$to

Returns

\CI_Email

cc()

cc(  $cc) : \CI_Email

Set CC

Parameters

$cc

Returns

\CI_Email

bcc()

bcc(  $bcc,   $limit = '') : \CI_Email

Set BCC

Parameters

$bcc
$limit

Returns

\CI_Email

subject()

subject(  $subject) : \CI_Email

Set Email Subject

Parameters

$subject

Returns

\CI_Email

message()

message(  $body) : \CI_Email

Set Body

Parameters

$body

Returns

\CI_Email

attach()

attach(string  $file, string  $disposition = '', string  $newname = NULL, string  $mime = '') : \CI_Email

Assign file attachments

Parameters

string $file

Can be local path, URL or buffered content
string $disposition

= 'attachment'
string $newname

= NULL
string $mime

= ''

Returns

\CI_Email

attachment_cid()

attachment_cid(string  $filename) : string

Set and return attachment Content-ID

Useful for attached inline pictures

Parameters

string $filename

Returns

string

set_header()

set_header(  $header,   $value) : \CI_Email

Add a Header Item

Parameters

$header
$value

Returns

\CI_Email

set_alt_message()

set_alt_message(  $str) : \CI_Email

Set Multipart Value

Parameters

$str

Returns

\CI_Email

set_mailtype()

set_mailtype(  $type = 'text') : \CI_Email

Set Mailtype

Parameters

$type

Returns

\CI_Email

set_wordwrap()

set_wordwrap(  $wordwrap = TRUE) : \CI_Email

Set Wordwrap

Parameters

$wordwrap

Returns

\CI_Email

set_protocol()

set_protocol(  $protocol = 'mail') : \CI_Email

Set Protocol

Parameters

$protocol

Returns

\CI_Email

set_priority()

set_priority(  $n = 3) : \CI_Email

Set Priority

Parameters

$n

Returns

\CI_Email

set_newline()

set_newline(  $newline = "\n") : \CI_Email

Set Newline Character

Parameters

$newline

Returns

\CI_Email

set_crlf()

set_crlf(  $crlf = "\n") : \CI_Email

Set CRLF

Parameters

$crlf

Returns

\CI_Email

validate_email()

validate_email(  $email) : boolean

Validate Email Address

Parameters

$email

Returns

boolean

valid_email()

valid_email(  $email) : boolean

Email Validation

Parameters

$email

Returns

boolean

clean_email()

clean_email(  $email) : string

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

Parameters

$email

Returns

string

word_wrap()

word_wrap(  $str,   $charlim = NULL) : string

Word Wrap

Parameters

$str
$charlim

Returns

string

send()

send(boolean  $auto_clear = TRUE) : boolean

Send Email

Parameters

boolean $auto_clear

= TRUE

Returns

boolean

batch_bcc_send()

batch_bcc_send() : void

Batch Bcc Send. Sends groups of BCCs in batches

print_debugger()

print_debugger(array  $include = array('headers', 'subject', 'body')) : string

Get Debug Message

Parameters

array $include

List of raw data chunks to include in the output Valid options are: 'headers', 'subject', 'body'

Returns

string

__destruct()

__destruct() : void

Destructor

_str_to_array()

_str_to_array(  $email) : array

Convert a String to an Array

Parameters

$email

Returns

array

_get_message_id()

_get_message_id() : string

Get the Message ID

Returns

string

_get_protocol()

_get_protocol() : mixed

Get Mail Protocol

Returns

mixed

_get_encoding()

_get_encoding() : string

Get Mail Encoding

Returns

string

_get_content_type()

_get_content_type() : string

Get content type (text/html/attachment)

Returns

string

_set_date()

_set_date() : string

Set RFC 822 Date

Returns

string

_get_mime_message()

_get_mime_message() : string

Mime message

Returns

string

_get_alt_message()

_get_alt_message() : string

Build alternative plain text message

Provides the raw message for use in plain-text headers of HTML-formatted emails. If the user hasn't specified his own alternative message it creates one by stripping the HTML

Returns

string

_build_headers()

_build_headers() : void

Build final headers

_write_headers()

_write_headers() : void

Write Headers as a string

_build_message()

_build_message() : void

Build Final Body and attachments

_attachments_have_multipart()

_attachments_have_multipart(  $type)

Parameters

$type

_append_attachments()

_append_attachments(string  $body, string  $boundary, string  $multipart = null) : string

Prepares attachment string

Parameters

string $body

Message body to append to
string $boundary

Multipart boundary
string $multipart

When provided, only attachments of this type will be processed

Returns

string

_prep_quoted_printable()

_prep_quoted_printable(  $str) : string

Prep Quoted Printable

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

Parameters

$str

Returns

string

_prep_q_encoding()

_prep_q_encoding(  $str) : string

Prep Q Encoding

Performs "Q Encoding" on a string for use in email headers. It's related but not identical to quoted-printable, so it has its own method.

Parameters

$str

Returns

string

_unwrap_specials()

_unwrap_specials() : void

Unwrap special elements

_remove_nl_callback()

_remove_nl_callback(string  $matches) : string

Strip line-breaks via callback

Parameters

string $matches

Returns

string

_spool_email()

_spool_email() : boolean

Spool mail to the mail server

Returns

boolean

_validate_email_for_shell()

_validate_email_for_shell(string  $email) : boolean

Validate email for shell

Applies stricter, shell-safe validation to email addresses. Introduced to prevent RCE via sendmail's -f option.

Parameters

string $email

Returns

boolean

_send_with_mail()

_send_with_mail() : boolean

Send using mail()

Returns

boolean

_send_with_sendmail()

_send_with_sendmail() : boolean

Send using Sendmail

Returns

boolean

_send_with_smtp()

_send_with_smtp() : boolean

Send using SMTP

Returns

boolean

_smtp_end()

_smtp_end() : void

SMTP End

Shortcut to send RSET or QUIT depending on keep-alive

_smtp_connect()

_smtp_connect() : string

SMTP Connect

Returns

string

_send_command()

_send_command(  $cmd,   $data = '') : boolean

Send SMTP command

Parameters

$cmd
$data

Returns

boolean

_smtp_authenticate()

_smtp_authenticate() : boolean

SMTP Authenticate

Returns

boolean

_send_data()

_send_data(string  $data) : boolean

Send SMTP data

Parameters

string $data

Returns

boolean

_get_smtp_data()

_get_smtp_data() : string

Get SMTP data

Returns

string

_get_hostname()

_get_hostname() : string

Get Hostname

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]").

Returns

string

_set_error_message()

_set_error_message(string  $msg, string  $val = '') : void

Set Message

Parameters

string $msg
string $val

= ''

_mime_types()

_mime_types(  $ext = '') : string

Mime Types

Parameters

$ext

Returns

string

strlen()

strlen(string  $str) : integer

Byte-safe strlen()

Parameters

string $str

Returns

integer

substr()

substr(string  $str, integer  $start, integer  $length = NULL) : string

Byte-safe substr()

Parameters

string $str
integer $start
integer $length

Returns

string