123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490 |
- <?php
- /**
- * CodeIgniter
- *
- * An open source application development framework for PHP
- *
- * This content is released under the MIT License (MIT)
- *
- * Copyright (c) 2014 - 2019, British Columbia Institute of Technology
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- *
- * @package CodeIgniter
- * @author EllisLab Dev Team
- * @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (https://ellislab.com/)
- * @copyright Copyright (c) 2014 - 2019, British Columbia Institute of Technology (https://bcit.ca/)
- * @license https://opensource.org/licenses/MIT MIT License
- * @link https://codeigniter.com
- * @since Version 1.0.0
- * @filesource
- */
- defined('BASEPATH') OR exit('No direct script access allowed');
- /**
- * CodeIgniter Email Class
- *
- * Permits email to be sent using Mail, Sendmail, or SMTP.
- *
- * @package CodeIgniter
- * @subpackage Libraries
- * @category Libraries
- * @author EllisLab Dev Team
- * @link https://codeigniter.com/user_guide/libraries/email.html
- */
- class CI_Email {
- /**
- * Used as the User-Agent and X-Mailer headers' value.
- *
- * @var string
- */
- public $useragent = 'CodeIgniter';
- /**
- * Path to the Sendmail binary.
- *
- * @var string
- */
- public $mailpath = '/usr/sbin/sendmail'; // Sendmail path
- /**
- * Which method to use for sending e-mails.
- *
- * @var string 'mail', 'sendmail' or 'smtp'
- */
- public $protocol = 'mail'; // mail/sendmail/smtp
- /**
- * STMP Server host
- *
- * @var string
- */
- public $smtp_host = '';
- /**
- * SMTP Username
- *
- * @var string
- */
- public $smtp_user = '';
- /**
- * SMTP Password
- *
- * @var string
- */
- public $smtp_pass = '';
- /**
- * SMTP Server port
- *
- * @var int
- */
- public $smtp_port = 25;
- /**
- * SMTP connection timeout in seconds
- *
- * @var int
- */
- public $smtp_timeout = 5;
- /**
- * SMTP persistent connection
- *
- * @var bool
- */
- public $smtp_keepalive = FALSE;
- /**
- * SMTP Encryption
- *
- * @var string empty, 'tls' or 'ssl'
- */
- public $smtp_crypto = '';
- /**
- * Whether to apply word-wrapping to the message body.
- *
- * @var bool
- */
- public $wordwrap = TRUE;
- /**
- * Number of characters to wrap at.
- *
- * @see CI_Email::$wordwrap
- * @var int
- */
- public $wrapchars = 76;
- /**
- * Message format.
- *
- * @var string 'text' or 'html'
- */
- public $mailtype = 'text';
- /**
- * Character set (default: utf-8)
- *
- * @var string
- */
- public $charset = 'UTF-8';
- /**
- * Alternative message (for HTML messages only)
- *
- * @var string
- */
- public $alt_message = '';
- /**
- * Whether to validate e-mail addresses.
- *
- * @var bool
- */
- public $validate = FALSE;
- /**
- * X-Priority header value.
- *
- * @var int 1-5
- */
- public $priority = 3; // Default priority (1 - 5)
- /**
- * Newline character sequence.
- * Use "\r\n" to comply with RFC 822.
- *
- * @link http://www.ietf.org/rfc/rfc822.txt
- * @var string "\r\n" or "\n"
- */
- public $newline = "\n"; // Default newline. "\r\n" or "\n" (Use "\r\n" to comply with RFC 822)
- /**
- * 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.
- *
- * @link http://www.ietf.org/rfc/rfc822.txt
- * @var string
- */
- public $crlf = "\n";
- /**
- * Whether to use Delivery Status Notification.
- *
- * @var bool
- */
- public $dsn = FALSE;
- /**
- * Whether to send multipart alternatives.
- * Yahoo! doesn't seem to like these.
- *
- * @var bool
- */
- public $send_multipart = TRUE;
- /**
- * Whether to send messages to BCC recipients in batches.
- *
- * @var bool
- */
- public $bcc_batch_mode = FALSE;
- /**
- * BCC Batch max number size.
- *
- * @see CI_Email::$bcc_batch_mode
- * @var int
- */
- public $bcc_batch_size = 200;
- // --------------------------------------------------------------------
- /**
- * Whether PHP is running in safe mode. Initialized by the class constructor.
- *
- * @var bool
- */
- protected $_safe_mode = FALSE;
- /**
- * Subject header
- *
- * @var string
- */
- protected $_subject = '';
- /**
- * Message body
- *
- * @var string
- */
- protected $_body = '';
- /**
- * Final message body to be sent.
- *
- * @var string
- */
- protected $_finalbody = '';
- /**
- * Final headers to send
- *
- * @var string
- */
- protected $_header_str = '';
- /**
- * SMTP Connection socket placeholder
- *
- * @var resource
- */
- protected $_smtp_connect = '';
- /**
- * Mail encoding
- *
- * @var string '8bit' or '7bit'
- */
- protected $_encoding = '8bit';
- /**
- * Whether to perform SMTP authentication
- *
- * @var bool
- */
- protected $_smtp_auth = FALSE;
- /**
- * Whether to send a Reply-To header
- *
- * @var bool
- */
- protected $_replyto_flag = FALSE;
- /**
- * Debug messages
- *
- * @see CI_Email::print_debugger()
- * @var string
- */
- protected $_debug_msg = array();
- /**
- * Recipients
- *
- * @var string[]
- */
- protected $_recipients = array();
- /**
- * CC Recipients
- *
- * @var string[]
- */
- protected $_cc_array = array();
- /**
- * BCC Recipients
- *
- * @var string[]
- */
- protected $_bcc_array = array();
- /**
- * Message headers
- *
- * @var string[]
- */
- protected $_headers = array();
- /**
- * Attachment data
- *
- * @var array
- */
- protected $_attachments = array();
- /**
- * Valid $protocol values
- *
- * @see CI_Email::$protocol
- * @var string[]
- */
- protected $_protocols = array('mail', 'sendmail', 'smtp');
- /**
- * Base charsets
- *
- * Character sets valid for 7-bit encoding,
- * excluding language suffix.
- *
- * @var string[]
- */
- protected $_base_charsets = array('us-ascii', 'iso-2022-');
- /**
- * Bit depths
- *
- * Valid mail encodings
- *
- * @see CI_Email::$_encoding
- * @var string[]
- */
- protected $_bit_depths = array('7bit', '8bit');
- /**
- * $priority translations
- *
- * Actual values to send with the X-Priority header
- *
- * @var string[]
- */
- protected $_priorities = array(
- 1 => '1 (Highest)',
- 2 => '2 (High)',
- 3 => '3 (Normal)',
- 4 => '4 (Low)',
- 5 => '5 (Lowest)'
- );
- /**
- * mbstring.func_overload flag
- *
- * @var bool
- */
- protected static $func_overload;
- // --------------------------------------------------------------------
- /**
- * Constructor - Sets Email Preferences
- *
- * The constructor can be passed an array of config values
- *
- * @param array $config = array()
- * @return void
- */
- public function __construct(array $config = array())
- {
- $this->charset = config_item('charset');
- $this->initialize($config);
- $this->_safe_mode = ( ! is_php('5.4') && ini_get('safe_mode'));
- isset(self::$func_overload) OR self::$func_overload = (extension_loaded('mbstring') && ini_get('mbstring.func_overload'));
- log_message('info', 'Email Class Initialized');
- }
- // --------------------------------------------------------------------
- /**
- * Initialize preferences
- *
- * @param array $config
- * @return CI_Email
- */
- public function initialize(array $config = array())
- {
- $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;
- }
- }
- }
- $this->charset = strtoupper($this->charset);
- $this->_smtp_auth = isset($this->smtp_user[0], $this->smtp_pass[0]);
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Initialize the Email Data
- *
- * @param bool
- * @return CI_Email
- */
- public function clear($clear_attachments = FALSE)
- {
- $this->_subject = '';
- $this->_body = '';
- $this->_finalbody = '';
- $this->_header_str = '';
- $this->_replyto_flag = FALSE;
- $this->_recipients = array();
- $this->_cc_array = array();
- $this->_bcc_array = array();
- $this->_headers = array();
- $this->_debug_msg = array();
- $this->set_header('Date', $this->_set_date());
- if ($clear_attachments !== FALSE)
- {
- $this->_attachments = array();
- }
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Set FROM
- *
- * @param string $from
- * @param string $name
- * @param string $return_path = NULL Return-Path
- * @return CI_Email
- */
- public function from($from, $name = '', $return_path = NULL)
- {
- if (preg_match('/\<(.*)\>/', $from, $match))
- {
- $from = $match[1];
- }
- if ($this->validate)
- {
- $this->validate_email($this->_str_to_array($from));
- if ($return_path)
- {
- $this->validate_email($this->_str_to_array($return_path));
- }
- }
- // prepare the display name
- if ($name !== '')
- {
- // only use Q encoding if there are characters that would require it
- if ( ! preg_match('/[\200-\377]/', $name))
- {
- // add slashes for non-printing characters, slashes, and double quotes, and surround it in double quotes
- $name = '"'.addcslashes($name, "\0..\37\177'\"\\").'"';
- }
- else
- {
- $name = $this->_prep_q_encoding($name);
- }
- }
- $this->set_header('From', $name.' <'.$from.'>');
- isset($return_path) OR $return_path = $from;
- $this->set_header('Return-Path', '<'.$return_path.'>');
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Set Reply-to
- *
- * @param string
- * @param string
- * @return CI_Email
- */
- public function reply_to($replyto, $name = '')
- {
- if (preg_match('/\<(.*)\>/', $replyto, $match))
- {
- $replyto = $match[1];
- }
- if ($this->validate)
- {
- $this->validate_email($this->_str_to_array($replyto));
- }
- if ($name !== '')
- {
- // only use Q encoding if there are characters that would require it
- if ( ! preg_match('/[\200-\377]/', $name))
- {
- // add slashes for non-printing characters, slashes, and double quotes, and surround it in double quotes
- $name = '"'.addcslashes($name, "\0..\37\177'\"\\").'"';
- }
- else
- {
- $name = $this->_prep_q_encoding($name);
- }
- }
- $this->set_header('Reply-To', $name.' <'.$replyto.'>');
- $this->_replyto_flag = TRUE;
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Set Recipients
- *
- * @param string
- * @return CI_Email
- */
- public function to($to)
- {
- $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));
- }
- $this->_recipients = $to;
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Set CC
- *
- * @param string
- * @return CI_Email
- */
- public function cc($cc)
- {
- $cc = $this->clean_email($this->_str_to_array($cc));
- if ($this->validate)
- {
- $this->validate_email($cc);
- }
- $this->set_header('Cc', implode(', ', $cc));
- if ($this->_get_protocol() === 'smtp')
- {
- $this->_cc_array = $cc;
- }
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Set BCC
- *
- * @param string
- * @param string
- * @return CI_Email
- */
- public function bcc($bcc, $limit = '')
- {
- if ($limit !== '' && is_numeric($limit))
- {
- $this->bcc_batch_mode = TRUE;
- $this->bcc_batch_size = $limit;
- }
- $bcc = $this->clean_email($this->_str_to_array($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));
- }
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Set Email Subject
- *
- * @param string
- * @return CI_Email
- */
- public function subject($subject)
- {
- $subject = $this->_prep_q_encoding($subject);
- $this->set_header('Subject', $subject);
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Set Body
- *
- * @param string
- * @return CI_Email
- */
- public function message($body)
- {
- $this->_body = rtrim(str_replace("\r", '', $body));
- /* strip slashes only if magic quotes is ON
- if we do it with magic quotes OFF, it strips real, user-inputted chars.
- NOTE: In PHP 5.4 get_magic_quotes_gpc() will always return 0 and
- it will probably not exist in future versions at all.
- */
- if ( ! is_php('5.4') && get_magic_quotes_gpc())
- {
- $this->_body = stripslashes($this->_body);
- }
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Assign file attachments
- *
- * @param string $file Can be local path, URL or buffered content
- * @param string $disposition = 'attachment'
- * @param string $newname = NULL
- * @param string $mime = ''
- * @return CI_Email
- */
- public function attach($file, $disposition = '', $newname = NULL, $mime = '')
- {
- if ($mime === '')
- {
- if (strpos($file, '://') === FALSE && ! file_exists($file))
- {
- $this->_set_error_message('lang:email_attachment_missing', $file);
- return FALSE;
- }
- if ( ! $fp = @fopen($file, 'rb'))
- {
- $this->_set_error_message('lang:email_attachment_unreadable', $file);
- return FALSE;
- }
- $file_content = stream_get_contents($fp);
- $mime = $this->_mime_types(pathinfo($file, PATHINFO_EXTENSION));
- fclose($fp);
- }
- else
- {
- $file_content =& $file; // buffered file
- }
- $this->_attachments[] = array(
- 'name' => array($file, $newname),
- 'disposition' => empty($disposition) ? 'attachment' : $disposition, // Can also be 'inline' Not sure if it matters
- 'type' => $mime,
- 'content' => chunk_split(base64_encode($file_content)),
- 'multipart' => 'mixed'
- );
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Set and return attachment Content-ID
- *
- * Useful for attached inline pictures
- *
- * @param string $filename
- * @return string
- */
- public function attachment_cid($filename)
- {
- for ($i = 0, $c = count($this->_attachments); $i < $c; $i++)
- {
- if ($this->_attachments[$i]['name'][0] === $filename)
- {
- $this->_attachments[$i]['multipart'] = 'related';
- $this->_attachments[$i]['cid'] = uniqid(basename($this->_attachments[$i]['name'][0]).'@');
- return $this->_attachments[$i]['cid'];
- }
- }
- return FALSE;
- }
- // --------------------------------------------------------------------
- /**
- * Add a Header Item
- *
- * @param string
- * @param string
- * @return CI_Email
- */
- public function set_header($header, $value)
- {
- $this->_headers[$header] = str_replace(array("\n", "\r"), '', $value);
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Convert a String to an Array
- *
- * @param string
- * @return array
- */
- protected function _str_to_array($email)
- {
- if ( ! is_array($email))
- {
- return (strpos($email, ',') !== FALSE)
- ? preg_split('/[\s,]/', $email, -1, PREG_SPLIT_NO_EMPTY)
- : (array) trim($email);
- }
- return $email;
- }
- // --------------------------------------------------------------------
- /**
- * Set Multipart Value
- *
- * @param string
- * @return CI_Email
- */
- public function set_alt_message($str)
- {
- $this->alt_message = (string) $str;
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Set Mailtype
- *
- * @param string
- * @return CI_Email
- */
- public function set_mailtype($type = 'text')
- {
- $this->mailtype = ($type === 'html') ? 'html' : 'text';
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Set Wordwrap
- *
- * @param bool
- * @return CI_Email
- */
- public function set_wordwrap($wordwrap = TRUE)
- {
- $this->wordwrap = (bool) $wordwrap;
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Set Protocol
- *
- * @param string
- * @return CI_Email
- */
- public function set_protocol($protocol = 'mail')
- {
- $this->protocol = in_array($protocol, $this->_protocols, TRUE) ? strtolower($protocol) : 'mail';
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Set Priority
- *
- * @param int
- * @return CI_Email
- */
- public function set_priority($n = 3)
- {
- $this->priority = preg_match('/^[1-5]$/', $n) ? (int) $n : 3;
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Set Newline Character
- *
- * @param string
- * @return CI_Email
- */
- public function set_newline($newline = "\n")
- {
- $this->newline = in_array($newline, array("\n", "\r\n", "\r")) ? $newline : "\n";
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Set CRLF
- *
- * @param string
- * @return CI_Email
- */
- public function set_crlf($crlf = "\n")
- {
- $this->crlf = ($crlf !== "\n" && $crlf !== "\r\n" && $crlf !== "\r") ? "\n" : $crlf;
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Get the Message ID
- *
- * @return string
- */
- protected function _get_message_id()
- {
- $from = str_replace(array('>', '<'), '', $this->_headers['Return-Path']);
- return '<'.uniqid('').strstr($from, '@').'>';
- }
- // --------------------------------------------------------------------
- /**
- * Get Mail Protocol
- *
- * @return mixed
- */
- protected function _get_protocol()
- {
- $this->protocol = strtolower($this->protocol);
- in_array($this->protocol, $this->_protocols, TRUE) OR $this->protocol = 'mail';
- return $this->protocol;
- }
- // --------------------------------------------------------------------
- /**
- * Get Mail Encoding
- *
- * @return string
- */
- protected function _get_encoding()
- {
- in_array($this->_encoding, $this->_bit_depths) OR $this->_encoding = '8bit';
- foreach ($this->_base_charsets as $charset)
- {
- if (strpos($this->charset, $charset) === 0)
- {
- $this->_encoding = '7bit';
- }
- }
- return $this->_encoding;
- }
- // --------------------------------------------------------------------
- /**
- * Get content type (text/html/attachment)
- *
- * @return string
- */
- protected function _get_content_type()
- {
- if ($this->mailtype === 'html')
- {
- return empty($this->_attachments) ? 'html' : 'html-attach';
- }
- elseif ($this->mailtype === 'text' && ! empty($this->_attachments))
- {
- return 'plain-attach';
- }
- return 'plain';
- }
- // --------------------------------------------------------------------
- /**
- * Set RFC 822 Date
- *
- * @return string
- */
- protected function _set_date()
- {
- $timezone = date('Z');
- $operator = ($timezone[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);
- }
- // --------------------------------------------------------------------
- /**
- * Mime message
- *
- * @return string
- */
- protected function _get_mime_message()
- {
- return 'This is a multi-part message in MIME format.'.$this->newline.'Your email application may not support this format.';
- }
- // --------------------------------------------------------------------
- /**
- * Validate Email Address
- *
- * @param string
- * @return bool
- */
- public function validate_email($email)
- {
- if ( ! is_array($email))
- {
- $this->_set_error_message('lang:email_must_be_array');
- return FALSE;
- }
- foreach ($email as $val)
- {
- if ( ! $this->valid_email($val))
- {
- $this->_set_error_message('lang:email_invalid_address', $val);
- return FALSE;
- }
- }
- return TRUE;
- }
- // --------------------------------------------------------------------
- /**
- * Email Validation
- *
- * @param string
- * @return bool
- */
- public function valid_email($email)
- {
- if (function_exists('idn_to_ascii') && strpos($email, '@'))
- {
- list($account, $domain) = explode('@', $email, 2);
- $domain = defined('INTL_IDNA_VARIANT_UTS46')
- ? idn_to_ascii($domain, 0, INTL_IDNA_VARIANT_UTS46)
- : idn_to_ascii($domain);
- if ($domain !== FALSE)
- {
- $email = $account.'@'.$domain;
- }
- }
- return (bool) filter_var($email, FILTER_VALIDATE_EMAIL);
- }
- // --------------------------------------------------------------------
- /**
- * Clean Extended Email Address: Joe Smith <joe@smith.com>
- *
- * @param string
- * @return string
- */
- public function clean_email($email)
- {
- if ( ! is_array($email))
- {
- return preg_match('/\<(.*)\>/', $email, $match) ? $match[1] : $email;
- }
- $clean_email = array();
- foreach ($email as $addy)
- {
- $clean_email[] = preg_match('/\<(.*)\>/', $addy, $match) ? $match[1] : $addy;
- }
- return $clean_email;
- }
- // --------------------------------------------------------------------
- /**
- * 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
- *
- * @return string
- */
- protected function _get_alt_message()
- {
- if ( ! empty($this->alt_message))
- {
- return ($this->wordwrap)
- ? $this->word_wrap($this->alt_message, 76)
- : $this->alt_message;
- }
- $body = preg_match('/\<body.*?\>(.*)\<\/body\>/si', $this->_body, $match) ? $match[1] : $this->_body;
- $body = str_replace("\t", '', preg_replace('#<!--(.*)--\>#', '', trim(strip_tags($body))));
- for ($i = 20; $i >= 3; $i--)
- {
- $body = str_replace(str_repeat("\n", $i), "\n\n", $body);
- }
- // Reduce multiple spaces
- $body = preg_replace('| +|', ' ', $body);
- return ($this->wordwrap)
- ? $this->word_wrap($body, 76)
- : $body;
- }
- // --------------------------------------------------------------------
- /**
- * Word Wrap
- *
- * @param string
- * @param int line-length limit
- * @return string
- */
- public function word_wrap($str, $charlim = NULL)
- {
- // Set the character limit, if not already present
- if (empty($charlim))
- {
- $charlim = empty($this->wrapchars) ? 76 : $this->wrapchars;
- }
- // Standardize newlines
- if (strpos($str, "\r") !== FALSE)
- {
- $str = str_replace(array("\r\n", "\r"), "\n", $str);
- }
- // Reduce multiple spaces at end of line
- $str = preg_replace('| +\n|', "\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, $c = count($matches[0]); $i < $c; $i++)
- {
- $unwrap[] = $matches[1][$i];
- $str = str_replace($matches[0][$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 (self::strlen($line) <= $charlim)
- {
- $output .= $line.$this->newline;
- continue;
- }
- $temp = '';
- do
- {
- // If the over-length word is a URL we won't wrap it
- if (preg_match('!\[url.+\]|://|www\.!', $line))
- {
- break;
- }
- // Trim the word down
- $temp .= self::substr($line, 0, $charlim - 1);
- $line = self::substr($line, $charlim - 1);
- }
- while (self::strlen($line) > $charlim);
- // 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;
- }
- $output .= $line.$this->newline;
- }
- // Put our markers back
- if (count($unwrap) > 0)
- {
- foreach ($unwrap as $key => $val)
- {
- $output = str_replace('{{unwrapped'.$key.'}}', $val, $output);
- }
- }
- return $output;
- }
- // --------------------------------------------------------------------
- /**
- * Build final headers
- *
- * @return void
- */
- protected function _build_headers()
- {
- $this->set_header('User-Agent', $this->useragent);
- $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]);
- $this->set_header('Message-ID', $this->_get_message_id());
- $this->set_header('Mime-Version', '1.0');
- }
- // --------------------------------------------------------------------
- /**
- * Write Headers as a string
- *
- * @return void
- */
- protected function _write_headers()
- {
- if ($this->protocol === 'mail')
- {
- if (isset($this->_headers['Subject']))
- {
- $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 = rtrim($this->_header_str);
- }
- }
- // --------------------------------------------------------------------
- /**
- * Build Final Body and attachments
- *
- * @return bool
- */
- protected function _build_message()
- {
- if ($this->wordwrap === TRUE && $this->mailtype !== 'html')
- {
- $this->_body = $this->word_wrap($this->_body);
- }
- $this->_write_headers();
- $hdr = ($this->_get_protocol() === 'mail') ? $this->newline : '';
- $body = '';
- switch ($this->_get_content_type())
- {
- case 'plain':
- $hdr .= 'Content-Type: text/plain; charset='.$this->charset.$this->newline
- .'Content-Transfer-Encoding: '.$this->_get_encoding();
- if ($this->_get_protocol() === 'mail')
- {
- $this->_header_str .= $hdr;
- $this->_finalbody = $this->_body;
- }
- else
- {
- $this->_finalbody = $hdr.$this->newline.$this->newline.$this->_body;
- }
- return;
- case 'html':
- if ($this->send_multipart === FALSE)
- {
- $hdr .= 'Content-Type: text/html; charset='.$this->charset.$this->newline
- .'Content-Transfer-Encoding: quoted-printable';
- }
- else
- {
- $boundary = uniqid('B_ALT_');
- $hdr .= 'Content-Type: multipart/alternative; boundary="'.$boundary.'"';
- $body .= $this->_get_mime_message().$this->newline.$this->newline
- .'--'.$boundary.$this->newline
- .'Content-Type: text/plain; charset='.$this->charset.$this->newline
- .'Content-Transfer-Encoding: '.$this->_get_encoding().$this->newline.$this->newline
- .$this->_get_alt_message().$this->newline.$this->newline
- .'--'.$boundary.$this->newline
- .'Content-Type: text/html; charset='.$this->charset.$this->newline
- .'Content-Transfer-Encoding: quoted-printable'.$this->newline.$this->newline;
- }
- $this->_finalbody = $body.$this->_prep_quoted_printable($this->_body).$this->newline.$this->newline;
- if ($this->_get_protocol() === 'mail')
- {
- $this->_header_str .= $hdr;
- }
- else
- {
- $this->_finalbody = $hdr.$this->newline.$this->newline.$this->_finalbody;
- }
- if ($this->send_multipart !== FALSE)
- {
- $this->_finalbody .= '--'.$boundary.'--';
- }
- return;
- case 'plain-attach':
- $boundary = uniqid('B_ATC_');
- $hdr .= 'Content-Type: multipart/mixed; boundary="'.$boundary.'"';
- if ($this->_get_protocol() === 'mail')
- {
- $this->_header_str .= $hdr;
- }
- $body .= $this->_get_mime_message().$this->newline
- .$this->newline
- .'--'.$boundary.$this->newline
- .'Content-Type: text/plain; charset='.$this->charset.$this->newline
- .'Content-Transfer-Encoding: '.$this->_get_encoding().$this->newline
- .$this->newline
- .$this->_body.$this->newline.$this->newline;
- $this->_append_attachments($body, $boundary);
- break;
- case 'html-attach':
- $alt_boundary = uniqid('B_ALT_');
- $last_boundary = NULL;
- if ($this->_attachments_have_multipart('mixed'))
- {
- $atc_boundary = uniqid('B_ATC_');
- $hdr .= 'Content-Type: multipart/mixed; boundary="'.$atc_boundary.'"';
- $last_boundary = $atc_boundary;
- }
- if ($this->_attachments_have_multipart('related'))
- {
- $rel_boundary = uniqid('B_REL_');
- $rel_boundary_header = 'Content-Type: multipart/related; boundary="'.$rel_boundary.'"';
- if (isset($last_boundary))
- {
- $body .= '--'.$last_boundary.$this->newline.$rel_boundary_header;
- }
- else
- {
- $hdr .= $rel_boundary_header;
- }
- $last_boundary = $rel_boundary;
- }
- if ($this->_get_protocol() === 'mail')
- {
- $this->_header_str .= $hdr;
- }
- self::strlen($body) && $body .= $this->newline.$this->newline;
- $body .= $this->_get_mime_message().$this->newline.$this->newline
- .'--'.$last_boundary.$this->newline
- .'Content-Type: multipart/alternative; boundary="'.$alt_boundary.'"'.$this->newline.$this->newline
- .'--'.$alt_boundary.$this->newline
- .'Content-Type: text/plain; charset='.$this->charset.$this->newline
- .'Content-Transfer-Encoding: '.$this->_get_encoding().$this->newline.$this->newline
- .$this->_get_alt_message().$this->newline.$this->newline
- .'--'.$alt_boundary.$this->newline
- .'Content-Type: text/html; charset='.$this->charset.$this->newline
- .'Content-Transfer-Encoding: quoted-printable'.$this->newline.$this->newline
- .$this->_prep_quoted_printable($this->_body).$this->newline.$this->newline
- .'--'.$alt_boundary.'--'.$this->newline.$this->newline;
- if ( ! empty($rel_boundary))
- {
- $body .= $this->newline.$this->newline;
- $this->_append_attachments($body, $rel_boundary, 'related');
- }
- // multipart/mixed attachments
- if ( ! empty($atc_boundary))
- {
- $body .= $this->newline.$this->newline;
- $this->_append_attachments($body, $atc_boundary, 'mixed');
- }
- break;
- }
- $this->_finalbody = ($this->_get_protocol() === 'mail')
- ? $body
- : $hdr.$this->newline.$this->newline.$body;
- return TRUE;
- }
- // --------------------------------------------------------------------
- protected function _attachments_have_multipart($type)
- {
- foreach ($this->_attachments as &$attachment)
- {
- if ($attachment['multipart'] === $type)
- {
- return TRUE;
- }
- }
- return FALSE;
- }
- // --------------------------------------------------------------------
- /**
- * Prepares attachment string
- *
- * @param string $body Message body to append to
- * @param string $boundary Multipart boundary
- * @param string $multipart When provided, only attachments of this type will be processed
- * @return string
- */
- protected function _append_attachments(&$body, $boundary, $multipart = null)
- {
- for ($i = 0, $c = count($this->_attachments); $i < $c; $i++)
- {
- if (isset($multipart) && $this->_attachments[$i]['multipart'] !== $multipart)
- {
- continue;
- }
- $name = isset($this->_attachments[$i]['name'][1])
- ? $this->_attachments[$i]['name'][1]
- : basename($this->_attachments[$i]['name'][0]);
- $body .= '--'.$boundary.$this->newline
- .'Content-Type: '.$this->_attachments[$i]['type'].'; name="'.$name.'"'.$this->newline
- .'Content-Disposition: '.$this->_attachments[$i]['disposition'].';'.$this->newline
- .'Content-Transfer-Encoding: base64'.$this->newline
- .(empty($this->_attachments[$i]['cid']) ? '' : 'Content-ID: <'.$this->_attachments[$i]['cid'].'>'.$this->newline)
- .$this->newline
- .$this->_attachments[$i]['content'].$this->newline;
- }
- // $name won't be set if no attachments were appended,
- // and therefore a boundary wouldn't be necessary
- empty($name) OR $body .= '--'.$boundary.'--';
- }
- // --------------------------------------------------------------------
- /**
- * Prep Quoted Printable
- *
- * Prepares string for Quoted-Printable Content-Transfer-Encoding
- * Refer to RFC 2045 http://www.ietf.org/rfc/rfc2045.txt
- *
- * @param string
- * @return string
- */
- protected function _prep_quoted_printable($str)
- {
- // ASCII code numbers for "safe" characters that can always be
- // used literally, without encoding, as described in RFC 2049.
- // http://www.ietf.org/rfc/rfc2049.txt
- static $ascii_safe_chars = array(
- // ' ( ) + , - . / : = ?
- 39, 40, 41, 43, 44, 45, 46, 47, 58, 61, 63,
- // numbers
- 48, 49, 50, 51, 52, 53, 54, 55, 56, 57,
- // upper-case letters
- 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90,
- // lower-case letters
- 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122
- );
- // 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);
- // RFC 2045 specifies CRLF as "\r\n".
- // However, many developers choose to override that and violate
- // the RFC rules due to (apparently) a bug in MS Exchange,
- // which only works with "\n".
- if ($this->crlf === "\r\n")
- {
- return quoted_printable_encode($str);
- }
- // Reduce multiple spaces & remove nulls
- $str = preg_replace(array('| +|', '/\x00+/'), array(' ', ''), $str);
- // Standardize newlines
- if (strpos($str, "\r") !== FALSE)
- {
- $str = str_replace(array("\r\n", "\r"), "\n", $str);
- }
- $escape = '=';
- $output = '';
- foreach (explode("\n", $str) as $line)
- {
- $length = self::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 = $line[$i];
- $ascii = ord($char);
- // Convert spaces and tabs but only if it's the end of the line
- if ($ascii === 32 OR $ascii === 9)
- {
- if ($i === ($length - 1))
- {
- $char = $escape.sprintf('%02s', dechex($ascii));
- }
- }
- // DO NOT move this below the $ascii_safe_chars line!
- //
- // = (equals) signs are allowed by RFC2049, but must be encoded
- // as they are the encoding delimiter!
- elseif ($ascii === 61)
- {
- $char = $escape.strtoupper(sprintf('%02s', dechex($ascii))); // =3D
- }
- elseif ( ! in_array($ascii, $ascii_safe_chars, TRUE))
- {
- $char = $escape.strtoupper(sprintf('%02s', dechex($ascii)));
- }
- // If we're at the character limit, add the line to the output,
- // reset our temp variable, and keep on chuggin'
- if ((self::strlen($temp) + self::strlen($char)) >= 76)
- {
- $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
- return self::substr($output, 0, self::strlen($this->crlf) * -1);
- }
- // --------------------------------------------------------------------
- /**
- * 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.
- *
- * @param string
- * @return string
- */
- protected function _prep_q_encoding($str)
- {
- $str = str_replace(array("\r", "\n"), '', $str);
- if ($this->charset === 'UTF-8')
- {
- // Note: We used to have mb_encode_mimeheader() as the first choice
- // here, but it turned out to be buggy and unreliable. DO NOT
- // re-add it! -- Narf
- if (ICONV_ENABLED === TRUE)
- {
- $output = @iconv_mime_encode('', $str,
- array(
- 'scheme' => 'Q',
- 'line-length' => 76,
- 'input-charset' => $this->charset,
- 'output-charset' => $this->charset,
- 'line-break-chars' => $this->crlf
- )
- );
- // There are reports that iconv_mime_encode() might fail and return FALSE
- if ($output !== FALSE)
- {
- // iconv_mime_encode() will always put a header field name.
- // We've passed it an empty one, but it still prepends our
- // encoded string with ': ', so we need to strip it.
- return self::substr($output, 2);
- }
- $chars = iconv_strlen($str, 'UTF-8');
- }
- elseif (MB_ENABLED === TRUE)
- {
- $chars = mb_strlen($str, 'UTF-8');
- }
- }
- // We might already have this set for UTF-8
- isset($chars) OR $chars = self::strlen($str);
- $output = '=?'.$this->charset.'?Q?';
- for ($i = 0, $length = self::strlen($output); $i < $chars; $i++)
- {
- $chr = ($this->charset === 'UTF-8' && ICONV_ENABLED === TRUE)
- ? '='.implode('=', str_split(strtoupper(bin2hex(iconv_substr($str, $i, 1, $this->charset))), 2))
- : '='.strtoupper(bin2hex($str[$i]));
- // RFC 2045 sets a limit of 76 characters per line.
- // We'll append ?= to the end of each line though.
- if ($length + ($l = self::strlen($chr)) > 74)
- {
- $output .= '?='.$this->crlf // EOL
- .' =?'.$this->charset.'?Q?'.$chr; // New line
- $length = 6 + self::strlen($this->charset) + $l; // Reset the length for the new line
- }
- else
- {
- $output .= $chr;
- $length += $l;
- }
- }
- // End the header
- return $output.'?=';
- }
- // --------------------------------------------------------------------
- /**
- * Send Email
- *
- * @param bool $auto_clear = TRUE
- * @return bool
- */
- public function send($auto_clear = TRUE)
- {
- if ( ! isset($this->_headers['From']))
- {
- $this->_set_error_message('lang:email_no_from');
- return FALSE;
- }
- if ($this->_replyto_flag === FALSE)
- {
- $this->reply_to($this->_headers['From']);
- }
- if ( ! isset($this->_recipients) && ! isset($this->_headers['To'])
- && ! isset($this->_bcc_array) && ! isset($this->_headers['Bcc'])
- && ! isset($this->_headers['Cc']))
- {
- $this->_set_error_message('lang:email_no_recipients');
- return FALSE;
- }
- $this->_build_headers();
- if ($this->bcc_batch_mode && count($this->_bcc_array) > $this->bcc_batch_size)
- {
- $result = $this->batch_bcc_send();
- if ($result && $auto_clear)
- {
- $this->clear();
- }
- return $result;
- }
- if ($this->_build_message() === FALSE)
- {
- return FALSE;
- }
- $result = $this->_spool_email();
- if ($result && $auto_clear)
- {
- $this->clear();
- }
- return $result;
- }
- // --------------------------------------------------------------------
- /**
- * Batch Bcc Send. Sends groups of BCCs in batches
- *
- * @return void
- */
- public function batch_bcc_send()
- {
- $float = $this->bcc_batch_size - 1;
- $set = '';
- $chunk = array();
- for ($i = 0, $c = count($this->_bcc_array); $i < $c; $i++)
- {
- if (isset($this->_bcc_array[$i]))
- {
- $set .= ', '.$this->_bcc_array[$i];
- }
- if ($i === $float)
- {
- $chunk[] = self::substr($set, 1);
- $float += $this->bcc_batch_size;
- $set = '';
- }
- if ($i === $c-1)
- {
- $chunk[] = self::substr($set, 1);
- }
- }
- for ($i = 0, $c = count($chunk); $i < $c; $i++)
- {
- unset($this->_headers['Bcc']);
- $bcc = $this->clean_email($this->_str_to_array($chunk[$i]));
- if ($this->protocol !== 'smtp')
- {
- $this->set_header('Bcc', implode(', ', $bcc));
- }
- else
- {
- $this->_bcc_array = $bcc;
- }
- if ($this->_build_message() === FALSE)
- {
- return FALSE;
- }
- $this->_spool_email();
- }
- }
- // --------------------------------------------------------------------
- /**
- * Unwrap special elements
- *
- * @return void
- */
- protected function _unwrap_specials()
- {
- $this->_finalbody = preg_replace_callback('/\{unwrap\}(.*?)\{\/unwrap\}/si', array($this, '_remove_nl_callback'), $this->_finalbody);
- }
- // --------------------------------------------------------------------
- /**
- * Strip line-breaks via callback
- *
- * @param string $matches
- * @return string
- */
- protected function _remove_nl_callback($matches)
- {
- 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];
- }
- // --------------------------------------------------------------------
- /**
- * Spool mail to the mail server
- *
- * @return bool
- */
- protected function _spool_email()
- {
- $this->_unwrap_specials();
- $protocol = $this->_get_protocol();
- $method = '_send_with_'.$protocol;
- if ( ! $this->$method())
- {
- $this->_set_error_message('lang:email_send_failure_'.($protocol === 'mail' ? 'phpmail' : $protocol));
- return FALSE;
- }
- $this->_set_error_message('lang:email_sent', $protocol);
- return TRUE;
- }
- // --------------------------------------------------------------------
- /**
- * Validate email for shell
- *
- * Applies stricter, shell-safe validation to email addresses.
- * Introduced to prevent RCE via sendmail's -f option.
- *
- * @see https://github.com/bcit-ci/CodeIgniter/issues/4963
- * @see https://gist.github.com/Zenexer/40d02da5e07f151adeaeeaa11af9ab36
- * @license https://creativecommons.org/publicdomain/zero/1.0/ CC0 1.0, Public Domain
- *
- * Credits for the base concept go to Paul Buonopane <paul@namepros.com>
- *
- * @param string $email
- * @return bool
- */
- protected function _validate_email_for_shell(&$email)
- {
- if (function_exists('idn_to_ascii') && strpos($email, '@'))
- {
- list($account, $domain) = explode('@', $email, 2);
- $domain = defined('INTL_IDNA_VARIANT_UTS46')
- ? idn_to_ascii($domain, 0, INTL_IDNA_VARIANT_UTS46)
- : idn_to_ascii($domain);
- if ($domain !== FALSE)
- {
- $email = $account.'@'.$domain;
- }
- }
- return (filter_var($email, FILTER_VALIDATE_EMAIL) === $email && preg_match('#\A[a-z0-9._+-]+@[a-z0-9.-]{1,253}\z#i', $email));
- }
- // --------------------------------------------------------------------
- /**
- * Send using mail()
- *
- * @return bool
- */
- protected function _send_with_mail()
- {
- if (is_array($this->_recipients))
- {
- $this->_recipients = implode(', ', $this->_recipients);
- }
- // _validate_email_for_shell() below accepts by reference,
- // so this needs to be assigned to a variable
- $from = $this->clean_email($this->_headers['Return-Path']);
- if ($this->_safe_mode === TRUE || ! $this->_validate_email_for_shell($from))
- {
- return mail($this->_recipients, $this->_subject, $this->_finalbody, $this->_header_str);
- }
- 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.
- return mail($this->_recipients, $this->_subject, $this->_finalbody, $this->_header_str, '-f '.$from);
- }
- }
- // --------------------------------------------------------------------
- /**
- * Send using Sendmail
- *
- * @return bool
- */
- protected function _send_with_sendmail()
- {
- // _validate_email_for_shell() below accepts by reference,
- // so this needs to be assigned to a variable
- $from = $this->clean_email($this->_headers['From']);
- if ($this->_validate_email_for_shell($from))
- {
- $from = '-f '.$from;
- }
- else
- {
- $from = '';
- }
- // is popen() enabled?
- if ( ! function_usable('popen') OR FALSE === ($fp = @popen($this->mailpath.' -oi '.$from.' -t', 'w')))
- {
- // server probably has popen disabled, so nothing we can do to get a verbose error.
- return FALSE;
- }
- fputs($fp, $this->_header_str);
- fputs($fp, $this->_finalbody);
- $status = pclose($fp);
- if ($status !== 0)
- {
- $this->_set_error_message('lang:email_exit_status', $status);
- $this->_set_error_message('lang:email_no_socket');
- return FALSE;
- }
- return TRUE;
- }
- // --------------------------------------------------------------------
- /**
- * Send using SMTP
- *
- * @return bool
- */
- protected function _send_with_smtp()
- {
- if ($this->smtp_host === '')
- {
- $this->_set_error_message('lang:email_no_hostname');
- return FALSE;
- }
- if ( ! $this->_smtp_connect() OR ! $this->_smtp_authenticate())
- {
- return FALSE;
- }
- if ( ! $this->_send_command('from', $this->clean_email($this->_headers['From'])))
- {
- $this->_smtp_end();
- return FALSE;
- }
- foreach ($this->_recipients as $val)
- {
- if ( ! $this->_send_command('to', $val))
- {
- $this->_smtp_end();
- return FALSE;
- }
- }
- if (count($this->_cc_array) > 0)
- {
- foreach ($this->_cc_array as $val)
- {
- if ($val !== '' && ! $this->_send_command('to', $val))
- {
- $this->_smtp_end();
- return FALSE;
- }
- }
- }
- if (count($this->_bcc_array) > 0)
- {
- foreach ($this->_bcc_array as $val)
- {
- if ($val !== '' && ! $this->_send_command('to', $val))
- {
- $this->_smtp_end();
- return FALSE;
- }
- }
- }
- if ( ! $this->_send_command('data'))
- {
- $this->_smtp_end();
- return FALSE;
- }
- // 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);
- $this->_smtp_end();
- if (strpos($reply, '250') !== 0)
- {
- $this->_set_error_message('lang:email_smtp_error', $reply);
- return FALSE;
- }
- return TRUE;
- }
- // --------------------------------------------------------------------
- /**
- * SMTP End
- *
- * Shortcut to send RSET or QUIT depending on keep-alive
- *
- * @return void
- */
- protected function _smtp_end()
- {
- ($this->smtp_keepalive)
- ? $this->_send_command('reset')
- : $this->_send_command('quit');
- }
- // --------------------------------------------------------------------
- /**
- * SMTP Connect
- *
- * @return string
- */
- protected function _smtp_connect()
- {
- if (is_resource($this->_smtp_connect))
- {
- return TRUE;
- }
- $ssl = ($this->smtp_crypto === 'ssl') ? 'ssl://' : '';
- $this->_smtp_connect = fsockopen($ssl.$this->smtp_host,
- $this->smtp_port,
- $errno,
- $errstr,
- $this->smtp_timeout);
- if ( ! is_resource($this->_smtp_connect))
- {
- $this->_set_error_message('lang:email_smtp_error', $errno.' '.$errstr);
- return FALSE;
- }
- stream_set_timeout($this->_smtp_connect, $this->smtp_timeout);
- $this->_set_error_message($this->_get_smtp_data());
- if ($this->smtp_crypto === 'tls')
- {
- $this->_send_command('hello');
- $this->_send_command('starttls');
- /**
- * STREAM_CRYPTO_METHOD_TLS_CLIENT is quite the mess ...
- *
- * - On PHP <5.6 it doesn't even mean TLS, but SSL 2.0, and there's no option to use actual TLS
- * - On PHP 5.6.0-5.6.6, >=7.2 it means negotiation with any of TLS 1.0, 1.1, 1.2
- * - On PHP 5.6.7-7.1.* it means only TLS 1.0
- *
- * We want the negotiation, so we'll force it below ...
- */
- $method = is_php('5.6')
- ? STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT | STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT | STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT
- : STREAM_CRYPTO_METHOD_TLS_CLIENT;
- $crypto = stream_socket_enable_crypto($this->_smtp_connect, TRUE, $method);
- if ($crypto !== TRUE)
- {
- $this->_set_error_message('lang:email_smtp_error', $this->_get_smtp_data());
- return FALSE;
- }
- }
- return $this->_send_command('hello');
- }
- // --------------------------------------------------------------------
- /**
- * Send SMTP command
- *
- * @param string
- * @param string
- * @return bool
- */
- protected function _send_command($cmd, $data = '')
- {
- 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 'starttls' :
- $this->_send_data('STARTTLS');
- $resp = 220;
- break;
- case 'from' :
- $this->_send_data('MAIL FROM:<'.$data.'>');
- $resp = 250;
- break;
- case 'to' :
- if ($this->dsn)
- {
- $this->_send_data('RCPT TO:<'.$data.'> NOTIFY=SUCCESS,DELAY,FAILURE ORCPT=rfc822;'.$data);
- }
- else
- {
- $this->_send_data('RCPT TO:<'.$data.'>');
- }
- $resp = 250;
- break;
- case 'data' :
- $this->_send_data('DATA');
- $resp = 354;
- break;
- case 'reset':
- $this->_send_data('RSET');
- $resp = 250;
- break;
- case 'quit' :
- $this->_send_data('QUIT');
- $resp = 221;
- break;
- }
- $reply = $this->_get_smtp_data();
- $this->_debug_msg[] = '<pre>'.$cmd.': '.$reply.'</pre>';
- if ((int) self::substr($reply, 0, 3) !== $resp)
- {
- $this->_set_error_message('lang:email_smtp_error', $reply);
- return FALSE;
- }
- if ($cmd === 'quit')
- {
- fclose($this->_smtp_connect);
- }
- return TRUE;
- }
- // --------------------------------------------------------------------
- /**
- * SMTP Authenticate
- *
- * @return bool
- */
- protected function _smtp_authenticate()
- {
- if ( ! $this->_smtp_auth)
- {
- return TRUE;
- }
- if ($this->smtp_user === '' && $this->smtp_pass === '')
- {
- $this->_set_error_message('lang:email_no_smtp_unpw');
- return FALSE;
- }
- $this->_send_data('AUTH LOGIN');
- $reply = $this->_get_smtp_data();
- if (strpos($reply, '503') === 0) // Already authenticated
- {
- return TRUE;
- }
- elseif (strpos($reply, '334') !== 0)
- {
- $this->_set_error_message('lang:email_failed_smtp_login', $reply);
- return FALSE;
- }
- $this->_send_data(base64_encode($this->smtp_user));
- $reply = $this->_get_smtp_data();
- if (strpos($reply, '334') !== 0)
- {
- $this->_set_error_message('lang:email_smtp_auth_un', $reply);
- return FALSE;
- }
- $this->_send_data(base64_encode($this->smtp_pass));
- $reply = $this->_get_smtp_data();
- if (strpos($reply, '235') !== 0)
- {
- $this->_set_error_message('lang:email_smtp_auth_pw', $reply);
- return FALSE;
- }
- if ($this->smtp_keepalive)
- {
- $this->_smtp_auth = FALSE;
- }
- return TRUE;
- }
- // --------------------------------------------------------------------
- /**
- * Send SMTP data
- *
- * @param string $data
- * @return bool
- */
- protected function _send_data($data)
- {
- $data .= $this->newline;
- for ($written = $timestamp = 0, $length = self::strlen($data); $written < $length; $written += $result)
- {
- if (($result = fwrite($this->_smtp_connect, self::substr($data, $written))) === FALSE)
- {
- break;
- }
- // See https://bugs.php.net/bug.php?id=39598 and http://php.net/manual/en/function.fwrite.php#96951
- elseif ($result === 0)
- {
- if ($timestamp === 0)
- {
- $timestamp = time();
- }
- elseif ($timestamp < (time() - $this->smtp_timeout))
- {
- $result = FALSE;
- break;
- }
- usleep(250000);
- continue;
- }
- $timestamp = 0;
- }
- if ($result === FALSE)
- {
- $this->_set_error_message('lang:email_smtp_data_failure', $data);
- return FALSE;
- }
- return TRUE;
- }
- // --------------------------------------------------------------------
- /**
- * Get SMTP data
- *
- * @return string
- */
- protected function _get_smtp_data()
- {
- $data = '';
- while ($str = fgets($this->_smtp_connect, 512))
- {
- $data .= $str;
- if ($str[3] === ' ')
- {
- break;
- }
- }
- return $data;
- }
- // --------------------------------------------------------------------
- /**
- * 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]").
- *
- * @link https://tools.ietf.org/html/rfc5321#section-2.3.5
- * @link http://cbl.abuseat.org/namingproblems.html
- * @return string
- */
- protected function _get_hostname()
- {
- if (isset($_SERVER['SERVER_NAME']))
- {
- return $_SERVER['SERVER_NAME'];
- }
- return isset($_SERVER['SERVER_ADDR']) ? '['.$_SERVER['SERVER_ADDR'].']' : '[127.0.0.1]';
- }
- // --------------------------------------------------------------------
- /**
- * Get Debug Message
- *
- * @param array $include List of raw data chunks to include in the output
- * Valid options are: 'headers', 'subject', 'body'
- * @return string
- */
- public function print_debugger($include = array('headers', 'subject', 'body'))
- {
- $msg = '';
- if (count($this->_debug_msg) > 0)
- {
- foreach ($this->_debug_msg as $val)
- {
- $msg .= $val;
- }
- }
- // Determine which parts of our raw data needs to be printed
- $raw_data = '';
- is_array($include) OR $include = array($include);
- if (in_array('headers', $include, TRUE))
- {
- $raw_data = htmlspecialchars($this->_header_str)."\n";
- }
- if (in_array('subject', $include, TRUE))
- {
- $raw_data .= htmlspecialchars($this->_subject)."\n";
- }
- if (in_array('body', $include, TRUE))
- {
- $raw_data .= htmlspecialchars($this->_finalbody);
- }
- return $msg.($raw_data === '' ? '' : '<pre>'.$raw_data.'</pre>');
- }
- // --------------------------------------------------------------------
- /**
- * Set Message
- *
- * @param string $msg
- * @param string $val = ''
- * @return void
- */
- protected function _set_error_message($msg, $val = '')
- {
- $CI =& get_instance();
- $CI->lang->load('email');
- if (sscanf($msg, 'lang:%s', $line) !== 1 OR FALSE === ($line = $CI->lang->line($line)))
- {
- $this->_debug_msg[] = str_replace('%s', $val, $msg).'<br />';
- }
- else
- {
- $this->_debug_msg[] = str_replace('%s', $val, $line).'<br />';
- }
- }
- // --------------------------------------------------------------------
- /**
- * Mime Types
- *
- * @param string
- * @return string
- */
- protected function _mime_types($ext = '')
- {
- $ext = strtolower($ext);
- $mimes =& get_mimes();
- if (isset($mimes[$ext]))
- {
- return is_array($mimes[$ext])
- ? current($mimes[$ext])
- : $mimes[$ext];
- }
- return 'application/x-unknown-content-type';
- }
- // --------------------------------------------------------------------
- /**
- * Destructor
- *
- * @return void
- */
- public function __destruct()
- {
- is_resource($this->_smtp_connect) && $this->_send_command('quit');
- }
- // --------------------------------------------------------------------
- /**
- * Byte-safe strlen()
- *
- * @param string $str
- * @return int
- */
- protected static function strlen($str)
- {
- return (self::$func_overload)
- ? mb_strlen($str, '8bit')
- : strlen($str);
- }
- // --------------------------------------------------------------------
- /**
- * Byte-safe substr()
- *
- * @param string $str
- * @param int $start
- * @param int $length
- * @return string
- */
- protected static function substr($str, $start, $length = NULL)
- {
- if (self::$func_overload)
- {
- // mb_substr($str, $start, null, '8bit') returns an empty
- // string on PHP 5.3
- isset($length) OR $length = ($start >= 0 ? self::strlen($str) - $start : -$start);
- return mb_substr($str, $start, $length, '8bit');
- }
- return isset($length)
- ? substr($str, $start, $length)
- : substr($str, $start);
- }
- }
|