blob: efdbfd7c1e08d846133270baa05065911d9d2587 [file] [log] [blame]
Andrey Andreevc5536aa2012-11-01 17:33:58 +02001<?php
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Phil Sturgeon07c1ac82012-03-09 17:03:37 +00005 * An open source application development framework for PHP 5.2.4 or newer
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05007 * NOTICE OF LICENSE
Andrey Andreev1bd3d882011-12-22 15:38:20 +02008 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05009 * Licensed under the Open Software License version 3.0
Andrey Andreev1bd3d882011-12-22 15:38:20 +020010 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -050011 * This source file is subject to the Open Software License (OSL 3.0) that is
12 * bundled with this package in the files license.txt / license.rst. It is
13 * also available through the world wide web at this URL:
14 * http://opensource.org/licenses/OSL-3.0
15 * If you did not receive a copy of the license and are unable to obtain it
16 * through the world wide web, please send an email to
17 * licensing@ellislab.com so we can send you a copy immediately.
18 *
Derek Allard2067d1a2008-11-13 22:59:24 +000019 * @package CodeIgniter
Derek Jonesf4a4bd82011-10-20 12:18:42 -050020 * @author EllisLab Dev Team
Andrey Andreev80500af2013-01-01 08:16:53 +020021 * @copyright Copyright (c) 2008 - 2013, EllisLab, Inc. (http://ellislab.com/)
Derek Jonesf4a4bd82011-10-20 12:18:42 -050022 * @license http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
Derek Allard2067d1a2008-11-13 22:59:24 +000023 * @link http://codeigniter.com
24 * @since Version 1.0
25 * @filesource
26 */
Andrey Andreevc5536aa2012-11-01 17:33:58 +020027defined('BASEPATH') OR exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +000028
Derek Allard2067d1a2008-11-13 22:59:24 +000029/**
30 * CodeIgniter Email Class
31 *
32 * Permits email to be sent using Mail, Sendmail, or SMTP.
33 *
34 * @package CodeIgniter
35 * @subpackage Libraries
36 * @category Libraries
Derek Jonesf4a4bd82011-10-20 12:18:42 -050037 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000038 * @link http://codeigniter.com/user_guide/libraries/email.html
39 */
trita15dd4f2011-11-23 07:40:05 -050040class CI_Email {
Derek Allard2067d1a2008-11-13 22:59:24 +000041
Andrey Andreev597ea272012-11-01 22:56:26 +020042 /**
43 * Used as the User-Agent and X-Mailer headers' value.
44 *
45 * @var string
46 */
Andrey Andreev59c5b532012-03-01 14:09:51 +020047 public $useragent = 'CodeIgniter';
Andrey Andreev50814092012-03-01 12:36:12 +020048
Andrey Andreev597ea272012-11-01 22:56:26 +020049 /**
50 * Path to the Sendmail binary.
51 *
52 * @var string
53 */
54 public $mailpath = '/usr/sbin/sendmail'; // Sendmail path
55
56 /**
57 * Which method to use for sending e-mails.
58 *
59 * @var string 'mail', 'sendmail' or 'smtp'
60 */
61 public $protocol = 'mail'; // mail/sendmail/smtp
62
63 /**
64 * STMP Server host
65 *
66 * @var string
67 */
68 public $smtp_host = '';
69
70 /**
71 * SMTP Username
72 *
73 * @var string
74 */
75 public $smtp_user = '';
76
77 /**
78 * SMTP Password
79 *
80 * @var string
81 */
82 public $smtp_pass = '';
83
84 /**
85 * SMTP Server port
86 *
87 * @var int
88 */
89 public $smtp_port = 25;
90
91 /**
92 * SMTP connection timeout in seconds
93 *
94 * @var int
95 */
96 public $smtp_timeout = 5;
vlakofff3994252013-02-19 01:45:23 +010097
nisheeth-barthwalcf225572013-02-18 01:08:04 +053098 /**
nisheeth-barthwal59209de2013-02-18 17:02:13 +053099 * SMTP persistent connection
100 *
101 * @var bool
102 */
103 public $smtp_keepalive = FALSE;
Andrey Andreev597ea272012-11-01 22:56:26 +0200104
105 /**
106 * SMTP Encryption
107 *
Andrey Andreev89b67b42013-03-12 19:34:23 +0200108 * @var string empty, 'tls' or 'ssl'
Andrey Andreev597ea272012-11-01 22:56:26 +0200109 */
Andrey Andreev89b67b42013-03-12 19:34:23 +0200110 public $smtp_crypto = '';
Andrey Andreev597ea272012-11-01 22:56:26 +0200111
112 /**
113 * Whether to apply word-wrapping to the message body.
114 *
115 * @var bool
116 */
117 public $wordwrap = TRUE;
118
119 /**
120 * Number of characters to wrap at.
121 *
122 * @see CI_Email::$wordwrap
123 * @var int
124 */
125 public $wrapchars = 76;
126
127 /**
128 * Message format.
129 *
130 * @var string 'text' or 'html'
131 */
132 public $mailtype = 'text';
133
134 /**
135 * Character set (default: utf-8)
136 *
137 * @var string
138 */
139 public $charset = 'utf-8';
140
141 /**
142 * Multipart message
143 *
144 * @var string 'mixed' (in the body) or 'related' (separate)
145 */
146 public $multipart = 'mixed'; // "mixed" (in the body) or "related" (separate)
147
148 /**
149 * Alternative message (for HTML messages only)
150 *
151 * @var string
152 */
153 public $alt_message = '';
154
155 /**
156 * Whether to validate e-mail addresses.
157 *
158 * @var bool
159 */
160 public $validate = FALSE;
161
162 /**
163 * X-Priority header value.
164 *
165 * @var int 1-5
166 */
167 public $priority = 3; // Default priority (1 - 5)
168
169 /**
170 * Newline character sequence.
171 * Use "\r\n" to comply with RFC 822.
172 *
173 * @link http://www.ietf.org/rfc/rfc822.txt
174 * @var string "\r\n" or "\n"
175 */
176 public $newline = "\n"; // Default newline. "\r\n" or "\n" (Use "\r\n" to comply with RFC 822)
177
178 /**
179 * CRLF character sequence
180 *
181 * RFC 2045 specifies that for 'quoted-printable' encoding,
182 * "\r\n" must be used. However, it appears that some servers
183 * (even on the receiving end) don't handle it properly and
184 * switching to "\n", while improper, is the only solution
185 * that seems to work for all environments.
186 *
187 * @link http://www.ietf.org/rfc/rfc822.txt
188 * @var string
189 */
190 public $crlf = "\n";
191
192 /**
193 * Whether to use Delivery Status Notification.
194 *
195 * @var bool
196 */
197 public $dsn = FALSE;
198
199 /**
200 * Whether to send multipart alternatives.
201 * Yahoo! doesn't seem to like these.
202 *
203 * @var bool
204 */
205 public $send_multipart = TRUE;
206
207 /**
208 * Whether to send messages to BCC recipients in batches.
209 *
210 * @var bool
211 */
212 public $bcc_batch_mode = FALSE;
213
214 /**
215 * BCC Batch max number size.
216 *
217 * @see CI_Email::$bcc_batch_mode
218 * @var int
219 */
220 public $bcc_batch_size = 200;
221
222 // --------------------------------------------------------------------
223
224 /**
225 * Whether PHP is running in safe mode. Initialized by the class constructor.
226 *
227 * @var bool
228 */
Andrey Andreev50814092012-03-01 12:36:12 +0200229 protected $_safe_mode = FALSE;
Andrey Andreev597ea272012-11-01 22:56:26 +0200230
231 /**
232 * Subject header
233 *
234 * @var string
235 */
Andrey Andreev50814092012-03-01 12:36:12 +0200236 protected $_subject = '';
Andrey Andreev597ea272012-11-01 22:56:26 +0200237
238 /**
239 * Message body
240 *
241 * @var string
242 */
Andrey Andreev50814092012-03-01 12:36:12 +0200243 protected $_body = '';
Andrey Andreev597ea272012-11-01 22:56:26 +0200244
245 /**
246 * Final message body to be sent.
247 *
248 * @var string
249 */
Andrey Andreev50814092012-03-01 12:36:12 +0200250 protected $_finalbody = '';
Andrey Andreev597ea272012-11-01 22:56:26 +0200251
252 /**
253 * multipart/alternative boundary
254 *
255 * @var string
256 */
Andrey Andreev50814092012-03-01 12:36:12 +0200257 protected $_alt_boundary = '';
Andrey Andreev597ea272012-11-01 22:56:26 +0200258
259 /**
260 * Attachment boundary
261 *
262 * @var string
263 */
Andrey Andreev50814092012-03-01 12:36:12 +0200264 protected $_atc_boundary = '';
Andrey Andreev597ea272012-11-01 22:56:26 +0200265
266 /**
267 * Final headers to send
268 *
269 * @var string
270 */
Andrey Andreev50814092012-03-01 12:36:12 +0200271 protected $_header_str = '';
Andrey Andreev597ea272012-11-01 22:56:26 +0200272
273 /**
274 * SMTP Connection socket placeholder
275 *
276 * @var resource
277 */
Andrey Andreev50814092012-03-01 12:36:12 +0200278 protected $_smtp_connect = '';
Andrey Andreev597ea272012-11-01 22:56:26 +0200279
280 /**
281 * Mail encoding
282 *
283 * @var string '8bit' or '7bit'
284 */
Andrey Andreev50814092012-03-01 12:36:12 +0200285 protected $_encoding = '8bit';
Andrey Andreev597ea272012-11-01 22:56:26 +0200286
287 /**
288 * Whether to perform SMTP authentication
289 *
290 * @var bool
291 */
Andrey Andreev50814092012-03-01 12:36:12 +0200292 protected $_smtp_auth = FALSE;
Andrey Andreev597ea272012-11-01 22:56:26 +0200293
294 /**
295 * Whether to send a Reply-To header
296 *
297 * @var bool
298 */
Andrey Andreev50814092012-03-01 12:36:12 +0200299 protected $_replyto_flag = FALSE;
Andrey Andreev597ea272012-11-01 22:56:26 +0200300
301 /**
302 * Debug messages
303 *
304 * @see CI_Email::print_debugger()
305 * @var string
306 */
Andrey Andreev50814092012-03-01 12:36:12 +0200307 protected $_debug_msg = array();
Andrey Andreev597ea272012-11-01 22:56:26 +0200308
309 /**
310 * Recipients
311 *
312 * @var string[]
313 */
Andrey Andreev50814092012-03-01 12:36:12 +0200314 protected $_recipients = array();
Andrey Andreev597ea272012-11-01 22:56:26 +0200315
316 /**
317 * CC Recipients
318 *
319 * @var string[]
320 */
Andrey Andreev50814092012-03-01 12:36:12 +0200321 protected $_cc_array = array();
Andrey Andreev597ea272012-11-01 22:56:26 +0200322
323 /**
324 * BCC Recipients
325 *
326 * @var string[]
327 */
Andrey Andreev50814092012-03-01 12:36:12 +0200328 protected $_bcc_array = array();
Andrey Andreev597ea272012-11-01 22:56:26 +0200329
330 /**
331 * Message headers
332 *
333 * @var string[]
334 */
Andrey Andreev50814092012-03-01 12:36:12 +0200335 protected $_headers = array();
Andrey Andreev597ea272012-11-01 22:56:26 +0200336
337 /**
338 * Attachment data
339 *
340 * @var array
341 */
Andrey Andreevb8f9a152012-10-27 01:36:51 +0300342 protected $_attachments = array();
Andrey Andreev597ea272012-11-01 22:56:26 +0200343
344 /**
345 * Valid $protocol values
346 *
347 * @see CI_Email::$protocol
348 * @var string[]
349 */
Andrey Andreev50814092012-03-01 12:36:12 +0200350 protected $_protocols = array('mail', 'sendmail', 'smtp');
Andrey Andreev597ea272012-11-01 22:56:26 +0200351
352 /**
353 * Base charsets
354 *
355 * Character sets valid for 7-bit encoding,
356 * excluding language suffix.
357 *
358 * @var string[]
359 */
360 protected $_base_charsets = array('us-ascii', 'iso-2022-');
361
362 /**
363 * Bit depths
364 *
365 * Valid mail encodings
366 *
367 * @see CI_Email::$_encoding
368 * @var string[]
369 */
Andrey Andreev50814092012-03-01 12:36:12 +0200370 protected $_bit_depths = array('7bit', '8bit');
Andrey Andreev597ea272012-11-01 22:56:26 +0200371
372 /**
373 * $priority translations
374 *
375 * Actual values to send with the X-Priority header
376 *
377 * @var string[]
378 */
Andrey Andreev50814092012-03-01 12:36:12 +0200379 protected $_priorities = array('1 (Highest)', '2 (High)', '3 (Normal)', '4 (Low)', '5 (Lowest)');
Derek Allard2067d1a2008-11-13 22:59:24 +0000380
Andrey Andreev597ea272012-11-01 22:56:26 +0200381 // --------------------------------------------------------------------
382
Derek Allard2067d1a2008-11-13 22:59:24 +0000383 /**
384 * Constructor - Sets Email Preferences
385 *
386 * The constructor can be passed an array of config values
Andrey Andreev56454792012-05-17 14:32:19 +0300387 *
Andrey Andreev5fd3ae82012-10-24 14:55:35 +0300388 * @param array $config = array()
Andrey Andreev56454792012-05-17 14:32:19 +0300389 * @return void
Derek Allard2067d1a2008-11-13 22:59:24 +0000390 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000391 public function __construct($config = array())
Derek Allard2067d1a2008-11-13 22:59:24 +0000392 {
Andrey Andreev925dd902012-10-19 11:06:31 +0300393 $this->charset = config_item('charset');
Andrey Andreev9f44c212012-10-10 16:07:17 +0300394
Derek Allard2067d1a2008-11-13 22:59:24 +0000395 if (count($config) > 0)
396 {
397 $this->initialize($config);
398 }
399 else
400 {
Alex Bilbied261b1e2012-06-02 11:12:16 +0100401 $this->_smtp_auth = ! ($this->smtp_user === '' && $this->smtp_pass === '');
Derek Allard2067d1a2008-11-13 22:59:24 +0000402 }
403
Andrey Andreev5932a732013-09-13 14:45:53 +0300404 $this->_safe_mode = ( ! is_php('5.4') && (bool) @ini_get('safe_mode'));
Andrey Andreev925dd902012-10-19 11:06:31 +0300405 $this->charset = strtoupper($this->charset);
406
Andrey Andreev59c5b532012-03-01 14:09:51 +0200407 log_message('debug', 'Email Class Initialized');
Derek Allard2067d1a2008-11-13 22:59:24 +0000408 }
nisheeth-barthwal59209de2013-02-18 17:02:13 +0530409
nisheeth-barthwalcf225572013-02-18 01:08:04 +0530410 // --------------------------------------------------------------------
vlakofff3994252013-02-19 01:45:23 +0100411
nisheeth-barthwalcf225572013-02-18 01:08:04 +0530412 /**
nisheeth-barthwal59209de2013-02-18 17:02:13 +0530413 * Destructor - Releases Resources
414 *
415 * @return void
416 */
417 public function __destruct()
418 {
nisheeth-barthwal758f40c2013-02-18 17:18:51 +0530419 if (is_resource($this->_smtp_connect))
420 {
nisheeth-barthwal59209de2013-02-18 17:02:13 +0530421 $this->_send_command('quit');
nisheeth-barthwal758f40c2013-02-18 17:18:51 +0530422 }
nisheeth-barthwal59209de2013-02-18 17:02:13 +0530423 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000424
425 // --------------------------------------------------------------------
426
427 /**
428 * Initialize preferences
429 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000430 * @param array
Andrew Podner4296a652012-12-17 07:51:15 -0500431 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000432 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000433 public function initialize($config = array())
Derek Allard2067d1a2008-11-13 22:59:24 +0000434 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000435 foreach ($config as $key => $val)
436 {
437 if (isset($this->$key))
438 {
439 $method = 'set_'.$key;
440
441 if (method_exists($this, $method))
442 {
443 $this->$method($val);
444 }
445 else
446 {
447 $this->$key = $val;
448 }
449 }
450 }
Eric Barnes6113f542010-12-29 13:36:12 -0500451 $this->clear();
Derek Allard2067d1a2008-11-13 22:59:24 +0000452
Alex Bilbied261b1e2012-06-02 11:12:16 +0100453 $this->_smtp_auth = ! ($this->smtp_user === '' && $this->smtp_pass === '');
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000454
455 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000456 }
Barry Mienydd671972010-10-04 16:33:58 +0200457
Derek Allard2067d1a2008-11-13 22:59:24 +0000458 // --------------------------------------------------------------------
459
460 /**
461 * Initialize the Email Data
462 *
Bo-Yi Wu83320eb2011-09-15 13:28:02 +0800463 * @param bool
Andrew Podner4296a652012-12-17 07:51:15 -0500464 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000465 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000466 public function clear($clear_attachments = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000467 {
Andrey Andreev59c5b532012-03-01 14:09:51 +0200468 $this->_subject = '';
469 $this->_body = '';
470 $this->_finalbody = '';
471 $this->_header_str = '';
472 $this->_replyto_flag = FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000473 $this->_recipients = array();
Derek Jonesd1606352010-09-01 11:16:07 -0500474 $this->_cc_array = array();
475 $this->_bcc_array = array();
Derek Allard2067d1a2008-11-13 22:59:24 +0000476 $this->_headers = array();
477 $this->_debug_msg = array();
478
Mickey Wubfc1cad2012-05-31 22:28:40 -0700479 $this->set_header('User-Agent', $this->useragent);
480 $this->set_header('Date', $this->_set_date());
Derek Allard2067d1a2008-11-13 22:59:24 +0000481
482 if ($clear_attachments !== FALSE)
483 {
Andrey Andreevb8f9a152012-10-27 01:36:51 +0300484 $this->_attachments = array();
Derek Allard2067d1a2008-11-13 22:59:24 +0000485 }
Eric Barnes6113f542010-12-29 13:36:12 -0500486
Greg Akera769deb2010-11-10 15:47:29 -0600487 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000488 }
Barry Mienydd671972010-10-04 16:33:58 +0200489
Derek Allard2067d1a2008-11-13 22:59:24 +0000490 // --------------------------------------------------------------------
491
492 /**
493 * Set FROM
494 *
Andrey Andreev5fd3ae82012-10-24 14:55:35 +0300495 * @param string $from
496 * @param string $name
497 * @param string $return_path = NULL Return-Path
Andrew Podner4296a652012-12-17 07:51:15 -0500498 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000499 */
Andrey Andreev925dd902012-10-19 11:06:31 +0300500 public function from($from, $name = '', $return_path = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000501 {
Andrey Andreev59c5b532012-03-01 14:09:51 +0200502 if (preg_match('/\<(.*)\>/', $from, $match))
Derek Allard2067d1a2008-11-13 22:59:24 +0000503 {
Andrey Andreev1bd3d882011-12-22 15:38:20 +0200504 $from = $match[1];
Derek Allard2067d1a2008-11-13 22:59:24 +0000505 }
506
507 if ($this->validate)
508 {
509 $this->validate_email($this->_str_to_array($from));
Andrey Andreevccd01c72012-10-05 17:12:55 +0300510 if ($return_path)
Melounek58dfc082012-06-29 08:43:47 +0200511 {
512 $this->validate_email($this->_str_to_array($return_path));
513 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000514 }
515
516 // prepare the display name
Alex Bilbied261b1e2012-06-02 11:12:16 +0100517 if ($name !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000518 {
519 // only use Q encoding if there are characters that would require it
520 if ( ! preg_match('/[\200-\377]/', $name))
521 {
522 // add slashes for non-printing characters, slashes, and double quotes, and surround it in double quotes
Derek Jonesc630bcf2008-11-17 21:09:45 +0000523 $name = '"'.addcslashes($name, "\0..\37\177'\"\\").'"';
Derek Allard2067d1a2008-11-13 22:59:24 +0000524 }
525 else
526 {
Andrey Andreev925dd902012-10-19 11:06:31 +0300527 $name = $this->_prep_q_encoding($name);
Derek Allard2067d1a2008-11-13 22:59:24 +0000528 }
529 }
530
Mickey Wubfc1cad2012-05-31 22:28:40 -0700531 $this->set_header('From', $name.' <'.$from.'>');
Melounek58dfc082012-06-29 08:43:47 +0200532
Andrey Andreev925dd902012-10-19 11:06:31 +0300533 isset($return_path) OR $return_path = $from;
Melounek58dfc082012-06-29 08:43:47 +0200534 $this->set_header('Return-Path', '<'.$return_path.'>');
Eric Barnes6113f542010-12-29 13:36:12 -0500535
Greg Akera769deb2010-11-10 15:47:29 -0600536 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000537 }
Barry Mienydd671972010-10-04 16:33:58 +0200538
Derek Allard2067d1a2008-11-13 22:59:24 +0000539 // --------------------------------------------------------------------
540
541 /**
542 * Set Reply-to
543 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000544 * @param string
545 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500546 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000547 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000548 public function reply_to($replyto, $name = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000549 {
Andrey Andreev59c5b532012-03-01 14:09:51 +0200550 if (preg_match('/\<(.*)\>/', $replyto, $match))
Derek Allard2067d1a2008-11-13 22:59:24 +0000551 {
Andrey Andreev1bd3d882011-12-22 15:38:20 +0200552 $replyto = $match[1];
Derek Allard2067d1a2008-11-13 22:59:24 +0000553 }
554
555 if ($this->validate)
556 {
557 $this->validate_email($this->_str_to_array($replyto));
558 }
559
Alex Bilbied261b1e2012-06-02 11:12:16 +0100560 if ($name === '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000561 {
562 $name = $replyto;
563 }
564
Andrey Andreev3dad2e72012-06-14 15:10:56 +0300565 if (strpos($name, '"') !== 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000566 {
567 $name = '"'.$name.'"';
568 }
569
Mickey Wubfc1cad2012-05-31 22:28:40 -0700570 $this->set_header('Reply-To', $name.' <'.$replyto.'>');
Derek Allard2067d1a2008-11-13 22:59:24 +0000571 $this->_replyto_flag = TRUE;
Greg Akera769deb2010-11-10 15:47:29 -0600572
573 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000574 }
Barry Mienydd671972010-10-04 16:33:58 +0200575
Derek Allard2067d1a2008-11-13 22:59:24 +0000576 // --------------------------------------------------------------------
577
578 /**
579 * Set Recipients
580 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000581 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500582 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000583 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000584 public function to($to)
Derek Allard2067d1a2008-11-13 22:59:24 +0000585 {
586 $to = $this->_str_to_array($to);
587 $to = $this->clean_email($to);
588
589 if ($this->validate)
590 {
591 $this->validate_email($to);
592 }
593
Andrey Andreev1bd3d882011-12-22 15:38:20 +0200594 if ($this->_get_protocol() !== 'mail')
Derek Allard2067d1a2008-11-13 22:59:24 +0000595 {
Mickey Wubfc1cad2012-05-31 22:28:40 -0700596 $this->set_header('To', implode(', ', $to));
Derek Allard2067d1a2008-11-13 22:59:24 +0000597 }
598
Andrey Andreev8a7078b2012-10-17 10:52:49 +0300599 $this->_recipients = $to;
Eric Barnes6113f542010-12-29 13:36:12 -0500600
Greg Akera769deb2010-11-10 15:47:29 -0600601 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000602 }
Barry Mienydd671972010-10-04 16:33:58 +0200603
Derek Allard2067d1a2008-11-13 22:59:24 +0000604 // --------------------------------------------------------------------
605
606 /**
607 * Set CC
608 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000609 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500610 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000611 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000612 public function cc($cc)
Derek Allard2067d1a2008-11-13 22:59:24 +0000613 {
Andrey Andreev56454792012-05-17 14:32:19 +0300614 $cc = $this->clean_email($this->_str_to_array($cc));
Derek Allard2067d1a2008-11-13 22:59:24 +0000615
616 if ($this->validate)
617 {
618 $this->validate_email($cc);
619 }
620
Mickey Wubfc1cad2012-05-31 22:28:40 -0700621 $this->set_header('Cc', implode(', ', $cc));
Derek Allard2067d1a2008-11-13 22:59:24 +0000622
Andrey Andreev1bd3d882011-12-22 15:38:20 +0200623 if ($this->_get_protocol() === 'smtp')
Derek Allard2067d1a2008-11-13 22:59:24 +0000624 {
625 $this->_cc_array = $cc;
626 }
Eric Barnes6113f542010-12-29 13:36:12 -0500627
Greg Akera769deb2010-11-10 15:47:29 -0600628 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000629 }
Barry Mienydd671972010-10-04 16:33:58 +0200630
Derek Allard2067d1a2008-11-13 22:59:24 +0000631 // --------------------------------------------------------------------
632
633 /**
634 * Set BCC
635 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000636 * @param string
637 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500638 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000639 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000640 public function bcc($bcc, $limit = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000641 {
Alex Bilbied261b1e2012-06-02 11:12:16 +0100642 if ($limit !== '' && is_numeric($limit))
Derek Allard2067d1a2008-11-13 22:59:24 +0000643 {
644 $this->bcc_batch_mode = TRUE;
645 $this->bcc_batch_size = $limit;
646 }
647
Andrey Andreev56454792012-05-17 14:32:19 +0300648 $bcc = $this->clean_email($this->_str_to_array($bcc));
Derek Allard2067d1a2008-11-13 22:59:24 +0000649
650 if ($this->validate)
651 {
652 $this->validate_email($bcc);
653 }
654
Andrey Andreev1bd3d882011-12-22 15:38:20 +0200655 if ($this->_get_protocol() === 'smtp' OR ($this->bcc_batch_mode && count($bcc) > $this->bcc_batch_size))
Derek Allard2067d1a2008-11-13 22:59:24 +0000656 {
657 $this->_bcc_array = $bcc;
658 }
659 else
660 {
Mickey Wubfc1cad2012-05-31 22:28:40 -0700661 $this->set_header('Bcc', implode(', ', $bcc));
Derek Allard2067d1a2008-11-13 22:59:24 +0000662 }
Eric Barnes6113f542010-12-29 13:36:12 -0500663
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 Email Subject
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 subject($subject)
Derek Allard2067d1a2008-11-13 22:59:24 +0000676 {
677 $subject = $this->_prep_q_encoding($subject);
Mickey Wubfc1cad2012-05-31 22:28:40 -0700678 $this->set_header('Subject', $subject);
Greg Akera769deb2010-11-10 15:47:29 -0600679 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000680 }
Barry Mienydd671972010-10-04 16:33:58 +0200681
Derek Allard2067d1a2008-11-13 22:59:24 +0000682 // --------------------------------------------------------------------
683
684 /**
685 * Set Body
686 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000687 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500688 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000689 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000690 public function message($body)
Derek Allard2067d1a2008-11-13 22:59:24 +0000691 {
Andrey Andreev59c5b532012-03-01 14:09:51 +0200692 $this->_body = rtrim(str_replace("\r", '', $body));
diegorivera33c32802011-10-19 02:56:15 -0200693
Andrey Andreevaf728622011-10-20 10:11:59 +0300694 /* strip slashes only if magic quotes is ON
695 if we do it with magic quotes OFF, it strips real, user-inputted chars.
696
697 NOTE: In PHP 5.4 get_magic_quotes_gpc() will always return 0 and
698 it will probably not exist in future versions at all.
699 */
700 if ( ! is_php('5.4') && get_magic_quotes_gpc())
diegorivera9fca6152011-10-19 11:18:45 -0200701 {
diegorivera33c32802011-10-19 02:56:15 -0200702 $this->_body = stripslashes($this->_body);
diegorivera9fca6152011-10-19 11:18:45 -0200703 }
diegorivera33c32802011-10-19 02:56:15 -0200704
Greg Akera769deb2010-11-10 15:47:29 -0600705 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000706 }
Barry Mienydd671972010-10-04 16:33:58 +0200707
Derek Allard2067d1a2008-11-13 22:59:24 +0000708 // --------------------------------------------------------------------
709
710 /**
711 * Assign file attachments
712 *
Andrey Andreev5fd3ae82012-10-24 14:55:35 +0300713 * @param string $filename
714 * @param string $disposition = 'attachment'
715 * @param string $newname = NULL
716 * @param string $mime = ''
Andrew Podner4296a652012-12-17 07:51:15 -0500717 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000718 */
Matteo Matteic3b36f42012-03-26 10:27:17 +0200719 public function attach($filename, $disposition = '', $newname = NULL, $mime = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000720 {
Andrey Andreevb8f9a152012-10-27 01:36:51 +0300721 $this->_attachments[] = array(
722 'name' => array($filename, $newname),
723 'disposition' => empty($disposition) ? 'attachment' : $disposition, // Can also be 'inline' Not sure if it matters
724 'type' => $mime
725 );
726
Greg Akera769deb2010-11-10 15:47:29 -0600727 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000728 }
729
730 // --------------------------------------------------------------------
731
732 /**
733 * Add a Header Item
734 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000735 * @param string
736 * @param string
737 * @return void
738 */
Mickey Wubfc1cad2012-05-31 22:28:40 -0700739 public function set_header($header, $value)
Derek Allard2067d1a2008-11-13 22:59:24 +0000740 {
florisluitenf55d5142013-06-07 17:20:06 +0300741 $this->_headers[$header] = str_replace(array("\n", "\r"), '', $value);
Derek Allard2067d1a2008-11-13 22:59:24 +0000742 }
Barry Mienydd671972010-10-04 16:33:58 +0200743
Derek Allard2067d1a2008-11-13 22:59:24 +0000744 // --------------------------------------------------------------------
745
746 /**
747 * Convert a String to an Array
748 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000749 * @param string
750 * @return array
751 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -0600752 protected function _str_to_array($email)
Derek Allard2067d1a2008-11-13 22:59:24 +0000753 {
754 if ( ! is_array($email))
755 {
Andrey Andreev56454792012-05-17 14:32:19 +0300756 return (strpos($email, ',') !== FALSE)
757 ? preg_split('/[\s,]/', $email, -1, PREG_SPLIT_NO_EMPTY)
758 : (array) trim($email);
Derek Allard2067d1a2008-11-13 22:59:24 +0000759 }
Andrey Andreev56454792012-05-17 14:32:19 +0300760
Derek Allard2067d1a2008-11-13 22:59:24 +0000761 return $email;
762 }
Barry Mienydd671972010-10-04 16:33:58 +0200763
Derek Allard2067d1a2008-11-13 22:59:24 +0000764 // --------------------------------------------------------------------
765
766 /**
767 * Set Multipart Value
768 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000769 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500770 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000771 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000772 public function set_alt_message($str = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000773 {
Dan Horrigand0ddeaf2011-08-21 09:07:27 -0400774 $this->alt_message = (string) $str;
Greg Akera769deb2010-11-10 15:47:29 -0600775 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000776 }
Barry Mienydd671972010-10-04 16:33:58 +0200777
Derek Allard2067d1a2008-11-13 22:59:24 +0000778 // --------------------------------------------------------------------
779
780 /**
781 * Set Mailtype
782 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000783 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500784 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000785 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000786 public function set_mailtype($type = 'text')
Derek Allard2067d1a2008-11-13 22:59:24 +0000787 {
Andrey Andreev56454792012-05-17 14:32:19 +0300788 $this->mailtype = ($type === 'html') ? 'html' : 'text';
Greg Akera769deb2010-11-10 15:47:29 -0600789 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000790 }
Barry Mienydd671972010-10-04 16:33:58 +0200791
Derek Allard2067d1a2008-11-13 22:59:24 +0000792 // --------------------------------------------------------------------
nisheeth-barthwalcf225572013-02-18 01:08:04 +0530793
Derek Allard2067d1a2008-11-13 22:59:24 +0000794 /**
795 * Set Wordwrap
796 *
Dan Horrigan628e6602011-08-21 09:08:31 -0400797 * @param bool
Andrew Podner4296a652012-12-17 07:51:15 -0500798 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000799 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000800 public function set_wordwrap($wordwrap = TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000801 {
Dan Horrigan628e6602011-08-21 09:08:31 -0400802 $this->wordwrap = (bool) $wordwrap;
Greg Akera769deb2010-11-10 15:47:29 -0600803 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000804 }
Barry Mienydd671972010-10-04 16:33:58 +0200805
Derek Allard2067d1a2008-11-13 22:59:24 +0000806 // --------------------------------------------------------------------
807
808 /**
809 * Set Protocol
810 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000811 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500812 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000813 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000814 public function set_protocol($protocol = 'mail')
Derek Allard2067d1a2008-11-13 22:59:24 +0000815 {
Andrey Andreev59c5b532012-03-01 14:09:51 +0200816 $this->protocol = in_array($protocol, $this->_protocols, TRUE) ? strtolower($protocol) : 'mail';
Greg Akera769deb2010-11-10 15:47:29 -0600817 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000818 }
Barry Mienydd671972010-10-04 16:33:58 +0200819
Derek Allard2067d1a2008-11-13 22:59:24 +0000820 // --------------------------------------------------------------------
821
822 /**
823 * Set Priority
824 *
Andrey Andreev081c9462012-03-01 12:58:11 +0200825 * @param int
Andrew Podner4296a652012-12-17 07:51:15 -0500826 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000827 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000828 public function set_priority($n = 3)
Derek Allard2067d1a2008-11-13 22:59:24 +0000829 {
Andrey Andreev59c5b532012-03-01 14:09:51 +0200830 $this->priority = preg_match('/^[1-5]$/', $n) ? (int) $n : 3;
Greg Akera769deb2010-11-10 15:47:29 -0600831 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000832 }
Barry Mienydd671972010-10-04 16:33:58 +0200833
Derek Allard2067d1a2008-11-13 22:59:24 +0000834 // --------------------------------------------------------------------
835
836 /**
837 * Set Newline Character
838 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000839 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500840 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000841 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000842 public function set_newline($newline = "\n")
Derek Allard2067d1a2008-11-13 22:59:24 +0000843 {
Andrey Andreevb71e06b2011-12-22 19:22:50 +0200844 $this->newline = in_array($newline, array("\n", "\r\n", "\r")) ? $newline : "\n";
Greg Akera769deb2010-11-10 15:47:29 -0600845 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000846 }
Barry Mienydd671972010-10-04 16:33:58 +0200847
Derek Allard2067d1a2008-11-13 22:59:24 +0000848 // --------------------------------------------------------------------
849
850 /**
851 * Set CRLF
852 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000853 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500854 * @return CI_Email
Derek Allard2067d1a2008-11-13 22:59:24 +0000855 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000856 public function set_crlf($crlf = "\n")
Derek Allard2067d1a2008-11-13 22:59:24 +0000857 {
Andrey Andreev76f15c92012-03-01 13:05:07 +0200858 $this->crlf = ($crlf !== "\n" && $crlf !== "\r\n" && $crlf !== "\r") ? "\n" : $crlf;
Greg Akera769deb2010-11-10 15:47:29 -0600859 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000860 }
Barry Mienydd671972010-10-04 16:33:58 +0200861
Derek Allard2067d1a2008-11-13 22:59:24 +0000862 // --------------------------------------------------------------------
863
864 /**
865 * Set Message Boundary
866 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000867 * @return void
868 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -0600869 protected function _set_boundaries()
Derek Allard2067d1a2008-11-13 22:59:24 +0000870 {
Andrey Andreev59c5b532012-03-01 14:09:51 +0200871 $this->_alt_boundary = 'B_ALT_'.uniqid(''); // multipart/alternative
872 $this->_atc_boundary = 'B_ATC_'.uniqid(''); // attachment boundary
Derek Allard2067d1a2008-11-13 22:59:24 +0000873 }
Barry Mienydd671972010-10-04 16:33:58 +0200874
Derek Allard2067d1a2008-11-13 22:59:24 +0000875 // --------------------------------------------------------------------
876
877 /**
878 * Get the Message ID
879 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000880 * @return string
881 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -0600882 protected function _get_message_id()
Derek Allard2067d1a2008-11-13 22:59:24 +0000883 {
Andrey Andreevb71e06b2011-12-22 19:22:50 +0200884 $from = str_replace(array('>', '<'), '', $this->_headers['Return-Path']);
Andrey Andreev56454792012-05-17 14:32:19 +0300885 return '<'.uniqid('').strstr($from, '@').'>';
Derek Allard2067d1a2008-11-13 22:59:24 +0000886 }
Barry Mienydd671972010-10-04 16:33:58 +0200887
Derek Allard2067d1a2008-11-13 22:59:24 +0000888 // --------------------------------------------------------------------
889
890 /**
891 * Get Mail Protocol
892 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000893 * @param bool
Andrey Andreev59c5b532012-03-01 14:09:51 +0200894 * @return mixed
Derek Allard2067d1a2008-11-13 22:59:24 +0000895 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -0600896 protected function _get_protocol($return = TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000897 {
898 $this->protocol = strtolower($this->protocol);
Andrey Andreev59c5b532012-03-01 14:09:51 +0200899 in_array($this->protocol, $this->_protocols, TRUE) OR $this->protocol = 'mail';
Derek Allard2067d1a2008-11-13 22:59:24 +0000900
Alex Bilbied261b1e2012-06-02 11:12:16 +0100901 if ($return === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000902 {
903 return $this->protocol;
904 }
905 }
Barry Mienydd671972010-10-04 16:33:58 +0200906
Derek Allard2067d1a2008-11-13 22:59:24 +0000907 // --------------------------------------------------------------------
908
909 /**
910 * Get Mail Encoding
911 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000912 * @param bool
913 * @return string
914 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -0600915 protected function _get_encoding($return = TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000916 {
Andrey Andreev59c5b532012-03-01 14:09:51 +0200917 in_array($this->_encoding, $this->_bit_depths) OR $this->_encoding = '8bit';
Derek Allard2067d1a2008-11-13 22:59:24 +0000918
919 foreach ($this->_base_charsets as $charset)
920 {
Andrey Andreev3dad2e72012-06-14 15:10:56 +0300921 if (strpos($charset, $this->charset) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000922 {
923 $this->_encoding = '7bit';
924 }
925 }
926
Alex Bilbied261b1e2012-06-02 11:12:16 +0100927 if ($return === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000928 {
929 return $this->_encoding;
930 }
931 }
932
933 // --------------------------------------------------------------------
934
935 /**
936 * Get content type (text/html/attachment)
937 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000938 * @return string
939 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -0600940 protected function _get_content_type()
Derek Allard2067d1a2008-11-13 22:59:24 +0000941 {
Andrey Andreev56454792012-05-17 14:32:19 +0300942 if ($this->mailtype === 'html')
Derek Allard2067d1a2008-11-13 22:59:24 +0000943 {
Andrey Andreevb8f9a152012-10-27 01:36:51 +0300944 return (count($this->_attachments) === 0) ? 'html' : 'html-attach';
Derek Allard2067d1a2008-11-13 22:59:24 +0000945 }
Andrey Andreevb8f9a152012-10-27 01:36:51 +0300946 elseif ($this->mailtype === 'text' && count($this->_attachments) > 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000947 {
948 return 'plain-attach';
949 }
950 else
951 {
952 return 'plain';
953 }
954 }
Barry Mienydd671972010-10-04 16:33:58 +0200955
Derek Allard2067d1a2008-11-13 22:59:24 +0000956 // --------------------------------------------------------------------
957
958 /**
959 * Set RFC 822 Date
960 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000961 * @return string
962 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -0600963 protected function _set_date()
Derek Allard2067d1a2008-11-13 22:59:24 +0000964 {
Andrey Andreev59c5b532012-03-01 14:09:51 +0200965 $timezone = date('Z');
Andrey Andreev3dad2e72012-06-14 15:10:56 +0300966 $operator = ($timezone[0] === '-') ? '-' : '+';
Derek Allard2067d1a2008-11-13 22:59:24 +0000967 $timezone = abs($timezone);
Andrey Andreev1bd3d882011-12-22 15:38:20 +0200968 $timezone = floor($timezone/3600) * 100 + ($timezone % 3600) / 60;
Derek Allard2067d1a2008-11-13 22:59:24 +0000969
Andrey Andreev59c5b532012-03-01 14:09:51 +0200970 return sprintf('%s %s%04d', date('D, j M Y H:i:s'), $operator, $timezone);
Derek Allard2067d1a2008-11-13 22:59:24 +0000971 }
Barry Mienydd671972010-10-04 16:33:58 +0200972
Derek Allard2067d1a2008-11-13 22:59:24 +0000973 // --------------------------------------------------------------------
974
975 /**
976 * Mime message
977 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000978 * @return string
979 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -0600980 protected function _get_mime_message()
Derek Allard2067d1a2008-11-13 22:59:24 +0000981 {
Andrey Andreev59c5b532012-03-01 14:09:51 +0200982 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 +0000983 }
Barry Mienydd671972010-10-04 16:33:58 +0200984
Derek Allard2067d1a2008-11-13 22:59:24 +0000985 // --------------------------------------------------------------------
986
987 /**
988 * Validate Email Address
989 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000990 * @param string
991 * @return bool
992 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +0000993 public function validate_email($email)
Derek Allard2067d1a2008-11-13 22:59:24 +0000994 {
995 if ( ! is_array($email))
996 {
patworkb0707982011-04-08 15:10:05 +0200997 $this->_set_error_message('lang:email_must_be_array');
Derek Allard2067d1a2008-11-13 22:59:24 +0000998 return FALSE;
999 }
1000
1001 foreach ($email as $val)
1002 {
1003 if ( ! $this->valid_email($val))
1004 {
patworkb0707982011-04-08 15:10:05 +02001005 $this->_set_error_message('lang:email_invalid_address', $val);
Derek Allard2067d1a2008-11-13 22:59:24 +00001006 return FALSE;
1007 }
1008 }
1009
1010 return TRUE;
1011 }
Barry Mienydd671972010-10-04 16:33:58 +02001012
Derek Allard2067d1a2008-11-13 22:59:24 +00001013 // --------------------------------------------------------------------
1014
1015 /**
1016 * Email Validation
1017 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001018 * @param string
1019 * @return bool
1020 */
Timothy Warrend37f0e92012-06-27 08:21:59 -04001021 public function valid_email($email)
Derek Allard2067d1a2008-11-13 22:59:24 +00001022 {
Andrey Andreev580388b2012-06-27 15:43:46 +03001023 return (bool) filter_var($email, FILTER_VALIDATE_EMAIL);
Derek Allard2067d1a2008-11-13 22:59:24 +00001024 }
Barry Mienydd671972010-10-04 16:33:58 +02001025
Derek Allard2067d1a2008-11-13 22:59:24 +00001026 // --------------------------------------------------------------------
1027
1028 /**
1029 * Clean Extended Email Address: Joe Smith <joe@smith.com>
1030 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001031 * @param string
1032 * @return string
1033 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +00001034 public function clean_email($email)
Derek Allard2067d1a2008-11-13 22:59:24 +00001035 {
1036 if ( ! is_array($email))
1037 {
Andrey Andreev56454792012-05-17 14:32:19 +03001038 return preg_match('/\<(.*)\>/', $email, $match) ? $match[1] : $email;
Derek Allard2067d1a2008-11-13 22:59:24 +00001039 }
1040
1041 $clean_email = array();
1042
1043 foreach ($email as $addy)
1044 {
Andrey Andreev59c5b532012-03-01 14:09:51 +02001045 $clean_email[] = preg_match('/\<(.*)\>/', $addy, $match) ? $match[1] : $addy;
Derek Allard2067d1a2008-11-13 22:59:24 +00001046 }
1047
1048 return $clean_email;
1049 }
Barry Mienydd671972010-10-04 16:33:58 +02001050
Derek Allard2067d1a2008-11-13 22:59:24 +00001051 // --------------------------------------------------------------------
1052
1053 /**
1054 * Build alternative plain text message
1055 *
Andrey Andreev8df1ae22012-10-19 11:20:54 +03001056 * Provides the raw message for use in plain-text headers of
1057 * HTML-formatted emails.
Derek Allard2067d1a2008-11-13 22:59:24 +00001058 * If the user hasn't specified his own alternative message
1059 * it creates one by stripping the HTML
1060 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001061 * @return string
1062 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06001063 protected function _get_alt_message()
Derek Allard2067d1a2008-11-13 22:59:24 +00001064 {
Andrey Andreev8df1ae22012-10-19 11:20:54 +03001065 if ( ! empty($this->alt_message))
Derek Allard2067d1a2008-11-13 22:59:24 +00001066 {
Andrey Andreev8df1ae22012-10-19 11:20:54 +03001067 return ($this->wordwrap)
1068 ? $this->word_wrap($this->alt_message, 76)
1069 : $this->alt_message;
Derek Allard2067d1a2008-11-13 22:59:24 +00001070 }
1071
Andrey Andreev56454792012-05-17 14:32:19 +03001072 $body = preg_match('/\<body.*?\>(.*)\<\/body\>/si', $this->_body, $match) ? $match[1] : $this->_body;
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001073 $body = str_replace("\t", '', preg_replace('#<!--(.*)--\>#', '', trim(strip_tags($body))));
Derek Allard2067d1a2008-11-13 22:59:24 +00001074
1075 for ($i = 20; $i >= 3; $i--)
1076 {
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001077 $body = str_replace(str_repeat("\n", $i), "\n\n", $body);
Derek Allard2067d1a2008-11-13 22:59:24 +00001078 }
1079
GDmac9bea4be2012-10-30 06:14:19 +01001080 // Reduce multiple spaces
Andrey Andreev8a203f62012-11-02 20:40:43 +02001081 $body = preg_replace('| +|', ' ', $body);
GDmac9bea4be2012-10-30 06:14:19 +01001082
Andrey Andreev8df1ae22012-10-19 11:20:54 +03001083 return ($this->wordwrap)
1084 ? $this->word_wrap($body, 76)
1085 : $body;
Derek Allard2067d1a2008-11-13 22:59:24 +00001086 }
Barry Mienydd671972010-10-04 16:33:58 +02001087
Derek Allard2067d1a2008-11-13 22:59:24 +00001088 // --------------------------------------------------------------------
1089
1090 /**
1091 * Word Wrap
1092 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001093 * @param string
Andrey Andreev8df1ae22012-10-19 11:20:54 +03001094 * @param int line-length limit
Derek Allard2067d1a2008-11-13 22:59:24 +00001095 * @return string
1096 */
Andrey Andreev00ea2a92012-10-18 14:59:29 +03001097 public function word_wrap($str, $charlim = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001098 {
Andrey Andreev00ea2a92012-10-18 14:59:29 +03001099 // Set the character limit, if not already present
1100 if (empty($charlim))
Derek Allard2067d1a2008-11-13 22:59:24 +00001101 {
Andrey Andreev00ea2a92012-10-18 14:59:29 +03001102 $charlim = empty($this->wrapchars) ? 76 : $this->wrapchars;
Derek Allard2067d1a2008-11-13 22:59:24 +00001103 }
1104
Derek Allard2067d1a2008-11-13 22:59:24 +00001105 // Standardize newlines
1106 if (strpos($str, "\r") !== FALSE)
1107 {
Andrey Andreevb71e06b2011-12-22 19:22:50 +02001108 $str = str_replace(array("\r\n", "\r"), "\n", $str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001109 }
1110
GDmac9bea4be2012-10-30 06:14:19 +01001111 // Reduce multiple spaces at end of line
1112 $str = preg_replace('| +\n|', "\n", $str);
1113
Derek Allard2067d1a2008-11-13 22:59:24 +00001114 // If the current word is surrounded by {unwrap} tags we'll
1115 // strip the entire chunk and replace it with a marker.
1116 $unwrap = array();
Andrey Andreev56454792012-05-17 14:32:19 +03001117 if (preg_match_all('|(\{unwrap\}.+?\{/unwrap\})|s', $str, $matches))
Derek Allard2067d1a2008-11-13 22:59:24 +00001118 {
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001119 for ($i = 0, $c = count($matches[0]); $i < $c; $i++)
Derek Allard2067d1a2008-11-13 22:59:24 +00001120 {
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001121 $unwrap[] = $matches[1][$i];
Andrey Andreev56454792012-05-17 14:32:19 +03001122 $str = str_replace($matches[1][$i], '{{unwrapped'.$i.'}}', $str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001123 }
1124 }
1125
Phil Sturgeona0f980e2011-01-13 10:59:12 +00001126 // Use PHP's native public function to do the initial wordwrap.
Derek Allard2067d1a2008-11-13 22:59:24 +00001127 // We set the cut flag to FALSE so that any individual words that are
Andrey Andreev56454792012-05-17 14:32:19 +03001128 // too long get left alone. In the next step we'll deal with them.
Derek Allard2067d1a2008-11-13 22:59:24 +00001129 $str = wordwrap($str, $charlim, "\n", FALSE);
1130
1131 // Split the string into individual lines of text and cycle through them
Andrey Andreev56454792012-05-17 14:32:19 +03001132 $output = '';
Derek Allard2067d1a2008-11-13 22:59:24 +00001133 foreach (explode("\n", $str) as $line)
1134 {
1135 // Is the line within the allowed character count?
1136 // If so we'll join it to the output and continue
1137 if (strlen($line) <= $charlim)
1138 {
1139 $output .= $line.$this->newline;
1140 continue;
1141 }
1142
1143 $temp = '';
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001144 do
Derek Allard2067d1a2008-11-13 22:59:24 +00001145 {
1146 // If the over-length word is a URL we won't wrap it
Andrey Andreev56454792012-05-17 14:32:19 +03001147 if (preg_match('!\[url.+\]|://|wwww.!', $line))
Derek Allard2067d1a2008-11-13 22:59:24 +00001148 {
1149 break;
1150 }
1151
1152 // Trim the word down
1153 $temp .= substr($line, 0, $charlim-1);
1154 $line = substr($line, $charlim-1);
1155 }
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001156 while (strlen($line) > $charlim);
Derek Allard2067d1a2008-11-13 22:59:24 +00001157
1158 // If $temp contains data it means we had to split up an over-length
1159 // word into smaller chunks so we'll add it back to our current line
Alex Bilbied261b1e2012-06-02 11:12:16 +01001160 if ($temp !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001161 {
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001162 $output .= $temp.$this->newline;
Derek Allard2067d1a2008-11-13 22:59:24 +00001163 }
1164
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001165 $output .= $line.$this->newline;
Derek Allard2067d1a2008-11-13 22:59:24 +00001166 }
1167
1168 // Put our markers back
1169 if (count($unwrap) > 0)
1170 {
1171 foreach ($unwrap as $key => $val)
1172 {
Andrey Andreev56454792012-05-17 14:32:19 +03001173 $output = str_replace('{{unwrapped'.$key.'}}', $val, $output);
Derek Allard2067d1a2008-11-13 22:59:24 +00001174 }
1175 }
1176
1177 return $output;
1178 }
Barry Mienydd671972010-10-04 16:33:58 +02001179
Derek Allard2067d1a2008-11-13 22:59:24 +00001180 // --------------------------------------------------------------------
1181
1182 /**
1183 * Build final headers
1184 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001185 * @return string
1186 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06001187 protected function _build_headers()
Derek Allard2067d1a2008-11-13 22:59:24 +00001188 {
Mickey Wubfc1cad2012-05-31 22:28:40 -07001189 $this->set_header('X-Sender', $this->clean_email($this->_headers['From']));
1190 $this->set_header('X-Mailer', $this->useragent);
1191 $this->set_header('X-Priority', $this->_priorities[$this->priority - 1]);
1192 $this->set_header('Message-ID', $this->_get_message_id());
1193 $this->set_header('Mime-Version', '1.0');
Derek Allard2067d1a2008-11-13 22:59:24 +00001194 }
Barry Mienydd671972010-10-04 16:33:58 +02001195
Derek Allard2067d1a2008-11-13 22:59:24 +00001196 // --------------------------------------------------------------------
1197
1198 /**
1199 * Write Headers as a string
1200 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001201 * @return void
1202 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06001203 protected function _write_headers()
Derek Allard2067d1a2008-11-13 22:59:24 +00001204 {
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001205 if ($this->protocol === 'mail')
Derek Allard2067d1a2008-11-13 22:59:24 +00001206 {
nisheeth-barthwal6bb98902013-02-19 18:11:14 +05301207 if (isset($this->_headers['Subject']))
1208 {
1209 $this->_subject = $this->_headers['Subject'];
1210 unset($this->_headers['Subject']);
1211 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001212 }
1213
1214 reset($this->_headers);
Andrey Andreev56454792012-05-17 14:32:19 +03001215 $this->_header_str = '';
Derek Allard2067d1a2008-11-13 22:59:24 +00001216
Pascal Kriete14287f32011-02-14 13:39:34 -05001217 foreach ($this->_headers as $key => $val)
Derek Allard2067d1a2008-11-13 22:59:24 +00001218 {
1219 $val = trim($val);
1220
Alex Bilbied261b1e2012-06-02 11:12:16 +01001221 if ($val !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001222 {
Andrey Andreev56454792012-05-17 14:32:19 +03001223 $this->_header_str .= $key.': '.$val.$this->newline;
Derek Allard2067d1a2008-11-13 22:59:24 +00001224 }
1225 }
1226
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001227 if ($this->_get_protocol() === 'mail')
Derek Allard2067d1a2008-11-13 22:59:24 +00001228 {
Derek Jones1d890882009-02-10 20:32:14 +00001229 $this->_header_str = rtrim($this->_header_str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001230 }
1231 }
Barry Mienydd671972010-10-04 16:33:58 +02001232
Derek Allard2067d1a2008-11-13 22:59:24 +00001233 // --------------------------------------------------------------------
1234
1235 /**
1236 * Build Final Body and attachments
1237 *
buhayc6da1ef2013-04-18 09:06:49 -07001238 * @return bool
Derek Allard2067d1a2008-11-13 22:59:24 +00001239 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06001240 protected function _build_message()
Derek Allard2067d1a2008-11-13 22:59:24 +00001241 {
Andrey Andreev76f15c92012-03-01 13:05:07 +02001242 if ($this->wordwrap === TRUE && $this->mailtype !== 'html')
Derek Allard2067d1a2008-11-13 22:59:24 +00001243 {
1244 $this->_body = $this->word_wrap($this->_body);
1245 }
1246
1247 $this->_set_boundaries();
1248 $this->_write_headers();
1249
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001250 $hdr = ($this->_get_protocol() === 'mail') ? $this->newline : '';
Brandon Jones485d7412010-11-09 16:38:17 -05001251 $body = '';
Derek Allard2067d1a2008-11-13 22:59:24 +00001252
1253 switch ($this->_get_content_type())
1254 {
1255 case 'plain' :
1256
Andrey Andreev56454792012-05-17 14:32:19 +03001257 $hdr .= 'Content-Type: text/plain; charset='.$this->charset.$this->newline
1258 .'Content-Transfer-Encoding: '.$this->_get_encoding();
Derek Allard2067d1a2008-11-13 22:59:24 +00001259
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001260 if ($this->_get_protocol() === 'mail')
Derek Allard2067d1a2008-11-13 22:59:24 +00001261 {
1262 $this->_header_str .= $hdr;
1263 $this->_finalbody = $this->_body;
Derek Allard2067d1a2008-11-13 22:59:24 +00001264 }
Brandon Jones485d7412010-11-09 16:38:17 -05001265 else
1266 {
Andrey Andreev2b956af2013-08-07 14:32:56 +03001267 $this->_finalbody = $hdr.$this->newline.$this->newline.$this->_body;
Brandon Jones485d7412010-11-09 16:38:17 -05001268 }
Eric Barnes6113f542010-12-29 13:36:12 -05001269
Derek Allard2067d1a2008-11-13 22:59:24 +00001270 return;
1271
Derek Allard2067d1a2008-11-13 22:59:24 +00001272 case 'html' :
1273
1274 if ($this->send_multipart === FALSE)
1275 {
Andrey Andreev56454792012-05-17 14:32:19 +03001276 $hdr .= 'Content-Type: text/html; charset='.$this->charset.$this->newline
Andrey Andreev2b956af2013-08-07 14:32:56 +03001277 .'Content-Transfer-Encoding: quoted-printable';
Derek Allard2067d1a2008-11-13 22:59:24 +00001278 }
1279 else
1280 {
Andrey Andreev2b956af2013-08-07 14:32:56 +03001281 $hdr .= 'Content-Type: multipart/alternative; boundary="'.$this->_alt_boundary.'"';
Derek Allard2067d1a2008-11-13 22:59:24 +00001282
Andrey Andreev56454792012-05-17 14:32:19 +03001283 $body .= $this->_get_mime_message().$this->newline.$this->newline
1284 .'--'.$this->_alt_boundary.$this->newline
Derek Allard2067d1a2008-11-13 22:59:24 +00001285
Andrey Andreev56454792012-05-17 14:32:19 +03001286 .'Content-Type: text/plain; charset='.$this->charset.$this->newline
1287 .'Content-Transfer-Encoding: '.$this->_get_encoding().$this->newline.$this->newline
1288 .$this->_get_alt_message().$this->newline.$this->newline.'--'.$this->_alt_boundary.$this->newline
Brandon Jones485d7412010-11-09 16:38:17 -05001289
Andrey Andreev56454792012-05-17 14:32:19 +03001290 .'Content-Type: text/html; charset='.$this->charset.$this->newline
1291 .'Content-Transfer-Encoding: quoted-printable'.$this->newline.$this->newline;
Derek Allard2067d1a2008-11-13 22:59:24 +00001292 }
Eric Barnes6113f542010-12-29 13:36:12 -05001293
Andrey Andreev56454792012-05-17 14:32:19 +03001294 $this->_finalbody = $body.$this->_prep_quoted_printable($this->_body).$this->newline.$this->newline;
Eric Barnes6113f542010-12-29 13:36:12 -05001295
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001296 if ($this->_get_protocol() === 'mail')
Derek Allard2067d1a2008-11-13 22:59:24 +00001297 {
1298 $this->_header_str .= $hdr;
Brandon Jones485d7412010-11-09 16:38:17 -05001299 }
1300 else
1301 {
Andrey Andreev2b956af2013-08-07 14:32:56 +03001302 $this->_finalbody = $hdr.$this->newline.$this->newline.$this->_finalbody;
Derek Allard2067d1a2008-11-13 22:59:24 +00001303 }
1304
Derek Allard2067d1a2008-11-13 22:59:24 +00001305 if ($this->send_multipart !== FALSE)
1306 {
Andrey Andreev56454792012-05-17 14:32:19 +03001307 $this->_finalbody .= '--'.$this->_alt_boundary.'--';
Derek Allard2067d1a2008-11-13 22:59:24 +00001308 }
1309
Derek Allard2067d1a2008-11-13 22:59:24 +00001310 return;
1311
Derek Allard2067d1a2008-11-13 22:59:24 +00001312 case 'plain-attach' :
1313
Andrey Andreev2b956af2013-08-07 14:32:56 +03001314 $hdr .= 'Content-Type: multipart/'.$this->multipart.'; boundary="'.$this->_atc_boundary.'"';
Derek Allard2067d1a2008-11-13 22:59:24 +00001315
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001316 if ($this->_get_protocol() === 'mail')
Derek Allard2067d1a2008-11-13 22:59:24 +00001317 {
1318 $this->_header_str .= $hdr;
Eric Barnes6113f542010-12-29 13:36:12 -05001319 }
1320
Andrey Andreev2b956af2013-08-07 14:32:56 +03001321 $body .= $this->_get_mime_message().$this->newline
1322 .$this->newline
Andrey Andreev56454792012-05-17 14:32:19 +03001323 .'--'.$this->_atc_boundary.$this->newline
Andrey Andreev56454792012-05-17 14:32:19 +03001324 .'Content-Type: text/plain; charset='.$this->charset.$this->newline
Andrey Andreev2b956af2013-08-07 14:32:56 +03001325 .'Content-Transfer-Encoding: '.$this->_get_encoding().$this->newline
1326 .$this->newline
Andrey Andreev56454792012-05-17 14:32:19 +03001327 .$this->_body.$this->newline.$this->newline;
Derek Allard2067d1a2008-11-13 22:59:24 +00001328
1329 break;
1330 case 'html-attach' :
1331
Andrey Andreev2b956af2013-08-07 14:32:56 +03001332 $hdr .= 'Content-Type: multipart/'.$this->multipart.'; boundary="'.$this->_atc_boundary.'"';
Eric Barnes6113f542010-12-29 13:36:12 -05001333
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001334 if ($this->_get_protocol() === 'mail')
Derek Allard2067d1a2008-11-13 22:59:24 +00001335 {
1336 $this->_header_str .= $hdr;
Derek Allard2067d1a2008-11-13 22:59:24 +00001337 }
1338
Andrey Andreev56454792012-05-17 14:32:19 +03001339 $body .= $this->_get_mime_message().$this->newline.$this->newline
1340 .'--'.$this->_atc_boundary.$this->newline
Brandon Jones485d7412010-11-09 16:38:17 -05001341
Andrey Andreev56454792012-05-17 14:32:19 +03001342 .'Content-Type: multipart/alternative; boundary="'.$this->_alt_boundary.'"'.$this->newline.$this->newline
1343 .'--'.$this->_alt_boundary.$this->newline
Brandon Jones485d7412010-11-09 16:38:17 -05001344
Andrey Andreev56454792012-05-17 14:32:19 +03001345 .'Content-Type: text/plain; charset='.$this->charset.$this->newline
1346 .'Content-Transfer-Encoding: '.$this->_get_encoding().$this->newline.$this->newline
1347 .$this->_get_alt_message().$this->newline.$this->newline.'--'.$this->_alt_boundary.$this->newline
Brandon Jones485d7412010-11-09 16:38:17 -05001348
Andrey Andreev56454792012-05-17 14:32:19 +03001349 .'Content-Type: text/html; charset='.$this->charset.$this->newline
1350 .'Content-Transfer-Encoding: quoted-printable'.$this->newline.$this->newline
Brandon Jones485d7412010-11-09 16:38:17 -05001351
Andrey Andreev56454792012-05-17 14:32:19 +03001352 .$this->_prep_quoted_printable($this->_body).$this->newline.$this->newline
1353 .'--'.$this->_alt_boundary.'--'.$this->newline.$this->newline;
Derek Allard2067d1a2008-11-13 22:59:24 +00001354
1355 break;
1356 }
1357
1358 $attachment = array();
Andrey Andreevb8f9a152012-10-27 01:36:51 +03001359 for ($i = 0, $c = count($this->_attachments), $z = 0; $i < $c; $i++)
Derek Allard2067d1a2008-11-13 22:59:24 +00001360 {
Andrey Andreevb8f9a152012-10-27 01:36:51 +03001361 $filename = $this->_attachments[$i]['name'][0];
vlakoff912f1bc2013-01-15 03:34:12 +01001362 $basename = ($this->_attachments[$i]['name'][1] === NULL)
Andrey Andreevb8f9a152012-10-27 01:36:51 +03001363 ? basename($filename) : $this->_attachments[$i]['name'][1];
1364 $ctype = $this->_attachments[$i]['type'];
Matteo Mattei5688d582012-03-13 19:29:29 +01001365 $file_content = '';
Derek Allard2067d1a2008-11-13 22:59:24 +00001366
Andrey Andreevb8f9a152012-10-27 01:36:51 +03001367 if ($ctype === '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001368 {
Matteo Mattei5688d582012-03-13 19:29:29 +01001369 if ( ! file_exists($filename))
1370 {
1371 $this->_set_error_message('lang:email_attachment_missing', $filename);
1372 return FALSE;
1373 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001374
Matteo Mattei5688d582012-03-13 19:29:29 +01001375 $file = filesize($filename) +1;
1376
1377 if ( ! $fp = fopen($filename, FOPEN_READ))
1378 {
1379 $this->_set_error_message('lang:email_attachment_unreadable', $filename);
1380 return FALSE;
1381 }
1382
Matteo Matteic3b36f42012-03-26 10:27:17 +02001383 $ctype = $this->_mime_types(pathinfo($filename, PATHINFO_EXTENSION));
Matteo Mattei5688d582012-03-13 19:29:29 +01001384 $file_content = fread($fp, $file);
1385 fclose($fp);
1386 }
1387 else
1388 {
Andrey Andreevb8f9a152012-10-27 01:36:51 +03001389 $file_content =& $this->_attachments[$i]['name'][0];
Matteo Mattei5688d582012-03-13 19:29:29 +01001390 }
Andrey Andreev56454792012-05-17 14:32:19 +03001391
1392 $attachment[$z++] = '--'.$this->_atc_boundary.$this->newline
1393 .'Content-type: '.$ctype.'; '
1394 .'name="'.$basename.'"'.$this->newline
Andrey Andreevb8f9a152012-10-27 01:36:51 +03001395 .'Content-Disposition: '.$this->_attachments[$i]['disposition'].';'.$this->newline
Andrey Andreev56454792012-05-17 14:32:19 +03001396 .'Content-Transfer-Encoding: base64'.$this->newline;
Derek Allard2067d1a2008-11-13 22:59:24 +00001397
Matteo Mattei5688d582012-03-13 19:29:29 +01001398 $attachment[$z++] = chunk_split(base64_encode($file_content));
Derek Allard2067d1a2008-11-13 22:59:24 +00001399 }
1400
Andrey Andreev56454792012-05-17 14:32:19 +03001401 $body .= implode($this->newline, $attachment).$this->newline.'--'.$this->_atc_boundary.'--';
Andrey Andreev2b956af2013-08-07 14:32:56 +03001402 $this->_finalbody = ($this->_get_protocol() === 'mail')
1403 ? $body
1404 : $hdr.$this->newline.$this->newline.$body;
buhay466e8082013-04-17 14:25:34 -07001405 return TRUE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001406 }
Barry Mienydd671972010-10-04 16:33:58 +02001407
Derek Allard2067d1a2008-11-13 22:59:24 +00001408 // --------------------------------------------------------------------
1409
1410 /**
1411 * Prep Quoted Printable
1412 *
1413 * Prepares string for Quoted-Printable Content-Transfer-Encoding
1414 * Refer to RFC 2045 http://www.ietf.org/rfc/rfc2045.txt
1415 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001416 * @param string
Derek Allard2067d1a2008-11-13 22:59:24 +00001417 * @return string
1418 */
Andrey Andreev683b34d2012-10-09 15:00:00 +03001419 protected function _prep_quoted_printable($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001420 {
Andrey Andreev00ea2a92012-10-18 14:59:29 +03001421 // We are intentionally wrapping so mail servers will encode characters
1422 // properly and MUAs will behave, so {unwrap} must go!
1423 $str = str_replace(array('{unwrap}', '{/unwrap}'), '', $str);
1424
Andrey Andreev683b34d2012-10-09 15:00:00 +03001425 // RFC 2045 specifies CRLF as "\r\n".
1426 // However, many developers choose to override that and violate
1427 // the RFC rules due to (apparently) a bug in MS Exchange,
1428 // which only works with "\n".
Andrey Andreev26f0cf92012-10-11 13:52:39 +03001429 if ($this->crlf === "\r\n")
Andrey Andreev683b34d2012-10-09 15:00:00 +03001430 {
Andrey Andreev26f0cf92012-10-11 13:52:39 +03001431 if (is_php('5.3'))
1432 {
1433 return quoted_printable_encode($str);
1434 }
1435 elseif (function_exists('imap_8bit'))
1436 {
1437 return imap_8bit($str);
1438 }
Andrey Andreev683b34d2012-10-09 15:00:00 +03001439 }
1440
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001441 // Reduce multiple spaces & remove nulls
Andrey Andreev56454792012-05-17 14:32:19 +03001442 $str = preg_replace(array('| +|', '/\x00+/'), array(' ', ''), $str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001443
1444 // Standardize newlines
1445 if (strpos($str, "\r") !== FALSE)
1446 {
1447 $str = str_replace(array("\r\n", "\r"), "\n", $str);
1448 }
1449
Derek Allard2067d1a2008-11-13 22:59:24 +00001450 $escape = '=';
1451 $output = '';
1452
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001453 foreach (explode("\n", $str) as $line)
Derek Allard2067d1a2008-11-13 22:59:24 +00001454 {
1455 $length = strlen($line);
1456 $temp = '';
1457
1458 // Loop through each character in the line to add soft-wrap
1459 // characters at the end of a line " =\r\n" and add the newly
1460 // processed line(s) to the output (see comment on $crlf class property)
1461 for ($i = 0; $i < $length; $i++)
1462 {
1463 // Grab the next character
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001464 $char = $line[$i];
Derek Allard2067d1a2008-11-13 22:59:24 +00001465 $ascii = ord($char);
1466
1467 // Convert spaces and tabs but only if it's the end of the line
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001468 if ($i === ($length - 1) && ($ascii === 32 OR $ascii === 9))
Derek Allard2067d1a2008-11-13 22:59:24 +00001469 {
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001470 $char = $escape.sprintf('%02s', dechex($ascii));
Derek Allard2067d1a2008-11-13 22:59:24 +00001471 }
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001472 elseif ($ascii === 61) // encode = signs
Derek Allard2067d1a2008-11-13 22:59:24 +00001473 {
Derek Jones37f4b9c2011-07-01 17:56:50 -05001474 $char = $escape.strtoupper(sprintf('%02s', dechex($ascii))); // =3D
Derek Allard2067d1a2008-11-13 22:59:24 +00001475 }
1476
1477 // If we're at the character limit, add the line to the output,
1478 // reset our temp variable, and keep on chuggin'
Andrey Andreeve8bc5f42012-10-10 11:13:59 +03001479 if ((strlen($temp) + strlen($char)) >= 76)
Derek Allard2067d1a2008-11-13 22:59:24 +00001480 {
1481 $output .= $temp.$escape.$this->crlf;
1482 $temp = '';
1483 }
1484
1485 // Add the character to our temporary line
1486 $temp .= $char;
1487 }
1488
1489 // Add our completed line to the output
1490 $output .= $temp.$this->crlf;
1491 }
1492
1493 // get rid of extra CRLF tacked onto the end
Andrey Andreev59c5b532012-03-01 14:09:51 +02001494 return substr($output, 0, strlen($this->crlf) * -1);
Derek Allard2067d1a2008-11-13 22:59:24 +00001495 }
1496
1497 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001498
Derek Allard2067d1a2008-11-13 22:59:24 +00001499 /**
1500 * Prep Q Encoding
1501 *
Andrey Andreev925dd902012-10-19 11:06:31 +03001502 * Performs "Q Encoding" on a string for use in email headers.
1503 * It's related but not identical to quoted-printable, so it has its
1504 * own method.
Derek Allard2067d1a2008-11-13 22:59:24 +00001505 *
Andrey Andreev081c9462012-03-01 12:58:11 +02001506 * @param string
Andrey Andreev081c9462012-03-01 12:58:11 +02001507 * @return string
Derek Allard2067d1a2008-11-13 22:59:24 +00001508 */
Andrey Andreev925dd902012-10-19 11:06:31 +03001509 protected function _prep_q_encoding($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001510 {
Andrey Andreev925dd902012-10-19 11:06:31 +03001511 $str = str_replace(array("\r", "\n"), '', $str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001512
Andrey Andreev925dd902012-10-19 11:06:31 +03001513 if ($this->charset === 'UTF-8')
Derek Allard2067d1a2008-11-13 22:59:24 +00001514 {
Andrey Andreev925dd902012-10-19 11:06:31 +03001515 if (MB_ENABLED === TRUE)
1516 {
1517 return mb_encode_mimeheader($str, $this->charset, 'Q', $this->crlf);
1518 }
1519 elseif (extension_loaded('iconv'))
1520 {
1521 $output = @iconv_mime_encode('', $str,
1522 array(
1523 'scheme' => 'Q',
1524 'line-length' => 76,
1525 'input-charset' => $this->charset,
1526 'output-charset' => $this->charset,
1527 'line-break-chars' => $this->crlf
1528 )
1529 );
1530
1531 // There are reports that iconv_mime_encode() might fail and return FALSE
1532 if ($output !== FALSE)
1533 {
1534 // iconv_mime_encode() will always put a header field name.
1535 // We've passed it an empty one, but it still prepends our
1536 // encoded string with ': ', so we need to strip it.
1537 return substr($output, 2);
1538 }
1539
1540 $chars = iconv_strlen($str, 'UTF-8');
1541 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001542 }
1543
Andrey Andreev925dd902012-10-19 11:06:31 +03001544 // We might already have this set for UTF-8
1545 isset($chars) OR $chars = strlen($str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001546
Andrey Andreev925dd902012-10-19 11:06:31 +03001547 $output = '=?'.$this->charset.'?Q?';
1548 for ($i = 0, $length = strlen($output), $iconv = extension_loaded('iconv'); $i < $chars; $i++)
Derek Allard2067d1a2008-11-13 22:59:24 +00001549 {
Andrey Andreev925dd902012-10-19 11:06:31 +03001550 $chr = ($this->charset === 'UTF-8' && $iconv === TRUE)
1551 ? '='.implode('=', str_split(strtoupper(bin2hex(iconv_substr($str, $i, 1, $this->charset))), 2))
1552 : '='.strtoupper(bin2hex($str[$i]));
Derek Allard2067d1a2008-11-13 22:59:24 +00001553
Andrey Andreev925dd902012-10-19 11:06:31 +03001554 // RFC 2045 sets a limit of 76 characters per line.
1555 // We'll append ?= to the end of each line though.
1556 if ($length + ($l = strlen($chr)) > 74)
Derek Allard2067d1a2008-11-13 22:59:24 +00001557 {
Andrey Andreev925dd902012-10-19 11:06:31 +03001558 $output .= '?='.$this->crlf // EOL
1559 .' =?'.$this->charset.'?Q?'.$chr; // New line
1560 $length = 6 + strlen($this->charset) + $l; // Reset the length for the new line
Derek Allard2067d1a2008-11-13 22:59:24 +00001561 }
Andrey Andreev925dd902012-10-19 11:06:31 +03001562 else
Derek Allard2067d1a2008-11-13 22:59:24 +00001563 {
Andrey Andreev925dd902012-10-19 11:06:31 +03001564 $output .= $chr;
1565 $length += $l;
Derek Allard2067d1a2008-11-13 22:59:24 +00001566 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001567 }
1568
Andrey Andreev925dd902012-10-19 11:06:31 +03001569 // End the header
1570 return $output.'?=';
Derek Allard2067d1a2008-11-13 22:59:24 +00001571 }
1572
1573 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001574
Derek Allard2067d1a2008-11-13 22:59:24 +00001575 /**
1576 * Send Email
1577 *
Andrey Andreev5fd3ae82012-10-24 14:55:35 +03001578 * @param bool $auto_clear = TRUE
Derek Allard2067d1a2008-11-13 22:59:24 +00001579 * @return bool
1580 */
Alex Bilbied7bc8d02012-07-30 09:46:20 +01001581 public function send($auto_clear = TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +00001582 {
Alex Bilbied261b1e2012-06-02 11:12:16 +01001583 if ($this->_replyto_flag === FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +00001584 {
1585 $this->reply_to($this->_headers['From']);
1586 }
1587
Andrey Andreev76f15c92012-03-01 13:05:07 +02001588 if ( ! isset($this->_recipients) && ! isset($this->_headers['To'])
1589 && ! isset($this->_bcc_array) && ! isset($this->_headers['Bcc'])
1590 && ! isset($this->_headers['Cc']))
Derek Allard2067d1a2008-11-13 22:59:24 +00001591 {
patworkb0707982011-04-08 15:10:05 +02001592 $this->_set_error_message('lang:email_no_recipients');
Derek Allard2067d1a2008-11-13 22:59:24 +00001593 return FALSE;
1594 }
1595
1596 $this->_build_headers();
1597
Andrey Andreev76f15c92012-03-01 13:05:07 +02001598 if ($this->bcc_batch_mode && count($this->_bcc_array) > $this->bcc_batch_size)
Derek Allard2067d1a2008-11-13 22:59:24 +00001599 {
Alex Bilbieb901e732012-07-30 09:44:57 +01001600 $result = $this->batch_bcc_send();
Alex Bilbied7bc8d02012-07-30 09:46:20 +01001601
Alex Bilbiea87aab32012-07-30 09:50:37 +01001602 if ($result && $auto_clear)
Alex Bilbied7bc8d02012-07-30 09:46:20 +01001603 {
1604 $this->clear();
1605 }
1606
Alex Bilbieb901e732012-07-30 09:44:57 +01001607 return $result;
Derek Allard2067d1a2008-11-13 22:59:24 +00001608 }
1609
buhay466e8082013-04-17 14:25:34 -07001610 if ($this->_build_message() === FALSE)
1611 {
1612 return FALSE;
1613 }
buhayc6da1ef2013-04-18 09:06:49 -07001614
Alex Bilbieb901e732012-07-30 09:44:57 +01001615 $result = $this->_spool_email();
Andrey Andreevbdb99992012-07-30 17:38:05 +03001616
Alex Bilbiea87aab32012-07-30 09:50:37 +01001617 if ($result && $auto_clear)
Alex Bilbied7bc8d02012-07-30 09:46:20 +01001618 {
1619 $this->clear();
1620 }
Alex Bilbiea87aab32012-07-30 09:50:37 +01001621
Alex Bilbieb901e732012-07-30 09:44:57 +01001622 return $result;
Derek Allard2067d1a2008-11-13 22:59:24 +00001623 }
Barry Mienydd671972010-10-04 16:33:58 +02001624
Derek Allard2067d1a2008-11-13 22:59:24 +00001625 // --------------------------------------------------------------------
1626
1627 /**
Andrey Andreev081c9462012-03-01 12:58:11 +02001628 * Batch Bcc Send. Sends groups of BCCs in batches
Derek Allard2067d1a2008-11-13 22:59:24 +00001629 *
Andrey Andreev081c9462012-03-01 12:58:11 +02001630 * @return void
Derek Allard2067d1a2008-11-13 22:59:24 +00001631 */
Phil Sturgeona0f980e2011-01-13 10:59:12 +00001632 public function batch_bcc_send()
Derek Allard2067d1a2008-11-13 22:59:24 +00001633 {
Andrey Andreev59c5b532012-03-01 14:09:51 +02001634 $float = $this->bcc_batch_size - 1;
1635 $set = '';
Derek Allard2067d1a2008-11-13 22:59:24 +00001636 $chunk = array();
1637
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001638 for ($i = 0, $c = count($this->_bcc_array); $i < $c; $i++)
Derek Allard2067d1a2008-11-13 22:59:24 +00001639 {
1640 if (isset($this->_bcc_array[$i]))
1641 {
Andrey Andreev59c5b532012-03-01 14:09:51 +02001642 $set .= ', '.$this->_bcc_array[$i];
Derek Allard2067d1a2008-11-13 22:59:24 +00001643 }
1644
Alex Bilbied261b1e2012-06-02 11:12:16 +01001645 if ($i === $float)
Derek Allard2067d1a2008-11-13 22:59:24 +00001646 {
1647 $chunk[] = substr($set, 1);
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001648 $float += $this->bcc_batch_size;
Andrey Andreev59c5b532012-03-01 14:09:51 +02001649 $set = '';
Derek Allard2067d1a2008-11-13 22:59:24 +00001650 }
1651
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001652 if ($i === $c-1)
Derek Allard2067d1a2008-11-13 22:59:24 +00001653 {
1654 $chunk[] = substr($set, 1);
1655 }
1656 }
1657
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001658 for ($i = 0, $c = count($chunk); $i < $c; $i++)
Derek Allard2067d1a2008-11-13 22:59:24 +00001659 {
1660 unset($this->_headers['Bcc']);
Derek Allard2067d1a2008-11-13 22:59:24 +00001661
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001662 $bcc = $this->clean_email($this->_str_to_array($chunk[$i]));
Derek Allard2067d1a2008-11-13 22:59:24 +00001663
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001664 if ($this->protocol !== 'smtp')
Derek Allard2067d1a2008-11-13 22:59:24 +00001665 {
Mickey Wubfc1cad2012-05-31 22:28:40 -07001666 $this->set_header('Bcc', implode(', ', $bcc));
Derek Allard2067d1a2008-11-13 22:59:24 +00001667 }
1668 else
1669 {
1670 $this->_bcc_array = $bcc;
1671 }
1672
buhay466e8082013-04-17 14:25:34 -07001673 if ($this->_build_message() === FALSE)
1674 {
1675 return FALSE;
1676 }
buhayc6da1ef2013-04-18 09:06:49 -07001677
Derek Allard2067d1a2008-11-13 22:59:24 +00001678 $this->_spool_email();
1679 }
1680 }
Barry Mienydd671972010-10-04 16:33:58 +02001681
Derek Allard2067d1a2008-11-13 22:59:24 +00001682 // --------------------------------------------------------------------
1683
1684 /**
1685 * Unwrap special elements
1686 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001687 * @return void
1688 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06001689 protected function _unwrap_specials()
Derek Allard2067d1a2008-11-13 22:59:24 +00001690 {
Andrey Andreev56454792012-05-17 14:32:19 +03001691 $this->_finalbody = preg_replace_callback('/\{unwrap\}(.*?)\{\/unwrap\}/si', array($this, '_remove_nl_callback'), $this->_finalbody);
Derek Allard2067d1a2008-11-13 22:59:24 +00001692 }
Barry Mienydd671972010-10-04 16:33:58 +02001693
Derek Allard2067d1a2008-11-13 22:59:24 +00001694 // --------------------------------------------------------------------
1695
1696 /**
1697 * Strip line-breaks via callback
1698 *
Andrey Andreev5fd3ae82012-10-24 14:55:35 +03001699 * @param string $matches
Derek Allard2067d1a2008-11-13 22:59:24 +00001700 * @return string
1701 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06001702 protected function _remove_nl_callback($matches)
Derek Allard2067d1a2008-11-13 22:59:24 +00001703 {
1704 if (strpos($matches[1], "\r") !== FALSE OR strpos($matches[1], "\n") !== FALSE)
1705 {
1706 $matches[1] = str_replace(array("\r\n", "\r", "\n"), '', $matches[1]);
1707 }
1708
1709 return $matches[1];
1710 }
Barry Mienydd671972010-10-04 16:33:58 +02001711
Derek Allard2067d1a2008-11-13 22:59:24 +00001712 // --------------------------------------------------------------------
1713
1714 /**
1715 * Spool mail to the mail server
1716 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001717 * @return bool
1718 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06001719 protected function _spool_email()
Derek Allard2067d1a2008-11-13 22:59:24 +00001720 {
1721 $this->_unwrap_specials();
1722
Andrey Andreev56454792012-05-17 14:32:19 +03001723 $method = '_send_with_'.$this->_get_protocol();
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001724 if ( ! $this->$method())
Derek Allard2067d1a2008-11-13 22:59:24 +00001725 {
Andrey Andreev56454792012-05-17 14:32:19 +03001726 $this->_set_error_message('lang:email_send_failure_'.($this->_get_protocol() === 'mail' ? 'phpmail' : $this->_get_protocol()));
Diogo Osório7fcc7bd2012-03-02 16:54:52 +00001727 return FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001728 }
1729
patworkb0707982011-04-08 15:10:05 +02001730 $this->_set_error_message('lang:email_sent', $this->_get_protocol());
Derek Allard2067d1a2008-11-13 22:59:24 +00001731 return TRUE;
1732 }
Barry Mienydd671972010-10-04 16:33:58 +02001733
Derek Allard2067d1a2008-11-13 22:59:24 +00001734 // --------------------------------------------------------------------
1735
1736 /**
1737 * Send using mail()
1738 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001739 * @return bool
1740 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06001741 protected function _send_with_mail()
Derek Allard2067d1a2008-11-13 22:59:24 +00001742 {
Andrey Andreev8a7078b2012-10-17 10:52:49 +03001743 if (is_array($this->_recipients))
1744 {
1745 $this->_recipients = implode(', ', $this->_recipients);
1746 }
1747
Alex Bilbied261b1e2012-06-02 11:12:16 +01001748 if ($this->_safe_mode === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +00001749 {
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001750 return mail($this->_recipients, $this->_subject, $this->_finalbody, $this->_header_str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001751 }
1752 else
1753 {
1754 // most documentation of sendmail using the "-f" flag lacks a space after it, however
1755 // we've encountered servers that seem to require it to be in place.
Melounek58dfc082012-06-29 08:43:47 +02001756 return mail($this->_recipients, $this->_subject, $this->_finalbody, $this->_header_str, '-f '.$this->clean_email($this->_headers['Return-Path']));
Derek Allard2067d1a2008-11-13 22:59:24 +00001757 }
1758 }
Barry Mienydd671972010-10-04 16:33:58 +02001759
Derek Allard2067d1a2008-11-13 22:59:24 +00001760 // --------------------------------------------------------------------
1761
1762 /**
1763 * Send using Sendmail
1764 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001765 * @return bool
1766 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06001767 protected function _send_with_sendmail()
Derek Allard2067d1a2008-11-13 22:59:24 +00001768 {
Andrey Andreeve9d2dc82012-11-07 14:23:29 +02001769 // is popen() enabled?
1770 if ( ! function_usable('popen')
1771 OR FALSE === ($fp = @popen(
1772 $this->mailpath.' -oi -f '.$this->clean_email($this->_headers['From'])
1773 .' -t -r '.$this->clean_email($this->_headers['Return-Path'])
1774 , 'w'))
1775 ) // server probably has popen disabled, so nothing we can do to get a verbose error.
Derek Jones4cefaa42009-04-29 19:13:56 +00001776 {
Derek Jones4cefaa42009-04-29 19:13:56 +00001777 return FALSE;
1778 }
Derek Jones71141ce2010-03-02 16:41:20 -06001779
Derek Jonesc630bcf2008-11-17 21:09:45 +00001780 fputs($fp, $this->_header_str);
1781 fputs($fp, $this->_finalbody);
1782
Barry Mienydd671972010-10-04 16:33:58 +02001783 $status = pclose($fp);
Eric Barnes6113f542010-12-29 13:36:12 -05001784
Andrey Andreev1bd3d882011-12-22 15:38:20 +02001785 if ($status !== 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00001786 {
patworkb0707982011-04-08 15:10:05 +02001787 $this->_set_error_message('lang:email_exit_status', $status);
1788 $this->_set_error_message('lang:email_no_socket');
Derek Allard2067d1a2008-11-13 22:59:24 +00001789 return FALSE;
1790 }
1791
Derek Allard2067d1a2008-11-13 22:59:24 +00001792 return TRUE;
1793 }
Barry Mienydd671972010-10-04 16:33:58 +02001794
Derek Allard2067d1a2008-11-13 22:59:24 +00001795 // --------------------------------------------------------------------
1796
1797 /**
1798 * Send using SMTP
1799 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001800 * @return bool
1801 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06001802 protected function _send_with_smtp()
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301803 {
1804 if ($this->smtp_host === '')
1805 {
1806 $this->_set_error_message('lang:email_no_hostname');
1807 return FALSE;
1808 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001809
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301810 if ( ! $this->_smtp_connect() OR ! $this->_smtp_authenticate())
1811 {
1812 return FALSE;
1813 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001814
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301815 $this->_send_command('from', $this->clean_email($this->_headers['From']));
Derek Allard2067d1a2008-11-13 22:59:24 +00001816
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301817 foreach ($this->_recipients as $val)
1818 {
1819 $this->_send_command('to', $val);
1820 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001821
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301822 if (count($this->_cc_array) > 0)
1823 {
1824 foreach ($this->_cc_array as $val)
1825 {
1826 if ($val !== '')
1827 {
1828 $this->_send_command('to', $val);
1829 }
1830 }
1831 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001832
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301833 if (count($this->_bcc_array) > 0)
1834 {
1835 foreach ($this->_bcc_array as $val)
1836 {
1837 if ($val !== '')
1838 {
1839 $this->_send_command('to', $val);
1840 }
1841 }
1842 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001843
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301844 $this->_send_command('data');
Derek Allard2067d1a2008-11-13 22:59:24 +00001845
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301846 // perform dot transformation on any lines that begin with a dot
1847 $this->_send_data($this->_header_str.preg_replace('/^\./m', '..$1', $this->_finalbody));
Derek Allard2067d1a2008-11-13 22:59:24 +00001848
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301849 $this->_send_data('.');
Derek Allard2067d1a2008-11-13 22:59:24 +00001850
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301851 $reply = $this->_get_smtp_data();
Derek Allard2067d1a2008-11-13 22:59:24 +00001852
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301853 $this->_set_error_message($reply);
Derek Allard2067d1a2008-11-13 22:59:24 +00001854
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301855 if (strpos($reply, '250') !== 0)
1856 {
1857 $this->_set_error_message('lang:email_smtp_error', $reply);
1858 return FALSE;
1859 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001860
nisheeth-barthwal758f40c2013-02-18 17:18:51 +05301861 if ($this->smtp_keepalive)
1862 {
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301863 $this->_send_command('reset');
nisheeth-barthwal758f40c2013-02-18 17:18:51 +05301864 }
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301865 else
nisheeth-barthwal758f40c2013-02-18 17:18:51 +05301866 {
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301867 $this->_send_command('quit');
nisheeth-barthwal758f40c2013-02-18 17:18:51 +05301868 }
Barry Mienydd671972010-10-04 16:33:58 +02001869
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301870 return TRUE;
1871 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001872
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301873 // --------------------------------------------------------------------
Radu Potop4c589ae2011-09-29 10:19:55 +03001874
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301875 /**
1876 * SMTP Connect
1877 *
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301878 * @return string
1879 */
nisheeth-barthwala44e6912013-02-18 18:07:03 +05301880 protected function _smtp_connect()
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301881 {
nisheeth-barthwala44e6912013-02-18 18:07:03 +05301882 if (is_resource($this->_smtp_connect))
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301883 {
nisheeth-barthwala44e6912013-02-18 18:07:03 +05301884 return TRUE;
1885 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001886
Andrey Andreev89b67b42013-03-12 19:34:23 +02001887 $ssl = ($this->smtp_crypto === 'ssl') ? 'ssl://' : '';
Derek Allard2067d1a2008-11-13 22:59:24 +00001888
nisheeth-barthwala44e6912013-02-18 18:07:03 +05301889 $this->_smtp_connect = fsockopen($ssl.$this->smtp_host,
1890 $this->smtp_port,
1891 $errno,
1892 $errstr,
1893 $this->smtp_timeout);
1894
1895 if ( ! is_resource($this->_smtp_connect))
1896 {
1897 $this->_set_error_message('lang:email_smtp_error', $errno.' '.$errstr);
1898 return FALSE;
1899 }
1900
1901 stream_set_timeout($this->_smtp_connect, $this->smtp_timeout);
1902 $this->_set_error_message($this->_get_smtp_data());
1903
1904 if ($this->smtp_crypto === 'tls')
1905 {
1906 $this->_send_command('hello');
1907 $this->_send_command('starttls');
1908
1909 $crypto = stream_socket_enable_crypto($this->_smtp_connect, TRUE, STREAM_CRYPTO_METHOD_TLS_CLIENT);
1910
1911 if ($crypto !== TRUE)
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301912 {
nisheeth-barthwala44e6912013-02-18 18:07:03 +05301913 $this->_set_error_message('lang:email_smtp_error', $this->_get_smtp_data());
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301914 return FALSE;
1915 }
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301916 }
nisheeth-barthwala44e6912013-02-18 18:07:03 +05301917
1918 return $this->_send_command('hello');
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301919 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001920
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301921 // --------------------------------------------------------------------
Derek Allard2067d1a2008-11-13 22:59:24 +00001922
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301923 /**
1924 * Send SMTP command
1925 *
1926 * @param string
1927 * @param string
1928 * @return string
1929 */
1930 protected function _send_command($cmd, $data = '')
1931 {
1932 switch ($cmd)
1933 {
1934 case 'hello' :
Derek Allard2067d1a2008-11-13 22:59:24 +00001935
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301936 if ($this->_smtp_auth OR $this->_get_encoding() === '8bit')
1937 {
1938 $this->_send_data('EHLO '.$this->_get_hostname());
1939 }
1940 else
1941 {
1942 $this->_send_data('HELO '.$this->_get_hostname());
1943 }
Radu Potopbbf04b02011-09-28 13:57:51 +03001944
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301945 $resp = 250;
1946 break;
1947 case 'starttls' :
Derek Allard2067d1a2008-11-13 22:59:24 +00001948
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301949 $this->_send_data('STARTTLS');
1950 $resp = 220;
1951 break;
1952 case 'from' :
Andrey Andreev56454792012-05-17 14:32:19 +03001953
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301954 $this->_send_data('MAIL FROM:<'.$data.'>');
1955 $resp = 250;
1956 break;
1957 case 'to' :
Andrey Andreev56454792012-05-17 14:32:19 +03001958
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301959 if ($this->dsn)
1960 {
1961 $this->_send_data('RCPT TO:<'.$data.'> NOTIFY=SUCCESS,DELAY,FAILURE ORCPT=rfc822;'.$data);
1962 }
1963 else
1964 {
1965 $this->_send_data('RCPT TO:<'.$data.'>');
1966 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001967
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301968 $resp = 250;
1969 break;
1970 case 'data' :
Derek Allard2067d1a2008-11-13 22:59:24 +00001971
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301972 $this->_send_data('DATA');
1973 $resp = 354;
1974 break;
1975 case 'reset':
Derek Allard2067d1a2008-11-13 22:59:24 +00001976
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301977 $this->_send_data('RSET');
1978 $resp = 250;
1979 break;
1980 case 'quit' :
Derek Allard2067d1a2008-11-13 22:59:24 +00001981
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301982 $this->_send_data('QUIT');
1983 $resp = 221;
1984 break;
1985 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001986
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301987 $reply = $this->_get_smtp_data();
Derek Allard2067d1a2008-11-13 22:59:24 +00001988
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301989 $this->_debug_msg[] = '<pre>'.$cmd.': '.$reply.'</pre>';
Derek Allard2067d1a2008-11-13 22:59:24 +00001990
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301991 if ((int) substr($reply, 0, 3) !== $resp)
1992 {
1993 $this->_set_error_message('lang:email_smtp_error', $reply);
1994 return FALSE;
1995 }
Barry Mienydd671972010-10-04 16:33:58 +02001996
nisheeth-barthwal59209de2013-02-18 17:02:13 +05301997 if ($cmd === 'quit')
1998 {
1999 fclose($this->_smtp_connect);
2000 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002001
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302002 return TRUE;
2003 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002004
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302005 // --------------------------------------------------------------------
Derek Allard2067d1a2008-11-13 22:59:24 +00002006
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302007 /**
2008 * SMTP Authenticate
2009 *
2010 * @return bool
2011 */
2012 protected function _smtp_authenticate()
2013 {
2014 if ( ! $this->_smtp_auth)
2015 {
2016 return TRUE;
2017 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002018
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302019 if ($this->smtp_user === '' && $this->smtp_pass === '')
2020 {
2021 $this->_set_error_message('lang:email_no_smtp_unpw');
2022 return FALSE;
2023 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002024
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302025 $this->_send_data('AUTH LOGIN');
Derek Allard2067d1a2008-11-13 22:59:24 +00002026
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302027 $reply = $this->_get_smtp_data();
Derek Allard2067d1a2008-11-13 22:59:24 +00002028
Andrey Andreevfa01ae42013-03-04 14:40:18 +02002029 if (strpos($reply, '503') === 0) // Already authenticated
nisheeth-barthwal758f40c2013-02-18 17:18:51 +05302030 {
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302031 return TRUE;
nisheeth-barthwal758f40c2013-02-18 17:18:51 +05302032 }
Andrey Andreevfa01ae42013-03-04 14:40:18 +02002033 elseif (strpos($reply, '334') !== 0)
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302034 {
2035 $this->_set_error_message('lang:email_failed_smtp_login', $reply);
2036 return FALSE;
2037 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002038
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302039 $this->_send_data(base64_encode($this->smtp_user));
Derek Allard2067d1a2008-11-13 22:59:24 +00002040
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302041 $reply = $this->_get_smtp_data();
Derek Allard2067d1a2008-11-13 22:59:24 +00002042
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302043 if (strpos($reply, '334') !== 0)
2044 {
2045 $this->_set_error_message('lang:email_smtp_auth_un', $reply);
2046 return FALSE;
2047 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002048
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302049 $this->_send_data(base64_encode($this->smtp_pass));
Derek Allard2067d1a2008-11-13 22:59:24 +00002050
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302051 $reply = $this->_get_smtp_data();
nisheeth-barthwalcf225572013-02-18 01:08:04 +05302052
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302053 if (strpos($reply, '235') !== 0)
2054 {
2055 $this->_set_error_message('lang:email_smtp_auth_pw', $reply);
2056 return FALSE;
2057 }
nisheeth-barthwalcf225572013-02-18 01:08:04 +05302058
nisheeth-barthwal59209de2013-02-18 17:02:13 +05302059 return TRUE;
2060 }
Barry Mienydd671972010-10-04 16:33:58 +02002061
Derek Allard2067d1a2008-11-13 22:59:24 +00002062 // --------------------------------------------------------------------
2063
2064 /**
2065 * Send SMTP data
2066 *
Andrey Andreev5fd3ae82012-10-24 14:55:35 +03002067 * @param string $data
Derek Allard2067d1a2008-11-13 22:59:24 +00002068 * @return bool
2069 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06002070 protected function _send_data($data)
Derek Allard2067d1a2008-11-13 22:59:24 +00002071 {
Andrey Andreev5fd3ae82012-10-24 14:55:35 +03002072 if ( ! fwrite($this->_smtp_connect, $data.$this->newline))
Derek Allard2067d1a2008-11-13 22:59:24 +00002073 {
patworkb0707982011-04-08 15:10:05 +02002074 $this->_set_error_message('lang:email_smtp_data_failure', $data);
Derek Allard2067d1a2008-11-13 22:59:24 +00002075 return FALSE;
2076 }
Andrey Andreev1bd3d882011-12-22 15:38:20 +02002077
2078 return TRUE;
Derek Allard2067d1a2008-11-13 22:59:24 +00002079 }
Barry Mienydd671972010-10-04 16:33:58 +02002080
Derek Allard2067d1a2008-11-13 22:59:24 +00002081 // --------------------------------------------------------------------
2082
2083 /**
2084 * Get SMTP data
2085 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002086 * @return string
2087 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06002088 protected function _get_smtp_data()
Derek Allard2067d1a2008-11-13 22:59:24 +00002089 {
Andrey Andreev56454792012-05-17 14:32:19 +03002090 $data = '';
Derek Allard2067d1a2008-11-13 22:59:24 +00002091
2092 while ($str = fgets($this->_smtp_connect, 512))
2093 {
2094 $data .= $str;
2095
Alex Bilbied261b1e2012-06-02 11:12:16 +01002096 if ($str[3] === ' ')
Derek Allard2067d1a2008-11-13 22:59:24 +00002097 {
2098 break;
2099 }
2100 }
2101
2102 return $data;
2103 }
Barry Mienydd671972010-10-04 16:33:58 +02002104
Derek Allard2067d1a2008-11-13 22:59:24 +00002105 // --------------------------------------------------------------------
2106
2107 /**
2108 * Get Hostname
2109 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002110 * @return string
2111 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06002112 protected function _get_hostname()
Derek Allard2067d1a2008-11-13 22:59:24 +00002113 {
Andrey Andreev59c5b532012-03-01 14:09:51 +02002114 return isset($_SERVER['SERVER_NAME']) ? $_SERVER['SERVER_NAME'] : 'localhost.localdomain';
Derek Allard2067d1a2008-11-13 22:59:24 +00002115 }
Barry Mienydd671972010-10-04 16:33:58 +02002116
Derek Allard2067d1a2008-11-13 22:59:24 +00002117 // --------------------------------------------------------------------
2118
2119 /**
Derek Allard2067d1a2008-11-13 22:59:24 +00002120 * Get Debug Message
2121 *
Andrey Andreev61797f62012-11-26 16:15:12 +02002122 * @param array $include List of raw data chunks to include in the output
2123 * Valid options are: 'headers', 'subject', 'body'
Derek Allard2067d1a2008-11-13 22:59:24 +00002124 * @return string
2125 */
Andrey Andreev61797f62012-11-26 16:15:12 +02002126 public function print_debugger($include = array('headers', 'subject', 'body'))
Derek Allard2067d1a2008-11-13 22:59:24 +00002127 {
2128 $msg = '';
2129
2130 if (count($this->_debug_msg) > 0)
2131 {
2132 foreach ($this->_debug_msg as $val)
2133 {
2134 $msg .= $val;
2135 }
2136 }
2137
Andrey Andreev61797f62012-11-26 16:15:12 +02002138 // Determine which parts of our raw data needs to be printed
2139 $raw_data = '';
2140 is_array($include) OR $include = array($include);
2141
2142 if (in_array('headers', $include, TRUE))
2143 {
Andrey Andreev58f677f2013-07-16 11:01:37 +03002144 $raw_data = htmlspecialchars($this->_header_str)."\n";
Andrey Andreev61797f62012-11-26 16:15:12 +02002145 }
2146
2147 if (in_array('subject', $include, TRUE))
2148 {
2149 $raw_data .= htmlspecialchars($this->_subject)."\n";
2150 }
2151
2152 if (in_array('body', $include, TRUE))
2153 {
2154 $raw_data .= htmlspecialchars($this->_finalbody);
2155 }
2156
2157 return $msg.($raw_data === '' ? '' : '<pre>'.$raw_data.'</pre>');
Derek Allard2067d1a2008-11-13 22:59:24 +00002158 }
Barry Mienydd671972010-10-04 16:33:58 +02002159
Derek Allard2067d1a2008-11-13 22:59:24 +00002160 // --------------------------------------------------------------------
2161
2162 /**
2163 * Set Message
2164 *
Andrey Andreev5fd3ae82012-10-24 14:55:35 +03002165 * @param string $msg
2166 * @param string $val = ''
Andrey Andreev081c9462012-03-01 12:58:11 +02002167 * @return void
Derek Allard2067d1a2008-11-13 22:59:24 +00002168 */
Phil Sturgeon6d2f13a2011-07-20 10:04:52 -06002169 protected function _set_error_message($msg, $val = '')
Derek Allard2067d1a2008-11-13 22:59:24 +00002170 {
2171 $CI =& get_instance();
2172 $CI->lang->load('email');
2173
Andrey Andreev7a7ad782012-11-12 17:21:01 +02002174 if (sscanf($msg, 'lang:%s', $line) !== 1 OR FALSE === ($line = $CI->lang->line($line)))
Derek Allard2067d1a2008-11-13 22:59:24 +00002175 {
Andrey Andreev56454792012-05-17 14:32:19 +03002176 $this->_debug_msg[] = str_replace('%s', $val, $msg).'<br />';
Derek Allard2067d1a2008-11-13 22:59:24 +00002177 }
2178 else
2179 {
Andrey Andreev56454792012-05-17 14:32:19 +03002180 $this->_debug_msg[] = str_replace('%s', $val, $line).'<br />';
Derek Allard2067d1a2008-11-13 22:59:24 +00002181 }
2182 }
Barry Mienydd671972010-10-04 16:33:58 +02002183
Derek Allard2067d1a2008-11-13 22:59:24 +00002184 // --------------------------------------------------------------------
2185
2186 /**
2187 * Mime Types
2188 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002189 * @param string
2190 * @return string
2191 */
Andrey Andreev59c5b532012-03-01 14:09:51 +02002192 protected function _mime_types($ext = '')
Derek Allard2067d1a2008-11-13 22:59:24 +00002193 {
Andrey Andreev6ef498b2012-06-05 22:01:58 +03002194 static $mimes;
Derek Allard2067d1a2008-11-13 22:59:24 +00002195
Andrey Andreev6ef498b2012-06-05 22:01:58 +03002196 $ext = strtolower($ext);
2197
2198 if ( ! is_array($mimes))
2199 {
2200 $mimes =& get_mimes();
2201 }
2202
2203 if (isset($mimes[$ext]))
2204 {
2205 return is_array($mimes[$ext])
2206 ? current($mimes[$ext])
2207 : $mimes[$ext];
2208 }
2209
2210 return 'application/x-unknown-content-type';
Derek Allard2067d1a2008-11-13 22:59:24 +00002211 }
2212
2213}
Derek Allard2067d1a2008-11-13 22:59:24 +00002214
2215/* End of file Email.php */
Andrey Andreev50988592012-10-08 20:46:04 +03002216/* Location: ./system/libraries/Email.php */