blob: 0e9cf05743e045bbbdba604b29fa8d15e051e4a8 [file] [log] [blame]
Andrey Andreevc5536aa2012-11-01 17:33:58 +02001<?php
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Andrey Andreevfe9309d2015-01-09 17:48:58 +02005 * An open source application development framework for PHP
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +02007 * This content is released under the MIT License (MIT)
Andrey Andreev1bd3d882011-12-22 15:38:20 +02008 *
Master Yodada60e9b2016-12-31 08:46:18 -08009 * Copyright (c) 2014 - 2017, British Columbia Institute of Technology
Andrey Andreev1bd3d882011-12-22 15:38:20 +020010 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020011 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
Derek Jonesf4a4bd82011-10-20 12:18:42 -050017 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020018 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27 * THE SOFTWARE.
28 *
29 * @package CodeIgniter
30 * @author EllisLab Dev Team
Andrey Andreev1924e872016-01-11 12:55:34 +020031 * @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (https://ellislab.com/)
Master Yodada60e9b2016-12-31 08:46:18 -080032 * @copyright Copyright (c) 2014 - 2017, British Columbia Institute of Technology (http://bcit.ca/)
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020033 * @license http://opensource.org/licenses/MIT MIT License
Andrey Andreevbd202c92016-01-11 12:50:18 +020034 * @link https://codeigniter.com
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020035 * @since Version 1.0.0
Derek Allard2067d1a2008-11-13 22:59:24 +000036 * @filesource
37 */
Andrey Andreevc5536aa2012-11-01 17:33:58 +020038defined('BASEPATH') OR exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +000039
Derek Allard2067d1a2008-11-13 22:59:24 +000040/**
41 * CodeIgniter Email Class
42 *
43 * Permits email to be sent using Mail, Sendmail, or SMTP.
44 *
45 * @package CodeIgniter
46 * @subpackage Libraries
47 * @category Libraries
Derek Jonesf4a4bd82011-10-20 12:18:42 -050048 * @author EllisLab Dev Team
Andrey Andreevbd202c92016-01-11 12:50:18 +020049 * @link https://codeigniter.com/user_guide/libraries/email.html
Derek Allard2067d1a2008-11-13 22:59:24 +000050 */
trita15dd4f2011-11-23 07:40:05 -050051class CI_Email {
Derek Allard2067d1a2008-11-13 22:59:24 +000052
Andrey Andreev597ea272012-11-01 22:56:26 +020053 /**
54 * Used as the User-Agent and X-Mailer headers' value.
55 *
56 * @var string
57 */
Andrey Andreev59c5b532012-03-01 14:09:51 +020058 public $useragent = 'CodeIgniter';
Andrey Andreev50814092012-03-01 12:36:12 +020059
Andrey Andreev597ea272012-11-01 22:56:26 +020060 /**
61 * Path to the Sendmail binary.
62 *
63 * @var string
64 */
65 public $mailpath = '/usr/sbin/sendmail'; // Sendmail path
66
67 /**
68 * Which method to use for sending e-mails.
69 *
70 * @var string 'mail', 'sendmail' or 'smtp'
71 */
72 public $protocol = 'mail'; // mail/sendmail/smtp
73
74 /**
75 * STMP Server host
76 *
77 * @var string
78 */
79 public $smtp_host = '';
80
81 /**
82 * SMTP Username
83 *
84 * @var string
85 */
86 public $smtp_user = '';
87
88 /**
89 * SMTP Password
90 *
91 * @var string
92 */
93 public $smtp_pass = '';
94
95 /**
96 * SMTP Server port
97 *
98 * @var int
99 */
100 public $smtp_port = 25;
101
102 /**
103 * SMTP connection timeout in seconds
104 *
105 * @var int
106 */
107 public $smtp_timeout = 5;
vlakofff3994252013-02-19 01:45:23 +0100108
nisheeth-barthwalcf225572013-02-18 01:08:04 +0530109 /**
nisheeth-barthwal59209de2013-02-18 17:02:13 +0530110 * SMTP persistent connection
111 *
112 * @var bool
113 */
114 public $smtp_keepalive = FALSE;
Andrey Andreev597ea272012-11-01 22:56:26 +0200115
116 /**
117 * SMTP Encryption
118 *
Andrey Andreev89b67b42013-03-12 19:34:23 +0200119 * @var string empty, 'tls' or 'ssl'
Andrey Andreev597ea272012-11-01 22:56:26 +0200120 */
Andrey Andreev89b67b42013-03-12 19:34:23 +0200121 public $smtp_crypto = '';
Andrey Andreev597ea272012-11-01 22:56:26 +0200122
123 /**
124 * Whether to apply word-wrapping to the message body.
125 *
126 * @var bool
127 */
128 public $wordwrap = TRUE;
129
130 /**
131 * Number of characters to wrap at.
132 *
133 * @see CI_Email::$wordwrap
134 * @var int
135 */
136 public $wrapchars = 76;
137
138 /**
139 * Message format.
140 *
141 * @var string 'text' or 'html'
142 */
143 public $mailtype = 'text';
144
145 /**
146 * Character set (default: utf-8)
147 *
148 * @var string
149 */
Andrey Andreev8c95c3d2016-05-09 12:35:41 +0300150 public $charset = 'UTF-8';
Andrey Andreev597ea272012-11-01 22:56:26 +0200151
152 /**
Andrey Andreev597ea272012-11-01 22:56:26 +0200153 * Alternative message (for HTML messages only)
154 *
155 * @var string
156 */
157 public $alt_message = '';
158
159 /**
160 * Whether to validate e-mail addresses.
161 *
162 * @var bool
163 */
164 public $validate = FALSE;
165
166 /**
167 * X-Priority header value.
168 *
169 * @var int 1-5
170 */
171 public $priority = 3; // Default priority (1 - 5)
172
173 /**
174 * Newline character sequence.
175 * Use "\r\n" to comply with RFC 822.
176 *
177 * @link http://www.ietf.org/rfc/rfc822.txt
178 * @var string "\r\n" or "\n"
179 */
180 public $newline = "\n"; // Default newline. "\r\n" or "\n" (Use "\r\n" to comply with RFC 822)
181
182 /**
183 * CRLF character sequence
184 *
185 * RFC 2045 specifies that for 'quoted-printable' encoding,
186 * "\r\n" must be used. However, it appears that some servers
187 * (even on the receiving end) don't handle it properly and
188 * switching to "\n", while improper, is the only solution
189 * that seems to work for all environments.
190 *
191 * @link http://www.ietf.org/rfc/rfc822.txt
192 * @var string
193 */
194 public $crlf = "\n";
195
196 /**
197 * Whether to use Delivery Status Notification.
198 *
199 * @var bool
200 */
201 public $dsn = FALSE;
202
203 /**
204 * Whether to send multipart alternatives.
205 * Yahoo! doesn't seem to like these.
206 *
207 * @var bool
208 */
209 public $send_multipart = TRUE;
210
211 /**
212 * Whether to send messages to BCC recipients in batches.
213 *
214 * @var bool
215 */
216 public $bcc_batch_mode = FALSE;
217
218 /**
219 * BCC Batch max number size.
220 *
221 * @see CI_Email::$bcc_batch_mode
222 * @var int
223 */
224 public $bcc_batch_size = 200;
225
226 // --------------------------------------------------------------------
227
228 /**
229 * Whether PHP is running in safe mode. Initialized by the class constructor.
230 *
231 * @var bool
232 */
Andrey Andreev50814092012-03-01 12:36:12 +0200233 protected $_safe_mode = FALSE;
Andrey Andreev597ea272012-11-01 22:56:26 +0200234
235 /**
236 * Subject header
237 *
238 * @var string
239 */
Andrey Andreev50814092012-03-01 12:36:12 +0200240 protected $_subject = '';
Andrey Andreev597ea272012-11-01 22:56:26 +0200241
242 /**
243 * Message body
244 *
245 * @var string
246 */
Andrey Andreev50814092012-03-01 12:36:12 +0200247 protected $_body = '';
Andrey Andreev597ea272012-11-01 22:56:26 +0200248
249 /**
250 * Final message body to be sent.
251 *
252 * @var string
253 */
Andrey Andreev50814092012-03-01 12:36:12 +0200254 protected $_finalbody = '';
Andrey Andreev597ea272012-11-01 22:56:26 +0200255
256 /**
Andrey Andreev597ea272012-11-01 22:56:26 +0200257 * Final headers to send
258 *
259 * @var string
260 */
Andrey Andreev50814092012-03-01 12:36:12 +0200261 protected $_header_str = '';
Andrey Andreev597ea272012-11-01 22:56:26 +0200262
263 /**
264 * SMTP Connection socket placeholder
265 *
266 * @var resource
267 */
Andrey Andreev50814092012-03-01 12:36:12 +0200268 protected $_smtp_connect = '';
Andrey Andreev597ea272012-11-01 22:56:26 +0200269
270 /**
271 * Mail encoding
272 *
273 * @var string '8bit' or '7bit'
274 */
Andrey Andreev50814092012-03-01 12:36:12 +0200275 protected $_encoding = '8bit';
Andrey Andreev597ea272012-11-01 22:56:26 +0200276
277 /**
278 * Whether to perform SMTP authentication
279 *
280 * @var bool
281 */
Andrey Andreev50814092012-03-01 12:36:12 +0200282 protected $_smtp_auth = FALSE;
Andrey Andreev597ea272012-11-01 22:56:26 +0200283
284 /**
285 * Whether to send a Reply-To header
286 *
287 * @var bool
288 */
Andrey Andreev50814092012-03-01 12:36:12 +0200289 protected $_replyto_flag = FALSE;
Andrey Andreev597ea272012-11-01 22:56:26 +0200290
291 /**
292 * Debug messages
293 *
294 * @see CI_Email::print_debugger()
295 * @var string
296 */
Andrey Andreev50814092012-03-01 12:36:12 +0200297 protected $_debug_msg = array();
Andrey Andreev597ea272012-11-01 22:56:26 +0200298
299 /**
300 * Recipients
301 *
302 * @var string[]
303 */
Andrey Andreev50814092012-03-01 12:36:12 +0200304 protected $_recipients = array();
Andrey Andreev597ea272012-11-01 22:56:26 +0200305
306 /**
307 * CC Recipients
308 *
309 * @var string[]
310 */
Andrey Andreev50814092012-03-01 12:36:12 +0200311 protected $_cc_array = array();
Andrey Andreev597ea272012-11-01 22:56:26 +0200312
313 /**
314 * BCC Recipients
315 *
316 * @var string[]
317 */
Andrey Andreev50814092012-03-01 12:36:12 +0200318 protected $_bcc_array = array();
Andrey Andreev597ea272012-11-01 22:56:26 +0200319
320 /**
321 * Message headers
322 *
323 * @var string[]
324 */
Andrey Andreev50814092012-03-01 12:36:12 +0200325 protected $_headers = array();
Andrey Andreev597ea272012-11-01 22:56:26 +0200326
327 /**
328 * Attachment data
329 *
330 * @var array
331 */
Andrey Andreevb8f9a152012-10-27 01:36:51 +0300332 protected $_attachments = array();
Andrey Andreev597ea272012-11-01 22:56:26 +0200333
334 /**
335 * Valid $protocol values
336 *
337 * @see CI_Email::$protocol
338 * @var string[]
339 */
Andrey Andreev50814092012-03-01 12:36:12 +0200340 protected $_protocols = array('mail', 'sendmail', 'smtp');
Andrey Andreev597ea272012-11-01 22:56:26 +0200341
342 /**
343 * Base charsets
344 *
345 * Character sets valid for 7-bit encoding,
346 * excluding language suffix.
347 *
348 * @var string[]
349 */
350 protected $_base_charsets = array('us-ascii', 'iso-2022-');
351
352 /**
353 * Bit depths
354 *
355 * Valid mail encodings
356 *
357 * @see CI_Email::$_encoding
358 * @var string[]
359 */
Andrey Andreev50814092012-03-01 12:36:12 +0200360 protected $_bit_depths = array('7bit', '8bit');
Andrey Andreev597ea272012-11-01 22:56:26 +0200361
362 /**
363 * $priority translations
364 *
365 * Actual values to send with the X-Priority header
366 *
367 * @var string[]
368 */
Andrey Andreevdea61772014-02-24 16:36:25 +0200369 protected $_priorities = array(
370 1 => '1 (Highest)',
371 2 => '2 (High)',
372 3 => '3 (Normal)',
373 4 => '4 (Low)',
374 5 => '5 (Lowest)'
375 );
Derek Allard2067d1a2008-11-13 22:59:24 +0000376
Andrey Andreev4e2cdec2016-10-28 14:19:08 +0300377 /**
Andrey Andreevc0c74d52017-01-19 15:26:35 +0200378 * mbstring.func_overload flag
Andrey Andreev4e2cdec2016-10-28 14:19:08 +0300379 *
380 * @var bool
381 */
Andrey Andreevc0c74d52017-01-19 15:26:35 +0200382 protected static $func_overload;
Andrey Andreev4e2cdec2016-10-28 14:19:08 +0300383
Andrey Andreev597ea272012-11-01 22:56:26 +0200384 // --------------------------------------------------------------------
385
Derek Allard2067d1a2008-11-13 22:59:24 +0000386 /**
387 * Constructor - Sets Email Preferences
388 *
389 * The constructor can be passed an array of config values
Andrey Andreev56454792012-05-17 14:32:19 +0300390 *
Andrey Andreev5fd3ae82012-10-24 14:55:35 +0300391 * @param array $config = array()
Andrey Andreev56454792012-05-17 14:32:19 +0300392 * @return void
Derek Allard2067d1a2008-11-13 22:59:24 +0000393 */
Andrey Andreev0b1fd2c2015-03-10 20:00:19 +0200394 public function __construct(array $config = array())
Derek Allard2067d1a2008-11-13 22:59:24 +0000395 {
Andrey Andreev925dd902012-10-19 11:06:31 +0300396 $this->charset = config_item('charset');
Andrey Andreev8c95c3d2016-05-09 12:35:41 +0300397 $this->initialize($config);
Andrey Andreevf6274742014-02-20 18:05:58 +0200398 $this->_safe_mode = ( ! is_php('5.4') && ini_get('safe_mode'));
Andrey Andreev925dd902012-10-19 11:06:31 +0300399
Andrey Andreevc0c74d52017-01-19 15:26:35 +0200400 isset(self::$func_overload) OR self::$func_overload = (extension_loaded('mbstring') && ini_get('mbstring.func_overload'));
Andrey Andreev4e2cdec2016-10-28 14:19:08 +0300401
Andrey Andreev90726b82015-01-20 12:39:22 +0200402 log_message('info', 'Email Class Initialized');
Derek Allard2067d1a2008-11-13 22:59:24 +0000403 }
nisheeth-barthwal59209de2013-02-18 17:02:13 +0530404
nisheeth-barthwalcf225572013-02-18 01:08:04 +0530405 // --------------------------------------------------------------------
vlakofff3994252013-02-19 01:45:23 +0100406
nisheeth-barthwalcf225572013-02-18 01:08:04 +0530407 /**
Derek Allard2067d1a2008-11-13 22:59:24 +0000408 * Initialize preferences
409 *
Andrey Andreev8c95c3d2016-05-09 12:35:41 +0300410 * @param array $config
Andrew Podner4296a652012-12-17 07:51:15 -0500411 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000412 */
Andrey Andreev8c95c3d2016-05-09 12:35:41 +0300413 public function initialize(array $config = array())
Derek Allard2067d1a2008-11-13 22:59:24 +0000414 {
Andrey Andreev8c95c3d2016-05-09 12:35:41 +0300415 $this->clear();
416
Derek Allard2067d1a2008-11-13 22:59:24 +0000417 foreach ($config as $key => $val)
418 {
419 if (isset($this->$key))
420 {
421 $method = 'set_'.$key;
422
423 if (method_exists($this, $method))
424 {
425 $this->$method($val);
426 }
427 else
428 {
429 $this->$key = $val;
430 }
431 }
432 }
433
Andrey Andreev8c95c3d2016-05-09 12:35:41 +0300434 $this->charset = strtoupper($this->charset);
435 $this->_smtp_auth = isset($this->smtp_user[0], $this->smtp_pass[0]);
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000436
437 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000438 }
Barry Mienydd671972010-10-04 16:33:58 +0200439
Derek Allard2067d1a2008-11-13 22:59:24 +0000440 // --------------------------------------------------------------------
441
442 /**
443 * Initialize the Email Data
444 *
Bo-Yi Wu83320eb2011-09-15 13:28:02 +0800445 * @param bool
Andrew Podner4296a652012-12-17 07:51:15 -0500446 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000447 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000448 public function clear($clear_attachments = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000449 {
Andrey Andreev59c5b532012-03-01 14:09:51 +0200450 $this->_subject = '';
451 $this->_body = '';
452 $this->_finalbody = '';
453 $this->_header_str = '';
454 $this->_replyto_flag = FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000455 $this->_recipients = array();
Derek Jonesd1606352010-09-01 11:16:07 -0500456 $this->_cc_array = array();
457 $this->_bcc_array = array();
Derek Allard2067d1a2008-11-13 22:59:24 +0000458 $this->_headers = array();
459 $this->_debug_msg = array();
460
Mickey Wubfc1cad2012-05-31 22:28:40 -0700461 $this->set_header('Date', $this->_set_date());
Derek Allard2067d1a2008-11-13 22:59:24 +0000462
463 if ($clear_attachments !== FALSE)
464 {
Andrey Andreevb8f9a152012-10-27 01:36:51 +0300465 $this->_attachments = array();
Derek Allard2067d1a2008-11-13 22:59:24 +0000466 }
Eric Barnes6113f542010-12-29 13:36:12 -0500467
Greg Akera769deb2010-11-10 15:47:29 -0600468 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000469 }
Barry Mienydd671972010-10-04 16:33:58 +0200470
Derek Allard2067d1a2008-11-13 22:59:24 +0000471 // --------------------------------------------------------------------
472
473 /**
474 * Set FROM
475 *
Andrey Andreev5fd3ae82012-10-24 14:55:35 +0300476 * @param string $from
477 * @param string $name
478 * @param string $return_path = NULL Return-Path
Andrew Podner4296a652012-12-17 07:51:15 -0500479 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000480 */
Andrey Andreev925dd902012-10-19 11:06:31 +0300481 public function from($from, $name = '', $return_path = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000482 {
Andrey Andreev59c5b532012-03-01 14:09:51 +0200483 if (preg_match('/\<(.*)\>/', $from, $match))
Derek Allard2067d1a2008-11-13 22:59:24 +0000484 {
Andrey Andreev1bd3d882011-12-22 15:38:20 +0200485 $from = $match[1];
Derek Allard2067d1a2008-11-13 22:59:24 +0000486 }
487
488 if ($this->validate)
489 {
490 $this->validate_email($this->_str_to_array($from));
Andrey Andreevccd01c72012-10-05 17:12:55 +0300491 if ($return_path)
Melounek58dfc082012-06-29 08:43:47 +0200492 {
493 $this->validate_email($this->_str_to_array($return_path));
494 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000495 }
496
497 // prepare the display name
Alex Bilbied261b1e2012-06-02 11:12:16 +0100498 if ($name !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000499 {
500 // only use Q encoding if there are characters that would require it
501 if ( ! preg_match('/[\200-\377]/', $name))
502 {
503 // add slashes for non-printing characters, slashes, and double quotes, and surround it in double quotes
Derek Jonesc630bcf2008-11-17 21:09:45 +0000504 $name = '"'.addcslashes($name, "\0..\37\177'\"\\").'"';
Derek Allard2067d1a2008-11-13 22:59:24 +0000505 }
506 else
507 {
Andrey Andreev925dd902012-10-19 11:06:31 +0300508 $name = $this->_prep_q_encoding($name);
Derek Allard2067d1a2008-11-13 22:59:24 +0000509 }
510 }
511
Mickey Wubfc1cad2012-05-31 22:28:40 -0700512 $this->set_header('From', $name.' <'.$from.'>');
Melounek58dfc082012-06-29 08:43:47 +0200513
Andrey Andreev925dd902012-10-19 11:06:31 +0300514 isset($return_path) OR $return_path = $from;
Melounek58dfc082012-06-29 08:43:47 +0200515 $this->set_header('Return-Path', '<'.$return_path.'>');
Eric Barnes6113f542010-12-29 13:36:12 -0500516
Greg Akera769deb2010-11-10 15:47:29 -0600517 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000518 }
Barry Mienydd671972010-10-04 16:33:58 +0200519
Derek Allard2067d1a2008-11-13 22:59:24 +0000520 // --------------------------------------------------------------------
521
522 /**
523 * Set Reply-to
524 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000525 * @param string
526 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500527 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000528 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000529 public function reply_to($replyto, $name = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000530 {
Andrey Andreev59c5b532012-03-01 14:09:51 +0200531 if (preg_match('/\<(.*)\>/', $replyto, $match))
Derek Allard2067d1a2008-11-13 22:59:24 +0000532 {
Andrey Andreev1bd3d882011-12-22 15:38:20 +0200533 $replyto = $match[1];
Derek Allard2067d1a2008-11-13 22:59:24 +0000534 }
535
536 if ($this->validate)
537 {
538 $this->validate_email($this->_str_to_array($replyto));
539 }
540
Andrey Andreevc70216d2016-01-20 17:25:13 +0200541 if ($name !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000542 {
Andrey Andreevc70216d2016-01-20 17:25:13 +0200543 // only use Q encoding if there are characters that would require it
544 if ( ! preg_match('/[\200-\377]/', $name))
545 {
546 // add slashes for non-printing characters, slashes, and double quotes, and surround it in double quotes
547 $name = '"'.addcslashes($name, "\0..\37\177'\"\\").'"';
548 }
549 else
550 {
551 $name = $this->_prep_q_encoding($name);
552 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000553 }
554
Mickey Wubfc1cad2012-05-31 22:28:40 -0700555 $this->set_header('Reply-To', $name.' <'.$replyto.'>');
Derek Allard2067d1a2008-11-13 22:59:24 +0000556 $this->_replyto_flag = TRUE;
Greg Akera769deb2010-11-10 15:47:29 -0600557
558 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000559 }
Barry Mienydd671972010-10-04 16:33:58 +0200560
Derek Allard2067d1a2008-11-13 22:59:24 +0000561 // --------------------------------------------------------------------
562
563 /**
564 * Set Recipients
565 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000566 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500567 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000568 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000569 public function to($to)
Derek Allard2067d1a2008-11-13 22:59:24 +0000570 {
571 $to = $this->_str_to_array($to);
572 $to = $this->clean_email($to);
573
574 if ($this->validate)
575 {
576 $this->validate_email($to);
577 }
578
Andrey Andreev1bd3d882011-12-22 15:38:20 +0200579 if ($this->_get_protocol() !== 'mail')
Derek Allard2067d1a2008-11-13 22:59:24 +0000580 {
Mickey Wubfc1cad2012-05-31 22:28:40 -0700581 $this->set_header('To', implode(', ', $to));
Derek Allard2067d1a2008-11-13 22:59:24 +0000582 }
583
Andrey Andreev8a7078b2012-10-17 10:52:49 +0300584 $this->_recipients = $to;
Eric Barnes6113f542010-12-29 13:36:12 -0500585
Greg Akera769deb2010-11-10 15:47:29 -0600586 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000587 }
Barry Mienydd671972010-10-04 16:33:58 +0200588
Derek Allard2067d1a2008-11-13 22:59:24 +0000589 // --------------------------------------------------------------------
590
591 /**
592 * Set CC
593 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000594 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500595 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000596 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000597 public function cc($cc)
Derek Allard2067d1a2008-11-13 22:59:24 +0000598 {
Andrey Andreev56454792012-05-17 14:32:19 +0300599 $cc = $this->clean_email($this->_str_to_array($cc));
Derek Allard2067d1a2008-11-13 22:59:24 +0000600
601 if ($this->validate)
602 {
603 $this->validate_email($cc);
604 }
605
Mickey Wubfc1cad2012-05-31 22:28:40 -0700606 $this->set_header('Cc', implode(', ', $cc));
Derek Allard2067d1a2008-11-13 22:59:24 +0000607
Andrey Andreev1bd3d882011-12-22 15:38:20 +0200608 if ($this->_get_protocol() === 'smtp')
Derek Allard2067d1a2008-11-13 22:59:24 +0000609 {
610 $this->_cc_array = $cc;
611 }
Eric Barnes6113f542010-12-29 13:36:12 -0500612
Greg Akera769deb2010-11-10 15:47:29 -0600613 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000614 }
Barry Mienydd671972010-10-04 16:33:58 +0200615
Derek Allard2067d1a2008-11-13 22:59:24 +0000616 // --------------------------------------------------------------------
617
618 /**
619 * Set BCC
620 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000621 * @param string
622 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500623 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000624 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000625 public function bcc($bcc, $limit = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000626 {
Alex Bilbied261b1e2012-06-02 11:12:16 +0100627 if ($limit !== '' && is_numeric($limit))
Derek Allard2067d1a2008-11-13 22:59:24 +0000628 {
629 $this->bcc_batch_mode = TRUE;
630 $this->bcc_batch_size = $limit;
631 }
632
Andrey Andreev56454792012-05-17 14:32:19 +0300633 $bcc = $this->clean_email($this->_str_to_array($bcc));
Derek Allard2067d1a2008-11-13 22:59:24 +0000634
635 if ($this->validate)
636 {
637 $this->validate_email($bcc);
638 }
639
Andrey Andreev1bd3d882011-12-22 15:38:20 +0200640 if ($this->_get_protocol() === 'smtp' OR ($this->bcc_batch_mode && count($bcc) > $this->bcc_batch_size))
Derek Allard2067d1a2008-11-13 22:59:24 +0000641 {
642 $this->_bcc_array = $bcc;
643 }
644 else
645 {
Mickey Wubfc1cad2012-05-31 22:28:40 -0700646 $this->set_header('Bcc', implode(', ', $bcc));
Derek Allard2067d1a2008-11-13 22:59:24 +0000647 }
Eric Barnes6113f542010-12-29 13:36:12 -0500648
Greg Akera769deb2010-11-10 15:47:29 -0600649 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000650 }
Barry Mienydd671972010-10-04 16:33:58 +0200651
Derek Allard2067d1a2008-11-13 22:59:24 +0000652 // --------------------------------------------------------------------
653
654 /**
655 * Set Email Subject
656 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000657 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500658 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000659 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000660 public function subject($subject)
Derek Allard2067d1a2008-11-13 22:59:24 +0000661 {
662 $subject = $this->_prep_q_encoding($subject);
Mickey Wubfc1cad2012-05-31 22:28:40 -0700663 $this->set_header('Subject', $subject);
Greg Akera769deb2010-11-10 15:47:29 -0600664 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000665 }
Barry Mienydd671972010-10-04 16:33:58 +0200666
Derek Allard2067d1a2008-11-13 22:59:24 +0000667 // --------------------------------------------------------------------
668
669 /**
670 * Set Body
671 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000672 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500673 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000674 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000675 public function message($body)
Derek Allard2067d1a2008-11-13 22:59:24 +0000676 {
Andrey Andreev59c5b532012-03-01 14:09:51 +0200677 $this->_body = rtrim(str_replace("\r", '', $body));
diegorivera33c32802011-10-19 02:56:15 -0200678
Andrey Andreevaf728622011-10-20 10:11:59 +0300679 /* strip slashes only if magic quotes is ON
680 if we do it with magic quotes OFF, it strips real, user-inputted chars.
681
682 NOTE: In PHP 5.4 get_magic_quotes_gpc() will always return 0 and
683 it will probably not exist in future versions at all.
684 */
685 if ( ! is_php('5.4') && get_magic_quotes_gpc())
diegorivera9fca6152011-10-19 11:18:45 -0200686 {
diegorivera33c32802011-10-19 02:56:15 -0200687 $this->_body = stripslashes($this->_body);
diegorivera9fca6152011-10-19 11:18:45 -0200688 }
diegorivera33c32802011-10-19 02:56:15 -0200689
Greg Akera769deb2010-11-10 15:47:29 -0600690 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000691 }
Barry Mienydd671972010-10-04 16:33:58 +0200692
Derek Allard2067d1a2008-11-13 22:59:24 +0000693 // --------------------------------------------------------------------
694
695 /**
696 * Assign file attachments
697 *
Petr Heralecky1dbdf72c2014-01-10 16:54:51 +0100698 * @param string $file Can be local path, URL or buffered content
Andrey Andreev5fd3ae82012-10-24 14:55:35 +0300699 * @param string $disposition = 'attachment'
700 * @param string $newname = NULL
701 * @param string $mime = ''
Andrew Podner4296a652012-12-17 07:51:15 -0500702 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000703 */
Petr Heraleckyceb03af2014-01-10 16:40:54 +0100704 public function attach($file, $disposition = '', $newname = NULL, $mime = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000705 {
Petr Heralecky300e3f02014-01-10 11:49:11 +0100706 if ($mime === '')
707 {
Petr Heralecky1dbdf72c2014-01-10 16:54:51 +0100708 if (strpos($file, '://') === FALSE && ! file_exists($file))
Petr Heralecky300e3f02014-01-10 11:49:11 +0100709 {
Petr Heraleckyceb03af2014-01-10 16:40:54 +0100710 $this->_set_error_message('lang:email_attachment_missing', $file);
Petr Heralecky300e3f02014-01-10 11:49:11 +0100711 return FALSE;
712 }
Andrey Andreevc8097262014-01-10 14:45:31 +0200713
Andrey Andreev7cf682a2014-03-13 14:55:45 +0200714 if ( ! $fp = @fopen($file, 'rb'))
Petr Heralecky300e3f02014-01-10 11:49:11 +0100715 {
Petr Heraleckyceb03af2014-01-10 16:40:54 +0100716 $this->_set_error_message('lang:email_attachment_unreadable', $file);
Petr Heralecky300e3f02014-01-10 11:49:11 +0100717 return FALSE;
718 }
Petr Heralecky1dbdf72c2014-01-10 16:54:51 +0100719
Petr Heralecky300e3f02014-01-10 11:49:11 +0100720 $file_content = stream_get_contents($fp);
Petr Heraleckyceb03af2014-01-10 16:40:54 +0100721 $mime = $this->_mime_types(pathinfo($file, PATHINFO_EXTENSION));
Petr Heraleckyde886152014-01-10 12:52:56 +0100722 fclose($fp);
Petr Heralecky300e3f02014-01-10 11:49:11 +0100723 }
724 else
725 {
Petr Heraleckyceb03af2014-01-10 16:40:54 +0100726 $file_content =& $file; // buffered file
Petr Heralecky300e3f02014-01-10 11:49:11 +0100727 }
Andrey Andreevc8097262014-01-10 14:45:31 +0200728
Andrey Andreevb8f9a152012-10-27 01:36:51 +0300729 $this->_attachments[] = array(
Petr Heraleckyceb03af2014-01-10 16:40:54 +0100730 'name' => array($file, $newname),
Andrey Andreevb8f9a152012-10-27 01:36:51 +0300731 'disposition' => empty($disposition) ? 'attachment' : $disposition, // Can also be 'inline' Not sure if it matters
Petr Heralecky300e3f02014-01-10 11:49:11 +0100732 'type' => $mime,
Andrey Andreev3c422792016-06-06 09:44:50 +0300733 'content' => chunk_split(base64_encode($file_content)),
734 'multipart' => 'mixed'
Andrey Andreevb8f9a152012-10-27 01:36:51 +0300735 );
Petr Heralecky9ad2fff2014-01-10 13:25:34 +0100736
Greg Akera769deb2010-11-10 15:47:29 -0600737 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000738 }
Andrey Andreevc8097262014-01-10 14:45:31 +0200739
Petr Heralecky300e3f02014-01-10 11:49:11 +0100740 // --------------------------------------------------------------------
Andrey Andreevc8097262014-01-10 14:45:31 +0200741
Petr Heralecky300e3f02014-01-10 11:49:11 +0100742 /**
Andrey Andreevc8097262014-01-10 14:45:31 +0200743 * Set and return attachment Content-ID
744 *
745 * Useful for attached inline pictures
Petr Heralecky300e3f02014-01-10 11:49:11 +0100746 *
Petr Heraleckyde886152014-01-10 12:52:56 +0100747 * @param string $filename
748 * @return string
Petr Heralecky300e3f02014-01-10 11:49:11 +0100749 */
Andrey Andreevc8097262014-01-10 14:45:31 +0200750 public function attachment_cid($filename)
Petr Heralecky300e3f02014-01-10 11:49:11 +0100751 {
Petr Heraleckyde886152014-01-10 12:52:56 +0100752 for ($i = 0, $c = count($this->_attachments); $i < $c; $i++)
Petr Heralecky300e3f02014-01-10 11:49:11 +0100753 {
Petr Heralecky9ad2fff2014-01-10 13:25:34 +0100754 if ($this->_attachments[$i]['name'][0] === $filename)
Petr Heralecky300e3f02014-01-10 11:49:11 +0100755 {
Andrey Andreev3c422792016-06-06 09:44:50 +0300756 $this->_attachments[$i]['multipart'] = 'related';
Petr Heralecky230fca32014-01-10 12:55:57 +0100757 $this->_attachments[$i]['cid'] = uniqid(basename($this->_attachments[$i]['name'][0]).'@');
Petr Heraleckyde886152014-01-10 12:52:56 +0100758 return $this->_attachments[$i]['cid'];
Petr Heralecky300e3f02014-01-10 11:49:11 +0100759 }
760 }
Andrey Andreevc8097262014-01-10 14:45:31 +0200761
Petr Heralecky300e3f02014-01-10 11:49:11 +0100762 return FALSE;
763 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000764
765 // --------------------------------------------------------------------
766
767 /**
768 * Add a Header Item
769 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000770 * @param string
771 * @param string
Andrey Andreev6cefc6b2015-08-03 10:22:19 +0300772 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000773 */
Mickey Wubfc1cad2012-05-31 22:28:40 -0700774 public function set_header($header, $value)
Derek Allard2067d1a2008-11-13 22:59:24 +0000775 {
florisluitenf55d5142013-06-07 17:20:06 +0300776 $this->_headers[$header] = str_replace(array("\n", "\r"), '', $value);
Andrey Andreev6cefc6b2015-08-03 10:22:19 +0300777 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000778 }
Barry Mienydd671972010-10-04 16:33:58 +0200779
Derek Allard2067d1a2008-11-13 22:59:24 +0000780 // --------------------------------------------------------------------
781
782 /**
783 * Convert a String to an Array
784 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000785 * @param string
786 * @return array
787 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -0600788 protected function _str_to_array($email)
Derek Allard2067d1a2008-11-13 22:59:24 +0000789 {
790 if ( ! is_array($email))
791 {
Andrey Andreev56454792012-05-17 14:32:19 +0300792 return (strpos($email, ',') !== FALSE)
793 ? preg_split('/[\s,]/', $email, -1, PREG_SPLIT_NO_EMPTY)
794 : (array) trim($email);
Derek Allard2067d1a2008-11-13 22:59:24 +0000795 }
Andrey Andreev56454792012-05-17 14:32:19 +0300796
Derek Allard2067d1a2008-11-13 22:59:24 +0000797 return $email;
798 }
Barry Mienydd671972010-10-04 16:33:58 +0200799
Derek Allard2067d1a2008-11-13 22:59:24 +0000800 // --------------------------------------------------------------------
801
802 /**
803 * Set Multipart Value
804 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000805 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500806 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000807 */
Andrey Andreev505b3d62014-02-08 18:24:00 +0200808 public function set_alt_message($str)
Derek Allard2067d1a2008-11-13 22:59:24 +0000809 {
Dan Horrigand0ddeaf2011-08-21 09:07:27 -0400810 $this->alt_message = (string) $str;
Greg Akera769deb2010-11-10 15:47:29 -0600811 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000812 }
Barry Mienydd671972010-10-04 16:33:58 +0200813
Derek Allard2067d1a2008-11-13 22:59:24 +0000814 // --------------------------------------------------------------------
815
816 /**
817 * Set Mailtype
818 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000819 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500820 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000821 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000822 public function set_mailtype($type = 'text')
Derek Allard2067d1a2008-11-13 22:59:24 +0000823 {
Andrey Andreev56454792012-05-17 14:32:19 +0300824 $this->mailtype = ($type === 'html') ? 'html' : 'text';
Greg Akera769deb2010-11-10 15:47:29 -0600825 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000826 }
Barry Mienydd671972010-10-04 16:33:58 +0200827
Derek Allard2067d1a2008-11-13 22:59:24 +0000828 // --------------------------------------------------------------------
nisheeth-barthwalcf225572013-02-18 01:08:04 +0530829
Derek Allard2067d1a2008-11-13 22:59:24 +0000830 /**
831 * Set Wordwrap
832 *
Dan Horrigan628e6602011-08-21 09:08:31 -0400833 * @param bool
Andrew Podner4296a652012-12-17 07:51:15 -0500834 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000835 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000836 public function set_wordwrap($wordwrap = TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000837 {
Dan Horrigan628e6602011-08-21 09:08:31 -0400838 $this->wordwrap = (bool) $wordwrap;
Greg Akera769deb2010-11-10 15:47:29 -0600839 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000840 }
Barry Mienydd671972010-10-04 16:33:58 +0200841
Derek Allard2067d1a2008-11-13 22:59:24 +0000842 // --------------------------------------------------------------------
843
844 /**
845 * Set Protocol
846 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000847 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500848 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000849 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000850 public function set_protocol($protocol = 'mail')
Derek Allard2067d1a2008-11-13 22:59:24 +0000851 {
Andrey Andreev59c5b532012-03-01 14:09:51 +0200852 $this->protocol = in_array($protocol, $this->_protocols, TRUE) ? strtolower($protocol) : 'mail';
Greg Akera769deb2010-11-10 15:47:29 -0600853 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000854 }
Barry Mienydd671972010-10-04 16:33:58 +0200855
Derek Allard2067d1a2008-11-13 22:59:24 +0000856 // --------------------------------------------------------------------
857
858 /**
859 * Set Priority
860 *
Andrey Andreev081c9462012-03-01 12:58:11 +0200861 * @param int
Andrew Podner4296a652012-12-17 07:51:15 -0500862 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000863 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000864 public function set_priority($n = 3)
Derek Allard2067d1a2008-11-13 22:59:24 +0000865 {
Andrey Andreev59c5b532012-03-01 14:09:51 +0200866 $this->priority = preg_match('/^[1-5]$/', $n) ? (int) $n : 3;
Greg Akera769deb2010-11-10 15:47:29 -0600867 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000868 }
Barry Mienydd671972010-10-04 16:33:58 +0200869
Derek Allard2067d1a2008-11-13 22:59:24 +0000870 // --------------------------------------------------------------------
871
872 /**
873 * Set Newline Character
874 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000875 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500876 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000877 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000878 public function set_newline($newline = "\n")
Derek Allard2067d1a2008-11-13 22:59:24 +0000879 {
Andrey Andreevb71e06b2011-12-22 19:22:50 +0200880 $this->newline = in_array($newline, array("\n", "\r\n", "\r")) ? $newline : "\n";
Greg Akera769deb2010-11-10 15:47:29 -0600881 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000882 }
Barry Mienydd671972010-10-04 16:33:58 +0200883
Derek Allard2067d1a2008-11-13 22:59:24 +0000884 // --------------------------------------------------------------------
885
886 /**
887 * Set CRLF
888 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000889 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500890 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000891 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000892 public function set_crlf($crlf = "\n")
Derek Allard2067d1a2008-11-13 22:59:24 +0000893 {
Andrey Andreev76f15c92012-03-01 13:05:07 +0200894 $this->crlf = ($crlf !== "\n" && $crlf !== "\r\n" && $crlf !== "\r") ? "\n" : $crlf;
Greg Akera769deb2010-11-10 15:47:29 -0600895 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000896 }
Barry Mienydd671972010-10-04 16:33:58 +0200897
Derek Allard2067d1a2008-11-13 22:59:24 +0000898 // --------------------------------------------------------------------
899
900 /**
Derek Allard2067d1a2008-11-13 22:59:24 +0000901 * Get the Message ID
902 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000903 * @return string
904 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -0600905 protected function _get_message_id()
Derek Allard2067d1a2008-11-13 22:59:24 +0000906 {
Andrey Andreevb71e06b2011-12-22 19:22:50 +0200907 $from = str_replace(array('>', '<'), '', $this->_headers['Return-Path']);
Andrey Andreev56454792012-05-17 14:32:19 +0300908 return '<'.uniqid('').strstr($from, '@').'>';
Derek Allard2067d1a2008-11-13 22:59:24 +0000909 }
Barry Mienydd671972010-10-04 16:33:58 +0200910
Derek Allard2067d1a2008-11-13 22:59:24 +0000911 // --------------------------------------------------------------------
912
913 /**
914 * Get Mail Protocol
915 *
Andrey Andreev59c5b532012-03-01 14:09:51 +0200916 * @return mixed
Derek Allard2067d1a2008-11-13 22:59:24 +0000917 */
Andrey Andreevb9e45e32017-04-06 14:36:19 +0300918 protected function _get_protocol()
Derek Allard2067d1a2008-11-13 22:59:24 +0000919 {
920 $this->protocol = strtolower($this->protocol);
Andrey Andreev59c5b532012-03-01 14:09:51 +0200921 in_array($this->protocol, $this->_protocols, TRUE) OR $this->protocol = 'mail';
Andrey Andreevb9e45e32017-04-06 14:36:19 +0300922 return $this->protocol;
Derek Allard2067d1a2008-11-13 22:59:24 +0000923 }
Barry Mienydd671972010-10-04 16:33:58 +0200924
Derek Allard2067d1a2008-11-13 22:59:24 +0000925 // --------------------------------------------------------------------
926
927 /**
928 * Get Mail Encoding
929 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000930 * @return string
931 */
Andrey Andreevb9e45e32017-04-06 14:36:19 +0300932 protected function _get_encoding()
Derek Allard2067d1a2008-11-13 22:59:24 +0000933 {
Andrey Andreev59c5b532012-03-01 14:09:51 +0200934 in_array($this->_encoding, $this->_bit_depths) OR $this->_encoding = '8bit';
Derek Allard2067d1a2008-11-13 22:59:24 +0000935
936 foreach ($this->_base_charsets as $charset)
937 {
Andrey Andreevbdcafdf2017-03-28 17:31:09 +0300938 if (strpos($this->charset, $charset) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000939 {
940 $this->_encoding = '7bit';
941 }
942 }
943
Andrey Andreevb9e45e32017-04-06 14:36:19 +0300944 return $this->_encoding;
Derek Allard2067d1a2008-11-13 22:59:24 +0000945 }
946
947 // --------------------------------------------------------------------
948
949 /**
950 * Get content type (text/html/attachment)
951 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000952 * @return string
953 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -0600954 protected function _get_content_type()
Derek Allard2067d1a2008-11-13 22:59:24 +0000955 {
Andrey Andreev56454792012-05-17 14:32:19 +0300956 if ($this->mailtype === 'html')
Derek Allard2067d1a2008-11-13 22:59:24 +0000957 {
Andrey Andreev3c422792016-06-06 09:44:50 +0300958 return empty($this->_attachments) ? 'html' : 'html-attach';
Derek Allard2067d1a2008-11-13 22:59:24 +0000959 }
Andrey Andreev3c422792016-06-06 09:44:50 +0300960 elseif ($this->mailtype === 'text' && ! empty($this->_attachments))
Derek Allard2067d1a2008-11-13 22:59:24 +0000961 {
962 return 'plain-attach';
963 }
964 else
965 {
966 return 'plain';
967 }
968 }
Barry Mienydd671972010-10-04 16:33:58 +0200969
Derek Allard2067d1a2008-11-13 22:59:24 +0000970 // --------------------------------------------------------------------
971
972 /**
973 * Set RFC 822 Date
974 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000975 * @return string
976 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -0600977 protected function _set_date()
Derek Allard2067d1a2008-11-13 22:59:24 +0000978 {
Andrey Andreev59c5b532012-03-01 14:09:51 +0200979 $timezone = date('Z');
Andrey Andreev3dad2e72012-06-14 15:10:56 +0300980 $operator = ($timezone[0] === '-') ? '-' : '+';
Derek Allard2067d1a2008-11-13 22:59:24 +0000981 $timezone = abs($timezone);
Andrey Andreev1bd3d882011-12-22 15:38:20 +0200982 $timezone = floor($timezone/3600) * 100 + ($timezone % 3600) / 60;
Derek Allard2067d1a2008-11-13 22:59:24 +0000983
Andrey Andreev59c5b532012-03-01 14:09:51 +0200984 return sprintf('%s %s%04d', date('D, j M Y H:i:s'), $operator, $timezone);
Derek Allard2067d1a2008-11-13 22:59:24 +0000985 }
Barry Mienydd671972010-10-04 16:33:58 +0200986
Derek Allard2067d1a2008-11-13 22:59:24 +0000987 // --------------------------------------------------------------------
988
989 /**
990 * Mime message
991 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000992 * @return string
993 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -0600994 protected function _get_mime_message()
Derek Allard2067d1a2008-11-13 22:59:24 +0000995 {
Andrey Andreev59c5b532012-03-01 14:09:51 +0200996 return 'This is a multi-part message in MIME format.'.$this->newline.'Your email application may not support this format.';
Derek Allard2067d1a2008-11-13 22:59:24 +0000997 }
Barry Mienydd671972010-10-04 16:33:58 +0200998
Derek Allard2067d1a2008-11-13 22:59:24 +0000999 // --------------------------------------------------------------------
1000
1001 /**
1002 * Validate Email Address
1003 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001004 * @param string
1005 * @return bool
1006 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +00001007 public function validate_email($email)
Derek Allard2067d1a2008-11-13 22:59:24 +00001008 {
1009 if ( ! is_array($email))
1010 {
patworkb0707982011-04-08 15:10:05 +02001011 $this->_set_error_message('lang:email_must_be_array');
Derek Allard2067d1a2008-11-13 22:59:24 +00001012 return FALSE;
1013 }
1014
1015 foreach ($email as $val)
1016 {
1017 if ( ! $this->valid_email($val))
1018 {
patworkb0707982011-04-08 15:10:05 +02001019 $this->_set_error_message('lang:email_invalid_address', $val);
Derek Allard2067d1a2008-11-13 22:59:24 +00001020 return FALSE;
1021 }
1022 }
1023
1024 return TRUE;
1025 }
Barry Mienydd671972010-10-04 16:33:58 +02001026
Derek Allard2067d1a2008-11-13 22:59:24 +00001027 // --------------------------------------------------------------------
1028
1029 /**
1030 * Email Validation
1031 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001032 * @param string
1033 * @return bool
1034 */
Timothy Warrend37f0e92012-06-27 08:21:59 -04001035 public function valid_email($email)
Derek Allard2067d1a2008-11-13 22:59:24 +00001036 {
Andrey Andreev95496662014-06-01 00:00:13 +03001037 if (function_exists('idn_to_ascii') && $atpos = strpos($email, '@'))
1038 {
Andrey Andreev4e2cdec2016-10-28 14:19:08 +03001039 $email = self::substr($email, 0, ++$atpos).idn_to_ascii(self::substr($email, $atpos));
Andrey Andreev95496662014-06-01 00:00:13 +03001040 }
1041
Andrey Andreev580388b2012-06-27 15:43:46 +03001042 return (bool) filter_var($email, FILTER_VALIDATE_EMAIL);
Derek Allard2067d1a2008-11-13 22:59:24 +00001043 }
Barry Mienydd671972010-10-04 16:33:58 +02001044
Derek Allard2067d1a2008-11-13 22:59:24 +00001045 // --------------------------------------------------------------------
1046
1047 /**
1048 * Clean Extended Email Address: Joe Smith <joe@smith.com>
1049 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001050 * @param string
1051 * @return string
1052 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +00001053 public function clean_email($email)
Derek Allard2067d1a2008-11-13 22:59:24 +00001054 {
1055 if ( ! is_array($email))
1056 {
Andrey Andreev56454792012-05-17 14:32:19 +03001057 return preg_match('/\<(.*)\>/', $email, $match) ? $match[1] : $email;
Derek Allard2067d1a2008-11-13 22:59:24 +00001058 }
1059
1060 $clean_email = array();
1061
1062 foreach ($email as $addy)
1063 {
Andrey Andreev59c5b532012-03-01 14:09:51 +02001064 $clean_email[] = preg_match('/\<(.*)\>/', $addy, $match) ? $match[1] : $addy;
Derek Allard2067d1a2008-11-13 22:59:24 +00001065 }
1066
1067 return $clean_email;
1068 }
Barry Mienydd671972010-10-04 16:33:58 +02001069
Derek Allard2067d1a2008-11-13 22:59:24 +00001070 // --------------------------------------------------------------------
1071
1072 /**
1073 * Build alternative plain text message
1074 *
Andrey Andreev8df1ae22012-10-19 11:20:54 +03001075 * Provides the raw message for use in plain-text headers of
1076 * HTML-formatted emails.
Derek Allard2067d1a2008-11-13 22:59:24 +00001077 * If the user hasn't specified his own alternative message
1078 * it creates one by stripping the HTML
1079 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001080 * @return string
1081 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06001082 protected function _get_alt_message()
Derek Allard2067d1a2008-11-13 22:59:24 +00001083 {
Andrey Andreev8df1ae22012-10-19 11:20:54 +03001084 if ( ! empty($this->alt_message))
Derek Allard2067d1a2008-11-13 22:59:24 +00001085 {
Andrey Andreev8df1ae22012-10-19 11:20:54 +03001086 return ($this->wordwrap)
1087 ? $this->word_wrap($this->alt_message, 76)
1088 : $this->alt_message;
Derek Allard2067d1a2008-11-13 22:59:24 +00001089 }
1090
Andrey Andreev56454792012-05-17 14:32:19 +03001091 $body = preg_match('/\<body.*?\>(.*)\<\/body\>/si', $this->_body, $match) ? $match[1] : $this->_body;
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001092 $body = str_replace("\t", '', preg_replace('#<!--(.*)--\>#', '', trim(strip_tags($body))));
Derek Allard2067d1a2008-11-13 22:59:24 +00001093
1094 for ($i = 20; $i >= 3; $i--)
1095 {
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001096 $body = str_replace(str_repeat("\n", $i), "\n\n", $body);
Derek Allard2067d1a2008-11-13 22:59:24 +00001097 }
1098
GDmac9bea4be2012-10-30 06:14:19 +01001099 // Reduce multiple spaces
Andrey Andreev8a203f62012-11-02 20:40:43 +02001100 $body = preg_replace('| +|', ' ', $body);
GDmac9bea4be2012-10-30 06:14:19 +01001101
Andrey Andreev8df1ae22012-10-19 11:20:54 +03001102 return ($this->wordwrap)
1103 ? $this->word_wrap($body, 76)
1104 : $body;
Derek Allard2067d1a2008-11-13 22:59:24 +00001105 }
Barry Mienydd671972010-10-04 16:33:58 +02001106
Derek Allard2067d1a2008-11-13 22:59:24 +00001107 // --------------------------------------------------------------------
1108
1109 /**
1110 * Word Wrap
1111 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001112 * @param string
Andrey Andreev8df1ae22012-10-19 11:20:54 +03001113 * @param int line-length limit
Derek Allard2067d1a2008-11-13 22:59:24 +00001114 * @return string
1115 */
Andrey Andreev00ea2a92012-10-18 14:59:29 +03001116 public function word_wrap($str, $charlim = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001117 {
Andrey Andreev00ea2a92012-10-18 14:59:29 +03001118 // Set the character limit, if not already present
1119 if (empty($charlim))
Derek Allard2067d1a2008-11-13 22:59:24 +00001120 {
Andrey Andreev00ea2a92012-10-18 14:59:29 +03001121 $charlim = empty($this->wrapchars) ? 76 : $this->wrapchars;
Derek Allard2067d1a2008-11-13 22:59:24 +00001122 }
1123
Derek Allard2067d1a2008-11-13 22:59:24 +00001124 // Standardize newlines
1125 if (strpos($str, "\r") !== FALSE)
1126 {
Andrey Andreevb71e06b2011-12-22 19:22:50 +02001127 $str = str_replace(array("\r\n", "\r"), "\n", $str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001128 }
1129
GDmac9bea4be2012-10-30 06:14:19 +01001130 // Reduce multiple spaces at end of line
1131 $str = preg_replace('| +\n|', "\n", $str);
1132
Derek Allard2067d1a2008-11-13 22:59:24 +00001133 // If the current word is surrounded by {unwrap} tags we'll
1134 // strip the entire chunk and replace it with a marker.
1135 $unwrap = array();
vlakoff0f7eba22014-05-20 10:32:44 +02001136 if (preg_match_all('|\{unwrap\}(.+?)\{/unwrap\}|s', $str, $matches))
Derek Allard2067d1a2008-11-13 22:59:24 +00001137 {
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001138 for ($i = 0, $c = count($matches[0]); $i < $c; $i++)
Derek Allard2067d1a2008-11-13 22:59:24 +00001139 {
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001140 $unwrap[] = $matches[1][$i];
vlakoff0f7eba22014-05-20 10:32:44 +02001141 $str = str_replace($matches[0][$i], '{{unwrapped'.$i.'}}', $str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001142 }
1143 }
1144
vlakofff0ab8132014-05-20 10:32:53 +02001145 // Use PHP's native function to do the initial wordwrap.
Derek Allard2067d1a2008-11-13 22:59:24 +00001146 // We set the cut flag to FALSE so that any individual words that are
Andrey Andreev56454792012-05-17 14:32:19 +03001147 // too long get left alone. In the next step we'll deal with them.
Derek Allard2067d1a2008-11-13 22:59:24 +00001148 $str = wordwrap($str, $charlim, "\n", FALSE);
1149
1150 // Split the string into individual lines of text and cycle through them
Andrey Andreev56454792012-05-17 14:32:19 +03001151 $output = '';
Derek Allard2067d1a2008-11-13 22:59:24 +00001152 foreach (explode("\n", $str) as $line)
1153 {
1154 // Is the line within the allowed character count?
1155 // If so we'll join it to the output and continue
Andrey Andreev4e2cdec2016-10-28 14:19:08 +03001156 if (self::strlen($line) <= $charlim)
Derek Allard2067d1a2008-11-13 22:59:24 +00001157 {
1158 $output .= $line.$this->newline;
1159 continue;
1160 }
1161
1162 $temp = '';
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001163 do
Derek Allard2067d1a2008-11-13 22:59:24 +00001164 {
1165 // If the over-length word is a URL we won't wrap it
vlakoff2a8560c2014-05-20 10:32:35 +02001166 if (preg_match('!\[url.+\]|://|www\.!', $line))
Derek Allard2067d1a2008-11-13 22:59:24 +00001167 {
1168 break;
1169 }
1170
1171 // Trim the word down
Andrey Andreev4e2cdec2016-10-28 14:19:08 +03001172 $temp .= self::substr($line, 0, $charlim - 1);
1173 $line = self::substr($line, $charlim - 1);
Derek Allard2067d1a2008-11-13 22:59:24 +00001174 }
Andrey Andreev4e2cdec2016-10-28 14:19:08 +03001175 while (self::strlen($line) > $charlim);
Derek Allard2067d1a2008-11-13 22:59:24 +00001176
1177 // If $temp contains data it means we had to split up an over-length
1178 // word into smaller chunks so we'll add it back to our current line
Alex Bilbied261b1e2012-06-02 11:12:16 +01001179 if ($temp !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001180 {
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001181 $output .= $temp.$this->newline;
Derek Allard2067d1a2008-11-13 22:59:24 +00001182 }
1183
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001184 $output .= $line.$this->newline;
Derek Allard2067d1a2008-11-13 22:59:24 +00001185 }
1186
1187 // Put our markers back
1188 if (count($unwrap) > 0)
1189 {
1190 foreach ($unwrap as $key => $val)
1191 {
Andrey Andreev56454792012-05-17 14:32:19 +03001192 $output = str_replace('{{unwrapped'.$key.'}}', $val, $output);
Derek Allard2067d1a2008-11-13 22:59:24 +00001193 }
1194 }
1195
1196 return $output;
1197 }
Barry Mienydd671972010-10-04 16:33:58 +02001198
Derek Allard2067d1a2008-11-13 22:59:24 +00001199 // --------------------------------------------------------------------
1200
1201 /**
1202 * Build final headers
1203 *
Andrey Andreev19277092016-08-22 11:34:56 +03001204 * @return void
Derek Allard2067d1a2008-11-13 22:59:24 +00001205 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06001206 protected function _build_headers()
Derek Allard2067d1a2008-11-13 22:59:24 +00001207 {
Andrey Andreev6a5b5e72017-01-06 13:45:55 +02001208 $this->set_header('User-Agent', $this->useragent);
Mickey Wubfc1cad2012-05-31 22:28:40 -07001209 $this->set_header('X-Sender', $this->clean_email($this->_headers['From']));
1210 $this->set_header('X-Mailer', $this->useragent);
Andrey Andreevdea61772014-02-24 16:36:25 +02001211 $this->set_header('X-Priority', $this->_priorities[$this->priority]);
Mickey Wubfc1cad2012-05-31 22:28:40 -07001212 $this->set_header('Message-ID', $this->_get_message_id());
1213 $this->set_header('Mime-Version', '1.0');
Derek Allard2067d1a2008-11-13 22:59:24 +00001214 }
Barry Mienydd671972010-10-04 16:33:58 +02001215
Derek Allard2067d1a2008-11-13 22:59:24 +00001216 // --------------------------------------------------------------------
1217
1218 /**
1219 * Write Headers as a string
1220 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001221 * @return void
1222 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06001223 protected function _write_headers()
Derek Allard2067d1a2008-11-13 22:59:24 +00001224 {
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001225 if ($this->protocol === 'mail')
Derek Allard2067d1a2008-11-13 22:59:24 +00001226 {
nisheeth-barthwal6bb98902013-02-19 18:11:14 +05301227 if (isset($this->_headers['Subject']))
1228 {
1229 $this->_subject = $this->_headers['Subject'];
1230 unset($this->_headers['Subject']);
1231 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001232 }
1233
1234 reset($this->_headers);
Andrey Andreev56454792012-05-17 14:32:19 +03001235 $this->_header_str = '';
Derek Allard2067d1a2008-11-13 22:59:24 +00001236
Pascal Kriete14287f32011-02-14 13:39:34 -05001237 foreach ($this->_headers as $key => $val)
Derek Allard2067d1a2008-11-13 22:59:24 +00001238 {
1239 $val = trim($val);
1240
Alex Bilbied261b1e2012-06-02 11:12:16 +01001241 if ($val !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001242 {
Andrey Andreev56454792012-05-17 14:32:19 +03001243 $this->_header_str .= $key.': '.$val.$this->newline;
Derek Allard2067d1a2008-11-13 22:59:24 +00001244 }
1245 }
1246
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001247 if ($this->_get_protocol() === 'mail')
Derek Allard2067d1a2008-11-13 22:59:24 +00001248 {
Derek Jones1d890882009-02-10 20:32:14 +00001249 $this->_header_str = rtrim($this->_header_str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001250 }
1251 }
Barry Mienydd671972010-10-04 16:33:58 +02001252
Derek Allard2067d1a2008-11-13 22:59:24 +00001253 // --------------------------------------------------------------------
1254
1255 /**
1256 * Build Final Body and attachments
1257 *
buhayc6da1ef2013-04-18 09:06:49 -07001258 * @return bool
Derek Allard2067d1a2008-11-13 22:59:24 +00001259 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06001260 protected function _build_message()
Derek Allard2067d1a2008-11-13 22:59:24 +00001261 {
Andrey Andreev76f15c92012-03-01 13:05:07 +02001262 if ($this->wordwrap === TRUE && $this->mailtype !== 'html')
Derek Allard2067d1a2008-11-13 22:59:24 +00001263 {
1264 $this->_body = $this->word_wrap($this->_body);
1265 }
1266
Derek Allard2067d1a2008-11-13 22:59:24 +00001267 $this->_write_headers();
1268
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001269 $hdr = ($this->_get_protocol() === 'mail') ? $this->newline : '';
Brandon Jones485d7412010-11-09 16:38:17 -05001270 $body = '';
Derek Allard2067d1a2008-11-13 22:59:24 +00001271
1272 switch ($this->_get_content_type())
1273 {
Andrey Andreev3c422792016-06-06 09:44:50 +03001274 case 'plain':
Derek Allard2067d1a2008-11-13 22:59:24 +00001275
Andrey Andreev56454792012-05-17 14:32:19 +03001276 $hdr .= 'Content-Type: text/plain; charset='.$this->charset.$this->newline
1277 .'Content-Transfer-Encoding: '.$this->_get_encoding();
Derek Allard2067d1a2008-11-13 22:59:24 +00001278
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001279 if ($this->_get_protocol() === 'mail')
Derek Allard2067d1a2008-11-13 22:59:24 +00001280 {
1281 $this->_header_str .= $hdr;
1282 $this->_finalbody = $this->_body;
Derek Allard2067d1a2008-11-13 22:59:24 +00001283 }
Brandon Jones485d7412010-11-09 16:38:17 -05001284 else
1285 {
Andrey Andreev2b956af2013-08-07 14:32:56 +03001286 $this->_finalbody = $hdr.$this->newline.$this->newline.$this->_body;
Brandon Jones485d7412010-11-09 16:38:17 -05001287 }
Eric Barnes6113f542010-12-29 13:36:12 -05001288
Derek Allard2067d1a2008-11-13 22:59:24 +00001289 return;
1290
Andrey Andreev3c422792016-06-06 09:44:50 +03001291 case 'html':
Derek Allard2067d1a2008-11-13 22:59:24 +00001292
1293 if ($this->send_multipart === FALSE)
1294 {
Andrey Andreev56454792012-05-17 14:32:19 +03001295 $hdr .= 'Content-Type: text/html; charset='.$this->charset.$this->newline
Andrey Andreev2b956af2013-08-07 14:32:56 +03001296 .'Content-Transfer-Encoding: quoted-printable';
Derek Allard2067d1a2008-11-13 22:59:24 +00001297 }
1298 else
1299 {
Andrey Andreev3c422792016-06-06 09:44:50 +03001300 $boundary = uniqid('B_ALT_');
1301 $hdr .= 'Content-Type: multipart/alternative; boundary="'.$boundary.'"';
Derek Allard2067d1a2008-11-13 22:59:24 +00001302
Andrey Andreev56454792012-05-17 14:32:19 +03001303 $body .= $this->_get_mime_message().$this->newline.$this->newline
Andrey Andreev3c422792016-06-06 09:44:50 +03001304 .'--'.$boundary.$this->newline
Derek Allard2067d1a2008-11-13 22:59:24 +00001305
Andrey Andreev56454792012-05-17 14:32:19 +03001306 .'Content-Type: text/plain; charset='.$this->charset.$this->newline
1307 .'Content-Transfer-Encoding: '.$this->_get_encoding().$this->newline.$this->newline
Andrey Andreev3c422792016-06-06 09:44:50 +03001308 .$this->_get_alt_message().$this->newline.$this->newline
1309 .'--'.$boundary.$this->newline
Brandon Jones485d7412010-11-09 16:38:17 -05001310
Andrey Andreev56454792012-05-17 14:32:19 +03001311 .'Content-Type: text/html; charset='.$this->charset.$this->newline
1312 .'Content-Transfer-Encoding: quoted-printable'.$this->newline.$this->newline;
Derek Allard2067d1a2008-11-13 22:59:24 +00001313 }
Eric Barnes6113f542010-12-29 13:36:12 -05001314
Andrey Andreev56454792012-05-17 14:32:19 +03001315 $this->_finalbody = $body.$this->_prep_quoted_printable($this->_body).$this->newline.$this->newline;
Eric Barnes6113f542010-12-29 13:36:12 -05001316
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001317 if ($this->_get_protocol() === 'mail')
Derek Allard2067d1a2008-11-13 22:59:24 +00001318 {
1319 $this->_header_str .= $hdr;
Brandon Jones485d7412010-11-09 16:38:17 -05001320 }
1321 else
1322 {
Andrey Andreev2b956af2013-08-07 14:32:56 +03001323 $this->_finalbody = $hdr.$this->newline.$this->newline.$this->_finalbody;
Derek Allard2067d1a2008-11-13 22:59:24 +00001324 }
1325
Derek Allard2067d1a2008-11-13 22:59:24 +00001326 if ($this->send_multipart !== FALSE)
1327 {
Andrey Andreev3c422792016-06-06 09:44:50 +03001328 $this->_finalbody .= '--'.$boundary.'--';
Derek Allard2067d1a2008-11-13 22:59:24 +00001329 }
1330
Derek Allard2067d1a2008-11-13 22:59:24 +00001331 return;
1332
Andrey Andreev3c422792016-06-06 09:44:50 +03001333 case 'plain-attach':
Derek Allard2067d1a2008-11-13 22:59:24 +00001334
Andrey Andreev3c422792016-06-06 09:44:50 +03001335 $boundary = uniqid('B_ATC_');
1336 $hdr .= 'Content-Type: multipart/mixed; boundary="'.$boundary.'"';
Derek Allard2067d1a2008-11-13 22:59:24 +00001337
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001338 if ($this->_get_protocol() === 'mail')
Derek Allard2067d1a2008-11-13 22:59:24 +00001339 {
1340 $this->_header_str .= $hdr;
Eric Barnes6113f542010-12-29 13:36:12 -05001341 }
1342
Andrey Andreev2b956af2013-08-07 14:32:56 +03001343 $body .= $this->_get_mime_message().$this->newline
1344 .$this->newline
Andrey Andreev3c422792016-06-06 09:44:50 +03001345 .'--'.$boundary.$this->newline
Andrey Andreev56454792012-05-17 14:32:19 +03001346 .'Content-Type: text/plain; charset='.$this->charset.$this->newline
Andrey Andreev2b956af2013-08-07 14:32:56 +03001347 .'Content-Transfer-Encoding: '.$this->_get_encoding().$this->newline
1348 .$this->newline
Andrey Andreev56454792012-05-17 14:32:19 +03001349 .$this->_body.$this->newline.$this->newline;
Derek Allard2067d1a2008-11-13 22:59:24 +00001350
Andrey Andreev3c422792016-06-06 09:44:50 +03001351 $this->_append_attachments($body, $boundary);
Derek Allard2067d1a2008-11-13 22:59:24 +00001352
Andrey Andreev3c422792016-06-06 09:44:50 +03001353 break;
1354 case 'html-attach':
1355
1356 $alt_boundary = uniqid('B_ALT_');
1357 $last_boundary = NULL;
1358
1359 if ($this->_attachments_have_multipart('mixed'))
1360 {
1361 $atc_boundary = uniqid('B_ATC_');
1362 $hdr .= 'Content-Type: multipart/mixed; boundary="'.$atc_boundary.'"';
1363 $last_boundary = $atc_boundary;
1364 }
1365
1366 if ($this->_attachments_have_multipart('related'))
1367 {
1368 $rel_boundary = uniqid('B_REL_');
1369 $rel_boundary_header = 'Content-Type: multipart/related; boundary="'.$rel_boundary.'"';
1370
1371 if (isset($last_boundary))
1372 {
1373 $body .= '--'.$last_boundary.$this->newline.$rel_boundary_header;
1374 }
1375 else
1376 {
1377 $hdr .= $rel_boundary_header;
1378 }
1379
1380 $last_boundary = $rel_boundary;
1381 }
Eric Barnes6113f542010-12-29 13:36:12 -05001382
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001383 if ($this->_get_protocol() === 'mail')
Derek Allard2067d1a2008-11-13 22:59:24 +00001384 {
1385 $this->_header_str .= $hdr;
Derek Allard2067d1a2008-11-13 22:59:24 +00001386 }
1387
Andrey Andreev4e2cdec2016-10-28 14:19:08 +03001388 self::strlen($body) && $body .= $this->newline.$this->newline;
Andrey Andreev56454792012-05-17 14:32:19 +03001389 $body .= $this->_get_mime_message().$this->newline.$this->newline
Andrey Andreev3c422792016-06-06 09:44:50 +03001390 .'--'.$last_boundary.$this->newline
Brandon Jones485d7412010-11-09 16:38:17 -05001391
Andrey Andreev3c422792016-06-06 09:44:50 +03001392 .'Content-Type: multipart/alternative; boundary="'.$alt_boundary.'"'.$this->newline.$this->newline
1393 .'--'.$alt_boundary.$this->newline
Brandon Jones485d7412010-11-09 16:38:17 -05001394
Andrey Andreev56454792012-05-17 14:32:19 +03001395 .'Content-Type: text/plain; charset='.$this->charset.$this->newline
1396 .'Content-Transfer-Encoding: '.$this->_get_encoding().$this->newline.$this->newline
Andrey Andreev3c422792016-06-06 09:44:50 +03001397 .$this->_get_alt_message().$this->newline.$this->newline
1398 .'--'.$alt_boundary.$this->newline
Brandon Jones485d7412010-11-09 16:38:17 -05001399
Andrey Andreev56454792012-05-17 14:32:19 +03001400 .'Content-Type: text/html; charset='.$this->charset.$this->newline
1401 .'Content-Transfer-Encoding: quoted-printable'.$this->newline.$this->newline
Brandon Jones485d7412010-11-09 16:38:17 -05001402
Andrey Andreev56454792012-05-17 14:32:19 +03001403 .$this->_prep_quoted_printable($this->_body).$this->newline.$this->newline
Andrey Andreev3c422792016-06-06 09:44:50 +03001404 .'--'.$alt_boundary.'--'.$this->newline.$this->newline;
Derek Allard2067d1a2008-11-13 22:59:24 +00001405
Andrey Andreev3c422792016-06-06 09:44:50 +03001406 if ( ! empty($rel_boundary))
1407 {
1408 $body .= $this->newline.$this->newline;
1409 $this->_append_attachments($body, $rel_boundary, 'related');
1410 }
1411
1412 // multipart/mixed attachments
1413 if ( ! empty($atc_boundary))
1414 {
1415 $body .= $this->newline.$this->newline;
1416 $this->_append_attachments($body, $atc_boundary, 'mixed');
1417 }
1418
1419 break;
Derek Allard2067d1a2008-11-13 22:59:24 +00001420 }
1421
Andrey Andreev2b956af2013-08-07 14:32:56 +03001422 $this->_finalbody = ($this->_get_protocol() === 'mail')
1423 ? $body
1424 : $hdr.$this->newline.$this->newline.$body;
Andrey Andreevc8097262014-01-10 14:45:31 +02001425
buhay466e8082013-04-17 14:25:34 -07001426 return TRUE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001427 }
Barry Mienydd671972010-10-04 16:33:58 +02001428
Derek Allard2067d1a2008-11-13 22:59:24 +00001429 // --------------------------------------------------------------------
1430
Andrey Andreev3c422792016-06-06 09:44:50 +03001431 protected function _attachments_have_multipart($type)
1432 {
1433 foreach ($this->_attachments as &$attachment)
1434 {
1435 if ($attachment['multipart'] === $type)
1436 {
1437 return TRUE;
1438 }
1439 }
1440
1441 return FALSE;
1442 }
1443
1444 // --------------------------------------------------------------------
1445
1446 /**
1447 * Prepares attachment string
1448 *
1449 * @param string $body Message body to append to
1450 * @param string $boundary Multipart boundary
1451 * @param string $multipart When provided, only attachments of this type will be processed
1452 * @return string
1453 */
1454 protected function _append_attachments(&$body, $boundary, $multipart = null)
1455 {
1456 for ($i = 0, $c = count($this->_attachments); $i < $c; $i++)
1457 {
1458 if (isset($multipart) && $this->_attachments[$i]['multipart'] !== $multipart)
1459 {
1460 continue;
1461 }
1462
1463 $name = isset($this->_attachments[$i]['name'][1])
1464 ? $this->_attachments[$i]['name'][1]
1465 : basename($this->_attachments[$i]['name'][0]);
1466
1467 $body .= '--'.$boundary.$this->newline
1468 .'Content-Type: '.$this->_attachments[$i]['type'].'; name="'.$name.'"'.$this->newline
1469 .'Content-Disposition: '.$this->_attachments[$i]['disposition'].';'.$this->newline
1470 .'Content-Transfer-Encoding: base64'.$this->newline
Andrey Andreev9b0f5fa2016-08-01 13:54:06 +03001471 .(empty($this->_attachments[$i]['cid']) ? '' : 'Content-ID: <'.$this->_attachments[$i]['cid'].'>'.$this->newline)
1472 .$this->newline
Andrey Andreev3c422792016-06-06 09:44:50 +03001473 .$this->_attachments[$i]['content'].$this->newline;
1474 }
1475
1476 // $name won't be set if no attachments were appended,
1477 // and therefore a boundary wouldn't be necessary
1478 empty($name) OR $body .= '--'.$boundary.'--';
1479 }
1480
1481 // --------------------------------------------------------------------
1482
Derek Allard2067d1a2008-11-13 22:59:24 +00001483 /**
1484 * Prep Quoted Printable
1485 *
1486 * Prepares string for Quoted-Printable Content-Transfer-Encoding
1487 * Refer to RFC 2045 http://www.ietf.org/rfc/rfc2045.txt
1488 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001489 * @param string
Derek Allard2067d1a2008-11-13 22:59:24 +00001490 * @return string
1491 */
Andrey Andreev683b34d2012-10-09 15:00:00 +03001492 protected function _prep_quoted_printable($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001493 {
Andrey Andreevb06b5c42015-11-16 13:37:58 +02001494 // ASCII code numbers for "safe" characters that can always be
1495 // used literally, without encoding, as described in RFC 2049.
1496 // http://www.ietf.org/rfc/rfc2049.txt
1497 static $ascii_safe_chars = array(
1498 // ' ( ) + , - . / : = ?
1499 39, 40, 41, 43, 44, 45, 46, 47, 58, 61, 63,
1500 // numbers
1501 48, 49, 50, 51, 52, 53, 54, 55, 56, 57,
1502 // upper-case letters
1503 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,
1504 // lower-case letters
1505 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
1506 );
1507
Andrey Andreev00ea2a92012-10-18 14:59:29 +03001508 // We are intentionally wrapping so mail servers will encode characters
1509 // properly and MUAs will behave, so {unwrap} must go!
1510 $str = str_replace(array('{unwrap}', '{/unwrap}'), '', $str);
1511
Andrey Andreev683b34d2012-10-09 15:00:00 +03001512 // RFC 2045 specifies CRLF as "\r\n".
1513 // However, many developers choose to override that and violate
1514 // the RFC rules due to (apparently) a bug in MS Exchange,
1515 // which only works with "\n".
Andrey Andreev26f0cf92012-10-11 13:52:39 +03001516 if ($this->crlf === "\r\n")
Andrey Andreev683b34d2012-10-09 15:00:00 +03001517 {
Andrey Andreeva8382792016-07-28 16:40:12 +03001518 return quoted_printable_encode($str);
Andrey Andreev683b34d2012-10-09 15:00:00 +03001519 }
1520
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001521 // Reduce multiple spaces & remove nulls
Andrey Andreev56454792012-05-17 14:32:19 +03001522 $str = preg_replace(array('| +|', '/\x00+/'), array(' ', ''), $str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001523
1524 // Standardize newlines
1525 if (strpos($str, "\r") !== FALSE)
1526 {
1527 $str = str_replace(array("\r\n", "\r"), "\n", $str);
1528 }
1529
Derek Allard2067d1a2008-11-13 22:59:24 +00001530 $escape = '=';
1531 $output = '';
1532
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001533 foreach (explode("\n", $str) as $line)
Derek Allard2067d1a2008-11-13 22:59:24 +00001534 {
Andrey Andreev4e2cdec2016-10-28 14:19:08 +03001535 $length = self::strlen($line);
Derek Allard2067d1a2008-11-13 22:59:24 +00001536 $temp = '';
1537
1538 // Loop through each character in the line to add soft-wrap
1539 // characters at the end of a line " =\r\n" and add the newly
1540 // processed line(s) to the output (see comment on $crlf class property)
1541 for ($i = 0; $i < $length; $i++)
1542 {
1543 // Grab the next character
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001544 $char = $line[$i];
Derek Allard2067d1a2008-11-13 22:59:24 +00001545 $ascii = ord($char);
1546
1547 // Convert spaces and tabs but only if it's the end of the line
Andrey Andreevb06b5c42015-11-16 13:37:58 +02001548 if ($ascii === 32 OR $ascii === 9)
Derek Allard2067d1a2008-11-13 22:59:24 +00001549 {
Andrey Andreevb06b5c42015-11-16 13:37:58 +02001550 if ($i === ($length - 1))
1551 {
1552 $char = $escape.sprintf('%02s', dechex($ascii));
1553 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001554 }
Andrey Andreevb06b5c42015-11-16 13:37:58 +02001555 // DO NOT move this below the $ascii_safe_chars line!
1556 //
1557 // = (equals) signs are allowed by RFC2049, but must be encoded
1558 // as they are the encoding delimiter!
1559 elseif ($ascii === 61)
Derek Allard2067d1a2008-11-13 22:59:24 +00001560 {
Derek Jones37f4b9c2011-07-01 17:56:50 -05001561 $char = $escape.strtoupper(sprintf('%02s', dechex($ascii))); // =3D
Derek Allard2067d1a2008-11-13 22:59:24 +00001562 }
Andrey Andreevb06b5c42015-11-16 13:37:58 +02001563 elseif ( ! in_array($ascii, $ascii_safe_chars, TRUE))
1564 {
1565 $char = $escape.strtoupper(sprintf('%02s', dechex($ascii)));
1566 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001567
1568 // If we're at the character limit, add the line to the output,
1569 // reset our temp variable, and keep on chuggin'
Andrey Andreev4e2cdec2016-10-28 14:19:08 +03001570 if ((self::strlen($temp) + self::strlen($char)) >= 76)
Derek Allard2067d1a2008-11-13 22:59:24 +00001571 {
1572 $output .= $temp.$escape.$this->crlf;
1573 $temp = '';
1574 }
1575
1576 // Add the character to our temporary line
1577 $temp .= $char;
1578 }
1579
1580 // Add our completed line to the output
1581 $output .= $temp.$this->crlf;
1582 }
1583
1584 // get rid of extra CRLF tacked onto the end
Andrey Andreev4e2cdec2016-10-28 14:19:08 +03001585 return self::substr($output, 0, self::strlen($this->crlf) * -1);
Derek Allard2067d1a2008-11-13 22:59:24 +00001586 }
1587
1588 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001589
Derek Allard2067d1a2008-11-13 22:59:24 +00001590 /**
1591 * Prep Q Encoding
1592 *
Andrey Andreev925dd902012-10-19 11:06:31 +03001593 * Performs "Q Encoding" on a string for use in email headers.
1594 * It's related but not identical to quoted-printable, so it has its
1595 * own method.
Derek Allard2067d1a2008-11-13 22:59:24 +00001596 *
Andrey Andreev081c9462012-03-01 12:58:11 +02001597 * @param string
Andrey Andreev081c9462012-03-01 12:58:11 +02001598 * @return string
Derek Allard2067d1a2008-11-13 22:59:24 +00001599 */
Andrey Andreev925dd902012-10-19 11:06:31 +03001600 protected function _prep_q_encoding($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001601 {
Andrey Andreev925dd902012-10-19 11:06:31 +03001602 $str = str_replace(array("\r", "\n"), '', $str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001603
Andrey Andreev925dd902012-10-19 11:06:31 +03001604 if ($this->charset === 'UTF-8')
Derek Allard2067d1a2008-11-13 22:59:24 +00001605 {
Andrey Andreev3368ceb2015-10-30 12:25:15 +02001606 // Note: We used to have mb_encode_mimeheader() as the first choice
1607 // here, but it turned out to be buggy and unreliable. DO NOT
1608 // re-add it! -- Narf
1609 if (ICONV_ENABLED === TRUE)
Andrey Andreev925dd902012-10-19 11:06:31 +03001610 {
1611 $output = @iconv_mime_encode('', $str,
1612 array(
1613 'scheme' => 'Q',
1614 'line-length' => 76,
1615 'input-charset' => $this->charset,
1616 'output-charset' => $this->charset,
1617 'line-break-chars' => $this->crlf
1618 )
1619 );
1620
1621 // There are reports that iconv_mime_encode() might fail and return FALSE
1622 if ($output !== FALSE)
1623 {
1624 // iconv_mime_encode() will always put a header field name.
1625 // We've passed it an empty one, but it still prepends our
1626 // encoded string with ': ', so we need to strip it.
Andrey Andreev4e2cdec2016-10-28 14:19:08 +03001627 return self::substr($output, 2);
Andrey Andreev925dd902012-10-19 11:06:31 +03001628 }
1629
1630 $chars = iconv_strlen($str, 'UTF-8');
1631 }
Andrey Andreev3368ceb2015-10-30 12:25:15 +02001632 elseif (MB_ENABLED === TRUE)
1633 {
1634 $chars = mb_strlen($str, 'UTF-8');
1635 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001636 }
1637
Andrey Andreev925dd902012-10-19 11:06:31 +03001638 // We might already have this set for UTF-8
Andrey Andreev4e2cdec2016-10-28 14:19:08 +03001639 isset($chars) OR $chars = self::strlen($str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001640
Andrey Andreev925dd902012-10-19 11:06:31 +03001641 $output = '=?'.$this->charset.'?Q?';
Andrey Andreev4e2cdec2016-10-28 14:19:08 +03001642 for ($i = 0, $length = self::strlen($output); $i < $chars; $i++)
Derek Allard2067d1a2008-11-13 22:59:24 +00001643 {
Andrey Andreevbe1496d2014-02-11 22:48:45 +02001644 $chr = ($this->charset === 'UTF-8' && ICONV_ENABLED === TRUE)
Andrey Andreev925dd902012-10-19 11:06:31 +03001645 ? '='.implode('=', str_split(strtoupper(bin2hex(iconv_substr($str, $i, 1, $this->charset))), 2))
1646 : '='.strtoupper(bin2hex($str[$i]));
Derek Allard2067d1a2008-11-13 22:59:24 +00001647
Andrey Andreev925dd902012-10-19 11:06:31 +03001648 // RFC 2045 sets a limit of 76 characters per line.
1649 // We'll append ?= to the end of each line though.
Andrey Andreev4e2cdec2016-10-28 14:19:08 +03001650 if ($length + ($l = self::strlen($chr)) > 74)
Derek Allard2067d1a2008-11-13 22:59:24 +00001651 {
Andrey Andreev925dd902012-10-19 11:06:31 +03001652 $output .= '?='.$this->crlf // EOL
1653 .' =?'.$this->charset.'?Q?'.$chr; // New line
Andrey Andreev4e2cdec2016-10-28 14:19:08 +03001654 $length = 6 + self::strlen($this->charset) + $l; // Reset the length for the new line
Derek Allard2067d1a2008-11-13 22:59:24 +00001655 }
Andrey Andreev925dd902012-10-19 11:06:31 +03001656 else
Derek Allard2067d1a2008-11-13 22:59:24 +00001657 {
Andrey Andreev925dd902012-10-19 11:06:31 +03001658 $output .= $chr;
1659 $length += $l;
Derek Allard2067d1a2008-11-13 22:59:24 +00001660 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001661 }
1662
Andrey Andreev925dd902012-10-19 11:06:31 +03001663 // End the header
1664 return $output.'?=';
Derek Allard2067d1a2008-11-13 22:59:24 +00001665 }
1666
1667 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001668
Derek Allard2067d1a2008-11-13 22:59:24 +00001669 /**
1670 * Send Email
1671 *
Andrey Andreev5fd3ae82012-10-24 14:55:35 +03001672 * @param bool $auto_clear = TRUE
Derek Allard2067d1a2008-11-13 22:59:24 +00001673 * @return bool
1674 */
Alex Bilbied7bc8d02012-07-30 09:46:20 +01001675 public function send($auto_clear = TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +00001676 {
Michael Granados92e2fd22014-11-11 21:49:26 -02001677 if ( ! isset($this->_headers['From']))
Michael Granados0b85d6b2014-11-09 02:43:48 -02001678 {
Michael Granados92e2fd22014-11-11 21:49:26 -02001679 $this->_set_error_message('lang:email_no_from');
Michael Granados0b85d6b2014-11-09 02:43:48 -02001680 return FALSE;
1681 }
1682
Alex Bilbied261b1e2012-06-02 11:12:16 +01001683 if ($this->_replyto_flag === FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +00001684 {
1685 $this->reply_to($this->_headers['From']);
1686 }
1687
Andrey Andreev76f15c92012-03-01 13:05:07 +02001688 if ( ! isset($this->_recipients) && ! isset($this->_headers['To'])
1689 && ! isset($this->_bcc_array) && ! isset($this->_headers['Bcc'])
1690 && ! isset($this->_headers['Cc']))
Derek Allard2067d1a2008-11-13 22:59:24 +00001691 {
patworkb0707982011-04-08 15:10:05 +02001692 $this->_set_error_message('lang:email_no_recipients');
Derek Allard2067d1a2008-11-13 22:59:24 +00001693 return FALSE;
1694 }
1695
1696 $this->_build_headers();
1697
Andrey Andreev76f15c92012-03-01 13:05:07 +02001698 if ($this->bcc_batch_mode && count($this->_bcc_array) > $this->bcc_batch_size)
Derek Allard2067d1a2008-11-13 22:59:24 +00001699 {
Alex Bilbieb901e732012-07-30 09:44:57 +01001700 $result = $this->batch_bcc_send();
Alex Bilbied7bc8d02012-07-30 09:46:20 +01001701
Alex Bilbiea87aab32012-07-30 09:50:37 +01001702 if ($result && $auto_clear)
Alex Bilbied7bc8d02012-07-30 09:46:20 +01001703 {
1704 $this->clear();
1705 }
1706
Alex Bilbieb901e732012-07-30 09:44:57 +01001707 return $result;
Derek Allard2067d1a2008-11-13 22:59:24 +00001708 }
1709
buhay466e8082013-04-17 14:25:34 -07001710 if ($this->_build_message() === FALSE)
1711 {
1712 return FALSE;
1713 }
buhayc6da1ef2013-04-18 09:06:49 -07001714
Alex Bilbieb901e732012-07-30 09:44:57 +01001715 $result = $this->_spool_email();
Andrey Andreevbdb99992012-07-30 17:38:05 +03001716
Alex Bilbiea87aab32012-07-30 09:50:37 +01001717 if ($result && $auto_clear)
Alex Bilbied7bc8d02012-07-30 09:46:20 +01001718 {
1719 $this->clear();
1720 }
Alex Bilbiea87aab32012-07-30 09:50:37 +01001721
Alex Bilbieb901e732012-07-30 09:44:57 +01001722 return $result;
Derek Allard2067d1a2008-11-13 22:59:24 +00001723 }
Barry Mienydd671972010-10-04 16:33:58 +02001724
Derek Allard2067d1a2008-11-13 22:59:24 +00001725 // --------------------------------------------------------------------
1726
1727 /**
Andrey Andreev081c9462012-03-01 12:58:11 +02001728 * Batch Bcc Send. Sends groups of BCCs in batches
Derek Allard2067d1a2008-11-13 22:59:24 +00001729 *
Andrey Andreev081c9462012-03-01 12:58:11 +02001730 * @return void
Derek Allard2067d1a2008-11-13 22:59:24 +00001731 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +00001732 public function batch_bcc_send()
Derek Allard2067d1a2008-11-13 22:59:24 +00001733 {
Andrey Andreev59c5b532012-03-01 14:09:51 +02001734 $float = $this->bcc_batch_size - 1;
1735 $set = '';
Derek Allard2067d1a2008-11-13 22:59:24 +00001736 $chunk = array();
1737
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001738 for ($i = 0, $c = count($this->_bcc_array); $i < $c; $i++)
Derek Allard2067d1a2008-11-13 22:59:24 +00001739 {
1740 if (isset($this->_bcc_array[$i]))
1741 {
Andrey Andreev59c5b532012-03-01 14:09:51 +02001742 $set .= ', '.$this->_bcc_array[$i];
Derek Allard2067d1a2008-11-13 22:59:24 +00001743 }
1744
Alex Bilbied261b1e2012-06-02 11:12:16 +01001745 if ($i === $float)
Derek Allard2067d1a2008-11-13 22:59:24 +00001746 {
Andrey Andreev4e2cdec2016-10-28 14:19:08 +03001747 $chunk[] = self::substr($set, 1);
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001748 $float += $this->bcc_batch_size;
Andrey Andreev59c5b532012-03-01 14:09:51 +02001749 $set = '';
Derek Allard2067d1a2008-11-13 22:59:24 +00001750 }
1751
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001752 if ($i === $c-1)
Derek Allard2067d1a2008-11-13 22:59:24 +00001753 {
Andrey Andreev4e2cdec2016-10-28 14:19:08 +03001754 $chunk[] = self::substr($set, 1);
Derek Allard2067d1a2008-11-13 22:59:24 +00001755 }
1756 }
1757
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001758 for ($i = 0, $c = count($chunk); $i < $c; $i++)
Derek Allard2067d1a2008-11-13 22:59:24 +00001759 {
1760 unset($this->_headers['Bcc']);
Derek Allard2067d1a2008-11-13 22:59:24 +00001761
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001762 $bcc = $this->clean_email($this->_str_to_array($chunk[$i]));
Derek Allard2067d1a2008-11-13 22:59:24 +00001763
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001764 if ($this->protocol !== 'smtp')
Derek Allard2067d1a2008-11-13 22:59:24 +00001765 {
Mickey Wubfc1cad2012-05-31 22:28:40 -07001766 $this->set_header('Bcc', implode(', ', $bcc));
Derek Allard2067d1a2008-11-13 22:59:24 +00001767 }
1768 else
1769 {
1770 $this->_bcc_array = $bcc;
1771 }
1772
buhay466e8082013-04-17 14:25:34 -07001773 if ($this->_build_message() === FALSE)
1774 {
1775 return FALSE;
1776 }
buhayc6da1ef2013-04-18 09:06:49 -07001777
Derek Allard2067d1a2008-11-13 22:59:24 +00001778 $this->_spool_email();
1779 }
1780 }
Barry Mienydd671972010-10-04 16:33:58 +02001781
Derek Allard2067d1a2008-11-13 22:59:24 +00001782 // --------------------------------------------------------------------
1783
1784 /**
1785 * Unwrap special elements
1786 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001787 * @return void
1788 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06001789 protected function _unwrap_specials()
Derek Allard2067d1a2008-11-13 22:59:24 +00001790 {
Andrey Andreev56454792012-05-17 14:32:19 +03001791 $this->_finalbody = preg_replace_callback('/\{unwrap\}(.*?)\{\/unwrap\}/si', array($this, '_remove_nl_callback'), $this->_finalbody);
Derek Allard2067d1a2008-11-13 22:59:24 +00001792 }
Barry Mienydd671972010-10-04 16:33:58 +02001793
Derek Allard2067d1a2008-11-13 22:59:24 +00001794 // --------------------------------------------------------------------
1795
1796 /**
1797 * Strip line-breaks via callback
1798 *
Andrey Andreev5fd3ae82012-10-24 14:55:35 +03001799 * @param string $matches
Derek Allard2067d1a2008-11-13 22:59:24 +00001800 * @return string
1801 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06001802 protected function _remove_nl_callback($matches)
Derek Allard2067d1a2008-11-13 22:59:24 +00001803 {
1804 if (strpos($matches[1], "\r") !== FALSE OR strpos($matches[1], "\n") !== FALSE)
1805 {
1806 $matches[1] = str_replace(array("\r\n", "\r", "\n"), '', $matches[1]);
1807 }
1808
1809 return $matches[1];
1810 }
Barry Mienydd671972010-10-04 16:33:58 +02001811
Derek Allard2067d1a2008-11-13 22:59:24 +00001812 // --------------------------------------------------------------------
1813
1814 /**
1815 * Spool mail to the mail server
1816 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001817 * @return bool
1818 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06001819 protected function _spool_email()
Derek Allard2067d1a2008-11-13 22:59:24 +00001820 {
1821 $this->_unwrap_specials();
1822
Andrey Andreevb9e45e32017-04-06 14:36:19 +03001823 $protocol = $this->_get_protocol();
1824 $method = '_send_with_'.$protocol;
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001825 if ( ! $this->$method())
Derek Allard2067d1a2008-11-13 22:59:24 +00001826 {
Andrey Andreevb9e45e32017-04-06 14:36:19 +03001827 $this->_set_error_message('lang:email_send_failure_'.($protocol === 'mail' ? 'phpmail' : $protocol));
Diogo Osório7fcc7bd2012-03-02 16:54:52 +00001828 return FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001829 }
1830
Andrey Andreevb9e45e32017-04-06 14:36:19 +03001831 $this->_set_error_message('lang:email_sent', $protocol);
Derek Allard2067d1a2008-11-13 22:59:24 +00001832 return TRUE;
1833 }
Barry Mienydd671972010-10-04 16:33:58 +02001834
Derek Allard2067d1a2008-11-13 22:59:24 +00001835 // --------------------------------------------------------------------
1836
1837 /**
Andrey Andreeva9600162017-01-05 17:35:28 +02001838 * Validate email for shell
1839 *
1840 * Applies stricter, shell-safe validation to email addresses.
1841 * Introduced to prevent RCE via sendmail's -f option.
1842 *
1843 * @see https://github.com/bcit-ci/CodeIgniter/issues/4963
1844 * @see https://gist.github.com/Zenexer/40d02da5e07f151adeaeeaa11af9ab36
1845 * @license https://creativecommons.org/publicdomain/zero/1.0/ CC0 1.0, Public Domain
1846 *
1847 * Credits for the base concept go to Paul Buonopane <paul@namepros.com>
1848 *
1849 * @param string $email
1850 * @return bool
1851 */
1852 protected function _validate_email_for_shell(&$email)
1853 {
1854 if (function_exists('idn_to_ascii') && $atpos = strpos($email, '@'))
1855 {
1856 $email = self::substr($email, 0, ++$atpos).idn_to_ascii(self::substr($email, $atpos));
1857 }
1858
1859 return (filter_var($email, FILTER_VALIDATE_EMAIL) === $email && preg_match('#\A[a-z0-9._+-]+@[a-z0-9.-]{1,253}\z#i', $email));
1860 }
1861
1862 // --------------------------------------------------------------------
1863
1864 /**
Derek Allard2067d1a2008-11-13 22:59:24 +00001865 * Send using mail()
1866 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001867 * @return bool
1868 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06001869 protected function _send_with_mail()
Derek Allard2067d1a2008-11-13 22:59:24 +00001870 {
Andrey Andreev8a7078b2012-10-17 10:52:49 +03001871 if (is_array($this->_recipients))
1872 {
1873 $this->_recipients = implode(', ', $this->_recipients);
1874 }
1875
Andrey Andreeva9600162017-01-05 17:35:28 +02001876 // _validate_email_for_shell() below accepts by reference,
1877 // so this needs to be assigned to a variable
1878 $from = $this->clean_email($this->_headers['Return-Path']);
1879
1880 if ($this->_safe_mode === TRUE || ! $this->_validate_email_for_shell($from))
Derek Allard2067d1a2008-11-13 22:59:24 +00001881 {
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001882 return mail($this->_recipients, $this->_subject, $this->_finalbody, $this->_header_str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001883 }
1884 else
1885 {
1886 // most documentation of sendmail using the "-f" flag lacks a space after it, however
1887 // we've encountered servers that seem to require it to be in place.
Andrey Andreeva9600162017-01-05 17:35:28 +02001888 return mail($this->_recipients, $this->_subject, $this->_finalbody, $this->_header_str, '-f '.$from);
Derek Allard2067d1a2008-11-13 22:59:24 +00001889 }
1890 }
Barry Mienydd671972010-10-04 16:33:58 +02001891
Derek Allard2067d1a2008-11-13 22:59:24 +00001892 // --------------------------------------------------------------------
1893
1894 /**
1895 * Send using Sendmail
1896 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001897 * @return bool
1898 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06001899 protected function _send_with_sendmail()
Derek Allard2067d1a2008-11-13 22:59:24 +00001900 {
Andrey Andreeva9600162017-01-05 17:35:28 +02001901 // _validate_email_for_shell() below accepts by reference,
1902 // so this needs to be assigned to a variable
1903 $from = $this->clean_email($this->_headers['From']);
1904 if ($this->_validate_email_for_shell($from))
Derek Jones4cefaa42009-04-29 19:13:56 +00001905 {
Andrey Andreeva9600162017-01-05 17:35:28 +02001906 $from = '-f '.$from;
1907 }
1908 else
1909 {
1910 $from = '';
1911 }
1912
1913 // is popen() enabled?
1914 if ( ! function_usable('popen') OR FALSE === ($fp = @popen($this->mailpath.' -oi '.$from.' -t', 'w')))
1915 {
1916 // server probably has popen disabled, so nothing we can do to get a verbose error.
Derek Jones4cefaa42009-04-29 19:13:56 +00001917 return FALSE;
1918 }
Derek Jones71141ce2010-03-02 16:41:20 -06001919
Derek Jonesc630bcf2008-11-17 21:09:45 +00001920 fputs($fp, $this->_header_str);
1921 fputs($fp, $this->_finalbody);
1922
Barry Mienydd671972010-10-04 16:33:58 +02001923 $status = pclose($fp);
Eric Barnes6113f542010-12-29 13:36:12 -05001924
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001925 if ($status !== 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00001926 {
patworkb0707982011-04-08 15:10:05 +02001927 $this->_set_error_message('lang:email_exit_status', $status);
1928 $this->_set_error_message('lang:email_no_socket');
Derek Allard2067d1a2008-11-13 22:59:24 +00001929 return FALSE;
1930 }
1931
Derek Allard2067d1a2008-11-13 22:59:24 +00001932 return TRUE;
1933 }
Barry Mienydd671972010-10-04 16:33:58 +02001934
Derek Allard2067d1a2008-11-13 22:59:24 +00001935 // --------------------------------------------------------------------
1936
1937 /**
1938 * Send using SMTP
1939 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001940 * @return bool
1941 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06001942 protected function _send_with_smtp()
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301943 {
1944 if ($this->smtp_host === '')
1945 {
1946 $this->_set_error_message('lang:email_no_hostname');
1947 return FALSE;
1948 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001949
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301950 if ( ! $this->_smtp_connect() OR ! $this->_smtp_authenticate())
1951 {
1952 return FALSE;
1953 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001954
Andrey Andreev8e138ec2015-08-31 15:23:42 +03001955 if ( ! $this->_send_command('from', $this->clean_email($this->_headers['From'])))
1956 {
Andrey Andreev0c821bb2016-07-19 16:04:02 +03001957 $this->_smtp_end();
Andrey Andreev8e138ec2015-08-31 15:23:42 +03001958 return FALSE;
1959 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001960
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301961 foreach ($this->_recipients as $val)
1962 {
Andrey Andreev8e138ec2015-08-31 15:23:42 +03001963 if ( ! $this->_send_command('to', $val))
1964 {
Andrey Andreev0c821bb2016-07-19 16:04:02 +03001965 $this->_smtp_end();
Andrey Andreev8e138ec2015-08-31 15:23:42 +03001966 return FALSE;
1967 }
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301968 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001969
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301970 if (count($this->_cc_array) > 0)
1971 {
1972 foreach ($this->_cc_array as $val)
1973 {
Andrey Andreev8e138ec2015-08-31 15:23:42 +03001974 if ($val !== '' && ! $this->_send_command('to', $val))
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301975 {
Andrey Andreev0c821bb2016-07-19 16:04:02 +03001976 $this->_smtp_end();
Andrey Andreev8e138ec2015-08-31 15:23:42 +03001977 return FALSE;
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301978 }
1979 }
1980 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001981
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301982 if (count($this->_bcc_array) > 0)
1983 {
1984 foreach ($this->_bcc_array as $val)
1985 {
Andrey Andreev8e138ec2015-08-31 15:23:42 +03001986 if ($val !== '' && ! $this->_send_command('to', $val))
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301987 {
Andrey Andreev0c821bb2016-07-19 16:04:02 +03001988 $this->_smtp_end();
Andrey Andreev8e138ec2015-08-31 15:23:42 +03001989 return FALSE;
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301990 }
1991 }
1992 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001993
Andrey Andreev8e138ec2015-08-31 15:23:42 +03001994 if ( ! $this->_send_command('data'))
1995 {
Andrey Andreev0c821bb2016-07-19 16:04:02 +03001996 $this->_smtp_end();
Andrey Andreev8e138ec2015-08-31 15:23:42 +03001997 return FALSE;
1998 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001999
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302000 // perform dot transformation on any lines that begin with a dot
2001 $this->_send_data($this->_header_str.preg_replace('/^\./m', '..$1', $this->_finalbody));
Derek Allard2067d1a2008-11-13 22:59:24 +00002002
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302003 $this->_send_data('.');
Derek Allard2067d1a2008-11-13 22:59:24 +00002004
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302005 $reply = $this->_get_smtp_data();
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302006 $this->_set_error_message($reply);
Derek Allard2067d1a2008-11-13 22:59:24 +00002007
Andrey Andreev0c821bb2016-07-19 16:04:02 +03002008 $this->_smtp_end();
2009
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302010 if (strpos($reply, '250') !== 0)
2011 {
2012 $this->_set_error_message('lang:email_smtp_error', $reply);
2013 return FALSE;
2014 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002015
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302016 return TRUE;
2017 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002018
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302019 // --------------------------------------------------------------------
Radu Potop4c589ae2011-09-29 10:19:55 +03002020
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302021 /**
Andrey Andreev0c821bb2016-07-19 16:04:02 +03002022 * SMTP End
2023 *
2024 * Shortcut to send RSET or QUIT depending on keep-alive
2025 *
2026 * @return void
2027 */
2028 protected function _smtp_end()
2029 {
2030 ($this->smtp_keepalive)
2031 ? $this->_send_command('reset')
2032 : $this->_send_command('quit');
2033 }
2034
2035 // --------------------------------------------------------------------
2036
2037 /**
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302038 * SMTP Connect
2039 *
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302040 * @return string
2041 */
nisheeth-barthwala44e6912013-02-18 18:07:03 +05302042 protected function _smtp_connect()
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302043 {
nisheeth-barthwala44e6912013-02-18 18:07:03 +05302044 if (is_resource($this->_smtp_connect))
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302045 {
nisheeth-barthwala44e6912013-02-18 18:07:03 +05302046 return TRUE;
2047 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002048
Andrey Andreev89b67b42013-03-12 19:34:23 +02002049 $ssl = ($this->smtp_crypto === 'ssl') ? 'ssl://' : '';
Derek Allard2067d1a2008-11-13 22:59:24 +00002050
nisheeth-barthwala44e6912013-02-18 18:07:03 +05302051 $this->_smtp_connect = fsockopen($ssl.$this->smtp_host,
2052 $this->smtp_port,
2053 $errno,
2054 $errstr,
2055 $this->smtp_timeout);
2056
2057 if ( ! is_resource($this->_smtp_connect))
2058 {
2059 $this->_set_error_message('lang:email_smtp_error', $errno.' '.$errstr);
2060 return FALSE;
2061 }
2062
2063 stream_set_timeout($this->_smtp_connect, $this->smtp_timeout);
2064 $this->_set_error_message($this->_get_smtp_data());
2065
2066 if ($this->smtp_crypto === 'tls')
2067 {
2068 $this->_send_command('hello');
2069 $this->_send_command('starttls');
2070
2071 $crypto = stream_socket_enable_crypto($this->_smtp_connect, TRUE, STREAM_CRYPTO_METHOD_TLS_CLIENT);
2072
2073 if ($crypto !== TRUE)
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302074 {
nisheeth-barthwala44e6912013-02-18 18:07:03 +05302075 $this->_set_error_message('lang:email_smtp_error', $this->_get_smtp_data());
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302076 return FALSE;
2077 }
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302078 }
nisheeth-barthwala44e6912013-02-18 18:07:03 +05302079
2080 return $this->_send_command('hello');
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302081 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002082
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302083 // --------------------------------------------------------------------
Derek Allard2067d1a2008-11-13 22:59:24 +00002084
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302085 /**
2086 * Send SMTP command
2087 *
2088 * @param string
2089 * @param string
Andrey Andreev19277092016-08-22 11:34:56 +03002090 * @return bool
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302091 */
2092 protected function _send_command($cmd, $data = '')
2093 {
2094 switch ($cmd)
2095 {
2096 case 'hello' :
Derek Allard2067d1a2008-11-13 22:59:24 +00002097
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302098 if ($this->_smtp_auth OR $this->_get_encoding() === '8bit')
2099 {
2100 $this->_send_data('EHLO '.$this->_get_hostname());
2101 }
2102 else
2103 {
2104 $this->_send_data('HELO '.$this->_get_hostname());
2105 }
Radu Potopbbf04b02011-09-28 13:57:51 +03002106
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302107 $resp = 250;
2108 break;
2109 case 'starttls' :
Derek Allard2067d1a2008-11-13 22:59:24 +00002110
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302111 $this->_send_data('STARTTLS');
2112 $resp = 220;
2113 break;
2114 case 'from' :
Andrey Andreev56454792012-05-17 14:32:19 +03002115
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302116 $this->_send_data('MAIL FROM:<'.$data.'>');
2117 $resp = 250;
2118 break;
2119 case 'to' :
Andrey Andreev56454792012-05-17 14:32:19 +03002120
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302121 if ($this->dsn)
2122 {
2123 $this->_send_data('RCPT TO:<'.$data.'> NOTIFY=SUCCESS,DELAY,FAILURE ORCPT=rfc822;'.$data);
2124 }
2125 else
2126 {
2127 $this->_send_data('RCPT TO:<'.$data.'>');
2128 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002129
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302130 $resp = 250;
2131 break;
2132 case 'data' :
Derek Allard2067d1a2008-11-13 22:59:24 +00002133
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302134 $this->_send_data('DATA');
2135 $resp = 354;
2136 break;
2137 case 'reset':
Derek Allard2067d1a2008-11-13 22:59:24 +00002138
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302139 $this->_send_data('RSET');
2140 $resp = 250;
2141 break;
2142 case 'quit' :
Derek Allard2067d1a2008-11-13 22:59:24 +00002143
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302144 $this->_send_data('QUIT');
2145 $resp = 221;
2146 break;
2147 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002148
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302149 $reply = $this->_get_smtp_data();
Derek Allard2067d1a2008-11-13 22:59:24 +00002150
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302151 $this->_debug_msg[] = '<pre>'.$cmd.': '.$reply.'</pre>';
Derek Allard2067d1a2008-11-13 22:59:24 +00002152
Andrey Andreev4e2cdec2016-10-28 14:19:08 +03002153 if ((int) self::substr($reply, 0, 3) !== $resp)
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302154 {
2155 $this->_set_error_message('lang:email_smtp_error', $reply);
2156 return FALSE;
2157 }
Barry Mienydd671972010-10-04 16:33:58 +02002158
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302159 if ($cmd === 'quit')
2160 {
2161 fclose($this->_smtp_connect);
2162 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002163
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302164 return TRUE;
2165 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002166
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302167 // --------------------------------------------------------------------
Derek Allard2067d1a2008-11-13 22:59:24 +00002168
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302169 /**
2170 * SMTP Authenticate
2171 *
2172 * @return bool
2173 */
2174 protected function _smtp_authenticate()
2175 {
2176 if ( ! $this->_smtp_auth)
2177 {
2178 return TRUE;
2179 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002180
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302181 if ($this->smtp_user === '' && $this->smtp_pass === '')
2182 {
2183 $this->_set_error_message('lang:email_no_smtp_unpw');
2184 return FALSE;
2185 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002186
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302187 $this->_send_data('AUTH LOGIN');
Derek Allard2067d1a2008-11-13 22:59:24 +00002188
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302189 $reply = $this->_get_smtp_data();
Derek Allard2067d1a2008-11-13 22:59:24 +00002190
Andrey Andreevfa01ae42013-03-04 14:40:18 +02002191 if (strpos($reply, '503') === 0) // Already authenticated
nisheeth-barthwal758f40c2013-02-18 17:18:51 +05302192 {
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302193 return TRUE;
nisheeth-barthwal758f40c2013-02-18 17:18:51 +05302194 }
Andrey Andreevfa01ae42013-03-04 14:40:18 +02002195 elseif (strpos($reply, '334') !== 0)
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302196 {
2197 $this->_set_error_message('lang:email_failed_smtp_login', $reply);
2198 return FALSE;
2199 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002200
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302201 $this->_send_data(base64_encode($this->smtp_user));
Derek Allard2067d1a2008-11-13 22:59:24 +00002202
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302203 $reply = $this->_get_smtp_data();
Derek Allard2067d1a2008-11-13 22:59:24 +00002204
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302205 if (strpos($reply, '334') !== 0)
2206 {
2207 $this->_set_error_message('lang:email_smtp_auth_un', $reply);
2208 return FALSE;
2209 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002210
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302211 $this->_send_data(base64_encode($this->smtp_pass));
Derek Allard2067d1a2008-11-13 22:59:24 +00002212
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302213 $reply = $this->_get_smtp_data();
nisheeth-barthwalcf225572013-02-18 01:08:04 +05302214
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302215 if (strpos($reply, '235') !== 0)
2216 {
2217 $this->_set_error_message('lang:email_smtp_auth_pw', $reply);
2218 return FALSE;
2219 }
nisheeth-barthwalcf225572013-02-18 01:08:04 +05302220
Andrey Andreev84253192016-05-09 12:24:52 +03002221 if ($this->smtp_keepalive)
2222 {
2223 $this->_smtp_auth = FALSE;
2224 }
2225
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302226 return TRUE;
2227 }
Barry Mienydd671972010-10-04 16:33:58 +02002228
Derek Allard2067d1a2008-11-13 22:59:24 +00002229 // --------------------------------------------------------------------
2230
2231 /**
2232 * Send SMTP data
2233 *
Andrey Andreev5fd3ae82012-10-24 14:55:35 +03002234 * @param string $data
Derek Allard2067d1a2008-11-13 22:59:24 +00002235 * @return bool
2236 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06002237 protected function _send_data($data)
Derek Allard2067d1a2008-11-13 22:59:24 +00002238 {
Andrey Andreevd8b1ad32014-01-15 17:42:52 +02002239 $data .= $this->newline;
Andrey Andreev4e2cdec2016-10-28 14:19:08 +03002240 for ($written = $timestamp = 0, $length = self::strlen($data); $written < $length; $written += $result)
Andrey Andreevd8b1ad32014-01-15 17:42:52 +02002241 {
Andrey Andreev4e2cdec2016-10-28 14:19:08 +03002242 if (($result = fwrite($this->_smtp_connect, self::substr($data, $written))) === FALSE)
Andrey Andreevd8b1ad32014-01-15 17:42:52 +02002243 {
2244 break;
2245 }
Andrey Andreev4e0496e2015-06-22 12:34:38 +03002246 // See https://bugs.php.net/bug.php?id=39598 and http://php.net/manual/en/function.fwrite.php#96951
2247 elseif ($result === 0)
2248 {
2249 if ($timestamp === 0)
2250 {
2251 $timestamp = time();
2252 }
2253 elseif ($timestamp < (time() - $this->smtp_timeout))
2254 {
2255 $result = FALSE;
2256 break;
2257 }
2258
2259 usleep(250000);
2260 continue;
2261 }
2262 else
2263 {
2264 $timestamp = 0;
2265 }
Andrey Andreevd8b1ad32014-01-15 17:42:52 +02002266 }
2267
2268 if ($result === FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +00002269 {
patworkb0707982011-04-08 15:10:05 +02002270 $this->_set_error_message('lang:email_smtp_data_failure', $data);
Derek Allard2067d1a2008-11-13 22:59:24 +00002271 return FALSE;
2272 }
Andrey Andreev1bd3d882011-12-22 15:38:20 +02002273
2274 return TRUE;
Derek Allard2067d1a2008-11-13 22:59:24 +00002275 }
Barry Mienydd671972010-10-04 16:33:58 +02002276
Derek Allard2067d1a2008-11-13 22:59:24 +00002277 // --------------------------------------------------------------------
2278
2279 /**
2280 * Get SMTP data
2281 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002282 * @return string
2283 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06002284 protected function _get_smtp_data()
Derek Allard2067d1a2008-11-13 22:59:24 +00002285 {
Andrey Andreev56454792012-05-17 14:32:19 +03002286 $data = '';
Derek Allard2067d1a2008-11-13 22:59:24 +00002287
2288 while ($str = fgets($this->_smtp_connect, 512))
2289 {
2290 $data .= $str;
2291
Alex Bilbied261b1e2012-06-02 11:12:16 +01002292 if ($str[3] === ' ')
Derek Allard2067d1a2008-11-13 22:59:24 +00002293 {
2294 break;
2295 }
2296 }
2297
2298 return $data;
2299 }
Barry Mienydd671972010-10-04 16:33:58 +02002300
Derek Allard2067d1a2008-11-13 22:59:24 +00002301 // --------------------------------------------------------------------
2302
2303 /**
2304 * Get Hostname
Andrey Andreev396eb892015-02-06 14:50:10 +02002305 *
2306 * There are only two legal types of hostname - either a fully
2307 * qualified domain name (eg: "mail.example.com") or an IP literal
2308 * (eg: "[1.2.3.4]").
2309 *
2310 * @link https://tools.ietf.org/html/rfc5321#section-2.3.5
James Wade3245af42015-02-06 11:48:51 +00002311 * @link http://cbl.abuseat.org/namingproblems.html
Derek Allard2067d1a2008-11-13 22:59:24 +00002312 * @return string
2313 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06002314 protected function _get_hostname()
Derek Allard2067d1a2008-11-13 22:59:24 +00002315 {
Andrey Andreev396eb892015-02-06 14:50:10 +02002316 if (isset($_SERVER['SERVER_NAME']))
2317 {
2318 return $_SERVER['SERVER_NAME'];
2319 }
2320
2321 return isset($_SERVER['SERVER_ADDR']) ? '['.$_SERVER['SERVER_ADDR'].']' : '[127.0.0.1]';
Derek Allard2067d1a2008-11-13 22:59:24 +00002322 }
Barry Mienydd671972010-10-04 16:33:58 +02002323
Derek Allard2067d1a2008-11-13 22:59:24 +00002324 // --------------------------------------------------------------------
2325
2326 /**
Derek Allard2067d1a2008-11-13 22:59:24 +00002327 * Get Debug Message
2328 *
Andrey Andreev61797f62012-11-26 16:15:12 +02002329 * @param array $include List of raw data chunks to include in the output
2330 * Valid options are: 'headers', 'subject', 'body'
Derek Allard2067d1a2008-11-13 22:59:24 +00002331 * @return string
2332 */
Andrey Andreev61797f62012-11-26 16:15:12 +02002333 public function print_debugger($include = array('headers', 'subject', 'body'))
Derek Allard2067d1a2008-11-13 22:59:24 +00002334 {
2335 $msg = '';
2336
2337 if (count($this->_debug_msg) > 0)
2338 {
2339 foreach ($this->_debug_msg as $val)
2340 {
2341 $msg .= $val;
2342 }
2343 }
2344
Andrey Andreev61797f62012-11-26 16:15:12 +02002345 // Determine which parts of our raw data needs to be printed
2346 $raw_data = '';
2347 is_array($include) OR $include = array($include);
2348
2349 if (in_array('headers', $include, TRUE))
2350 {
Andrey Andreev58f677f2013-07-16 11:01:37 +03002351 $raw_data = htmlspecialchars($this->_header_str)."\n";
Andrey Andreev61797f62012-11-26 16:15:12 +02002352 }
2353
2354 if (in_array('subject', $include, TRUE))
2355 {
2356 $raw_data .= htmlspecialchars($this->_subject)."\n";
2357 }
2358
2359 if (in_array('body', $include, TRUE))
2360 {
2361 $raw_data .= htmlspecialchars($this->_finalbody);
2362 }
2363
2364 return $msg.($raw_data === '' ? '' : '<pre>'.$raw_data.'</pre>');
Derek Allard2067d1a2008-11-13 22:59:24 +00002365 }
Barry Mienydd671972010-10-04 16:33:58 +02002366
Derek Allard2067d1a2008-11-13 22:59:24 +00002367 // --------------------------------------------------------------------
2368
2369 /**
2370 * Set Message
2371 *
Andrey Andreev5fd3ae82012-10-24 14:55:35 +03002372 * @param string $msg
2373 * @param string $val = ''
Andrey Andreev081c9462012-03-01 12:58:11 +02002374 * @return void
Derek Allard2067d1a2008-11-13 22:59:24 +00002375 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06002376 protected function _set_error_message($msg, $val = '')
Derek Allard2067d1a2008-11-13 22:59:24 +00002377 {
2378 $CI =& get_instance();
2379 $CI->lang->load('email');
2380
Andrey Andreev7a7ad782012-11-12 17:21:01 +02002381 if (sscanf($msg, 'lang:%s', $line) !== 1 OR FALSE === ($line = $CI->lang->line($line)))
Derek Allard2067d1a2008-11-13 22:59:24 +00002382 {
Andrey Andreev56454792012-05-17 14:32:19 +03002383 $this->_debug_msg[] = str_replace('%s', $val, $msg).'<br />';
Derek Allard2067d1a2008-11-13 22:59:24 +00002384 }
2385 else
2386 {
Andrey Andreev56454792012-05-17 14:32:19 +03002387 $this->_debug_msg[] = str_replace('%s', $val, $line).'<br />';
Derek Allard2067d1a2008-11-13 22:59:24 +00002388 }
2389 }
Barry Mienydd671972010-10-04 16:33:58 +02002390
Derek Allard2067d1a2008-11-13 22:59:24 +00002391 // --------------------------------------------------------------------
2392
2393 /**
2394 * Mime Types
2395 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002396 * @param string
2397 * @return string
2398 */
Andrey Andreev59c5b532012-03-01 14:09:51 +02002399 protected function _mime_types($ext = '')
Derek Allard2067d1a2008-11-13 22:59:24 +00002400 {
Andrey Andreev6ef498b2012-06-05 22:01:58 +03002401 $ext = strtolower($ext);
2402
vlakoff66c7bb42014-05-19 13:45:12 +02002403 $mimes =& get_mimes();
vlakoff69550c52014-05-19 13:45:02 +02002404
Andrey Andreev6ef498b2012-06-05 22:01:58 +03002405 if (isset($mimes[$ext]))
2406 {
2407 return is_array($mimes[$ext])
2408 ? current($mimes[$ext])
2409 : $mimes[$ext];
2410 }
2411
2412 return 'application/x-unknown-content-type';
Derek Allard2067d1a2008-11-13 22:59:24 +00002413 }
2414
Andrey Andreev8c95c3d2016-05-09 12:35:41 +03002415 // --------------------------------------------------------------------
2416
2417 /**
2418 * Destructor
2419 *
2420 * @return void
2421 */
2422 public function __destruct()
2423 {
2424 is_resource($this->_smtp_connect) && $this->_send_command('quit');
2425 }
Andrey Andreev4e2cdec2016-10-28 14:19:08 +03002426
2427 // --------------------------------------------------------------------
2428
2429 /**
2430 * Byte-safe strlen()
2431 *
2432 * @param string $str
2433 * @return int
2434 */
2435 protected static function strlen($str)
2436 {
Andrey Andreevc0c74d52017-01-19 15:26:35 +02002437 return (self::$func_overload)
Andrey Andreev4e2cdec2016-10-28 14:19:08 +03002438 ? mb_strlen($str, '8bit')
2439 : strlen($str);
2440 }
2441
2442 // --------------------------------------------------------------------
2443
2444 /**
2445 * Byte-safe substr()
2446 *
2447 * @param string $str
2448 * @param int $start
2449 * @param int $length
2450 * @return string
2451 */
2452 protected static function substr($str, $start, $length = NULL)
2453 {
Andrey Andreevc0c74d52017-01-19 15:26:35 +02002454 if (self::$func_overload)
Andrey Andreev4e2cdec2016-10-28 14:19:08 +03002455 {
2456 // mb_substr($str, $start, null, '8bit') returns an empty
2457 // string on PHP 5.3
2458 isset($length) OR $length = ($start >= 0 ? self::strlen($str) - $start : -$start);
2459 return mb_substr($str, $start, $length, '8bit');
2460 }
2461
2462 return isset($length)
2463 ? substr($str, $start, $length)
2464 : substr($str, $start);
2465 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002466}