CI_Email Class Reference

List of all members.

Public Member Functions
	CI_Email ($config=array())
	initialize ($config=array())
	clear ($clear_attachments=FALSE)
	from ($from, $name= '')
	reply_to ($replyto, $name= '')
	to ($to)
	cc ($cc)
	bcc ($bcc, $limit= '')
	subject ($subject)
	message ($body)
	attach ($filename, $disposition= 'attachment')
	_set_header ($header, $value)
	_str_to_array ($email)
	set_alt_message ($str= '')
	set_mailtype ($type= 'text')
	set_wordwrap ($wordwrap=TRUE)
	set_protocol ($protocol= 'mail')
	set_priority ($n=3)
	set_newline ($newline="\n")
	set_crlf ($crlf="\n")
	_set_boundaries ()
	_get_message_id ()
	_get_protocol ($return=TRUE)
	_get_encoding ($return=TRUE)
	_get_content_type ()
	_set_date ()
	_get_mime_message ()
	validate_email ($email)
	valid_email ($address)
	clean_email ($email)
	_get_alt_message ()
	word_wrap ($str, $charlim= '')
	_build_headers ()
	_write_headers ()
	_build_message ()
	_prep_quoted_printable ($str, $charlim= '')
	_prep_q_encoding ($str, $from=FALSE)
	send ()
	batch_bcc_send ()
	_unwrap_specials ()
	_remove_nl_callback ($matches)
	_spool_email ()
	_send_with_mail ()
	_send_with_sendmail ()
	_send_with_smtp ()
	_smtp_connect ()
	_send_command ($cmd, $data= '')
	_smtp_authenticate ()
	_send_data ($data)
	_get_smtp_data ()
	_get_hostname ()
	_get_ip ()
	print_debugger ()
	_set_error_message ($msg, $val= '')
	_mime_types ($ext="")
Public Attributes
	$useragent = "CodeIgniter"
	$mailpath = "/usr/sbin/sendmail"
	$protocol = "mail"
	$smtp_host = ""
	$smtp_user = ""
	$smtp_pass = ""
	$smtp_port = "25"
	$smtp_timeout = 5
	$wordwrap = TRUE
	$wrapchars = "76"
	$mailtype = "text"
	$charset = "utf-8"
	$multipart = "mixed"
	$alt_message = ''
	$validate = FALSE
	$priority = "3"
	$newline = "\n"
	$crlf = "\n"
	$send_multipart = TRUE
	$bcc_batch_mode = FALSE
	$bcc_batch_size = 200
	$_safe_mode = FALSE
	$_subject = ""
	$_body = ""
	$_finalbody = ""
	$_alt_boundary = ""
	$_atc_boundary = ""
	$_header_str = ""
	$_smtp_connect = ""
	$_encoding = "8bit"
	$_IP = FALSE
	$_smtp_auth = FALSE
	$_replyto_flag = FALSE
	$_debug_msg = array()
	$_recipients = array()
	$_cc_array = array()
	$_bcc_array = array()
	$_headers = array()
	$_attach_name = array()
	$_attach_type = array()
	$_attach_disp = array()
	$_protocols = array('mail', 'sendmail', 'smtp')
	$_base_charsets = array('us-ascii', 'iso-2022-')
	$_bit_depths = array('7bit', '8bit')
	$_priorities = array('1 (Highest)', '2 (High)', '3 (Normal)', '4 (Low)', '5 (Lowest)')

---

Member Function Documentation

CI_Email::_build_headers

(

)

Build final headers

private

Parameters:

string

Returns:

string

CI_Email::_build_message

(

)

Build Final Body and attachments

private

Returns:

void

CI_Email::_get_alt_message

(

)

Build alternative plain text message

This function 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

private

Returns:

string

CI_Email::_get_content_type

(

)

Get content type (text/html/attachment)

private

Returns:

string

CI_Email::_get_encoding

(

$

return = TRUE

)

Get Mail Encoding

private

Parameters:

bool

Returns:

string

CI_Email::_get_hostname

(

)

Get Hostname

private

Returns:

string

CI_Email::_get_ip

(

)

Get IP

private

Returns:

string

CI_Email::_get_message_id

(

)

Get the Message ID

private

Returns:

string

CI_Email::_get_mime_message

(

)

Mime message

private

Returns:

string

CI_Email::_get_protocol

(

$

return = TRUE

)

Get Mail Protocol

private

Parameters:

bool

Returns:

string

CI_Email::_get_smtp_data

(

)

Get SMTP data

private

Returns:

string

CI_Email::_mime_types

(

$

ext = ""

)

Mime Types

private

Parameters:

string

Returns:

string

CI_Email::_prep_q_encoding	(	$	str,
		$	from = FALSE
	)

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

public

Parameters:

	str
	bool	// set to TRUE for processing From: headers

Returns:

str

CI_Email::_prep_quoted_printable	(	$	str,
		$	charlim = ''
	)

Prep Quoted Printable

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

private

Parameters:

	string
	integer

Returns:

string

CI_Email::_remove_nl_callback

(

$

matches

)

Strip line-breaks via callback

private

Returns:

string

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

Send SMTP command

private

Parameters:

	string
	string

Returns:

string

CI_Email::_send_data

(

$

data

)

Send SMTP data

private

Returns:

bool

CI_Email::_send_with_mail

(

)

Send using mail()

private

Returns:

bool

CI_Email::_send_with_sendmail

(

)

Send using Sendmail

private

Returns:

bool

CI_Email::_send_with_smtp

(

)

Send using SMTP

private

Returns:

bool

CI_Email::_set_boundaries

(

)

Set Message Boundary

private

Returns:

void

CI_Email::_set_date

(

)

Set RFC 822 Date

private

Returns:

string

CI_Email::_set_error_message	(	$	msg,
		$	val = ''
	)

Set Message

private

Parameters:

string

Returns:

string

CI_Email::_set_header	(	$	header,
		$	value
	)

Add a Header Item

private

Parameters:

	string
	string

Returns:

void

CI_Email::_smtp_authenticate

(

)

SMTP Authenticate

private

Returns:

bool

CI_Email::_smtp_connect

(

)

SMTP Connect

private

Parameters:

string

Returns:

string

CI_Email::_spool_email

(

)

Spool mail to the mail server

private

Returns:

bool

CI_Email::_str_to_array

(

$

email

)

Convert a String to an Array

private

Parameters:

string

Returns:

array

CI_Email::_unwrap_specials

(

)

Unwrap special elements

private

Returns:

void

CI_Email::_write_headers

(

)

Write Headers as a string

private

Returns:

void

CI_Email::attach	(	$	filename,
		$	disposition = 'attachment'
	)

Assign file attachments

public

Parameters:

string

Returns:

void

CI_Email::batch_bcc_send

(

)

Batch Bcc Send. Sends groups of BCCs in batches

public

Returns:

bool

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

Set BCC

public

Parameters:

	string
	string

Returns:

void

CI_Email::cc

(

$

cc

)

Set CC

public

Parameters:

string

Returns:

void

CI_Email::CI_Email

(

$

config = array()

)

Constructor - Sets Email Preferences

The constructor can be passed an array of config values

CI_Email::clean_email

(

$

email

)

Clean Extended Email Address: Joe Smith <[email protected]>

public

Parameters:

string

Returns:

string

CI_Email::clear

(

$

clear_attachments = FALSE

)

Initialize the Email Data

public

Returns:

void

CI_Email::from	(	$	from,
		$	name = ''
	)

Set FROM

public

Parameters:

	string
	string

Returns:

void

CI_Email::initialize

(

$

config = array()

)

Initialize preferences

public

Parameters:

array

Returns:

void

CI_Email::message

(

$

body

)

Set Body

public

Parameters:

string

Returns:

void

CI_Email::print_debugger

(

)

Get Debug Message

public

Returns:

string

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

Set Reply-to

public

Parameters:

	string
	string

Returns:

void

CI_Email::send

(

)

Send Email

public

Returns:

bool

CI_Email::set_alt_message

(

$

str = ''

)

Set Multipart Value

public

Parameters:

string

Returns:

void

CI_Email::set_crlf

(

$

crlf = "\n"

)

Set CRLF

public

Parameters:

string

Returns:

void

CI_Email::set_mailtype

(

$

type = 'text'

)

Set Mailtype

public

Parameters:

string

Returns:

void

CI_Email::set_newline

(

$

newline = "\n"

)

Set Newline Character

public

Parameters:

string

Returns:

void

CI_Email::set_priority

(

$

n = 3

)

Set Priority

public

Parameters:

integer

Returns:

void

CI_Email::set_protocol

(

$

protocol = 'mail'

)

Set Protocol

public

Parameters:

string

Returns:

void

CI_Email::set_wordwrap

(

$

wordwrap = TRUE

)

Set Wordwrap

public

Parameters:

string

Returns:

void

CI_Email::subject

(

$

subject

)

Set Email Subject

public

Parameters:

string

Returns:

void

CI_Email::to

(

$

to

)

Set Recipients

public

Parameters:

string

Returns:

void

CI_Email::valid_email

(

$

address

)

Email Validation

public

Parameters:

string

Returns:

bool

CI_Email::validate_email

(

$

email

)

Validate Email Address

public

Parameters:

string

Returns:

bool

CI_Email::word_wrap	(	$	str,
		$	charlim = ''
	)

Word Wrap

public

Parameters:

	string
	integer

Returns:

string

---

Member Data Documentation

CI_Email::$_alt_boundary = ""

CI_Email::$_atc_boundary = ""

CI_Email::$_attach_disp = array()

CI_Email::$_attach_name = array()

CI_Email::$_attach_type = array()

CI_Email::$_base_charsets = array('us-ascii', 'iso-2022-')

CI_Email::$_bcc_array = array()

CI_Email::$_bit_depths = array('7bit', '8bit')

CI_Email::$_body = ""

CI_Email::$_cc_array = array()

CI_Email::$_debug_msg = array()

CI_Email::$_encoding = "8bit"

CI_Email::$_finalbody = ""

CI_Email::$_header_str = ""

CI_Email::$_headers = array()

CI_Email::$_IP = FALSE

CI_Email::$_priorities = array('1 (Highest)', '2 (High)', '3 (Normal)', '4 (Low)', '5 (Lowest)')

CI_Email::$_protocols = array('mail', 'sendmail', 'smtp')

CI_Email::$_recipients = array()

CI_Email::$_replyto_flag = FALSE

CI_Email::$_safe_mode = FALSE

CI_Email::$_smtp_auth = FALSE

CI_Email::$_smtp_connect = ""

CI_Email::$_subject = ""

CI_Email::$alt_message = ''

CI_Email::$bcc_batch_mode = FALSE

CI_Email::$bcc_batch_size = 200

CI_Email::$charset = "utf-8"

CI_Email::$crlf = "\n"

CI_Email::$mailpath = "/usr/sbin/sendmail"

CI_Email::$mailtype = "text"

CI_Email::$multipart = "mixed"

CI_Email::$newline = "\n"

CI_Email::$priority = "3"

CI_Email::$protocol = "mail"

CI_Email::$send_multipart = TRUE

CI_Email::$smtp_host = ""

CI_Email::$smtp_pass = ""

CI_Email::$smtp_port = "25"

CI_Email::$smtp_timeout = 5

CI_Email::$smtp_user = ""

CI_Email::$useragent = "CodeIgniter"

CI_Email::$validate = FALSE

CI_Email::$wordwrap = TRUE

CI_Email::$wrapchars = "76"

---

The documentation for this class was generated from the following file:

• Z:/projects/CI/system/libraries/Email.php