[4414] | 1 | <?php |
---|
| 2 | /** |
---|
| 3 | * The Mail_Mime class is used to create MIME E-mail messages |
---|
| 4 | * |
---|
| 5 | * The Mail_Mime class provides an OO interface to create MIME |
---|
| 6 | * enabled email messages. This way you can create emails that |
---|
| 7 | * contain plain-text bodies, HTML bodies, attachments, inline |
---|
| 8 | * images and specific headers. |
---|
| 9 | * |
---|
| 10 | * Compatible with PHP versions 4 and 5 |
---|
| 11 | * |
---|
| 12 | * LICENSE: This LICENSE is in the BSD license style. |
---|
| 13 | * Copyright (c) 2002-2003, Richard Heyes <richard@phpguru.org> |
---|
| 14 | * Copyright (c) 2003-2006, PEAR <pear-group@php.net> |
---|
| 15 | * All rights reserved. |
---|
| 16 | * |
---|
| 17 | * Redistribution and use in source and binary forms, with or |
---|
| 18 | * without modification, are permitted provided that the following |
---|
| 19 | * conditions are met: |
---|
| 20 | * |
---|
| 21 | * - Redistributions of source code must retain the above copyright |
---|
| 22 | * notice, this list of conditions and the following disclaimer. |
---|
| 23 | * - Redistributions in binary form must reproduce the above copyright |
---|
| 24 | * notice, this list of conditions and the following disclaimer in the |
---|
| 25 | * documentation and/or other materials provided with the distribution. |
---|
| 26 | * - Neither the name of the authors, nor the names of its contributors |
---|
| 27 | * may be used to endorse or promote products derived from this |
---|
| 28 | * software without specific prior written permission. |
---|
| 29 | * |
---|
| 30 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
---|
| 31 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
---|
| 32 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
---|
| 33 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE |
---|
| 34 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
---|
| 35 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
---|
| 36 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
---|
| 37 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
---|
| 38 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
---|
| 39 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF |
---|
| 40 | * THE POSSIBILITY OF SUCH DAMAGE. |
---|
| 41 | * |
---|
| 42 | * @category Mail |
---|
| 43 | * @package Mail_Mime |
---|
| 44 | * @author Richard Heyes <richard@phpguru.org> |
---|
| 45 | * @author Tomas V.V. Cox <cox@idecnet.com> |
---|
| 46 | * @author Cipriano Groenendal <cipri@php.net> |
---|
| 47 | * @author Sean Coates <sean@php.net> |
---|
| 48 | * @author Aleksander Machniak <alec@php.net> |
---|
| 49 | * @copyright 2003-2006 PEAR <pear-group@php.net> |
---|
| 50 | * @license http://www.opensource.org/licenses/bsd-license.php BSD License |
---|
| 51 | * @version CVS: $Id: mime.php 305690 2010-11-23 12:41:00Z alec $ |
---|
| 52 | * @link http://pear.php.net/package/Mail_mime |
---|
| 53 | * |
---|
| 54 | * This class is based on HTML Mime Mail class from |
---|
| 55 | * Richard Heyes <richard@phpguru.org> which was based also |
---|
| 56 | * in the mime_mail.class by Tobias Ratschiller <tobias@dnet.it> |
---|
| 57 | * and Sascha Schumann <sascha@schumann.cx> |
---|
| 58 | */ |
---|
| 59 | |
---|
| 60 | |
---|
| 61 | /** |
---|
| 62 | * require PEAR |
---|
| 63 | * |
---|
| 64 | * This package depends on PEAR to raise errors. |
---|
| 65 | */ |
---|
[5316] | 66 | require_once dirname(__FILE__).'/../PEAR/PEAR.php'; |
---|
[4414] | 67 | |
---|
| 68 | /** |
---|
| 69 | * require Mail_mimePart |
---|
| 70 | * |
---|
| 71 | * Mail_mimePart contains the code required to |
---|
| 72 | * create all the different parts a mail can |
---|
| 73 | * consist of. |
---|
| 74 | */ |
---|
| 75 | //require_once 'Mail/mimePart.php'; |
---|
| 76 | |
---|
| 77 | |
---|
| 78 | /** |
---|
| 79 | * The Mail_Mime class provides an OO interface to create MIME |
---|
| 80 | * enabled email messages. This way you can create emails that |
---|
| 81 | * contain plain-text bodies, HTML bodies, attachments, inline |
---|
| 82 | * images and specific headers. |
---|
| 83 | * |
---|
| 84 | * @category Mail |
---|
| 85 | * @package Mail_Mime |
---|
| 86 | * @author Richard Heyes <richard@phpguru.org> |
---|
| 87 | * @author Tomas V.V. Cox <cox@idecnet.com> |
---|
| 88 | * @author Cipriano Groenendal <cipri@php.net> |
---|
| 89 | * @author Sean Coates <sean@php.net> |
---|
| 90 | * @copyright 2003-2006 PEAR <pear-group@php.net> |
---|
| 91 | * @license http://www.opensource.org/licenses/bsd-license.php BSD License |
---|
| 92 | * @version Release: @package_version@ |
---|
| 93 | * @link http://pear.php.net/package/Mail_mime |
---|
| 94 | */ |
---|
| 95 | class Mail_mime |
---|
| 96 | { |
---|
| 97 | /** |
---|
| 98 | * Contains the plain text part of the email |
---|
| 99 | * |
---|
| 100 | * @var string |
---|
| 101 | * @access private |
---|
| 102 | */ |
---|
| 103 | var $_txtbody; |
---|
| 104 | |
---|
| 105 | /** |
---|
| 106 | * Contains the html part of the email |
---|
| 107 | * |
---|
| 108 | * @var string |
---|
| 109 | * @access private |
---|
| 110 | */ |
---|
| 111 | var $_htmlbody; |
---|
| 112 | |
---|
| 113 | /** |
---|
| 114 | * list of the attached images |
---|
| 115 | * |
---|
| 116 | * @var array |
---|
| 117 | * @access private |
---|
| 118 | */ |
---|
| 119 | var $_html_images = array(); |
---|
| 120 | |
---|
| 121 | /** |
---|
| 122 | * list of the attachements |
---|
| 123 | * |
---|
| 124 | * @var array |
---|
| 125 | * @access private |
---|
| 126 | */ |
---|
| 127 | var $_parts = array(); |
---|
| 128 | |
---|
| 129 | /** |
---|
| 130 | * Headers for the mail |
---|
| 131 | * |
---|
| 132 | * @var array |
---|
| 133 | * @access private |
---|
| 134 | */ |
---|
| 135 | var $_headers = array(); |
---|
| 136 | |
---|
| 137 | /** |
---|
| 138 | * Build parameters |
---|
| 139 | * |
---|
| 140 | * @var array |
---|
| 141 | * @access private |
---|
| 142 | */ |
---|
| 143 | var $_build_params = array( |
---|
| 144 | // What encoding to use for the headers |
---|
| 145 | // Options: quoted-printable or base64 |
---|
| 146 | 'head_encoding' => 'quoted-printable', |
---|
| 147 | // What encoding to use for plain text |
---|
| 148 | // Options: 7bit, 8bit, base64, or quoted-printable |
---|
| 149 | 'text_encoding' => 'quoted-printable', |
---|
| 150 | // What encoding to use for html |
---|
| 151 | // Options: 7bit, 8bit, base64, or quoted-printable |
---|
| 152 | 'html_encoding' => 'quoted-printable', |
---|
| 153 | // The character set to use for html |
---|
| 154 | 'html_charset' => 'ISO-8859-1', |
---|
| 155 | // The character set to use for text |
---|
| 156 | 'text_charset' => 'ISO-8859-1', |
---|
| 157 | // The character set to use for headers |
---|
| 158 | 'head_charset' => 'ISO-8859-1', |
---|
| 159 | // End-of-line sequence |
---|
| 160 | 'eol' => "\r\n", |
---|
| 161 | // Delay attachment files IO until building the message |
---|
| 162 | 'delay_file_io' => false |
---|
| 163 | ); |
---|
| 164 | |
---|
| 165 | /** |
---|
| 166 | * Constructor function |
---|
| 167 | * |
---|
| 168 | * @param mixed $params Build parameters that change the way the email |
---|
| 169 | * is built. Should be an associative array. |
---|
| 170 | * See $_build_params. |
---|
| 171 | * |
---|
| 172 | * @return void |
---|
| 173 | * @access public |
---|
| 174 | */ |
---|
| 175 | function Mail_mime($params = array()) |
---|
| 176 | { |
---|
| 177 | // Backward-compatible EOL setting |
---|
| 178 | if (is_string($params)) { |
---|
| 179 | $this->_build_params['eol'] = $params; |
---|
| 180 | } else if (defined('MAIL_MIME_CRLF') && !isset($params['eol'])) { |
---|
| 181 | $this->_build_params['eol'] = MAIL_MIME_CRLF; |
---|
| 182 | } |
---|
| 183 | |
---|
| 184 | // Update build parameters |
---|
| 185 | if (!empty($params) && is_array($params)) { |
---|
| 186 | while (list($key, $value) = each($params)) { |
---|
| 187 | $this->_build_params[$key] = $value; |
---|
| 188 | } |
---|
| 189 | } |
---|
| 190 | } |
---|
| 191 | |
---|
| 192 | /** |
---|
| 193 | * Set build parameter value |
---|
| 194 | * |
---|
| 195 | * @param string $name Parameter name |
---|
| 196 | * @param string $value Parameter value |
---|
| 197 | * |
---|
| 198 | * @return void |
---|
| 199 | * @access public |
---|
| 200 | * @since 1.6.0 |
---|
| 201 | */ |
---|
| 202 | function setParam($name, $value) |
---|
| 203 | { |
---|
| 204 | $this->_build_params[$name] = $value; |
---|
| 205 | } |
---|
| 206 | |
---|
| 207 | /** |
---|
| 208 | * Get build parameter value |
---|
| 209 | * |
---|
| 210 | * @param string $name Parameter name |
---|
| 211 | * |
---|
| 212 | * @return mixed Parameter value |
---|
| 213 | * @access public |
---|
| 214 | * @since 1.6.0 |
---|
| 215 | */ |
---|
| 216 | function getParam($name) |
---|
| 217 | { |
---|
| 218 | return isset($this->_build_params[$name]) ? $this->_build_params[$name] : null; |
---|
| 219 | } |
---|
| 220 | |
---|
| 221 | /** |
---|
| 222 | * Accessor function to set the body text. Body text is used if |
---|
| 223 | * it's not an html mail being sent or else is used to fill the |
---|
| 224 | * text/plain part that emails clients who don't support |
---|
| 225 | * html should show. |
---|
| 226 | * |
---|
| 227 | * @param string $data Either a string or |
---|
| 228 | * the file name with the contents |
---|
| 229 | * @param bool $isfile If true the first param should be treated |
---|
| 230 | * as a file name, else as a string (default) |
---|
| 231 | * @param bool $append If true the text or file is appended to |
---|
| 232 | * the existing body, else the old body is |
---|
| 233 | * overwritten |
---|
| 234 | * |
---|
| 235 | * @return mixed True on success or PEAR_Error object |
---|
| 236 | * @access public |
---|
| 237 | */ |
---|
| 238 | function setTXTBody($data, $isfile = false, $append = false) |
---|
| 239 | { |
---|
| 240 | if (!$isfile) { |
---|
| 241 | if (!$append) { |
---|
| 242 | $this->_txtbody = $data; |
---|
| 243 | } else { |
---|
| 244 | $this->_txtbody .= $data; |
---|
| 245 | } |
---|
| 246 | } else { |
---|
| 247 | $cont = $this->_file2str($data); |
---|
| 248 | if (PEAR::isError($cont)) { |
---|
| 249 | return $cont; |
---|
| 250 | } |
---|
| 251 | if (!$append) { |
---|
| 252 | $this->_txtbody = $cont; |
---|
| 253 | } else { |
---|
| 254 | $this->_txtbody .= $cont; |
---|
| 255 | } |
---|
| 256 | } |
---|
| 257 | return true; |
---|
| 258 | } |
---|
| 259 | |
---|
| 260 | /** |
---|
| 261 | * Get message text body |
---|
| 262 | * |
---|
| 263 | * @return string Text body |
---|
| 264 | * @access public |
---|
| 265 | * @since 1.6.0 |
---|
| 266 | */ |
---|
| 267 | function getTXTBody() |
---|
| 268 | { |
---|
| 269 | return $this->_txtbody; |
---|
| 270 | } |
---|
| 271 | |
---|
| 272 | /** |
---|
| 273 | * Adds a html part to the mail. |
---|
| 274 | * |
---|
| 275 | * @param string $data Either a string or the file name with the |
---|
| 276 | * contents |
---|
| 277 | * @param bool $isfile A flag that determines whether $data is a |
---|
| 278 | * filename, or a string(false, default) |
---|
| 279 | * |
---|
| 280 | * @return bool True on success |
---|
| 281 | * @access public |
---|
| 282 | */ |
---|
| 283 | function setHTMLBody($data, $isfile = false) |
---|
| 284 | { |
---|
| 285 | if (!$isfile) { |
---|
| 286 | $this->_htmlbody = $data; |
---|
| 287 | } else { |
---|
| 288 | $cont = $this->_file2str($data); |
---|
| 289 | if (PEAR::isError($cont)) { |
---|
| 290 | return $cont; |
---|
| 291 | } |
---|
| 292 | $this->_htmlbody = $cont; |
---|
| 293 | } |
---|
| 294 | |
---|
| 295 | return true; |
---|
| 296 | } |
---|
| 297 | |
---|
| 298 | /** |
---|
| 299 | * Get message HTML body |
---|
| 300 | * |
---|
| 301 | * @return string HTML body |
---|
| 302 | * @access public |
---|
| 303 | * @since 1.6.0 |
---|
| 304 | */ |
---|
| 305 | function getHTMLBody() |
---|
| 306 | { |
---|
| 307 | return $this->_htmlbody; |
---|
| 308 | } |
---|
| 309 | |
---|
| 310 | /** |
---|
| 311 | * Adds an image to the list of embedded images. |
---|
| 312 | * |
---|
| 313 | * @param string $file The image file name OR image data itself |
---|
| 314 | * @param string $c_type The content type |
---|
| 315 | * @param string $name The filename of the image. |
---|
| 316 | * Only used if $file is the image data. |
---|
| 317 | * @param bool $isfile Whether $file is a filename or not. |
---|
| 318 | * Defaults to true |
---|
| 319 | * @param string $content_id Desired Content-ID of MIME part |
---|
| 320 | * Defaults to generated unique ID |
---|
| 321 | * |
---|
| 322 | * @return bool True on success |
---|
| 323 | * @access public |
---|
| 324 | */ |
---|
| 325 | function addHTMLImage($file, |
---|
| 326 | $c_type='application/octet-stream', |
---|
| 327 | $name = '', |
---|
| 328 | $isfile = true, |
---|
| 329 | $content_id = null |
---|
| 330 | ) { |
---|
| 331 | $bodyfile = null; |
---|
| 332 | |
---|
| 333 | if ($isfile) { |
---|
| 334 | // Don't load file into memory |
---|
| 335 | if ($this->_build_params['delay_file_io']) { |
---|
| 336 | $filedata = null; |
---|
| 337 | $bodyfile = $file; |
---|
| 338 | } else { |
---|
| 339 | if (PEAR::isError($filedata = $this->_file2str($file))) { |
---|
| 340 | return $filedata; |
---|
| 341 | } |
---|
| 342 | } |
---|
| 343 | $filename = ($name ? $name : $file); |
---|
| 344 | } else { |
---|
| 345 | $filedata = $file; |
---|
| 346 | $filename = $name; |
---|
| 347 | } |
---|
| 348 | |
---|
| 349 | if (!$content_id) { |
---|
| 350 | $content_id = md5(uniqid(time())); |
---|
| 351 | } |
---|
| 352 | |
---|
| 353 | $this->_html_images[] = array( |
---|
| 354 | 'body' => $filedata, |
---|
| 355 | 'body_file' => $bodyfile, |
---|
| 356 | 'name' => $filename, |
---|
| 357 | 'c_type' => $c_type, |
---|
| 358 | 'cid' => $content_id |
---|
| 359 | ); |
---|
| 360 | |
---|
| 361 | return true; |
---|
| 362 | } |
---|
| 363 | |
---|
| 364 | /** |
---|
| 365 | * Adds a file to the list of attachments. |
---|
| 366 | * |
---|
| 367 | * @param string $file The file name of the file to attach |
---|
| 368 | * or the file contents itself |
---|
| 369 | * @param string $c_type The content type |
---|
| 370 | * @param string $name The filename of the attachment |
---|
| 371 | * Only use if $file is the contents |
---|
| 372 | * @param bool $isfile Whether $file is a filename or not. Defaults to true |
---|
| 373 | * @param string $encoding The type of encoding to use. Defaults to base64. |
---|
| 374 | * Possible values: 7bit, 8bit, base64 or quoted-printable. |
---|
| 375 | * @param string $disposition The content-disposition of this file |
---|
| 376 | * Defaults to attachment. |
---|
| 377 | * Possible values: attachment, inline. |
---|
| 378 | * @param string $charset The character set of attachment's content. |
---|
| 379 | * @param string $language The language of the attachment |
---|
| 380 | * @param string $location The RFC 2557.4 location of the attachment |
---|
| 381 | * @param string $n_encoding Encoding of the attachment's name in Content-Type |
---|
| 382 | * By default filenames are encoded using RFC2231 method |
---|
| 383 | * Here you can set RFC2047 encoding (quoted-printable |
---|
| 384 | * or base64) instead |
---|
| 385 | * @param string $f_encoding Encoding of the attachment's filename |
---|
| 386 | * in Content-Disposition header. |
---|
| 387 | * @param string $description Content-Description header |
---|
| 388 | * @param string $h_charset The character set of the headers e.g. filename |
---|
| 389 | * If not specified, $charset will be used |
---|
| 390 | * |
---|
| 391 | * @return mixed True on success or PEAR_Error object |
---|
| 392 | * @access public |
---|
| 393 | */ |
---|
| 394 | function addAttachment($file, |
---|
| 395 | $c_type = 'application/octet-stream', |
---|
| 396 | $name = '', |
---|
| 397 | $isfile = true, |
---|
| 398 | $encoding = 'base64', |
---|
| 399 | $disposition = 'attachment', |
---|
| 400 | $charset = '', |
---|
| 401 | $language = '', |
---|
| 402 | $location = '', |
---|
| 403 | $n_encoding = null, |
---|
| 404 | $f_encoding = null, |
---|
| 405 | $description = '', |
---|
| 406 | $h_charset = null |
---|
| 407 | ) { |
---|
| 408 | $bodyfile = null; |
---|
| 409 | |
---|
| 410 | if ($isfile) { |
---|
| 411 | // Don't load file into memory |
---|
| 412 | if ($this->_build_params['delay_file_io']) { |
---|
| 413 | $filedata = null; |
---|
| 414 | $bodyfile = $file; |
---|
| 415 | } else { |
---|
| 416 | if (PEAR::isError($filedata = $this->_file2str($file))) { |
---|
| 417 | return $filedata; |
---|
| 418 | } |
---|
| 419 | } |
---|
| 420 | // Force the name the user supplied, otherwise use $file |
---|
[6266] | 421 | $filename = ($name ? $name : $this->_basename($file )); |
---|
[4414] | 422 | } else { |
---|
| 423 | $filedata = $file; |
---|
| 424 | $filename = $name; |
---|
| 425 | } |
---|
| 426 | |
---|
| 427 | if (!strlen($filename)) { |
---|
| 428 | $msg = "The supplied filename for the attachment can't be empty"; |
---|
| 429 | $err = PEAR::raiseError($msg); |
---|
| 430 | return $err; |
---|
| 431 | } |
---|
[6266] | 432 | |
---|
[4414] | 433 | $this->_parts[] = array( |
---|
| 434 | 'body' => $filedata, |
---|
| 435 | 'body_file' => $bodyfile, |
---|
| 436 | 'name' => $filename, |
---|
| 437 | 'c_type' => $c_type, |
---|
| 438 | 'charset' => $charset, |
---|
| 439 | 'encoding' => $encoding, |
---|
| 440 | 'language' => $language, |
---|
| 441 | 'location' => $location, |
---|
| 442 | 'disposition' => $disposition, |
---|
| 443 | 'description' => $description, |
---|
| 444 | 'name_encoding' => $n_encoding, |
---|
| 445 | 'filename_encoding' => $f_encoding, |
---|
| 446 | 'headers_charset' => $h_charset, |
---|
| 447 | ); |
---|
| 448 | |
---|
| 449 | return true; |
---|
| 450 | } |
---|
| 451 | |
---|
| 452 | /** |
---|
| 453 | * Get the contents of the given file name as string |
---|
| 454 | * |
---|
| 455 | * @param string $file_name Path of file to process |
---|
| 456 | * |
---|
| 457 | * @return string Contents of $file_name |
---|
| 458 | * @access private |
---|
| 459 | */ |
---|
| 460 | function &_file2str($file_name) |
---|
| 461 | { |
---|
| 462 | // Check state of file and raise an error properly |
---|
| 463 | if (!file_exists($file_name)) { |
---|
| 464 | $err = PEAR::raiseError('File not found: ' . $file_name); |
---|
| 465 | return $err; |
---|
| 466 | } |
---|
| 467 | if (!is_file($file_name)) { |
---|
| 468 | $err = PEAR::raiseError('Not a regular file: ' . $file_name); |
---|
| 469 | return $err; |
---|
| 470 | } |
---|
| 471 | if (!is_readable($file_name)) { |
---|
| 472 | $err = PEAR::raiseError('File is not readable: ' . $file_name); |
---|
| 473 | return $err; |
---|
| 474 | } |
---|
| 475 | |
---|
| 476 | // Temporarily reset magic_quotes_runtime and read file contents |
---|
| 477 | if ($magic_quote_setting = get_magic_quotes_runtime()) { |
---|
| 478 | @ini_set('magic_quotes_runtime', 0); |
---|
| 479 | } |
---|
| 480 | $cont = file_get_contents($file_name); |
---|
| 481 | if ($magic_quote_setting) { |
---|
| 482 | @ini_set('magic_quotes_runtime', $magic_quote_setting); |
---|
| 483 | } |
---|
| 484 | |
---|
| 485 | return $cont; |
---|
| 486 | } |
---|
| 487 | |
---|
| 488 | /** |
---|
| 489 | * Adds a text subpart to the mimePart object and |
---|
| 490 | * returns it during the build process. |
---|
| 491 | * |
---|
| 492 | * @param mixed &$obj The object to add the part to, or |
---|
| 493 | * null if a new object is to be created. |
---|
| 494 | * @param string $text The text to add. |
---|
| 495 | * |
---|
| 496 | * @return object The text mimePart object |
---|
| 497 | * @access private |
---|
| 498 | */ |
---|
| 499 | function &_addTextPart(&$obj, $text) |
---|
| 500 | { |
---|
| 501 | $params['content_type'] = 'text/plain'; |
---|
| 502 | $params['encoding'] = $this->_build_params['text_encoding']; |
---|
| 503 | $params['charset'] = $this->_build_params['text_charset']; |
---|
| 504 | $params['eol'] = $this->_build_params['eol']; |
---|
| 505 | |
---|
| 506 | if (is_object($obj)) { |
---|
| 507 | $ret = $obj->addSubpart($text, $params); |
---|
| 508 | return $ret; |
---|
| 509 | } else { |
---|
| 510 | $ret = new Mail_mimePart($text, $params); |
---|
| 511 | return $ret; |
---|
| 512 | } |
---|
| 513 | } |
---|
| 514 | |
---|
| 515 | /** |
---|
| 516 | * Adds a html subpart to the mimePart object and |
---|
| 517 | * returns it during the build process. |
---|
| 518 | * |
---|
| 519 | * @param mixed &$obj The object to add the part to, or |
---|
| 520 | * null if a new object is to be created. |
---|
| 521 | * |
---|
| 522 | * @return object The html mimePart object |
---|
| 523 | * @access private |
---|
| 524 | */ |
---|
| 525 | function &_addHtmlPart(&$obj) |
---|
| 526 | { |
---|
| 527 | $params['content_type'] = 'text/html'; |
---|
| 528 | $params['encoding'] = $this->_build_params['html_encoding']; |
---|
| 529 | $params['charset'] = $this->_build_params['html_charset']; |
---|
| 530 | $params['eol'] = $this->_build_params['eol']; |
---|
| 531 | |
---|
| 532 | if (is_object($obj)) { |
---|
| 533 | $ret = $obj->addSubpart($this->_htmlbody, $params); |
---|
| 534 | return $ret; |
---|
| 535 | } else { |
---|
| 536 | $ret = new Mail_mimePart($this->_htmlbody, $params); |
---|
| 537 | return $ret; |
---|
| 538 | } |
---|
| 539 | } |
---|
| 540 | |
---|
| 541 | /** |
---|
| 542 | * Creates a new mimePart object, using multipart/mixed as |
---|
| 543 | * the initial content-type and returns it during the |
---|
| 544 | * build process. |
---|
| 545 | * |
---|
| 546 | * @return object The multipart/mixed mimePart object |
---|
| 547 | * @access private |
---|
| 548 | */ |
---|
| 549 | function &_addMixedPart() |
---|
| 550 | { |
---|
| 551 | $params = array(); |
---|
| 552 | $params['content_type'] = 'multipart/mixed'; |
---|
| 553 | $params['eol'] = $this->_build_params['eol']; |
---|
| 554 | |
---|
| 555 | // Create empty multipart/mixed Mail_mimePart object to return |
---|
| 556 | $ret = new Mail_mimePart('', $params); |
---|
| 557 | return $ret; |
---|
| 558 | } |
---|
| 559 | |
---|
| 560 | /** |
---|
| 561 | * Adds a multipart/alternative part to a mimePart |
---|
| 562 | * object (or creates one), and returns it during |
---|
| 563 | * the build process. |
---|
| 564 | * |
---|
| 565 | * @param mixed &$obj The object to add the part to, or |
---|
| 566 | * null if a new object is to be created. |
---|
| 567 | * |
---|
| 568 | * @return object The multipart/mixed mimePart object |
---|
| 569 | * @access private |
---|
| 570 | */ |
---|
| 571 | function &_addAlternativePart(&$obj) |
---|
| 572 | { |
---|
| 573 | $params['content_type'] = 'multipart/alternative'; |
---|
| 574 | $params['eol'] = $this->_build_params['eol']; |
---|
| 575 | |
---|
| 576 | if (is_object($obj)) { |
---|
| 577 | return $obj->addSubpart('', $params); |
---|
| 578 | } else { |
---|
| 579 | $ret = new Mail_mimePart('', $params); |
---|
| 580 | return $ret; |
---|
| 581 | } |
---|
| 582 | } |
---|
| 583 | |
---|
| 584 | /** |
---|
| 585 | * Adds a multipart/related part to a mimePart |
---|
| 586 | * object (or creates one), and returns it during |
---|
| 587 | * the build process. |
---|
| 588 | * |
---|
| 589 | * @param mixed &$obj The object to add the part to, or |
---|
| 590 | * null if a new object is to be created |
---|
| 591 | * |
---|
| 592 | * @return object The multipart/mixed mimePart object |
---|
| 593 | * @access private |
---|
| 594 | */ |
---|
| 595 | function &_addRelatedPart(&$obj) |
---|
| 596 | { |
---|
| 597 | $params['content_type'] = 'multipart/related'; |
---|
| 598 | $params['eol'] = $this->_build_params['eol']; |
---|
| 599 | |
---|
| 600 | if (is_object($obj)) { |
---|
| 601 | return $obj->addSubpart('', $params); |
---|
| 602 | } else { |
---|
| 603 | $ret = new Mail_mimePart('', $params); |
---|
| 604 | return $ret; |
---|
| 605 | } |
---|
| 606 | } |
---|
| 607 | |
---|
| 608 | /** |
---|
| 609 | * Adds an html image subpart to a mimePart object |
---|
| 610 | * and returns it during the build process. |
---|
| 611 | * |
---|
| 612 | * @param object &$obj The mimePart to add the image to |
---|
| 613 | * @param array $value The image information |
---|
| 614 | * |
---|
| 615 | * @return object The image mimePart object |
---|
| 616 | * @access private |
---|
| 617 | */ |
---|
| 618 | function &_addHtmlImagePart(&$obj, $value) |
---|
| 619 | { |
---|
| 620 | $params['content_type'] = $value['c_type']; |
---|
| 621 | $params['encoding'] = 'base64'; |
---|
| 622 | $params['disposition'] = 'inline'; |
---|
| 623 | $params['filename'] = $value['name']; |
---|
| 624 | $params['cid'] = $value['cid']; |
---|
| 625 | $params['body_file'] = $value['body_file']; |
---|
| 626 | $params['eol'] = $this->_build_params['eol']; |
---|
| 627 | |
---|
| 628 | if (!empty($value['name_encoding'])) { |
---|
| 629 | $params['name_encoding'] = $value['name_encoding']; |
---|
| 630 | } |
---|
| 631 | if (!empty($value['filename_encoding'])) { |
---|
| 632 | $params['filename_encoding'] = $value['filename_encoding']; |
---|
| 633 | } |
---|
| 634 | |
---|
| 635 | $ret = $obj->addSubpart($value['body'], $params); |
---|
| 636 | return $ret; |
---|
| 637 | } |
---|
| 638 | |
---|
| 639 | /** |
---|
| 640 | * Adds an attachment subpart to a mimePart object |
---|
| 641 | * and returns it during the build process. |
---|
| 642 | * |
---|
| 643 | * @param object &$obj The mimePart to add the image to |
---|
| 644 | * @param array $value The attachment information |
---|
| 645 | * |
---|
| 646 | * @return object The image mimePart object |
---|
| 647 | * @access private |
---|
| 648 | */ |
---|
| 649 | function &_addAttachmentPart(&$obj, $value) |
---|
| 650 | { |
---|
| 651 | $params['eol'] = $this->_build_params['eol']; |
---|
| 652 | $params['filename'] = $value['name']; |
---|
| 653 | $params['encoding'] = $value['encoding']; |
---|
| 654 | $params['content_type'] = $value['c_type']; |
---|
| 655 | $params['body_file'] = $value['body_file']; |
---|
| 656 | $params['disposition'] = isset($value['disposition']) ? |
---|
| 657 | $value['disposition'] : 'attachment'; |
---|
| 658 | |
---|
| 659 | // content charset |
---|
| 660 | if (!empty($value['charset'])) { |
---|
| 661 | $params['charset'] = $value['charset']; |
---|
| 662 | } |
---|
| 663 | // headers charset (filename, description) |
---|
| 664 | if (!empty($value['headers_charset'])) { |
---|
| 665 | $params['headers_charset'] = $value['headers_charset']; |
---|
| 666 | } |
---|
| 667 | if (!empty($value['language'])) { |
---|
| 668 | $params['language'] = $value['language']; |
---|
| 669 | } |
---|
| 670 | if (!empty($value['location'])) { |
---|
| 671 | $params['location'] = $value['location']; |
---|
| 672 | } |
---|
| 673 | if (!empty($value['name_encoding'])) { |
---|
| 674 | $params['name_encoding'] = $value['name_encoding']; |
---|
| 675 | } |
---|
| 676 | if (!empty($value['filename_encoding'])) { |
---|
| 677 | $params['filename_encoding'] = $value['filename_encoding']; |
---|
| 678 | } |
---|
| 679 | if (!empty($value['description'])) { |
---|
| 680 | $params['description'] = $value['description']; |
---|
| 681 | } |
---|
| 682 | |
---|
| 683 | $ret = $obj->addSubpart($value['body'], $params); |
---|
| 684 | return $ret; |
---|
| 685 | } |
---|
| 686 | |
---|
| 687 | /** |
---|
| 688 | * Returns the complete e-mail, ready to send using an alternative |
---|
| 689 | * mail delivery method. Note that only the mailpart that is made |
---|
| 690 | * with Mail_Mime is created. This means that, |
---|
| 691 | * YOU WILL HAVE NO TO: HEADERS UNLESS YOU SET IT YOURSELF |
---|
| 692 | * using the $headers parameter! |
---|
| 693 | * |
---|
| 694 | * @param string $separation The separation between these two parts. |
---|
| 695 | * @param array $params The Build parameters passed to the |
---|
| 696 | * &get() function. See &get for more info. |
---|
| 697 | * @param array $headers The extra headers that should be passed |
---|
| 698 | * to the &headers() function. |
---|
| 699 | * See that function for more info. |
---|
| 700 | * @param bool $overwrite Overwrite the existing headers with new. |
---|
| 701 | * |
---|
| 702 | * @return mixed The complete e-mail or PEAR error object |
---|
| 703 | * @access public |
---|
| 704 | */ |
---|
| 705 | function getMessage($separation = null, $params = null, $headers = null, |
---|
| 706 | $overwrite = false |
---|
| 707 | ) { |
---|
| 708 | if ($separation === null) { |
---|
| 709 | $separation = $this->_build_params['eol']; |
---|
| 710 | } |
---|
| 711 | |
---|
| 712 | $body = $this->get($params); |
---|
| 713 | |
---|
| 714 | if (PEAR::isError($body)) { |
---|
| 715 | return $body; |
---|
| 716 | } |
---|
| 717 | |
---|
| 718 | $head = $this->txtHeaders($headers, $overwrite); |
---|
| 719 | $mail = $head . $separation . $body; |
---|
| 720 | return $mail; |
---|
| 721 | } |
---|
| 722 | |
---|
| 723 | /** |
---|
| 724 | * Returns the complete e-mail body, ready to send using an alternative |
---|
| 725 | * mail delivery method. |
---|
| 726 | * |
---|
| 727 | * @param array $params The Build parameters passed to the |
---|
| 728 | * &get() function. See &get for more info. |
---|
| 729 | * |
---|
| 730 | * @return mixed The e-mail body or PEAR error object |
---|
| 731 | * @access public |
---|
| 732 | * @since 1.6.0 |
---|
| 733 | */ |
---|
| 734 | function getMessageBody($params = null) |
---|
| 735 | { |
---|
| 736 | return $this->get($params, null, true); |
---|
| 737 | } |
---|
| 738 | |
---|
| 739 | /** |
---|
| 740 | * Writes (appends) the complete e-mail into file. |
---|
| 741 | * |
---|
| 742 | * @param string $filename Output file location |
---|
| 743 | * @param array $params The Build parameters passed to the |
---|
| 744 | * &get() function. See &get for more info. |
---|
| 745 | * @param array $headers The extra headers that should be passed |
---|
| 746 | * to the &headers() function. |
---|
| 747 | * See that function for more info. |
---|
| 748 | * @param bool $overwrite Overwrite the existing headers with new. |
---|
| 749 | * |
---|
| 750 | * @return mixed True or PEAR error object |
---|
| 751 | * @access public |
---|
| 752 | * @since 1.6.0 |
---|
| 753 | */ |
---|
| 754 | function saveMessage($filename, $params = null, $headers = null, $overwrite = false) |
---|
| 755 | { |
---|
| 756 | // Check state of file and raise an error properly |
---|
| 757 | if (file_exists($filename) && !is_writable($filename)) { |
---|
| 758 | $err = PEAR::raiseError('File is not writable: ' . $filename); |
---|
| 759 | return $err; |
---|
| 760 | } |
---|
| 761 | |
---|
| 762 | // Temporarily reset magic_quotes_runtime and read file contents |
---|
| 763 | if ($magic_quote_setting = get_magic_quotes_runtime()) { |
---|
| 764 | @ini_set('magic_quotes_runtime', 0); |
---|
| 765 | } |
---|
| 766 | |
---|
| 767 | if (!($fh = fopen($filename, 'ab'))) { |
---|
| 768 | $err = PEAR::raiseError('Unable to open file: ' . $filename); |
---|
| 769 | return $err; |
---|
| 770 | } |
---|
| 771 | |
---|
| 772 | // Write message headers into file (skipping Content-* headers) |
---|
| 773 | $head = $this->txtHeaders($headers, $overwrite, true); |
---|
| 774 | if (fwrite($fh, $head) === false) { |
---|
| 775 | $err = PEAR::raiseError('Error writing to file: ' . $filename); |
---|
| 776 | return $err; |
---|
| 777 | } |
---|
| 778 | |
---|
| 779 | fclose($fh); |
---|
| 780 | |
---|
| 781 | if ($magic_quote_setting) { |
---|
| 782 | @ini_set('magic_quotes_runtime', $magic_quote_setting); |
---|
| 783 | } |
---|
| 784 | |
---|
| 785 | // Write the rest of the message into file |
---|
| 786 | $res = $this->get($params, $filename); |
---|
| 787 | |
---|
| 788 | return $res ? $res : true; |
---|
| 789 | } |
---|
| 790 | |
---|
| 791 | /** |
---|
| 792 | * Writes (appends) the complete e-mail body into file. |
---|
| 793 | * |
---|
| 794 | * @param string $filename Output file location |
---|
| 795 | * @param array $params The Build parameters passed to the |
---|
| 796 | * &get() function. See &get for more info. |
---|
| 797 | * |
---|
| 798 | * @return mixed True or PEAR error object |
---|
| 799 | * @access public |
---|
| 800 | * @since 1.6.0 |
---|
| 801 | */ |
---|
| 802 | function saveMessageBody($filename, $params = null) |
---|
| 803 | { |
---|
| 804 | // Check state of file and raise an error properly |
---|
| 805 | if (file_exists($filename) && !is_writable($filename)) { |
---|
| 806 | $err = PEAR::raiseError('File is not writable: ' . $filename); |
---|
| 807 | return $err; |
---|
| 808 | } |
---|
| 809 | |
---|
| 810 | // Temporarily reset magic_quotes_runtime and read file contents |
---|
| 811 | if ($magic_quote_setting = get_magic_quotes_runtime()) { |
---|
| 812 | @ini_set('magic_quotes_runtime', 0); |
---|
| 813 | } |
---|
| 814 | |
---|
| 815 | if (!($fh = fopen($filename, 'ab'))) { |
---|
| 816 | $err = PEAR::raiseError('Unable to open file: ' . $filename); |
---|
| 817 | return $err; |
---|
| 818 | } |
---|
| 819 | |
---|
| 820 | // Write the rest of the message into file |
---|
| 821 | $res = $this->get($params, $filename, true); |
---|
| 822 | |
---|
| 823 | return $res ? $res : true; |
---|
| 824 | } |
---|
| 825 | |
---|
| 826 | /** |
---|
| 827 | * Builds the multipart message from the list ($this->_parts) and |
---|
| 828 | * returns the mime content. |
---|
| 829 | * |
---|
| 830 | * @param array $params Build parameters that change the way the email |
---|
| 831 | * is built. Should be associative. See $_build_params. |
---|
| 832 | * @param resource $filename Output file where to save the message instead of |
---|
| 833 | * returning it |
---|
| 834 | * @param boolean $skip_head True if you want to return/save only the message |
---|
| 835 | * without headers |
---|
| 836 | * |
---|
| 837 | * @return mixed The MIME message content string, null or PEAR error object |
---|
| 838 | * @access public |
---|
| 839 | */ |
---|
| 840 | function &get($params = null, $filename = null, $skip_head = false) |
---|
| 841 | { |
---|
| 842 | if (isset($params)) { |
---|
| 843 | while (list($key, $value) = each($params)) { |
---|
| 844 | $this->_build_params[$key] = $value; |
---|
| 845 | } |
---|
| 846 | } |
---|
| 847 | |
---|
| 848 | if (isset($this->_headers['From'])) { |
---|
| 849 | // Bug #11381: Illegal characters in domain ID |
---|
| 850 | if (preg_match('#(@[0-9a-zA-Z\-\.]+)#', $this->_headers['From'], $matches)) { |
---|
| 851 | $domainID = $matches[1]; |
---|
| 852 | } else { |
---|
| 853 | $domainID = '@localhost'; |
---|
| 854 | } |
---|
| 855 | foreach ($this->_html_images as $i => $img) { |
---|
| 856 | $cid = $this->_html_images[$i]['cid']; |
---|
| 857 | if (!preg_match('#'.preg_quote($domainID).'$#', $cid)) { |
---|
| 858 | $this->_html_images[$i]['cid'] = $cid . $domainID; |
---|
| 859 | } |
---|
| 860 | } |
---|
| 861 | } |
---|
| 862 | |
---|
| 863 | if (count($this->_html_images) && isset($this->_htmlbody)) { |
---|
| 864 | foreach ($this->_html_images as $key => $value) { |
---|
| 865 | $regex = array(); |
---|
| 866 | $regex[] = '#(\s)((?i)src|background|href(?-i))\s*=\s*(["\']?)' . |
---|
| 867 | preg_quote($value['name'], '#') . '\3#'; |
---|
| 868 | $regex[] = '#(?i)url(?-i)\(\s*(["\']?)' . |
---|
| 869 | preg_quote($value['name'], '#') . '\1\s*\)#'; |
---|
| 870 | |
---|
| 871 | $rep = array(); |
---|
| 872 | $rep[] = '\1\2=\3cid:' . $value['cid'] .'\3'; |
---|
| 873 | $rep[] = 'url(\1cid:' . $value['cid'] . '\1)'; |
---|
[5604] | 874 | |
---|
[4414] | 875 | $this->_htmlbody = preg_replace($regex, $rep, $this->_htmlbody); |
---|
| 876 | $this->_html_images[$key]['name'] |
---|
| 877 | = $this->_basename($this->_html_images[$key]['name']); |
---|
[5604] | 878 | |
---|
[4414] | 879 | } |
---|
| 880 | } |
---|
| 881 | |
---|
| 882 | $this->_checkParams(); |
---|
| 883 | |
---|
| 884 | $null = null; |
---|
| 885 | $attachments = count($this->_parts) ? true : false; |
---|
| 886 | $html_images = count($this->_html_images) ? true : false; |
---|
| 887 | $html = strlen($this->_htmlbody) ? true : false; |
---|
| 888 | $text = (!$html && strlen($this->_txtbody)) ? true : false; |
---|
| 889 | |
---|
| 890 | switch (true) { |
---|
| 891 | case $text && !$attachments: |
---|
| 892 | $message =& $this->_addTextPart($null, $this->_txtbody); |
---|
| 893 | break; |
---|
| 894 | |
---|
| 895 | case !$text && !$html && $attachments: |
---|
| 896 | $message =& $this->_addMixedPart(); |
---|
| 897 | for ($i = 0; $i < count($this->_parts); $i++) { |
---|
| 898 | $this->_addAttachmentPart($message, $this->_parts[$i]); |
---|
| 899 | } |
---|
| 900 | break; |
---|
| 901 | |
---|
| 902 | case $text && $attachments: |
---|
| 903 | $message =& $this->_addMixedPart(); |
---|
| 904 | $this->_addTextPart($message, $this->_txtbody); |
---|
| 905 | for ($i = 0; $i < count($this->_parts); $i++) { |
---|
| 906 | $this->_addAttachmentPart($message, $this->_parts[$i]); |
---|
| 907 | } |
---|
| 908 | break; |
---|
| 909 | |
---|
| 910 | case $html && !$attachments && !$html_images: |
---|
| 911 | if (isset($this->_txtbody)) { |
---|
| 912 | $message =& $this->_addAlternativePart($null); |
---|
| 913 | $this->_addTextPart($message, $this->_txtbody); |
---|
| 914 | $this->_addHtmlPart($message); |
---|
| 915 | } else { |
---|
| 916 | $message =& $this->_addHtmlPart($null); |
---|
| 917 | } |
---|
| 918 | break; |
---|
| 919 | |
---|
| 920 | case $html && !$attachments && $html_images: |
---|
| 921 | // * Content-Type: multipart/alternative; |
---|
| 922 | // * text |
---|
| 923 | // * Content-Type: multipart/related; |
---|
| 924 | // * html |
---|
| 925 | // * image... |
---|
| 926 | if (isset($this->_txtbody)) { |
---|
| 927 | $message =& $this->_addAlternativePart($null); |
---|
| 928 | $this->_addTextPart($message, $this->_txtbody); |
---|
| 929 | |
---|
| 930 | $ht =& $this->_addRelatedPart($message); |
---|
| 931 | $this->_addHtmlPart($ht); |
---|
| 932 | for ($i = 0; $i < count($this->_html_images); $i++) { |
---|
| 933 | $this->_addHtmlImagePart($ht, $this->_html_images[$i]); |
---|
| 934 | } |
---|
| 935 | } else { |
---|
| 936 | // * Content-Type: multipart/related; |
---|
| 937 | // * html |
---|
| 938 | // * image... |
---|
| 939 | $message =& $this->_addRelatedPart($null); |
---|
| 940 | $this->_addHtmlPart($message); |
---|
| 941 | for ($i = 0; $i < count($this->_html_images); $i++) { |
---|
| 942 | $this->_addHtmlImagePart($message, $this->_html_images[$i]); |
---|
| 943 | } |
---|
| 944 | } |
---|
| 945 | /* |
---|
| 946 | // #13444, #9725: the code below was a non-RFC compliant hack |
---|
| 947 | // * Content-Type: multipart/related; |
---|
| 948 | // * Content-Type: multipart/alternative; |
---|
| 949 | // * text |
---|
| 950 | // * html |
---|
| 951 | // * image... |
---|
| 952 | $message =& $this->_addRelatedPart($null); |
---|
| 953 | if (isset($this->_txtbody)) { |
---|
| 954 | $alt =& $this->_addAlternativePart($message); |
---|
| 955 | $this->_addTextPart($alt, $this->_txtbody); |
---|
| 956 | $this->_addHtmlPart($alt); |
---|
| 957 | } else { |
---|
| 958 | $this->_addHtmlPart($message); |
---|
| 959 | } |
---|
| 960 | for ($i = 0; $i < count($this->_html_images); $i++) { |
---|
| 961 | $this->_addHtmlImagePart($message, $this->_html_images[$i]); |
---|
| 962 | } |
---|
| 963 | */ |
---|
| 964 | break; |
---|
| 965 | |
---|
| 966 | case $html && $attachments && !$html_images: |
---|
| 967 | $message =& $this->_addMixedPart(); |
---|
| 968 | if (isset($this->_txtbody)) { |
---|
| 969 | $alt =& $this->_addAlternativePart($message); |
---|
| 970 | $this->_addTextPart($alt, $this->_txtbody); |
---|
| 971 | $this->_addHtmlPart($alt); |
---|
| 972 | } else { |
---|
| 973 | $this->_addHtmlPart($message); |
---|
| 974 | } |
---|
| 975 | for ($i = 0; $i < count($this->_parts); $i++) { |
---|
| 976 | $this->_addAttachmentPart($message, $this->_parts[$i]); |
---|
| 977 | } |
---|
| 978 | break; |
---|
[5135] | 979 | /* |
---|
| 980 | * Original: |
---|
| 981 | * case $html && $attachments && $html_images: |
---|
[4414] | 982 | $message =& $this->_addMixedPart(); |
---|
| 983 | if (isset($this->_txtbody)) { |
---|
| 984 | $alt =& $this->_addAlternativePart($message); |
---|
| 985 | $this->_addTextPart($alt, $this->_txtbody); |
---|
| 986 | $rel =& $this->_addRelatedPart($alt); |
---|
| 987 | } else { |
---|
| 988 | $rel =& $this->_addRelatedPart($message); |
---|
| 989 | } |
---|
| 990 | $this->_addHtmlPart($rel); |
---|
| 991 | for ($i = 0; $i < count($this->_html_images); $i++) { |
---|
| 992 | $this->_addHtmlImagePart($rel, $this->_html_images[$i]); |
---|
| 993 | } |
---|
| 994 | for ($i = 0; $i < count($this->_parts); $i++) { |
---|
| 995 | $this->_addAttachmentPart($message, $this->_parts[$i]); |
---|
| 996 | } |
---|
[5135] | 997 | * break; |
---|
| 998 | * Alteração feita para que as imagens senjam inseridas junto com os anexos e não em uma alternate part. |
---|
| 999 | * Para compatibilização com a fomra do expresso anexar imagens no copo do e-mail |
---|
| 1000 | * |
---|
| 1001 | */ |
---|
| 1002 | case $html && $attachments && $html_images: |
---|
| 1003 | $message =& $this->_addMixedPart(); |
---|
| 1004 | if (isset($this->_txtbody)) { |
---|
| 1005 | $alt =& $this->_addAlternativePart($message); |
---|
| 1006 | $this->_addTextPart($alt, $this->_txtbody); |
---|
| 1007 | } else { |
---|
| 1008 | $this->_addHtmlPart($message); |
---|
| 1009 | } |
---|
| 1010 | |
---|
| 1011 | for ($i = 0; $i < count($this->_html_images); $i++) { |
---|
| 1012 | $this->_addHtmlImagePart($message, $this->_html_images[$i]); |
---|
| 1013 | } |
---|
| 1014 | for ($i = 0; $i < count($this->_parts); $i++) { |
---|
| 1015 | $this->_addAttachmentPart($message, $this->_parts[$i]); |
---|
| 1016 | } |
---|
[4414] | 1017 | break; |
---|
[5135] | 1018 | /* |
---|
| 1019 | * Fim da alteração |
---|
| 1020 | */ |
---|
[4414] | 1021 | |
---|
| 1022 | } |
---|
| 1023 | |
---|
| 1024 | if (!isset($message)) { |
---|
| 1025 | $ret = null; |
---|
| 1026 | return $ret; |
---|
| 1027 | } |
---|
| 1028 | |
---|
| 1029 | // Use saved boundary |
---|
| 1030 | if (!empty($this->_build_params['boundary'])) { |
---|
| 1031 | $boundary = $this->_build_params['boundary']; |
---|
| 1032 | } else { |
---|
| 1033 | $boundary = null; |
---|
| 1034 | } |
---|
| 1035 | |
---|
| 1036 | // Write output to file |
---|
| 1037 | if ($filename) { |
---|
| 1038 | // Append mimePart message headers and body into file |
---|
| 1039 | $headers = $message->encodeToFile($filename, $boundary, $skip_head); |
---|
| 1040 | if (PEAR::isError($headers)) { |
---|
| 1041 | return $headers; |
---|
| 1042 | } |
---|
| 1043 | $this->_headers = array_merge($this->_headers, $headers); |
---|
| 1044 | $ret = null; |
---|
| 1045 | return $ret; |
---|
| 1046 | } else { |
---|
| 1047 | $output = $message->encode($boundary, $skip_head); |
---|
| 1048 | if (PEAR::isError($output)) { |
---|
| 1049 | return $output; |
---|
| 1050 | } |
---|
| 1051 | $this->_headers = array_merge($this->_headers, $output['headers']); |
---|
| 1052 | $body = $output['body']; |
---|
| 1053 | return $body; |
---|
| 1054 | } |
---|
| 1055 | } |
---|
| 1056 | |
---|
| 1057 | /** |
---|
| 1058 | * Returns an array with the headers needed to prepend to the email |
---|
| 1059 | * (MIME-Version and Content-Type). Format of argument is: |
---|
| 1060 | * $array['header-name'] = 'header-value'; |
---|
| 1061 | * |
---|
| 1062 | * @param array $xtra_headers Assoc array with any extra headers (optional) |
---|
| 1063 | * (Don't set Content-Type for multipart messages here!) |
---|
| 1064 | * @param bool $overwrite Overwrite already existing headers. |
---|
| 1065 | * @param bool $skip_content Don't return content headers: Content-Type, |
---|
| 1066 | * Content-Disposition and Content-Transfer-Encoding |
---|
| 1067 | * |
---|
| 1068 | * @return array Assoc array with the mime headers |
---|
| 1069 | * @access public |
---|
| 1070 | */ |
---|
| 1071 | function &headers($xtra_headers = null, $overwrite = false, $skip_content = false) |
---|
| 1072 | { |
---|
| 1073 | // Add mime version header |
---|
| 1074 | $headers['MIME-Version'] = '1.0'; |
---|
| 1075 | |
---|
| 1076 | // Content-Type and Content-Transfer-Encoding headers should already |
---|
| 1077 | // be present if get() was called, but we'll re-set them to make sure |
---|
| 1078 | // we got them when called before get() or something in the message |
---|
| 1079 | // has been changed after get() [#14780] |
---|
| 1080 | if (!$skip_content) { |
---|
| 1081 | $headers += $this->_contentHeaders(); |
---|
| 1082 | } |
---|
| 1083 | |
---|
| 1084 | if (!empty($xtra_headers)) { |
---|
| 1085 | $headers = array_merge($headers, $xtra_headers); |
---|
| 1086 | } |
---|
| 1087 | |
---|
| 1088 | if ($overwrite) { |
---|
| 1089 | $this->_headers = array_merge($this->_headers, $headers); |
---|
| 1090 | } else { |
---|
| 1091 | $this->_headers = array_merge($headers, $this->_headers); |
---|
| 1092 | } |
---|
| 1093 | |
---|
| 1094 | $headers = $this->_headers; |
---|
| 1095 | |
---|
| 1096 | if ($skip_content) { |
---|
| 1097 | unset($headers['Content-Type']); |
---|
| 1098 | unset($headers['Content-Transfer-Encoding']); |
---|
| 1099 | unset($headers['Content-Disposition']); |
---|
| 1100 | } else if (!empty($this->_build_params['ctype'])) { |
---|
| 1101 | $headers['Content-Type'] = $this->_build_params['ctype']; |
---|
| 1102 | } |
---|
| 1103 | |
---|
| 1104 | $encodedHeaders = $this->_encodeHeaders($headers); |
---|
| 1105 | return $encodedHeaders; |
---|
| 1106 | } |
---|
| 1107 | |
---|
| 1108 | /** |
---|
| 1109 | * Get the text version of the headers |
---|
| 1110 | * (usefull if you want to use the PHP mail() function) |
---|
| 1111 | * |
---|
| 1112 | * @param array $xtra_headers Assoc array with any extra headers (optional) |
---|
| 1113 | * (Don't set Content-Type for multipart messages here!) |
---|
| 1114 | * @param bool $overwrite Overwrite the existing headers with new. |
---|
| 1115 | * @param bool $skip_content Don't return content headers: Content-Type, |
---|
| 1116 | * Content-Disposition and Content-Transfer-Encoding |
---|
| 1117 | * |
---|
| 1118 | * @return string Plain text headers |
---|
| 1119 | * @access public |
---|
| 1120 | */ |
---|
| 1121 | function txtHeaders($xtra_headers = null, $overwrite = false, $skip_content = false) |
---|
| 1122 | { |
---|
| 1123 | $headers = $this->headers($xtra_headers, $overwrite, $skip_content); |
---|
| 1124 | |
---|
| 1125 | // Place Received: headers at the beginning of the message |
---|
| 1126 | // Spam detectors often flag messages with it after the Subject: as spam |
---|
| 1127 | if (isset($headers['Received'])) { |
---|
| 1128 | $received = $headers['Received']; |
---|
| 1129 | unset($headers['Received']); |
---|
| 1130 | $headers = array('Received' => $received) + $headers; |
---|
| 1131 | } |
---|
| 1132 | |
---|
| 1133 | $ret = ''; |
---|
| 1134 | $eol = $this->_build_params['eol']; |
---|
| 1135 | |
---|
| 1136 | foreach ($headers as $key => $val) { |
---|
| 1137 | if (is_array($val)) { |
---|
| 1138 | foreach ($val as $value) { |
---|
| 1139 | $ret .= "$key: $value" . $eol; |
---|
| 1140 | } |
---|
| 1141 | } else { |
---|
| 1142 | $ret .= "$key: $val" . $eol; |
---|
| 1143 | } |
---|
| 1144 | } |
---|
| 1145 | |
---|
| 1146 | return $ret; |
---|
| 1147 | } |
---|
| 1148 | |
---|
| 1149 | /** |
---|
| 1150 | * Sets message Content-Type header. |
---|
| 1151 | * Use it to build messages with various content-types e.g. miltipart/raport |
---|
| 1152 | * not supported by _contentHeaders() function. |
---|
| 1153 | * |
---|
| 1154 | * @param string $type Type name |
---|
| 1155 | * @param array $params Hash array of header parameters |
---|
| 1156 | * |
---|
| 1157 | * @return void |
---|
| 1158 | * @access public |
---|
| 1159 | * @since 1.7.0 |
---|
| 1160 | */ |
---|
| 1161 | function setContentType($type, $params = array()) |
---|
| 1162 | { |
---|
| 1163 | $header = $type; |
---|
| 1164 | |
---|
| 1165 | $eol = !empty($this->_build_params['eol']) |
---|
| 1166 | ? $this->_build_params['eol'] : "\r\n"; |
---|
| 1167 | |
---|
| 1168 | // add parameters |
---|
| 1169 | $token_regexp = '#([^\x21,\x23-\x27,\x2A,\x2B,\x2D' |
---|
| 1170 | . ',\x2E,\x30-\x39,\x41-\x5A,\x5E-\x7E])#'; |
---|
| 1171 | if (is_array($params)) { |
---|
| 1172 | foreach ($params as $name => $value) { |
---|
| 1173 | if ($name == 'boundary') { |
---|
| 1174 | $this->_build_params['boundary'] = $value; |
---|
| 1175 | } |
---|
| 1176 | if (!preg_match($token_regexp, $value)) { |
---|
| 1177 | $header .= ";$eol $name=$value"; |
---|
| 1178 | } else { |
---|
| 1179 | $value = addcslashes($value, '\\"'); |
---|
| 1180 | $header .= ";$eol $name=\"$value\""; |
---|
| 1181 | } |
---|
| 1182 | } |
---|
| 1183 | } |
---|
| 1184 | |
---|
| 1185 | // add required boundary parameter if not defined |
---|
| 1186 | if (preg_match('/^multipart\//i', $type)) { |
---|
| 1187 | if (empty($this->_build_params['boundary'])) { |
---|
| 1188 | $this->_build_params['boundary'] = '=_' . md5(rand() . microtime()); |
---|
| 1189 | } |
---|
| 1190 | |
---|
| 1191 | $header .= ";$eol boundary=\"".$this->_build_params['boundary']."\""; |
---|
| 1192 | } |
---|
| 1193 | |
---|
| 1194 | $this->_build_params['ctype'] = $header; |
---|
| 1195 | } |
---|
| 1196 | |
---|
| 1197 | /** |
---|
| 1198 | * Sets the Subject header |
---|
| 1199 | * |
---|
| 1200 | * @param string $subject String to set the subject to. |
---|
| 1201 | * |
---|
| 1202 | * @return void |
---|
| 1203 | * @access public |
---|
| 1204 | */ |
---|
| 1205 | function setSubject($subject) |
---|
| 1206 | { |
---|
| 1207 | $this->_headers['Subject'] = $subject; |
---|
| 1208 | } |
---|
| 1209 | |
---|
| 1210 | /** |
---|
| 1211 | * Set an email to the From (the sender) header |
---|
| 1212 | * |
---|
| 1213 | * @param string $email The email address to use |
---|
| 1214 | * |
---|
| 1215 | * @return void |
---|
| 1216 | * @access public |
---|
| 1217 | */ |
---|
| 1218 | function setFrom($email) |
---|
| 1219 | { |
---|
| 1220 | $this->_headers['From'] = $email; |
---|
| 1221 | } |
---|
| 1222 | |
---|
| 1223 | /** |
---|
| 1224 | * Add an email to the To header |
---|
| 1225 | * (multiple calls to this method are allowed) |
---|
| 1226 | * |
---|
| 1227 | * @param string $email The email direction to add |
---|
| 1228 | * |
---|
| 1229 | * @return void |
---|
| 1230 | * @access public |
---|
| 1231 | */ |
---|
| 1232 | function addTo($email) |
---|
| 1233 | { |
---|
| 1234 | if (isset($this->_headers['To'])) { |
---|
| 1235 | $this->_headers['To'] .= ", $email"; |
---|
| 1236 | } else { |
---|
| 1237 | $this->_headers['To'] = $email; |
---|
| 1238 | } |
---|
| 1239 | } |
---|
| 1240 | |
---|
| 1241 | /** |
---|
| 1242 | * Add an email to the Cc (carbon copy) header |
---|
| 1243 | * (multiple calls to this method are allowed) |
---|
| 1244 | * |
---|
| 1245 | * @param string $email The email direction to add |
---|
| 1246 | * |
---|
| 1247 | * @return void |
---|
| 1248 | * @access public |
---|
| 1249 | */ |
---|
| 1250 | function addCc($email) |
---|
| 1251 | { |
---|
| 1252 | if (isset($this->_headers['Cc'])) { |
---|
| 1253 | $this->_headers['Cc'] .= ", $email"; |
---|
| 1254 | } else { |
---|
| 1255 | $this->_headers['Cc'] = $email; |
---|
| 1256 | } |
---|
| 1257 | } |
---|
| 1258 | |
---|
| 1259 | /** |
---|
| 1260 | * Add an email to the Bcc (blank carbon copy) header |
---|
| 1261 | * (multiple calls to this method are allowed) |
---|
| 1262 | * |
---|
| 1263 | * @param string $email The email direction to add |
---|
| 1264 | * |
---|
| 1265 | * @return void |
---|
| 1266 | * @access public |
---|
| 1267 | */ |
---|
| 1268 | function addBcc($email) |
---|
| 1269 | { |
---|
| 1270 | if (isset($this->_headers['Bcc'])) { |
---|
| 1271 | $this->_headers['Bcc'] .= ", $email"; |
---|
| 1272 | } else { |
---|
| 1273 | $this->_headers['Bcc'] = $email; |
---|
| 1274 | } |
---|
| 1275 | } |
---|
| 1276 | |
---|
| 1277 | /** |
---|
| 1278 | * Since the PHP send function requires you to specify |
---|
| 1279 | * recipients (To: header) separately from the other |
---|
| 1280 | * headers, the To: header is not properly encoded. |
---|
| 1281 | * To fix this, you can use this public method to |
---|
| 1282 | * encode your recipients before sending to the send |
---|
| 1283 | * function |
---|
| 1284 | * |
---|
| 1285 | * @param string $recipients A comma-delimited list of recipients |
---|
| 1286 | * |
---|
| 1287 | * @return string Encoded data |
---|
| 1288 | * @access public |
---|
| 1289 | */ |
---|
| 1290 | function encodeRecipients($recipients) |
---|
| 1291 | { |
---|
| 1292 | $input = array("To" => $recipients); |
---|
| 1293 | $retval = $this->_encodeHeaders($input); |
---|
| 1294 | return $retval["To"] ; |
---|
| 1295 | } |
---|
| 1296 | |
---|
| 1297 | /** |
---|
| 1298 | * Encodes headers as per RFC2047 |
---|
| 1299 | * |
---|
| 1300 | * @param array $input The header data to encode |
---|
| 1301 | * @param array $params Extra build parameters |
---|
| 1302 | * |
---|
| 1303 | * @return array Encoded data |
---|
| 1304 | * @access private |
---|
| 1305 | */ |
---|
| 1306 | function _encodeHeaders($input, $params = array()) |
---|
| 1307 | { |
---|
| 1308 | $build_params = $this->_build_params; |
---|
| 1309 | while (list($key, $value) = each($params)) { |
---|
| 1310 | $build_params[$key] = $value; |
---|
| 1311 | } |
---|
| 1312 | |
---|
| 1313 | foreach ($input as $hdr_name => $hdr_value) { |
---|
| 1314 | if (is_array($hdr_value)) { |
---|
| 1315 | foreach ($hdr_value as $idx => $value) { |
---|
| 1316 | $input[$hdr_name][$idx] = $this->encodeHeader( |
---|
| 1317 | $hdr_name, $value, |
---|
| 1318 | $build_params['head_charset'], $build_params['head_encoding'] |
---|
| 1319 | ); |
---|
| 1320 | } |
---|
| 1321 | } else { |
---|
| 1322 | $input[$hdr_name] = $this->encodeHeader( |
---|
| 1323 | $hdr_name, $hdr_value, |
---|
| 1324 | $build_params['head_charset'], $build_params['head_encoding'] |
---|
| 1325 | ); |
---|
| 1326 | } |
---|
| 1327 | } |
---|
| 1328 | |
---|
| 1329 | return $input; |
---|
| 1330 | } |
---|
| 1331 | |
---|
| 1332 | /** |
---|
| 1333 | * Encodes a header as per RFC2047 |
---|
| 1334 | * |
---|
| 1335 | * @param string $name The header name |
---|
| 1336 | * @param string $value The header data to encode |
---|
| 1337 | * @param string $charset Character set name |
---|
| 1338 | * @param string $encoding Encoding name (base64 or quoted-printable) |
---|
| 1339 | * |
---|
| 1340 | * @return string Encoded header data (without a name) |
---|
| 1341 | * @access public |
---|
| 1342 | * @since 1.5.3 |
---|
| 1343 | */ |
---|
| 1344 | function encodeHeader($name, $value, $charset, $encoding) |
---|
| 1345 | { |
---|
| 1346 | return Mail_mimePart::encodeHeader( |
---|
| 1347 | $name, $value, $charset, $encoding, $this->_build_params['eol'] |
---|
| 1348 | ); |
---|
| 1349 | } |
---|
| 1350 | |
---|
| 1351 | /** |
---|
| 1352 | * Get file's basename (locale independent) |
---|
| 1353 | * |
---|
| 1354 | * @param string $filename Filename |
---|
| 1355 | * |
---|
| 1356 | * @return string Basename |
---|
| 1357 | * @access private |
---|
| 1358 | */ |
---|
| 1359 | function _basename($filename) |
---|
| 1360 | { |
---|
| 1361 | // basename() is not unicode safe and locale dependent |
---|
| 1362 | if (stristr(PHP_OS, 'win') || stristr(PHP_OS, 'netware')) { |
---|
| 1363 | return preg_replace('/^.*[\\\\\\/]/', '', $filename); |
---|
| 1364 | } else { |
---|
| 1365 | return preg_replace('/^.*[\/]/', '', $filename); |
---|
| 1366 | } |
---|
| 1367 | } |
---|
| 1368 | |
---|
| 1369 | /** |
---|
| 1370 | * Get Content-Type and Content-Transfer-Encoding headers of the message |
---|
| 1371 | * |
---|
| 1372 | * @return array Headers array |
---|
| 1373 | * @access private |
---|
| 1374 | */ |
---|
| 1375 | function _contentHeaders() |
---|
| 1376 | { |
---|
| 1377 | $attachments = count($this->_parts) ? true : false; |
---|
| 1378 | $html_images = count($this->_html_images) ? true : false; |
---|
| 1379 | $html = strlen($this->_htmlbody) ? true : false; |
---|
| 1380 | $text = (!$html && strlen($this->_txtbody)) ? true : false; |
---|
| 1381 | $headers = array(); |
---|
| 1382 | |
---|
| 1383 | // See get() |
---|
| 1384 | switch (true) { |
---|
| 1385 | case $text && !$attachments: |
---|
| 1386 | $headers['Content-Type'] = 'text/plain'; |
---|
| 1387 | break; |
---|
| 1388 | |
---|
| 1389 | case !$text && !$html && $attachments: |
---|
| 1390 | case $text && $attachments: |
---|
| 1391 | case $html && $attachments && !$html_images: |
---|
| 1392 | case $html && $attachments && $html_images: |
---|
| 1393 | $headers['Content-Type'] = 'multipart/mixed'; |
---|
| 1394 | break; |
---|
| 1395 | |
---|
| 1396 | case $html && !$attachments && !$html_images && isset($this->_txtbody): |
---|
| 1397 | case $html && !$attachments && $html_images && isset($this->_txtbody): |
---|
| 1398 | $headers['Content-Type'] = 'multipart/alternative'; |
---|
| 1399 | break; |
---|
| 1400 | |
---|
| 1401 | case $html && !$attachments && !$html_images && !isset($this->_txtbody): |
---|
| 1402 | $headers['Content-Type'] = 'text/html'; |
---|
| 1403 | break; |
---|
| 1404 | |
---|
| 1405 | case $html && !$attachments && $html_images && !isset($this->_txtbody): |
---|
| 1406 | $headers['Content-Type'] = 'multipart/related'; |
---|
| 1407 | break; |
---|
| 1408 | |
---|
| 1409 | default: |
---|
| 1410 | return $headers; |
---|
| 1411 | } |
---|
| 1412 | |
---|
| 1413 | $this->_checkParams(); |
---|
| 1414 | |
---|
| 1415 | $eol = !empty($this->_build_params['eol']) |
---|
| 1416 | ? $this->_build_params['eol'] : "\r\n"; |
---|
| 1417 | |
---|
| 1418 | if ($headers['Content-Type'] == 'text/plain') { |
---|
| 1419 | // single-part message: add charset and encoding |
---|
| 1420 | $charset = 'charset=' . $this->_build_params['text_charset']; |
---|
| 1421 | // place charset parameter in the same line, if possible |
---|
| 1422 | // 26 = strlen("Content-Type: text/plain; ") |
---|
| 1423 | $headers['Content-Type'] |
---|
| 1424 | .= (strlen($charset) + 26 <= 76) ? "; $charset" : ";$eol $charset"; |
---|
| 1425 | $headers['Content-Transfer-Encoding'] |
---|
| 1426 | = $this->_build_params['text_encoding']; |
---|
| 1427 | } else if ($headers['Content-Type'] == 'text/html') { |
---|
| 1428 | // single-part message: add charset and encoding |
---|
| 1429 | $charset = 'charset=' . $this->_build_params['html_charset']; |
---|
| 1430 | // place charset parameter in the same line, if possible |
---|
| 1431 | $headers['Content-Type'] |
---|
| 1432 | .= (strlen($charset) + 25 <= 76) ? "; $charset" : ";$eol $charset"; |
---|
| 1433 | $headers['Content-Transfer-Encoding'] |
---|
| 1434 | = $this->_build_params['html_encoding']; |
---|
| 1435 | } else { |
---|
| 1436 | // multipart message: and boundary |
---|
| 1437 | if (!empty($this->_build_params['boundary'])) { |
---|
| 1438 | $boundary = $this->_build_params['boundary']; |
---|
| 1439 | } else if (!empty($this->_headers['Content-Type']) |
---|
| 1440 | && preg_match('/boundary="([^"]+)"/', $this->_headers['Content-Type'], $m) |
---|
| 1441 | ) { |
---|
| 1442 | $boundary = $m[1]; |
---|
| 1443 | } else { |
---|
| 1444 | $boundary = '=_' . md5(rand() . microtime()); |
---|
| 1445 | } |
---|
| 1446 | |
---|
| 1447 | $this->_build_params['boundary'] = $boundary; |
---|
| 1448 | $headers['Content-Type'] .= ";$eol boundary=\"$boundary\""; |
---|
| 1449 | } |
---|
| 1450 | |
---|
| 1451 | return $headers; |
---|
| 1452 | } |
---|
| 1453 | |
---|
| 1454 | /** |
---|
| 1455 | * Validate and set build parameters |
---|
| 1456 | * |
---|
| 1457 | * @return void |
---|
| 1458 | * @access private |
---|
| 1459 | */ |
---|
| 1460 | function _checkParams() |
---|
| 1461 | { |
---|
| 1462 | $encodings = array('7bit', '8bit', 'base64', 'quoted-printable'); |
---|
| 1463 | |
---|
| 1464 | $this->_build_params['text_encoding'] |
---|
| 1465 | = strtolower($this->_build_params['text_encoding']); |
---|
| 1466 | $this->_build_params['html_encoding'] |
---|
| 1467 | = strtolower($this->_build_params['html_encoding']); |
---|
| 1468 | |
---|
| 1469 | if (!in_array($this->_build_params['text_encoding'], $encodings)) { |
---|
| 1470 | $this->_build_params['text_encoding'] = '7bit'; |
---|
| 1471 | } |
---|
| 1472 | if (!in_array($this->_build_params['html_encoding'], $encodings)) { |
---|
| 1473 | $this->_build_params['html_encoding'] = '7bit'; |
---|
| 1474 | } |
---|
| 1475 | |
---|
| 1476 | // text body |
---|
| 1477 | if ($this->_build_params['text_encoding'] == '7bit' |
---|
| 1478 | && !preg_match('/ascii/i', $this->_build_params['text_charset']) |
---|
| 1479 | && preg_match('/[^\x00-\x7F]/', $this->_txtbody) |
---|
| 1480 | ) { |
---|
| 1481 | $this->_build_params['text_encoding'] = 'quoted-printable'; |
---|
| 1482 | } |
---|
| 1483 | // html body |
---|
| 1484 | if ($this->_build_params['html_encoding'] == '7bit' |
---|
| 1485 | && !preg_match('/ascii/i', $this->_build_params['html_charset']) |
---|
| 1486 | && preg_match('/[^\x00-\x7F]/', $this->_htmlbody) |
---|
| 1487 | ) { |
---|
| 1488 | $this->_build_params['html_encoding'] = 'quoted-printable'; |
---|
| 1489 | } |
---|
| 1490 | } |
---|
| 1491 | |
---|
| 1492 | } // End of class |
---|