CI_Email Class Reference

List of all members.

Public Member Functions
	CI_Email ($config=array())
	Constructor - Sets Email Preferences.
	initialize ($config=array())
	Initialize preferences.
	clear ($clear_attachments=FALSE)
	Initialize the Email Data.
	from ($from, $name= '')
	Set FROM.
	reply_to ($replyto, $name= '')
	Set Reply-to.
	to ($to)
	Set Recipients.
	cc ($cc)
	Set CC.
	bcc ($bcc, $limit= '')
	Set BCC.
	subject ($subject)
	Set Email Subject.
	message ($body)
	Set Body.
	attach ($filename, $disposition= 'attachment')
	Assign file attachments.
	_set_header ($header, $value)
	Add a Header Item.
	_str_to_array ($email)
	Convert a String to an Array.
	set_alt_message ($str= '')
	Set Multipart Value.
	set_mailtype ($type= 'text')
	Set Mailtype.
	set_wordwrap ($wordwrap=TRUE)
	Set Wordwrap.
	set_protocol ($protocol= 'mail')
	Set Protocol.
	set_priority ($n=3)
	Set Priority.
	set_newline ($newline="\n")
	Set Newline Character.
	set_crlf ($crlf="\n")
	Set CRLF.
	_set_boundaries ()
	Set Message Boundary.
	_get_message_id ()
	Get the Message ID.
	_get_protocol ($return=TRUE)
	Get Mail Protocol.
	_get_encoding ($return=TRUE)
	Get Mail Encoding.
	_get_content_type ()
	Get content type (text/html/attachment).
	_set_date ()
	Set RFC 822 Date.
	_get_mime_message ()
	Mime message.
	validate_email ($email)
	Validate Email Address.
	valid_email ($address)
	Email Validation.
	clean_email ($email)
	Clean Extended Email Address: Joe Smith <joe@smith.com>.
	_get_alt_message ()
	Build alternative plain text message.
	word_wrap ($str, $charlim= '')
	Word Wrap.
	_build_headers ()
	Build final headers.
	_write_headers ()
	Write Headers as a string.
	_build_message ()
	Build Final Body and attachments.
	_prep_quoted_printable ($str, $charlim= '')
	Prep Quoted Printable.
	send ()
	Send Email.
	batch_bcc_send ()
	Batch Bcc Send.
	_unwrap_specials ()
	Unwrap special elements.
	_remove_nl_callback ($matches)
	Strip line-breaks via callback.
	_spool_email ()
	Spool mail to the mail server.
	_send_with_mail ()
	Send using mail().
	_send_with_sendmail ()
	Send using Sendmail.
	_send_with_smtp ()
	Send using SMTP.
	_smtp_connect ()
	SMTP Connect.
	_send_command ($cmd, $data= '')
	Send SMTP command.
	_smtp_authenticate ()
	SMTP Authenticate.
	_send_data ($data)
	Send SMTP data.
	_get_smtp_data ()
	Get SMTP data.
	_get_hostname ()
	Get Hostname.
	_get_ip ()
	Get IP.
	print_debugger ()
	Get Debug Message.
	_set_error_message ($msg, $val= '')
	Set Message.
	_mime_types ($ext="")
	Mime Types.
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)')

---

Detailed Description

Definition at line 29 of file Email.php.

---

Member Function Documentation

CI_Email::_build_headers

(

)

Build final headers.

private

Parameters:

string

Returns:

string

Definition at line 909 of file Email.php.

References _get_message_id(), _set_header(), and clean_email().

Referenced by send().

        {
                $this->_set_header('X-Sender', $this->clean_email($this->_headers['From']));
                $this->_set_header('X-Mailer', $this->useragent);
                $this->_set_header('X-Priority', $this->_priorities[$this->priority - 1]);
                $this->_set_header('Message-ID', $this->_get_message_id());
                $this->_set_header('Mime-Version', '1.0');
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Email::_build_message

(

)

Build Final Body and attachments.

private

Returns:

void

Definition at line 959 of file Email.php.

References _get_alt_message(), _get_content_type(), _get_encoding(), _get_mime_message(), _get_protocol(), _prep_quoted_printable(), _set_boundaries(), _set_error_message(), _write_headers(), and word_wrap().

Referenced by batch_bcc_send(), and send().

        {
                if ($this->wordwrap === TRUE  AND  $this->mailtype != 'html')
                {
                        $this->_body = $this->word_wrap($this->_body);
                }
        
                $this->_set_boundaries();
                $this->_write_headers();

                $hdr = ($this->_get_protocol() == 'mail') ? $this->newline : '';
        
                switch ($this->_get_content_type())
                {
                        case 'plain' :
        
                                $hdr .= "Content-Type: text/plain; charset=" . $this->charset . $this->newline;
                                $hdr .= "Content-Transfer-Encoding: " . $this->_get_encoding();

                                if ($this->_get_protocol() == 'mail')
                                {
                                        $this->_header_str .= $hdr;
                                        $this->_finalbody = $this->_body;
        
                                        return;
                                }

                                $hdr .= $this->newline . $this->newline . $this->_body;

                                $this->_finalbody = $hdr;
                                return;
        
                        break;
                        case 'html' :
        
                                if ($this->send_multipart === FALSE)
                                {
                                        $hdr .= "Content-Type: text/html; charset=" . $this->charset . $this->newline;
                                        $hdr .= "Content-Transfer-Encoding: quoted-printable";
                                }
                                else
                                {       
                                        $hdr .= "Content-Type: multipart/alternative; boundary=\"" . $this->_alt_boundary . "\"" . $this->newline;
                                        $hdr .= $this->_get_mime_message() . $this->newline . $this->newline;
                                        $hdr .= "--" . $this->_alt_boundary . $this->newline;
        
                                        $hdr .= "Content-Type: text/plain; charset=" . $this->charset . $this->newline;
                                        $hdr .= "Content-Transfer-Encoding: " . $this->_get_encoding() . $this->newline . $this->newline;
                                        $hdr .= $this->_get_alt_message() . $this->newline . $this->newline . "--" . $this->_alt_boundary . $this->newline;

                                        $hdr .= "Content-Type: text/html; charset=" . $this->charset . $this->newline;
                                        $hdr .= "Content-Transfer-Encoding: quoted-printable";
                                }

                                $this->_body = $this->_prep_quoted_printable($this->_body);

                                if ($this->_get_protocol() == 'mail')
                                {
                                        $this->_header_str .= $hdr;
                                        $this->_finalbody = $this->_body . $this->newline . $this->newline;
        
                                        if ($this->send_multipart !== FALSE)
                                        {
                                                $this->_finalbody .= "--" . $this->_alt_boundary . "--";
                                        }
        
                                        return;
                                }

                                $hdr .= $this->newline . $this->newline;
                                $hdr .= $this->_body . $this->newline . $this->newline;

                                if ($this->send_multipart !== FALSE)
                                {
                                        $hdr .= "--" . $this->_alt_boundary . "--";
                                }

                                $this->_finalbody = $hdr;
                                return;

                        break;
                        case 'plain-attach' :
        
                                $hdr .= "Content-Type: multipart/".$this->multipart."; boundary=\"" . $this->_atc_boundary."\"" . $this->newline;
                                $hdr .= $this->_get_mime_message() . $this->newline . $this->newline;
                                $hdr .= "--" . $this->_atc_boundary . $this->newline;
        
                                $hdr .= "Content-Type: text/plain; charset=" . $this->charset . $this->newline;
                                $hdr .= "Content-Transfer-Encoding: " . $this->_get_encoding();

                                if ($this->_get_protocol() == 'mail')
                                {
                                        $this->_header_str .= $hdr;
        
                                        $body  = $this->_body . $this->newline . $this->newline;
                                }

                                $hdr .= $this->newline . $this->newline;
                                $hdr .= $this->_body . $this->newline . $this->newline;

                        break;
                        case 'html-attach' :
        
                                $hdr .= "Content-Type: multipart/".$this->multipart."; boundary=\"" . $this->_atc_boundary."\"" . $this->newline;
                                $hdr .= $this->_get_mime_message() . $this->newline . $this->newline;
                                $hdr .= "--" . $this->_atc_boundary . $this->newline;
        
                                $hdr .= "Content-Type: multipart/alternative; boundary=\"" . $this->_alt_boundary . "\"" . $this->newline .$this->newline;
                                $hdr .= "--" . $this->_alt_boundary . $this->newline;

                                $hdr .= "Content-Type: text/plain; charset=" . $this->charset . $this->newline;
                                $hdr .= "Content-Transfer-Encoding: " . $this->_get_encoding() . $this->newline . $this->newline;
                                $hdr .= $this->_get_alt_message() . $this->newline . $this->newline . "--" . $this->_alt_boundary . $this->newline;
        
                                $hdr .= "Content-Type: text/html; charset=" . $this->charset . $this->newline;
                                $hdr .= "Content-Transfer-Encoding: quoted-printable";

                                $this->_body = $this->_prep_quoted_printable($this->_body);

                                if ($this->_get_protocol() == 'mail')
                                {
                                        $this->_header_str .= $hdr;     
        
                                        $body  = $this->_body . $this->newline . $this->newline;
                                        $body .= "--" . $this->_alt_boundary . "--" . $this->newline . $this->newline;
                                }

                                $hdr .= $this->newline . $this->newline;
                                $hdr .= $this->_body . $this->newline . $this->newline;
                                $hdr .= "--" . $this->_alt_boundary . "--" . $this->newline . $this->newline;

                        break;
                }

                $attachment = array();

                $z = 0;

                for ($i=0; $i < count($this->_attach_name); $i++)
                {
                        $filename = $this->_attach_name[$i];
                        $basename = basename($filename);
                        $ctype = $this->_attach_type[$i];

                        if ( ! file_exists($filename))
                        {
                                $this->_set_error_message('email_attachment_missing', $filename);
                                return FALSE;
                        }       

                        $h  = "--".$this->_atc_boundary.$this->newline;
                        $h .= "Content-type: ".$ctype."; ";
                        $h .= "name=\"".$basename."\"".$this->newline;
                        $h .= "Content-Disposition: ".$this->_attach_disp[$i].";".$this->newline;
                        $h .= "Content-Transfer-Encoding: base64".$this->newline;

                        $attachment[$z++] = $h;
                        $file = filesize($filename) +1;
        
                        if ( ! $fp = fopen($filename, FOPEN_READ))
                        {
                                $this->_set_error_message('email_attachment_unreadable', $filename);
                                return FALSE;
                        }
        
                        $attachment[$z++] = chunk_split(base64_encode(fread($fp, $file)));
                        fclose($fp);
                }

                if ($this->_get_protocol() == 'mail')
                {
                        $this->_finalbody = $body . implode($this->newline, $attachment).$this->newline."--".$this->_atc_boundary."--"; 
        
                        return;
                }

                $this->_finalbody = $hdr.implode($this->newline, $attachment).$this->newline."--".$this->_atc_boundary."--";    

                return; 
        }

Here is the call graph for this function:

Here is the caller graph for this function:

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

Definition at line 769 of file Email.php.

References word_wrap().

Referenced by _build_message().

        {
                if ($this->alt_message != "")
                {
                        return $this->word_wrap($this->alt_message, '76');
                }

                if (preg_match('/<body.*?>(.*)<\/body>/si', $this->_body, $match))
                {
                        $body = $match['1'];
                }
                else
                {
                        $body = $this->_body;
                }

                $body = trim(strip_tags($body));
                $body = preg_replace( '#<!--(.*)-->#', "", $body);
                $body = str_replace("\t", "", $body);

                for ($i = 20; $i >= 3; $i--)
                {
                        $n = "";
        
                        for ($x = 1; $x <= $i; $x ++)
                        {
                                 $n .= "\n";
                        }

                        $body = str_replace($n, "\n\n", $body); 
                }

                return $this->word_wrap($body, '76');
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Email::_get_content_type

(

)

Get content type (text/html/attachment).

private

Returns:

string

Definition at line 624 of file Email.php.

Referenced by _build_message().

        {       
                if      ($this->mailtype == 'html' &&  count($this->_attach_name) == 0)
                {
                                return 'html';
                }
                elseif  ($this->mailtype == 'html' &&  count($this->_attach_name)  > 0)
                {
                                return 'html-attach';
                }
                elseif  ($this->mailtype == 'text' &&  count($this->_attach_name)  > 0)
                {
                                return 'plain-attach';
                }
                else
                {
                        return 'plain';
                }
        }

Here is the caller graph for this function:

CI_Email::_get_encoding

(

$

return = TRUE

)

Get Mail Encoding.

private

Parameters:

bool

Returns:

string

Definition at line 598 of file Email.php.

References $charset.

Referenced by _build_message(), and _send_command().

        {
                $this->_encoding = ( ! in_array($this->_encoding, $this->_bit_depths)) ? '8bit' : $this->_encoding;

                foreach ($this->_base_charsets as $charset)
                {
                        if (strncmp($charset, $this->charset, strlen($charset)) == 0)
                        {
                                $this->_encoding = '7bit';
                        }
                }
        
                if ($return == TRUE)
                {
                        return $this->_encoding;        
                }
        }

Here is the caller graph for this function:

CI_Email::_get_hostname

(

)

Get Hostname.

private

Returns:

string

Definition at line 1725 of file Email.php.

Referenced by _send_command().

        {       
                return (isset($_SERVER['SERVER_NAME'])) ? $_SERVER['SERVER_NAME'] : 'localhost.localdomain';    
        }

Here is the caller graph for this function:

CI_Email::_get_ip

(

)

Get IP.

private

Returns:

string

Definition at line 1738 of file Email.php.

        {
                if ($this->_IP !== FALSE)
                {
                        return $this->_IP;
                }
        
                $cip = (isset($_SERVER['HTTP_CLIENT_IP']) AND $_SERVER['HTTP_CLIENT_IP'] != "") ? $_SERVER['HTTP_CLIENT_IP'] : FALSE;
                $rip = (isset($_SERVER['REMOTE_ADDR']) AND $_SERVER['REMOTE_ADDR'] != "") ? $_SERVER['REMOTE_ADDR'] : FALSE;
                $fip = (isset($_SERVER['HTTP_X_FORWARDED_FOR']) AND $_SERVER['HTTP_X_FORWARDED_FOR'] != "") ? $_SERVER['HTTP_X_FORWARDED_FOR'] : FALSE;
        
                if ($cip && $rip)       $this->_IP = $cip;      
                elseif ($rip)           $this->_IP = $rip;
                elseif ($cip)           $this->_IP = $cip;
                elseif ($fip)           $this->_IP = $fip;

                if (strstr($this->_IP, ','))
                {
                        $x = explode(',', $this->_IP);
                        $this->_IP = end($x);
                }

                if ( ! preg_match( "/^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$/", $this->_IP))
                {
                        $this->_IP = '0.0.0.0';
                }

                unset($cip);
                unset($rip);
                unset($fip);

                return $this->_IP;
        }

CI_Email::_get_message_id

(

)

Get the Message ID.

private

Returns:

string

Definition at line 560 of file Email.php.

Referenced by _build_headers().

        {
                $from = $this->_headers['Return-Path'];
                $from = str_replace(">", "", $from);
                $from = str_replace("<", "", $from);
        
                return  "<".uniqid('').strstr($from, '@').">";  
        }

Here is the caller graph for this function:

CI_Email::_get_mime_message

(

)

Mime message.

private

Returns:

string

Definition at line 670 of file Email.php.

Referenced by _build_message().

        {
                return "This is a multi-part message in MIME format.".$this->newline."Your email application may not support this format.";
        }

Here is the caller graph for this function:

CI_Email::_get_protocol

(

$

return = TRUE

)

Get Mail Protocol.

private

Parameters:

bool

Returns:

string

Definition at line 578 of file Email.php.

Referenced by _build_message(), _spool_email(), _write_headers(), bcc(), cc(), and to().

        {
                $this->protocol = strtolower($this->protocol);
                $this->protocol = ( ! in_array($this->protocol, $this->_protocols, TRUE)) ? 'mail' : $this->protocol;

                if ($return == TRUE)
                {
                        return $this->protocol;
                }
        }

Here is the caller graph for this function:

CI_Email::_get_smtp_data

(

)

Get SMTP data.

private

Returns:

string

Definition at line 1700 of file Email.php.

References _smtp_connect().

Referenced by _send_command(), _send_with_smtp(), _smtp_authenticate(), and _smtp_connect().

        {
                $data = "";

                while ($str = fgets($this->_smtp_connect, 512))
                {
                        $data .= $str;
        
                        if (substr($str, 3, 1) == " ")
                        {
                                break;
                        }
                }

                return $data;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Email::_mime_types

(

$

ext = ""

)

Mime Types.

private

Parameters:

string

Returns:

string

Definition at line 1829 of file Email.php.

References $mimes.

Referenced by attach().

        {
                $mimes = array( 'hqx'   =>      'application/mac-binhex40',
                                                'cpt'   =>      'application/mac-compactpro',
                                                'doc'   =>      'application/msword',
                                                'bin'   =>      'application/macbinary',
                                                'dms'   =>      'application/octet-stream',
                                                'lha'   =>      'application/octet-stream',
                                                'lzh'   =>      'application/octet-stream',
                                                'exe'   =>      'application/octet-stream',
                                                'class' =>      'application/octet-stream',
                                                'psd'   =>      'application/octet-stream',
                                                'so'    =>      'application/octet-stream',
                                                'sea'   =>      'application/octet-stream',
                                                'dll'   =>      'application/octet-stream',
                                                'oda'   =>      'application/oda',
                                                'pdf'   =>      'application/pdf',
                                                'ai'    =>      'application/postscript',
                                                'eps'   =>      'application/postscript',
                                                'ps'    =>      'application/postscript',
                                                'smi'   =>      'application/smil',
                                                'smil'  =>      'application/smil',
                                                'mif'   =>      'application/vnd.mif',
                                                'xls'   =>      'application/vnd.ms-excel',
                                                'ppt'   =>      'application/vnd.ms-powerpoint',
                                                'wbxml' =>      'application/vnd.wap.wbxml',
                                                'wmlc'  =>      'application/vnd.wap.wmlc',
                                                'dcr'   =>      'application/x-director',
                                                'dir'   =>      'application/x-director',
                                                'dxr'   =>      'application/x-director',
                                                'dvi'   =>      'application/x-dvi',
                                                'gtar'  =>      'application/x-gtar',
                                                'php'   =>      'application/x-httpd-php',
                                                'php4'  =>      'application/x-httpd-php',
                                                'php3'  =>      'application/x-httpd-php',
                                                'phtml' =>      'application/x-httpd-php',
                                                'phps'  =>      'application/x-httpd-php-source',
                                                'js'    =>      'application/x-javascript',
                                                'swf'   =>      'application/x-shockwave-flash',
                                                'sit'   =>      'application/x-stuffit',
                                                'tar'   =>      'application/x-tar',
                                                'tgz'   =>      'application/x-tar',
                                                'xhtml' =>      'application/xhtml+xml',
                                                'xht'   =>      'application/xhtml+xml',
                                                'zip'   =>      'application/zip',
                                                'mid'   =>      'audio/midi',
                                                'midi'  =>      'audio/midi',
                                                'mpga'  =>      'audio/mpeg',
                                                'mp2'   =>      'audio/mpeg',
                                                'mp3'   =>      'audio/mpeg',
                                                'aif'   =>      'audio/x-aiff',
                                                'aiff'  =>      'audio/x-aiff',
                                                'aifc'  =>      'audio/x-aiff',
                                                'ram'   =>      'audio/x-pn-realaudio',
                                                'rm'    =>      'audio/x-pn-realaudio',
                                                'rpm'   =>      'audio/x-pn-realaudio-plugin',
                                                'ra'    =>      'audio/x-realaudio',
                                                'rv'    =>      'video/vnd.rn-realvideo',
                                                'wav'   =>      'audio/x-wav',
                                                'bmp'   =>      'image/bmp',
                                                'gif'   =>      'image/gif',
                                                'jpeg'  =>      'image/jpeg',
                                                'jpg'   =>      'image/jpeg',
                                                'jpe'   =>      'image/jpeg',
                                                'png'   =>      'image/png',
                                                'tiff'  =>      'image/tiff',
                                                'tif'   =>      'image/tiff',
                                                'css'   =>      'text/css',
                                                'html'  =>      'text/html',
                                                'htm'   =>      'text/html',
                                                'shtml' =>      'text/html',
                                                'txt'   =>      'text/plain',
                                                'text'  =>      'text/plain',
                                                'log'   =>      'text/plain',
                                                'rtx'   =>      'text/richtext',
                                                'rtf'   =>      'text/rtf',
                                                'xml'   =>      'text/xml',
                                                'xsl'   =>      'text/xml',
                                                'mpeg'  =>      'video/mpeg',
                                                'mpg'   =>      'video/mpeg',
                                                'mpe'   =>      'video/mpeg',
                                                'qt'    =>      'video/quicktime',
                                                'mov'   =>      'video/quicktime',
                                                'avi'   =>      'video/x-msvideo',
                                                'movie' =>      'video/x-sgi-movie',
                                                'doc'   =>      'application/msword',
                                                'word'  =>      'application/msword',
                                                'xl'    =>      'application/excel',
                                                'eml'   =>      'message/rfc822'
                                        );

                return ( ! isset($mimes[strtolower($ext)])) ? "application/x-unknown-content-type" : $mimes[strtolower($ext)];
        }

Here is the caller graph for this function:

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

Definition at line 1153 of file Email.php.

Referenced by _build_message().

        {
                // Set the character limit
                // Don't allow over 76, as that will make servers and MUAs barf
                // all over quoted-printable data
                if ($charlim == '' OR $charlim > '76')
                {
                        $charlim = '76';
                }

                // Reduce multiple spaces
                $str = preg_replace("| +|", " ", $str);

                // Standardize newlines
                if (strpos($str, "\r") !== FALSE)
                {
                        $str = str_replace(array("\r\n", "\r"), "\n", $str);                    
                }

                // We are intentionally wrapping so mail servers will encode characters
                // properly and MUAs will behave, so {unwrap} must go!
                $str = str_replace(array('{unwrap}', '{/unwrap}'), '', $str);

                // Break into an array of lines
                $lines = explode("\n", $str);

            $escape = '=';
            $output = '';

                foreach ($lines as $line)
                {
                        $length = strlen($line);
                        $temp = '';

                        // Loop through each character in the line to add soft-wrap
                        // characters at the end of a line " =\r\n" and add the newly
                        // processed line(s) to the output (see comment on $crlf class property)
                        for ($i = 0; $i < $length; $i++)
                        {
                                // Grab the next character
                                $char = substr($line, $i, 1);
                                $ascii = ord($char);

                                // Convert spaces and tabs but only if it's the end of the line
                                if ($i == ($length - 1))
                                {
                                        $char = ($ascii == '32' OR $ascii == '9') ? $escape.sprintf('%02s', dechex($char)) : $char;
                                }

                                // encode = signs
                                if ($ascii == '61')
                                {
                                        $char = $escape.strtoupper(sprintf('%02s', dechex($ascii)));  // =3D
                                }

                                // If we're at the character limit, add the line to the output,
                                // reset our temp variable, and keep on chuggin'
                                if ((strlen($temp) + strlen($char)) >= $charlim)
                                {
                                        $output .= $temp.$escape.$this->crlf;
                                        $temp = '';
                                }

                                // Add the character to our temporary line
                                $temp .= $char;
                        }

                        // Add our completed line to the output
                        $output .= $temp.$this->crlf;
                }

                // get rid of extra CRLF tacked onto the end
                $output = substr($output, 0, strlen($this->crlf) * -1);

                return $output;
        }

Here is the caller graph for this function:

CI_Email::_remove_nl_callback

(

$

matches

)

Strip line-breaks via callback.

private

Returns:

string

Definition at line 1352 of file Email.php.

        {
                if (strpos($matches[1], "\r") !== FALSE OR strpos($matches[1], "\n") !== FALSE)
                {
                        $matches[1] = str_replace(array("\r\n", "\r", "\n"), '', $matches[1]);
                }
                
                return $matches[1];
        }

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

Send SMTP command.

private

Parameters:

	string
	string

Returns:

string

Definition at line 1560 of file Email.php.

References _get_encoding(), _get_hostname(), _get_smtp_data(), _send_data(), _set_error_message(), and _smtp_connect().

Referenced by _send_with_smtp(), and _smtp_connect().

        {
                switch ($cmd)
                {
                        case 'hello' :

                                        if ($this->_smtp_auth OR $this->_get_encoding() == '8bit')
                                                $this->_send_data('EHLO '.$this->_get_hostname());
                                        else
                                                $this->_send_data('HELO '.$this->_get_hostname());

                                                $resp = 250;
                        break;
                        case 'from' :
        
                                                $this->_send_data('MAIL FROM:<'.$data.'>');

                                                $resp = 250;
                        break;
                        case 'to'       :
        
                                                $this->_send_data('RCPT TO:<'.$data.'>');

                                                $resp = 250;    
                        break;
                        case 'data'     :
        
                                                $this->_send_data('DATA');

                                                $resp = 354;    
                        break;
                        case 'quit'     :

                                                $this->_send_data('QUIT');

                                                $resp = 221;
                        break;
                }

                $reply = $this->_get_smtp_data();       

                $this->_debug_msg[] = "<pre>".$cmd.": ".$reply."</pre>";

                if (substr($reply, 0, 3) != $resp)
                {
                        $this->_set_error_message('email_smtp_error', $reply);
                        return FALSE;
                }
        
                if ($cmd == 'quit')
                {
                        fclose($this->_smtp_connect);
                }
        
                return TRUE;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Email::_send_data

(

$

data

)

Send SMTP data.

private

Returns:

bool

Definition at line 1679 of file Email.php.

References _set_error_message(), and _smtp_connect().

Referenced by _send_command(), _send_with_smtp(), and _smtp_authenticate().

        {
                if ( ! fwrite($this->_smtp_connect, $data . $this->newline))
                {
                        $this->_set_error_message('email_smtp_data_failure', $data);    
                        return FALSE;
                }
                else
                {
                        return TRUE;
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Email::_send_with_mail

(

)

Send using mail().

private

Returns:

bool

Definition at line 1415 of file Email.php.

References clean_email().

Referenced by _spool_email().

        {       
                if ($this->_safe_mode == TRUE)
                {
                        if ( ! mail($this->_recipients, $this->_subject, $this->_finalbody, $this->_header_str))
                                return FALSE;
                        else
                                return TRUE;
                }
                else
                {
                        // most documentation of sendmail using the "-f" flag lacks a space after it, however
                        // we've encountered servers that seem to require it to be in place.
                        if ( ! mail($this->_recipients, $this->_subject, $this->_finalbody, $this->_header_str, "-f ".$this->clean_email($this->_headers['From'])))
                                return FALSE;
                        else
                                return TRUE;
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Email::_send_with_sendmail

(

)

Send using Sendmail.

private

Returns:

bool

Definition at line 1443 of file Email.php.

References _set_error_message(), and clean_email().

Referenced by _spool_email().

        {
                $fp = @popen($this->mailpath . " -oi -f ".$this->clean_email($this->_headers['From'])." -t", 'w');

                if ( ! is_resource($fp))
                {               
                        $this->_set_error_message('email_no_socket');
                        return FALSE;
                }

                fputs($fp, $this->_header_str);
                fputs($fp, $this->_finalbody);
                pclose($fp) >> 8 & 0xFF;

                return TRUE;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Email::_send_with_smtp

(

)

Send using SMTP.

private

Returns:

bool

Definition at line 1468 of file Email.php.

References _get_smtp_data(), _send_command(), _send_data(), _set_error_message(), _smtp_authenticate(), _smtp_connect(), and clean_email().

Referenced by _spool_email().

        {       
                if ($this->smtp_host == '')
                {       
                        $this->_set_error_message('email_no_hostname');
                        return FALSE;
                }

                $this->_smtp_connect();
                $this->_smtp_authenticate();

                $this->_send_command('from', $this->clean_email($this->_headers['From']));

                foreach($this->_recipients as $val)
                        $this->_send_command('to', $val);
        
                if (count($this->_cc_array) > 0)
                {
                        foreach($this->_cc_array as $val)
                        {
                                if ($val != "")
                                $this->_send_command('to', $val);
                        }
                }

                if (count($this->_bcc_array) > 0)
                {
                        foreach($this->_bcc_array as $val)
                        {
                                if ($val != "")
                                $this->_send_command('to', $val);
                        }
                }

                $this->_send_command('data');

                // perform dot transformation on any lines that begin with a dot
                $this->_send_data($this->_header_str . preg_replace('/^\./m', '..$1', $this->_finalbody));

                $this->_send_data('.');

                $reply = $this->_get_smtp_data();

                $this->_set_error_message($reply);      

                if (strncmp($reply, '250', 3) != 0)
                {
                        $this->_set_error_message('email_smtp_error', $reply);  
                        return FALSE;
                }

                $this->_send_command('quit');
                return TRUE;
        }       

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Email::_set_boundaries

(

)

Set Message Boundary.

private

Returns:

void

Definition at line 546 of file Email.php.

Referenced by _build_message().

        {
                $this->_alt_boundary = "B_ALT_".uniqid(''); // multipart/alternative
                $this->_atc_boundary = "B_ATC_".uniqid(''); // attachment boundary
        }

Here is the caller graph for this function:

CI_Email::_set_date

(

)

Set RFC 822 Date.

private

Returns:

string

Definition at line 652 of file Email.php.

Referenced by clear().

        {
                $timezone = date("Z");
                $operator = (strncmp($timezone, '-', 1) == 0) ? '-' : '+';
                $timezone = abs($timezone);
                $timezone = floor($timezone/3600) * 100 + ($timezone % 3600 ) / 60;

                return sprintf("%s %s%04d", date("D, j M Y H:i:s"), $operator, $timezone);
        }

Here is the caller graph for this function:

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

Set Message.

private

Parameters:

string

Returns:

string

Definition at line 1805 of file Email.php.

References $CI, and get_instance().

Referenced by _build_message(), _send_command(), _send_data(), _send_with_sendmail(), _send_with_smtp(), _smtp_authenticate(), _smtp_connect(), _spool_email(), send(), and validate_email().

        {
                $CI =& get_instance();
                $CI->lang->load('email');
        
                if (FALSE === ($line = $CI->lang->line($msg)))
                {       
                        $this->_debug_msg[] = str_replace('%s', $val, $msg)."<br />";
                }       
                else
                {
                        $this->_debug_msg[] = str_replace('%s', $val, $line)."<br />";
                }       
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Email::_set_header	(	$	header,
		$	value
	)

Add a Header Item.

private

Parameters:

	string
	string

Returns:

void

Definition at line 385 of file Email.php.

Referenced by _build_headers(), batch_bcc_send(), bcc(), cc(), clear(), from(), reply_to(), subject(), and to().

        {
                $this->_headers[$header] = $value;
        }

Here is the caller graph for this function:

CI_Email::_smtp_authenticate

(

)

SMTP Authenticate.

private

Returns:

bool

Definition at line 1625 of file Email.php.

References _get_smtp_data(), _send_data(), and _set_error_message().

Referenced by _send_with_smtp().

        {       
                if ( ! $this->_smtp_auth)
                {
                        return TRUE;
                }
        
                if ($this->smtp_user == ""  AND  $this->smtp_pass == "")
                {
                        $this->_set_error_message('email_no_smtp_unpw');
                        return FALSE;
                }

                $this->_send_data('AUTH LOGIN');

                $reply = $this->_get_smtp_data();       

                if (strncmp($reply, '334', 3) != 0)
                {
                        $this->_set_error_message('email_failed_smtp_login', $reply);   
                        return FALSE;
                }

                $this->_send_data(base64_encode($this->smtp_user));

                $reply = $this->_get_smtp_data();       

                if (strncmp($reply, '334', 3) != 0)
                {
                        $this->_set_error_message('email_smtp_auth_un', $reply);        
                        return FALSE;
                }

                $this->_send_data(base64_encode($this->smtp_pass));

                $reply = $this->_get_smtp_data();       

                if (strncmp($reply, '235', 3) != 0)
                {
                        $this->_set_error_message('email_smtp_auth_pw', $reply);        
                        return FALSE;
                }
        
                return TRUE;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Email::_smtp_connect

(

)

SMTP Connect.

private

Parameters:

string

Returns:

string

Definition at line 1532 of file Email.php.

References _get_smtp_data(), _send_command(), and _set_error_message().

Referenced by _get_smtp_data(), _send_command(), _send_data(), and _send_with_smtp().

        {
                $this->_smtp_connect = fsockopen($this->smtp_host,
                                                                                $this->smtp_port,
                                                                                $errno,
                                                                                $errstr,
                                                                                $this->smtp_timeout);

                if( ! is_resource($this->_smtp_connect))
                {               
                        $this->_set_error_message('email_smtp_error', $errno." ".$errstr);
                        return FALSE;
                }

                $this->_set_error_message($this->_get_smtp_data());
                return $this->_send_command('hello');
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Email::_spool_email

(

)

Spool mail to the mail server.

private

Returns:

bool

Definition at line 1370 of file Email.php.

References _get_protocol(), _send_with_mail(), _send_with_sendmail(), _send_with_smtp(), _set_error_message(), and _unwrap_specials().

Referenced by batch_bcc_send(), and send().

        {
                $this->_unwrap_specials();

                switch ($this->_get_protocol())
                {
                        case 'mail'     :
        
                                        if ( ! $this->_send_with_mail())
                                        {
                                                $this->_set_error_message('email_send_failure_phpmail');        
                                                return FALSE;
                                        }
                        break;
                        case 'sendmail' :
                
                                        if ( ! $this->_send_with_sendmail())
                                        {
                                                $this->_set_error_message('email_send_failure_sendmail');       
                                                return FALSE;
                                        }
                        break;
                        case 'smtp'     :
                
                                        if ( ! $this->_send_with_smtp())
                                        {
                                                $this->_set_error_message('email_send_failure_smtp');   
                                                return FALSE;
                                        }
                        break;

                }

                $this->_set_error_message('email_sent', $this->_get_protocol());
                return TRUE;
        }       

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Email::_str_to_array

(

$

email

)

Convert a String to an Array.

private

Parameters:

string

Returns:

array

Definition at line 399 of file Email.php.

Referenced by batch_bcc_send(), bcc(), cc(), from(), reply_to(), and to().

        {
                if ( ! is_array($email))
                {
                        if (strpos($email, ',') !== FALSE)
                        {
                                $email = preg_split('/[\s,]/', $email, -1, PREG_SPLIT_NO_EMPTY);
                        }
                        else
                        {
                                $email = trim($email);
                                settype($email, "array");
                        }
                }
                return $email;
        }

Here is the caller graph for this function:

CI_Email::_unwrap_specials

(

)

Unwrap special elements.

private

Returns:

void

Definition at line 1339 of file Email.php.

Referenced by _spool_email().

        {
                $this->_finalbody = preg_replace_callback("/\{unwrap\}(.*?)\{\/unwrap\}/si", array($this, '_remove_nl_callback'), $this->_finalbody);
        }

Here is the caller graph for this function:

CI_Email::_write_headers

(

)

Write Headers as a string.

private

Returns:

void

Definition at line 926 of file Email.php.

References _get_protocol().

Referenced by _build_message().

        {
                if ($this->protocol == 'mail')
                {
                        $this->_subject = $this->_headers['Subject'];
                        unset($this->_headers['Subject']);
                }       

                reset($this->_headers);
                $this->_header_str = "";

                foreach($this->_headers as $key => $val)
                {
                        $val = trim($val);

                        if ($val != "")
                        {
                                $this->_header_str .= $key.": ".$val.$this->newline;
                        }
                }

                if ($this->_get_protocol() == 'mail')
                        $this->_header_str = substr($this->_header_str, 0, -1);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

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

Assign file attachments.

public

Parameters:

string

Returns:

string

Definition at line 368 of file Email.php.

References _mime_types().

        {       
                $this->_attach_name[] = $filename;
                $this->_attach_type[] = $this->_mime_types(next(explode('.', basename($filename))));
                $this->_attach_disp[] = $disposition; // Can also be 'inline'  Not sure if it matters
        }

Here is the call graph for this function:

CI_Email::batch_bcc_send

(

)

Batch Bcc Send.

Sends groups of BCCs in batches

public

Returns:

bool

Definition at line 1281 of file Email.php.

References _build_message(), _set_header(), _spool_email(), _str_to_array(), and clean_email().

Referenced by send().

        {
                $float = $this->bcc_batch_size -1;

                $set = "";

                $chunk = array();

                for ($i = 0; $i < count($this->_bcc_array); $i++)
                {
                        if (isset($this->_bcc_array[$i]))
                        {
                                $set .= ", ".$this->_bcc_array[$i];
                        }

                        if ($i == $float)
                        {       
                                $chunk[] = substr($set, 1);
                                $float = $float + $this->bcc_batch_size;
                                $set = "";
                        }
        
                        if ($i == count($this->_bcc_array)-1)
                        {
                                $chunk[] = substr($set, 1);
                        }
                }

                for ($i = 0; $i < count($chunk); $i++)
                {
                        unset($this->_headers['Bcc']);
                        unset($bcc);

                        $bcc = $this->_str_to_array($chunk[$i]);
                        $bcc = $this->clean_email($bcc);
        
                        if ($this->protocol != 'smtp')
                        {
                                $this->_set_header('Bcc', implode(", ", $bcc));
                        }
                        else
                        {
                                $this->_bcc_array = $bcc;
                        }
        
                        $this->_build_message();
                        $this->_spool_email();
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

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

Set BCC.

public

Parameters:

	string
	string

Returns:

void

Definition at line 295 of file Email.php.

References _get_protocol(), _set_header(), _str_to_array(), clean_email(), and validate_email().

        {
                if ($limit != '' && is_numeric($limit))
                {
                        $this->bcc_batch_mode = TRUE;
                        $this->bcc_batch_size = $limit;
                }

                $bcc = $this->_str_to_array($bcc);
                $bcc = $this->clean_email($bcc);

                if ($this->validate)
                {
                        $this->validate_email($bcc);
                }

                if (($this->_get_protocol() == "smtp") OR ($this->bcc_batch_mode && count($bcc) > $this->bcc_batch_size))
                {
                        $this->_bcc_array = $bcc;
                }
                else
                {
                        $this->_set_header('Bcc', implode(", ", $bcc));
                }
        }

Here is the call graph for this function:

CI_Email::cc

(

$

cc

)

Set CC.

public

Parameters:

string

Returns:

void

Definition at line 269 of file Email.php.

References _get_protocol(), _set_header(), _str_to_array(), clean_email(), and validate_email().

        {       
                $cc = $this->_str_to_array($cc);
                $cc = $this->clean_email($cc);

                if ($this->validate)
                        $this->validate_email($cc);

                $this->_set_header('Cc', implode(", ", $cc));

                if ($this->_get_protocol() == "smtp")
                {
                        $this->_cc_array = $cc;
                }
        }

Here is the call graph for this function:

CI_Email::CI_Email

(

$

config = array()

)

Constructor - Sets Email Preferences.

The constructor can be passed an array of config values

Definition at line 85 of file Email.php.

References $config, initialize(), and log_message().

        {
                if (count($config) > 0)
                {
                        $this->initialize($config);
                }       

                $this->_smtp_auth = ($this->smtp_user == '' AND $this->smtp_pass == '') ? FALSE : TRUE; 
                $this->_safe_mode = ((boolean)@ini_get("safe_mode") === FALSE) ? FALSE : TRUE;

                log_message('debug', "Email Class Initialized");
        }

Here is the call graph for this function:

CI_Email::clean_email

(

$

email

)

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

public

Parameters:

string

Returns:

string

Definition at line 725 of file Email.php.

Referenced by _build_headers(), _send_with_mail(), _send_with_sendmail(), _send_with_smtp(), batch_bcc_send(), bcc(), cc(), and to().

        {
                if ( ! is_array($email))
                {
                        if (preg_match('/<(.*)>/', $email, $match))
                        {
                                return $match['1'];
                        }
                        else
                        {
                                return $email;
                        }
                }
        
                $clean_email = array();

                foreach ($email as $addy)
                {
                        if (preg_match( '/<(.*)>/', $addy, $match))
                        {
                                $clean_email[] = $match['1'];
                        }
                        else
                        {
                                $clean_email[] = $addy; 
                        }
                }

                return $clean_email;
        }

Here is the caller graph for this function:

CI_Email::clear

(

$

clear_attachments = FALSE

)

Initialize the Email Data.

public

Returns:

void

Definition at line 136 of file Email.php.

References _set_date(), and _set_header().

Referenced by initialize().

        {
                $this->_subject         = "";
                $this->_body            = "";
                $this->_finalbody       = "";
                $this->_header_str      = "";
                $this->_replyto_flag = FALSE;
                $this->_recipients      = array();
                $this->_headers         = array();
                $this->_debug_msg       = array();

                $this->_set_header('User-Agent', $this->useragent);
                $this->_set_header('Date', $this->_set_date());

                if ($clear_attachments !== FALSE)
                {
                        $this->_attach_name = array();
                        $this->_attach_type = array();
                        $this->_attach_disp = array();
                }   
        }

Here is the call graph for this function:

Here is the caller graph for this function:

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

Set FROM.

public

Parameters:

	string
	string

Returns:

void

Definition at line 168 of file Email.php.

References _set_header(), _str_to_array(), and validate_email().

        {
                if (preg_match( '/<(.*)>/', $from, $match))
                {
                        $from = $match['1'];
                }

                if ($this->validate)
                {
                        $this->validate_email($this->_str_to_array($from));
                }
        
                if ($name != '' && strncmp($name, '"', 1) != 0)
                {
                        $name = '"'.$name.'"';
                }
        
                $this->_set_header('From', $name.' <'.$from.'>');
                $this->_set_header('Return-Path', '<'.$from.'>');
        }

Here is the call graph for this function:

CI_Email::initialize

(

$

config = array()

)

Initialize preferences.

public

Parameters:

array

Returns:

void

Definition at line 107 of file Email.php.

References $config, $method, and clear().

Referenced by CI_Email().

        {
                $this->clear();
                foreach ($config as $key => $val)
                {
                        if (isset($this->$key))
                        {
                                $method = 'set_'.$key;

                                if (method_exists($this, $method))
                                {
                                        $this->$method($val);
                                }
                                else
                                {
                                        $this->$key = $val;
                                }       
                        }
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Email::message

(

$

body

)

Set Body.

public

Parameters:

string

Returns:

void

Definition at line 354 of file Email.php.

        {
                $this->_body = stripslashes(rtrim(str_replace("\r", "", $body)));       
        }       

CI_Email::print_debugger

(

)

Get Debug Message.

public

Returns:

string

Definition at line 1780 of file Email.php.

        {
                $msg = '';

                if (count($this->_debug_msg) > 0)
                {
                        foreach ($this->_debug_msg as $val)
                        {
                                $msg .= $val;
                        }
                }

                $msg .= "<pre>".$this->_header_str."\n".htmlspecialchars($this->_subject)."\n".htmlspecialchars($this->_finalbody).'</pre>';    
                return $msg;
        }       

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

Set Reply-to.

public

Parameters:

	string
	string

Returns:

void

Definition at line 199 of file Email.php.

References _set_header(), _str_to_array(), and validate_email().

Referenced by send().

        {
                if (preg_match( '/<(.*)>/', $replyto, $match))
                {
                        $replyto = $match['1'];
                }

                if ($this->validate)
                {
                        $this->validate_email($this->_str_to_array($replyto));  
                }

                if ($name == '')
                {
                        $name = $replyto;
                }

                if (strncmp($name, '"', 1) != 0)
                {
                        $name = '"'.$name.'"';
                }

                $this->_set_header('Reply-To', $name.' <'.$replyto.'>');
                $this->_replyto_flag = TRUE;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Email::send

(

)

Send Email.

public

Returns:

bool

Definition at line 1238 of file Email.php.

References _build_headers(), _build_message(), _set_error_message(), _spool_email(), batch_bcc_send(), and reply_to().

        {       
                if ($this->_replyto_flag == FALSE)
                {
                        $this->reply_to($this->_headers['From']);
                }
        
                if (( ! isset($this->_recipients) AND ! isset($this->_headers['To']))  AND
                        ( ! isset($this->_bcc_array) AND ! isset($this->_headers['Bcc'])) AND
                        ( ! isset($this->_headers['Cc'])))
                {
                        $this->_set_error_message('email_no_recipients');
                        return FALSE;
                }

                $this->_build_headers();

                if ($this->bcc_batch_mode  AND  count($this->_bcc_array) > 0)
                {
                        if (count($this->_bcc_array) > $this->bcc_batch_size)
                                return $this->batch_bcc_send();
                }

                $this->_build_message();

                if ( ! $this->_spool_email())
                {
                        return FALSE;
                }
                else
                {
                        return TRUE;
                }
        }

Here is the call graph for this function:

CI_Email::set_alt_message

(

$

str = ''

)

Set Multipart Value.

public

Parameters:

string

Returns:

void

Definition at line 425 of file Email.php.

        {
                $this->alt_message = ($str == '') ? '' : $str;
        }

CI_Email::set_crlf

(

$

crlf = "\n"

)

Set CRLF.

public

Parameters:

string

Returns:

void

Definition at line 527 of file Email.php.

References $crlf.

        {
                if ($crlf != "\n" AND $crlf != "\r\n" AND $crlf != "\r")
                {
                        $this->crlf     = "\n"; 
                        return;
                }
        
                $this->crlf     = $crlf;        
        }

CI_Email::set_mailtype

(

$

type = 'text'

)

Set Mailtype.

public

Parameters:

string

Returns:

void

Definition at line 439 of file Email.php.

        {
                $this->mailtype = ($type == 'html') ? 'html' : 'text';
        }

CI_Email::set_newline

(

$

newline = "\n"

)

Set Newline Character.

public

Parameters:

string

Returns:

void

Definition at line 507 of file Email.php.

References $newline.

        {
                if ($newline != "\n" AND $newline != "\r\n" AND $newline != "\r")
                {
                        $this->newline  = "\n"; 
                        return;
                }
        
                $this->newline  = $newline;     
        }

CI_Email::set_priority

(

$

n = 3

)

Set Priority.

public

Parameters:

integer

Returns:

void

Definition at line 481 of file Email.php.

        {
                if ( ! is_numeric($n))
                {
                        $this->priority = 3;
                        return;
                }
        
                if ($n < 1 OR $n > 5)
                {
                        $this->priority = 3;
                        return;
                }
        
                $this->priority = $n;
        }

CI_Email::set_protocol

(

$

protocol = 'mail'

)

Set Protocol.

public

Parameters:

string

Returns:

void

Definition at line 467 of file Email.php.

References $protocol.

        {
                $this->protocol = ( ! in_array($protocol, $this->_protocols, TRUE)) ? 'mail' : strtolower($protocol);
        }

CI_Email::set_wordwrap

(

$

wordwrap = TRUE

)

Set Wordwrap.

public

Parameters:

string

Returns:

void

Definition at line 453 of file Email.php.

References $wordwrap.

        {
                $this->wordwrap = ($wordwrap === FALSE) ? FALSE : TRUE;
        }

CI_Email::subject

(

$

subject

)

Set Email Subject.

public

Parameters:

string

Returns:

void

Definition at line 330 of file Email.php.

References _set_header().

        {
                if (strpos($subject, "\r") !== FALSE OR strpos($subject, "\n") !== FALSE)
                {
                        $subject = str_replace(array("\r\n", "\r", "\n"), '', $subject);                        
                }

                if (strpos($subject, "\t"))
                {
                        $subject = str_replace("\t", ' ', $subject);
                }

                $this->_set_header('Subject', trim($subject));
        }

Here is the call graph for this function:

CI_Email::to

(

$

to

)

Set Recipients.

public

Parameters:

string

Returns:

void

Definition at line 234 of file Email.php.

References _get_protocol(), _set_header(), _str_to_array(), clean_email(), and validate_email().

        {
                $to = $this->_str_to_array($to);
                $to = $this->clean_email($to);
        
                if ($this->validate)
                {
                        $this->validate_email($to);
                }
        
                if ($this->_get_protocol() != 'mail')
                {
                        $this->_set_header('To', implode(", ", $to));
                }

                switch ($this->_get_protocol())
                {
                        case 'smtp'             : $this->_recipients = $to;
                        break;
                        case 'sendmail' : $this->_recipients = implode(", ", $to);
                        break;
                        case 'mail'             : $this->_recipients = implode(", ", $to);
                        break;
                }       
        }

Here is the call graph for this function:

CI_Email::valid_email

(

$

address

)

Email Validation.

public

Parameters:

string

Returns:

bool

Definition at line 711 of file Email.php.

Referenced by validate_email().

        {
                return ( ! preg_match("/^([a-z0-9\+_\-]+)(\.[a-z0-9\+_\-]+)*@([a-z0-9\-]+\.)+[a-z]{2,6}$/ix", $address)) ? FALSE : TRUE;
        }

Here is the caller graph for this function:

CI_Email::validate_email

(

$

email

)

Validate Email Address.

public

Parameters:

string

Returns:

bool

Definition at line 684 of file Email.php.

References _set_error_message(), and valid_email().

Referenced by bcc(), cc(), from(), reply_to(), and to().

        {       
                if ( ! is_array($email))
                {
                        $this->_set_error_message('email_must_be_array');
                        return FALSE;
                }

                foreach ($email as $val)
                {
                        if ( ! $this->valid_email($val))
                        {
                                $this->_set_error_message('email_invalid_address', $val);
                                return FALSE;
                        }
                }
        }       

Here is the call graph for this function:

Here is the caller graph for this function:

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

Word Wrap.

public

Parameters:

	string
	integer

Returns:

string

Definition at line 814 of file Email.php.

Referenced by _build_message(), and _get_alt_message().

        {
                // Se the character limit
                if ($charlim == '')
                {
                        $charlim = ($this->wrapchars == "") ? "76" : $this->wrapchars;
                }

                // Reduce multiple spaces
                $str = preg_replace("| +|", " ", $str);

                // Standardize newlines
                if (strpos($str, "\r") !== FALSE)
                {
                        $str = str_replace(array("\r\n", "\r"), "\n", $str);                    
                }

                // If the current word is surrounded by {unwrap} tags we'll 
                // strip the entire chunk and replace it with a marker.
                $unwrap = array();
                if (preg_match_all("|(\{unwrap\}.+?\{/unwrap\})|s", $str, $matches))
                {
                        for ($i = 0; $i < count($matches['0']); $i++)
                        {
                                $unwrap[] = $matches['1'][$i];
                                $str = str_replace($matches['1'][$i], "{{unwrapped".$i."}}", $str);
                        }
                }

                // Use PHP's native function to do the initial wordwrap.  
                // We set the cut flag to FALSE so that any individual words that are 
                // too long get left alone.  In the next step we'll deal with them.
                $str = wordwrap($str, $charlim, "\n", FALSE);

                // Split the string into individual lines of text and cycle through them
                $output = "";
                foreach (explode("\n", $str) as $line) 
                {
                        // Is the line within the allowed character count?
                        // If so we'll join it to the output and continue
                        if (strlen($line) <= $charlim)
                        {
                                $output .= $line.$this->newline;        
                                continue;
                        }

                        $temp = '';
                        while((strlen($line)) > $charlim) 
                        {
                                // If the over-length word is a URL we won't wrap it
                                if (preg_match("!\[url.+\]|://|wwww.!", $line))
                                {
                                        break;
                                }

                                // Trim the word down
                                $temp .= substr($line, 0, $charlim-1);
                                $line = substr($line, $charlim-1);
                        }
        
                        // If $temp contains data it means we had to split up an over-length 
                        // word into smaller chunks so we'll add it back to our current line
                        if ($temp != '')
                        {
                                $output .= $temp.$this->newline.$line;
                        }
                        else
                        {
                                $output .= $line;
                        }

                        $output .= $this->newline;
                }

                // Put our markers back
                if (count($unwrap) > 0)
                {       
                        foreach ($unwrap as $key => $val)
                        {
                                $output = str_replace("{{unwrapped".$key."}}", $val, $output);
                        }
                }

                return $output; 
        }

Here is the caller graph for this function:

---

Member Data Documentation

CI_Email::$_alt_boundary = ""

Definition at line 58 of file Email.php.

CI_Email::$_atc_boundary = ""

Definition at line 59 of file Email.php.

CI_Email::$_attach_disp = array()

Definition at line 73 of file Email.php.

CI_Email::$_attach_name = array()

Definition at line 71 of file Email.php.

CI_Email::$_attach_type = array()

Definition at line 72 of file Email.php.

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

Definition at line 75 of file Email.php.

CI_Email::$_bcc_array = array()

Definition at line 69 of file Email.php.

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

Definition at line 76 of file Email.php.

CI_Email::$_body = ""

Definition at line 56 of file Email.php.

CI_Email::$_cc_array = array()

Definition at line 68 of file Email.php.

CI_Email::$_debug_msg = array()

Definition at line 66 of file Email.php.

CI_Email::$_encoding = "8bit"

Definition at line 62 of file Email.php.

CI_Email::$_finalbody = ""

Definition at line 57 of file Email.php.

CI_Email::$_header_str = ""

Definition at line 60 of file Email.php.

CI_Email::$_headers = array()

Definition at line 70 of file Email.php.

CI_Email::$_IP = FALSE

Definition at line 63 of file Email.php.

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

Definition at line 77 of file Email.php.

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

Definition at line 74 of file Email.php.

CI_Email::$_recipients = array()

Definition at line 67 of file Email.php.

CI_Email::$_replyto_flag = FALSE

Definition at line 65 of file Email.php.

CI_Email::$_safe_mode = FALSE

Definition at line 54 of file Email.php.

CI_Email::$_smtp_auth = FALSE

Definition at line 64 of file Email.php.

CI_Email::$_smtp_connect = ""

Definition at line 61 of file Email.php.

CI_Email::$_subject = ""

Definition at line 55 of file Email.php.

CI_Email::$alt_message = ''

Definition at line 44 of file Email.php.

CI_Email::$bcc_batch_mode = FALSE

Definition at line 52 of file Email.php.

CI_Email::$bcc_batch_size = 200

Definition at line 53 of file Email.php.

CI_Email::$charset = "utf-8"

Definition at line 42 of file Email.php.

Referenced by _get_encoding().

CI_Email::$crlf = "\n"

Definition at line 48 of file Email.php.

Referenced by set_crlf().

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

Definition at line 32 of file Email.php.

CI_Email::$mailtype = "text"

Definition at line 41 of file Email.php.

CI_Email::$multipart = "mixed"

Definition at line 43 of file Email.php.

CI_Email::$newline = "\n"

Definition at line 47 of file Email.php.

Referenced by set_newline().

CI_Email::$priority = "3"

Definition at line 46 of file Email.php.

CI_Email::$protocol = "mail"

Definition at line 33 of file Email.php.

Referenced by set_protocol().

CI_Email::$send_multipart = TRUE

Definition at line 51 of file Email.php.

CI_Email::$smtp_host = ""

Definition at line 34 of file Email.php.

CI_Email::$smtp_pass = ""

Definition at line 36 of file Email.php.

CI_Email::$smtp_port = "25"

Definition at line 37 of file Email.php.

CI_Email::$smtp_timeout = 5

Definition at line 38 of file Email.php.

CI_Email::$smtp_user = ""

Definition at line 35 of file Email.php.

CI_Email::$useragent = "CodeIgniter"

Definition at line 31 of file Email.php.

CI_Email::$validate = FALSE

Definition at line 45 of file Email.php.

CI_Email::$wordwrap = TRUE

Definition at line 39 of file Email.php.

Referenced by set_wordwrap().

CI_Email::$wrapchars = "76"

Definition at line 40 of file Email.php.

---

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

• Email.php