| | |
| | | <?php |
| | | /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */ |
| | | // +-----------------------------------------------------------------------+ |
| | | // | Copyright (c) 2002-2003 Richard Heyes | |
| | | // | Copyright (c) 2003-2005 The PHP Group | |
| | | // | All rights reserved. | |
| | | // | | |
| | | // | Redistribution and use in source and binary forms, with or without | |
| | | // | modification, are permitted provided that the following conditions | |
| | | // | are met: | |
| | | // | | |
| | | // | o Redistributions of source code must retain the above copyright | |
| | | // | notice, this list of conditions and the following disclaimer. | |
| | | // | o Redistributions in binary form must reproduce the above copyright | |
| | | // | notice, this list of conditions and the following disclaimer in the | |
| | | // | documentation and/or other materials provided with the distribution.| |
| | | // | o The names of the authors may not be used to endorse or promote | |
| | | // | products derived from this software without specific prior written | |
| | | // | permission. | |
| | | // | | |
| | | // | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| | | // | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| | | // | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| | | // | A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| | | // | OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| | | // | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |
| | | // | LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
| | | // | DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
| | | // | THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
| | | // | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
| | | // | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| | | // | | |
| | | // +-----------------------------------------------------------------------+ |
| | | // | Author: Richard Heyes <richard@phpguru.org> | |
| | | // | Tomas V.V.Cox <cox@idecnet.com> (port to PEAR) | |
| | | // +-----------------------------------------------------------------------+ |
| | | // |
| | | // $Id$ |
| | | /** |
| | | * The Mail_Mime class is used to create MIME E-mail messages |
| | | * |
| | | * The Mail_Mime class provides an OO interface to create MIME |
| | | * enabled email messages. This way you can create emails that |
| | | * contain plain-text bodies, HTML bodies, attachments, inline |
| | | * images and specific headers. |
| | | * |
| | | * Compatible with PHP versions 4 and 5 |
| | | * |
| | | * LICENSE: This LICENSE is in the BSD license style. |
| | | * Copyright (c) 2002-2003, Richard Heyes <richard@phpguru.org> |
| | | * Copyright (c) 2003-2006, PEAR <pear-group@php.net> |
| | | * All rights reserved. |
| | | * |
| | | * Redistribution and use in source and binary forms, with or |
| | | * without modification, are permitted provided that the following |
| | | * conditions are met: |
| | | * |
| | | * - Redistributions of source code must retain the above copyright |
| | | * notice, this list of conditions and the following disclaimer. |
| | | * - Redistributions in binary form must reproduce the above copyright |
| | | * notice, this list of conditions and the following disclaimer in the |
| | | * documentation and/or other materials provided with the distribution. |
| | | * - Neither the name of the authors, nor the names of its contributors |
| | | * may be used to endorse or promote products derived from this |
| | | * software without specific prior written permission. |
| | | * |
| | | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| | | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| | | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| | | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE |
| | | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| | | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| | | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| | | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| | | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| | | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF |
| | | * THE POSSIBILITY OF SUCH DAMAGE. |
| | | * |
| | | * @category Mail |
| | | * @package Mail_Mime |
| | | * @author Richard Heyes <richard@phpguru.org> |
| | | * @author Tomas V.V. Cox <cox@idecnet.com> |
| | | * @author Cipriano Groenendal <cipri@php.net> |
| | | * @author Sean Coates <sean@php.net> |
| | | * @author Aleksander Machniak <alec@php.net> |
| | | * @copyright 2003-2006 PEAR <pear-group@php.net> |
| | | * @license http://www.opensource.org/licenses/bsd-license.php BSD License |
| | | * @version CVS: $Id$ |
| | | * @link http://pear.php.net/package/Mail_mime |
| | | * |
| | | * This class is based on HTML Mime Mail class from |
| | | * Richard Heyes <richard@phpguru.org> which was based also |
| | | * in the mime_mail.class by Tobias Ratschiller <tobias@dnet.it> |
| | | * and Sascha Schumann <sascha@schumann.cx> |
| | | */ |
| | | |
| | | require_once('PEAR.php'); |
| | | require_once('Mail/mimePart.php'); |
| | | |
| | | /** |
| | | * Mime mail composer class. Can handle: text and html bodies, embedded html |
| | | * images and attachments. |
| | | * Documentation and examples of this class are avaible here: |
| | | * http://pear.php.net/manual/ |
| | | * require PEAR |
| | | * |
| | | * @notes This class is based on HTML Mime Mail class from |
| | | * Richard Heyes <richard@phpguru.org> which was based also |
| | | * in the mime_mail.class by Tobias Ratschiller <tobias@dnet.it> and |
| | | * Sascha Schumann <sascha@schumann.cx> |
| | | * This package depends on PEAR to raise errors. |
| | | */ |
| | | require_once 'PEAR.php'; |
| | | |
| | | /** |
| | | * require Mail_mimePart |
| | | * |
| | | * @notes Replaced method _encodeHeaders by the version of ed@avi.ru |
| | | * See http://pear.php.net/bugs/bug.php?id=30 for details |
| | | * Mail_mimePart contains the code required to |
| | | * create all the different parts a mail can |
| | | * consist of. |
| | | */ |
| | | require_once 'Mail/mimePart.php'; |
| | | |
| | | |
| | | /** |
| | | * The Mail_Mime class provides an OO interface to create MIME |
| | | * enabled email messages. This way you can create emails that |
| | | * contain plain-text bodies, HTML bodies, attachments, inline |
| | | * images and specific headers. |
| | | * |
| | | * @author Richard Heyes <richard.heyes@heyes-computing.net> |
| | | * @author Tomas V.V.Cox <cox@idecnet.com> |
| | | * @package Mail |
| | | * @access public |
| | | * @category Mail |
| | | * @package Mail_Mime |
| | | * @author Richard Heyes <richard@phpguru.org> |
| | | * @author Tomas V.V. Cox <cox@idecnet.com> |
| | | * @author Cipriano Groenendal <cipri@php.net> |
| | | * @author Sean Coates <sean@php.net> |
| | | * @copyright 2003-2006 PEAR <pear-group@php.net> |
| | | * @license http://www.opensource.org/licenses/bsd-license.php BSD License |
| | | * @version Release: @package_version@ |
| | | * @link http://pear.php.net/package/Mail_mime |
| | | */ |
| | | class Mail_mime |
| | | { |
| | | /** |
| | | * Contains the plain text part of the email |
| | | * |
| | | * @var string |
| | | * @access private |
| | | */ |
| | | var $_txtbody; |
| | | |
| | | /** |
| | | * Contains the html part of the email |
| | | * |
| | | * @var string |
| | | * @access private |
| | | */ |
| | | var $_htmlbody; |
| | | /** |
| | | * contains the mime encoded text |
| | | * @var string |
| | | */ |
| | | var $_mime; |
| | | /** |
| | | * contains the multipart content |
| | | * @var string |
| | | */ |
| | | var $_multipart; |
| | | |
| | | /** |
| | | * list of the attached images |
| | | * |
| | | * @var array |
| | | * @access private |
| | | */ |
| | | var $_html_images = array(); |
| | | |
| | | /** |
| | | * list of the attachements |
| | | * |
| | | * @var array |
| | | * @access private |
| | | */ |
| | | var $_parts = array(); |
| | | /** |
| | | * Build parameters |
| | | * @var array |
| | | */ |
| | | var $_build_params = array(); |
| | | |
| | | /** |
| | | * Headers for the mail |
| | | * |
| | | * @var array |
| | | * @access private |
| | | */ |
| | | var $_headers = array(); |
| | | /** |
| | | * End Of Line sequence (for serialize) |
| | | * @var string |
| | | */ |
| | | var $_eol; |
| | | |
| | | /** |
| | | * Build parameters |
| | | * |
| | | * @var array |
| | | * @access private |
| | | */ |
| | | var $_build_params = array( |
| | | // What encoding to use for the headers |
| | | // Options: quoted-printable or base64 |
| | | 'head_encoding' => 'quoted-printable', |
| | | // What encoding to use for plain text |
| | | // Options: 7bit, 8bit, base64, or quoted-printable |
| | | 'text_encoding' => 'quoted-printable', |
| | | // What encoding to use for html |
| | | // Options: 7bit, 8bit, base64, or quoted-printable |
| | | 'html_encoding' => 'quoted-printable', |
| | | // The character set to use for html |
| | | 'html_charset' => 'ISO-8859-1', |
| | | // The character set to use for text |
| | | 'text_charset' => 'ISO-8859-1', |
| | | // The character set to use for headers |
| | | 'head_charset' => 'ISO-8859-1', |
| | | // End-of-line sequence |
| | | 'eol' => "\r\n", |
| | | // Delay attachment files IO until building the message |
| | | 'delay_file_io' => false |
| | | ); |
| | | |
| | | /** |
| | | * Constructor function |
| | | * |
| | | * @param mixed $params Build parameters that change the way the email |
| | | * is built. Should be an associative array. |
| | | * See $_build_params. |
| | | * |
| | | * @return void |
| | | * @access public |
| | | */ |
| | | function Mail_mime($crlf = "\r\n") |
| | | function Mail_mime($params = array()) |
| | | { |
| | | $this->_setEOL($crlf); |
| | | $this->_build_params = array( |
| | | 'text_encoding' => '7bit', |
| | | 'html_encoding' => 'quoted-printable', |
| | | 'header_encoding' => 'quoted-printable', |
| | | '7bit_wrap' => 998, |
| | | 'html_charset' => 'ISO-8859-1', |
| | | 'text_charset' => 'ISO-8859-1', |
| | | 'head_charset' => 'ISO-8859-1' |
| | | ); |
| | | // Backward-compatible EOL setting |
| | | if (is_string($params)) { |
| | | $this->_build_params['eol'] = $params; |
| | | } else if (defined('MAIL_MIME_CRLF') && !isset($params['eol'])) { |
| | | $this->_build_params['eol'] = MAIL_MIME_CRLF; |
| | | } |
| | | |
| | | // Update build parameters |
| | | if (!empty($params) && is_array($params)) { |
| | | while (list($key, $value) = each($params)) { |
| | | $this->_build_params[$key] = $value; |
| | | } |
| | | } |
| | | } |
| | | |
| | | /** |
| | | * Wakeup (unserialize) - re-sets EOL constant |
| | | * Set build parameter value |
| | | * |
| | | * @access private |
| | | * @param string $name Parameter name |
| | | * @param string $value Parameter value |
| | | * |
| | | * @return void |
| | | * @access public |
| | | * @since 1.6.0 |
| | | */ |
| | | function __wakeup() |
| | | function setParam($name, $value) |
| | | { |
| | | $this->_setEOL($this->_eol); |
| | | $this->_build_params[$name] = $value; |
| | | } |
| | | |
| | | /** |
| | | * Get build parameter value |
| | | * |
| | | * @param string $name Parameter name |
| | | * |
| | | * @return mixed Parameter value |
| | | * @access public |
| | | * @since 1.6.0 |
| | | */ |
| | | function getParam($name) |
| | | { |
| | | return isset($this->_build_params[$name]) ? $this->_build_params[$name] : null; |
| | | } |
| | | |
| | | /** |
| | |
| | | * text/plain part that emails clients who don't support |
| | | * html should show. |
| | | * |
| | | * @param string $data Either a string or |
| | | * the file name with the contents |
| | | * @param bool $isfile If true the first param should be treated |
| | | * as a file name, else as a string (default) |
| | | * @param bool $append If true the text or file is appended to |
| | | * the existing body, else the old body is |
| | | * overwritten |
| | | * @return mixed true on success or PEAR_Error object |
| | | * @param string $data Either a string or |
| | | * the file name with the contents |
| | | * @param bool $isfile If true the first param should be treated |
| | | * as a file name, else as a string (default) |
| | | * @param bool $append If true the text or file is appended to |
| | | * the existing body, else the old body is |
| | | * overwritten |
| | | * |
| | | * @return mixed True on success or PEAR_Error object |
| | | * @access public |
| | | */ |
| | | function setTXTBody($data, $isfile = false, $append = false) |
| | |
| | | } |
| | | |
| | | /** |
| | | * Adds a html part to the mail |
| | | * Get message text body |
| | | * |
| | | * @param string $data Either a string or the file name with the |
| | | * contents |
| | | * @param bool $isfile If true the first param should be treated |
| | | * as a file name, else as a string (default) |
| | | * @return mixed true on success or PEAR_Error object |
| | | * @return string Text body |
| | | * @access public |
| | | * @since 1.6.0 |
| | | */ |
| | | function getTXTBody() |
| | | { |
| | | return $this->_txtbody; |
| | | } |
| | | |
| | | /** |
| | | * Adds a html part to the mail. |
| | | * |
| | | * @param string $data Either a string or the file name with the |
| | | * contents |
| | | * @param bool $isfile A flag that determines whether $data is a |
| | | * filename, or a string(false, default) |
| | | * |
| | | * @return bool True on success |
| | | * @access public |
| | | */ |
| | | function setHTMLBody($data, $isfile = false) |
| | |
| | | } |
| | | |
| | | /** |
| | | * Get message HTML body |
| | | * |
| | | * @return string HTML body |
| | | * @access public |
| | | * @since 1.6.0 |
| | | */ |
| | | function getHTMLBody() |
| | | { |
| | | return $this->_htmlbody; |
| | | } |
| | | |
| | | /** |
| | | * Adds an image to the list of embedded images. |
| | | * |
| | | * @param string $file The image file name OR image data itself |
| | | * @param string $c_type The content type |
| | | * @param string $name The filename of the image. |
| | | * Only use if $file is the image data |
| | | * @param bool $isfilename Whether $file is a filename or not |
| | | * Defaults to true |
| | | * @return mixed true on success or PEAR_Error object |
| | | * @param string $file The image file name OR image data itself |
| | | * @param string $c_type The content type |
| | | * @param string $name The filename of the image. |
| | | * Only used if $file is the image data. |
| | | * @param bool $isfile Whether $file is a filename or not. |
| | | * Defaults to true |
| | | * @param string $content_id Desired Content-ID of MIME part |
| | | * Defaults to generated unique ID |
| | | * |
| | | * @return bool True on success |
| | | * @access public |
| | | */ |
| | | function addHTMLImage($file, $c_type='application/octet-stream', |
| | | $name = '', $isfilename = true) |
| | | { |
| | | $filedata = ($isfilename === true) ? $this->_file2str($file) |
| | | : $file; |
| | | if ($isfilename === true) { |
| | | $filename = ($name == '' ? basename($file) : basename($name)); |
| | | function addHTMLImage($file, |
| | | $c_type='application/octet-stream', |
| | | $name = '', |
| | | $isfile = true, |
| | | $content_id = null |
| | | ) { |
| | | $bodyfile = null; |
| | | |
| | | if ($isfile) { |
| | | // Don't load file into memory |
| | | if ($this->_build_params['delay_file_io']) { |
| | | $filedata = null; |
| | | $bodyfile = $file; |
| | | } else { |
| | | if (PEAR::isError($filedata = $this->_file2str($file))) { |
| | | return $filedata; |
| | | } |
| | | } |
| | | $filename = ($name ? $name : $file); |
| | | } else { |
| | | $filename = basename($name); |
| | | $filedata = $file; |
| | | $filename = $name; |
| | | } |
| | | if (PEAR::isError($filedata)) { |
| | | return $filedata; |
| | | |
| | | if (!$content_id) { |
| | | $content_id = md5(uniqid(time())); |
| | | } |
| | | |
| | | $this->_html_images[] = array( |
| | | 'body' => $filedata, |
| | | 'name' => $filename, |
| | | 'c_type' => $c_type, |
| | | 'cid' => md5(uniqid(time())) |
| | | ); |
| | | 'body' => $filedata, |
| | | 'body_file' => $bodyfile, |
| | | 'name' => $filename, |
| | | 'c_type' => $c_type, |
| | | 'cid' => $content_id |
| | | ); |
| | | |
| | | return true; |
| | | } |
| | | |
| | | /** |
| | | * Adds a file to the list of attachments. |
| | | * |
| | | * @param string $file The file name of the file to attach |
| | | * OR the file data itself |
| | | * @param string $c_type The content type |
| | | * @param string $name The filename of the attachment |
| | | * Only use if $file is the file data |
| | | * @param bool $isFilename Whether $file is a filename or not |
| | | * Defaults to true |
| | | * @return mixed true on success or PEAR_Error object |
| | | * @param string $file The file name of the file to attach |
| | | * or the file contents itself |
| | | * @param string $c_type The content type |
| | | * @param string $name The filename of the attachment |
| | | * Only use if $file is the contents |
| | | * @param bool $isfile Whether $file is a filename or not. Defaults to true |
| | | * @param string $encoding The type of encoding to use. Defaults to base64. |
| | | * Possible values: 7bit, 8bit, base64 or quoted-printable. |
| | | * @param string $disposition The content-disposition of this file |
| | | * Defaults to attachment. |
| | | * Possible values: attachment, inline. |
| | | * @param string $charset The character set of attachment's content. |
| | | * @param string $language The language of the attachment |
| | | * @param string $location The RFC 2557.4 location of the attachment |
| | | * @param string $n_encoding Encoding of the attachment's name in Content-Type |
| | | * By default filenames are encoded using RFC2231 method |
| | | * Here you can set RFC2047 encoding (quoted-printable |
| | | * or base64) instead |
| | | * @param string $f_encoding Encoding of the attachment's filename |
| | | * in Content-Disposition header. |
| | | * @param string $description Content-Description header |
| | | * @param string $h_charset The character set of the headers e.g. filename |
| | | * If not specified, $charset will be used |
| | | * |
| | | * @return mixed True on success or PEAR_Error object |
| | | * @access public |
| | | */ |
| | | function addAttachment($file, $c_type = 'application/octet-stream', |
| | | $name = '', $isfilename = true, |
| | | $encoding = 'base64') |
| | | { |
| | | $filedata = ($isfilename === true) ? $this->_file2str($file) |
| | | : $file; |
| | | if ($isfilename === true) { |
| | | function addAttachment($file, |
| | | $c_type = 'application/octet-stream', |
| | | $name = '', |
| | | $isfile = true, |
| | | $encoding = 'base64', |
| | | $disposition = 'attachment', |
| | | $charset = '', |
| | | $language = '', |
| | | $location = '', |
| | | $n_encoding = null, |
| | | $f_encoding = null, |
| | | $description = '', |
| | | $h_charset = null |
| | | ) { |
| | | $bodyfile = null; |
| | | |
| | | if ($isfile) { |
| | | // Don't load file into memory |
| | | if ($this->_build_params['delay_file_io']) { |
| | | $filedata = null; |
| | | $bodyfile = $file; |
| | | } else { |
| | | if (PEAR::isError($filedata = $this->_file2str($file))) { |
| | | return $filedata; |
| | | } |
| | | } |
| | | // Force the name the user supplied, otherwise use $file |
| | | $filename = (!empty($name)) ? $name : $file; |
| | | $filename = ($name ? $name : $file); |
| | | } else { |
| | | $filedata = $file; |
| | | $filename = $name; |
| | | } |
| | | if (empty($filename)) { |
| | | return PEAR::raiseError( |
| | | 'The supplied filename for the attachment can\'t be empty' |
| | | ); |
| | | |
| | | if (!strlen($filename)) { |
| | | $msg = "The supplied filename for the attachment can't be empty"; |
| | | $err = PEAR::raiseError($msg); |
| | | return $err; |
| | | } |
| | | $filename = basename($filename); |
| | | if (PEAR::isError($filedata)) { |
| | | return $filedata; |
| | | } |
| | | $filename = $this->_basename($filename); |
| | | |
| | | $this->_parts[] = array( |
| | | 'body' => $filedata, |
| | | 'name' => $filename, |
| | | 'c_type' => $c_type, |
| | | 'encoding' => $encoding |
| | | ); |
| | | 'body' => $filedata, |
| | | 'body_file' => $bodyfile, |
| | | 'name' => $filename, |
| | | 'c_type' => $c_type, |
| | | 'charset' => $charset, |
| | | 'encoding' => $encoding, |
| | | 'language' => $language, |
| | | 'location' => $location, |
| | | 'disposition' => $disposition, |
| | | 'description' => $description, |
| | | 'name_encoding' => $n_encoding, |
| | | 'filename_encoding' => $f_encoding, |
| | | 'headers_charset' => $h_charset, |
| | | ); |
| | | |
| | | return true; |
| | | } |
| | | |
| | | /** |
| | | * Get the contents of the given file name as string |
| | | * |
| | | * @param string $file_name path of file to process |
| | | * @return string contents of $file_name |
| | | * @param string $file_name Path of file to process |
| | | * |
| | | * @return string Contents of $file_name |
| | | * @access private |
| | | */ |
| | | function &_file2str($file_name) |
| | | { |
| | | // Check state of file and raise an error properly |
| | | if (!file_exists($file_name)) { |
| | | $err = PEAR::raiseError('File not found: ' . $file_name); |
| | | return $err; |
| | | } |
| | | if (!is_file($file_name)) { |
| | | $err = PEAR::raiseError('Not a regular file: ' . $file_name); |
| | | return $err; |
| | | } |
| | | if (!is_readable($file_name)) { |
| | | return PEAR::raiseError('File is not readable ' . $file_name); |
| | | $err = PEAR::raiseError('File is not readable: ' . $file_name); |
| | | return $err; |
| | | } |
| | | if (!$fd = fopen($file_name, 'rb')) { |
| | | return PEAR::raiseError('Could not open ' . $file_name); |
| | | |
| | | // Temporarily reset magic_quotes_runtime and read file contents |
| | | if ($magic_quote_setting = get_magic_quotes_runtime()) { |
| | | @ini_set('magic_quotes_runtime', 0); |
| | | } |
| | | $filesize = filesize($file_name); |
| | | if ($filesize == 0){ |
| | | $cont = ""; |
| | | }else{ |
| | | $cont = fread($fd, $filesize); |
| | | $cont = file_get_contents($file_name); |
| | | if ($magic_quote_setting) { |
| | | @ini_set('magic_quotes_runtime', $magic_quote_setting); |
| | | } |
| | | fclose($fd); |
| | | |
| | | return $cont; |
| | | } |
| | | |
| | |
| | | * Adds a text subpart to the mimePart object and |
| | | * returns it during the build process. |
| | | * |
| | | * @param mixed The object to add the part to, or |
| | | * null if a new object is to be created. |
| | | * @param string The text to add. |
| | | * @return object The text mimePart object |
| | | * @param mixed &$obj The object to add the part to, or |
| | | * null if a new object is to be created. |
| | | * @param string $text The text to add. |
| | | * |
| | | * @return object The text mimePart object |
| | | * @access private |
| | | */ |
| | | function &_addTextPart(&$obj, $text) |
| | |
| | | $params['content_type'] = 'text/plain'; |
| | | $params['encoding'] = $this->_build_params['text_encoding']; |
| | | $params['charset'] = $this->_build_params['text_charset']; |
| | | $params['eol'] = $this->_build_params['eol']; |
| | | |
| | | if (is_object($obj)) { |
| | | return $obj->addSubpart($text, $params); |
| | | $ret = $obj->addSubpart($text, $params); |
| | | return $ret; |
| | | } else { |
| | | return new Mail_mimePart($text, $params); |
| | | $ret = new Mail_mimePart($text, $params); |
| | | return $ret; |
| | | } |
| | | } |
| | | |
| | |
| | | * Adds a html subpart to the mimePart object and |
| | | * returns it during the build process. |
| | | * |
| | | * @param mixed The object to add the part to, or |
| | | * null if a new object is to be created. |
| | | * @return object The html mimePart object |
| | | * @param mixed &$obj The object to add the part to, or |
| | | * null if a new object is to be created. |
| | | * |
| | | * @return object The html mimePart object |
| | | * @access private |
| | | */ |
| | | function &_addHtmlPart(&$obj) |
| | |
| | | $params['content_type'] = 'text/html'; |
| | | $params['encoding'] = $this->_build_params['html_encoding']; |
| | | $params['charset'] = $this->_build_params['html_charset']; |
| | | $params['eol'] = $this->_build_params['eol']; |
| | | |
| | | if (is_object($obj)) { |
| | | return $obj->addSubpart($this->_htmlbody, $params); |
| | | $ret = $obj->addSubpart($this->_htmlbody, $params); |
| | | return $ret; |
| | | } else { |
| | | return new Mail_mimePart($this->_htmlbody, $params); |
| | | $ret = new Mail_mimePart($this->_htmlbody, $params); |
| | | return $ret; |
| | | } |
| | | } |
| | | |
| | |
| | | * the initial content-type and returns it during the |
| | | * build process. |
| | | * |
| | | * @return object The multipart/mixed mimePart object |
| | | * @return object The multipart/mixed mimePart object |
| | | * @access private |
| | | */ |
| | | function &_addMixedPart() |
| | | { |
| | | $params = array(); |
| | | $params['content_type'] = 'multipart/mixed'; |
| | | return new Mail_mimePart('', $params); |
| | | $params['eol'] = $this->_build_params['eol']; |
| | | |
| | | // Create empty multipart/mixed Mail_mimePart object to return |
| | | $ret = new Mail_mimePart('', $params); |
| | | return $ret; |
| | | } |
| | | |
| | | /** |
| | |
| | | * object (or creates one), and returns it during |
| | | * the build process. |
| | | * |
| | | * @param mixed The object to add the part to, or |
| | | * null if a new object is to be created. |
| | | * @return object The multipart/mixed mimePart object |
| | | * @param mixed &$obj The object to add the part to, or |
| | | * null if a new object is to be created. |
| | | * |
| | | * @return object The multipart/mixed mimePart object |
| | | * @access private |
| | | */ |
| | | function &_addAlternativePart(&$obj) |
| | | { |
| | | $params['content_type'] = 'multipart/alternative'; |
| | | $params['eol'] = $this->_build_params['eol']; |
| | | |
| | | if (is_object($obj)) { |
| | | return $obj->addSubpart('', $params); |
| | | } else { |
| | | return new Mail_mimePart('', $params); |
| | | $ret = new Mail_mimePart('', $params); |
| | | return $ret; |
| | | } |
| | | } |
| | | |
| | |
| | | * object (or creates one), and returns it during |
| | | * the build process. |
| | | * |
| | | * @param mixed The object to add the part to, or |
| | | * null if a new object is to be created |
| | | * @return object The multipart/mixed mimePart object |
| | | * @param mixed &$obj The object to add the part to, or |
| | | * null if a new object is to be created |
| | | * |
| | | * @return object The multipart/mixed mimePart object |
| | | * @access private |
| | | */ |
| | | function &_addRelatedPart(&$obj) |
| | | { |
| | | $params['content_type'] = 'multipart/related'; |
| | | $params['eol'] = $this->_build_params['eol']; |
| | | |
| | | if (is_object($obj)) { |
| | | return $obj->addSubpart('', $params); |
| | | } else { |
| | | return new Mail_mimePart('', $params); |
| | | $ret = new Mail_mimePart('', $params); |
| | | return $ret; |
| | | } |
| | | } |
| | | |
| | |
| | | * Adds an html image subpart to a mimePart object |
| | | * and returns it during the build process. |
| | | * |
| | | * @param object The mimePart to add the image to |
| | | * @param array The image information |
| | | * @return object The image mimePart object |
| | | * @param object &$obj The mimePart to add the image to |
| | | * @param array $value The image information |
| | | * |
| | | * @return object The image mimePart object |
| | | * @access private |
| | | */ |
| | | function &_addHtmlImagePart(&$obj, $value) |
| | |
| | | $params['content_type'] = $value['c_type']; |
| | | $params['encoding'] = 'base64'; |
| | | $params['disposition'] = 'inline'; |
| | | $params['dfilename'] = $value['name']; |
| | | $params['filename'] = $value['name']; |
| | | $params['cid'] = $value['cid']; |
| | | $obj->addSubpart($value['body'], $params); |
| | | $params['body_file'] = $value['body_file']; |
| | | $params['eol'] = $this->_build_params['eol']; |
| | | |
| | | if (!empty($value['name_encoding'])) { |
| | | $params['name_encoding'] = $value['name_encoding']; |
| | | } |
| | | if (!empty($value['filename_encoding'])) { |
| | | $params['filename_encoding'] = $value['filename_encoding']; |
| | | } |
| | | |
| | | $ret = $obj->addSubpart($value['body'], $params); |
| | | return $ret; |
| | | } |
| | | |
| | | /** |
| | | * Adds an attachment subpart to a mimePart object |
| | | * and returns it during the build process. |
| | | * |
| | | * @param object The mimePart to add the image to |
| | | * @param array The attachment information |
| | | * @return object The image mimePart object |
| | | * @param object &$obj The mimePart to add the image to |
| | | * @param array $value The attachment information |
| | | * |
| | | * @return object The image mimePart object |
| | | * @access private |
| | | */ |
| | | function &_addAttachmentPart(&$obj, $value) |
| | | { |
| | | $params['content_type'] = $value['c_type']; |
| | | $params['eol'] = $this->_build_params['eol']; |
| | | $params['filename'] = $value['name']; |
| | | $params['encoding'] = $value['encoding']; |
| | | $params['disposition'] = 'attachment'; |
| | | $params['dfilename'] = $value['name']; |
| | | $obj->addSubpart($value['body'], $params); |
| | | $params['content_type'] = $value['c_type']; |
| | | $params['body_file'] = $value['body_file']; |
| | | $params['disposition'] = isset($value['disposition']) ? |
| | | $value['disposition'] : 'attachment'; |
| | | |
| | | // content charset |
| | | if (!empty($value['charset'])) { |
| | | $params['charset'] = $value['charset']; |
| | | } |
| | | // headers charset (filename, description) |
| | | if (!empty($value['headers_charset'])) { |
| | | $params['headers_charset'] = $value['headers_charset']; |
| | | } |
| | | if (!empty($value['language'])) { |
| | | $params['language'] = $value['language']; |
| | | } |
| | | if (!empty($value['location'])) { |
| | | $params['location'] = $value['location']; |
| | | } |
| | | if (!empty($value['name_encoding'])) { |
| | | $params['name_encoding'] = $value['name_encoding']; |
| | | } |
| | | if (!empty($value['filename_encoding'])) { |
| | | $params['filename_encoding'] = $value['filename_encoding']; |
| | | } |
| | | if (!empty($value['description'])) { |
| | | $params['description'] = $value['description']; |
| | | } |
| | | |
| | | $ret = $obj->addSubpart($value['body'], $params); |
| | | return $ret; |
| | | } |
| | | |
| | | /** |
| | | * Returns the complete e-mail, ready to send using an alternative |
| | | * mail delivery method. Note that only the mailpart that is made |
| | | * with Mail_Mime is created. This means that, |
| | | * YOU WILL HAVE NO TO: HEADERS UNLESS YOU SET IT YOURSELF |
| | | * using the $headers parameter! |
| | | * |
| | | * @param string $separation The separation between these two parts. |
| | | * @param array $params The Build parameters passed to the |
| | | * &get() function. See &get for more info. |
| | | * @param array $headers The extra headers that should be passed |
| | | * to the &headers() function. |
| | | * See that function for more info. |
| | | * @param bool $overwrite Overwrite the existing headers with new. |
| | | * |
| | | * @return mixed The complete e-mail or PEAR error object |
| | | * @access public |
| | | */ |
| | | function getMessage($separation = null, $params = null, $headers = null, |
| | | $overwrite = false |
| | | ) { |
| | | if ($separation === null) { |
| | | $separation = $this->_build_params['eol']; |
| | | } |
| | | |
| | | $body = $this->get($params); |
| | | |
| | | if (PEAR::isError($body)) { |
| | | return $body; |
| | | } |
| | | |
| | | $head = $this->txtHeaders($headers, $overwrite); |
| | | $mail = $head . $separation . $body; |
| | | return $mail; |
| | | } |
| | | |
| | | /** |
| | | * Returns the complete e-mail body, ready to send using an alternative |
| | | * mail delivery method. |
| | | * |
| | | * @param array $params The Build parameters passed to the |
| | | * &get() function. See &get for more info. |
| | | * |
| | | * @return mixed The e-mail body or PEAR error object |
| | | * @access public |
| | | * @since 1.6.0 |
| | | */ |
| | | function getMessageBody($params = null) |
| | | { |
| | | return $this->get($params, null, true); |
| | | } |
| | | |
| | | /** |
| | | * Writes (appends) the complete e-mail into file. |
| | | * |
| | | * @param string $filename Output file location |
| | | * @param array $params The Build parameters passed to the |
| | | * &get() function. See &get for more info. |
| | | * @param array $headers The extra headers that should be passed |
| | | * to the &headers() function. |
| | | * See that function for more info. |
| | | * @param bool $overwrite Overwrite the existing headers with new. |
| | | * |
| | | * @return mixed True or PEAR error object |
| | | * @access public |
| | | * @since 1.6.0 |
| | | */ |
| | | function saveMessage($filename, $params = null, $headers = null, $overwrite = false) |
| | | { |
| | | // Check state of file and raise an error properly |
| | | if (file_exists($filename) && !is_writable($filename)) { |
| | | $err = PEAR::raiseError('File is not writable: ' . $filename); |
| | | return $err; |
| | | } |
| | | |
| | | // Temporarily reset magic_quotes_runtime and read file contents |
| | | if ($magic_quote_setting = get_magic_quotes_runtime()) { |
| | | @ini_set('magic_quotes_runtime', 0); |
| | | } |
| | | |
| | | if (!($fh = fopen($filename, 'ab'))) { |
| | | $err = PEAR::raiseError('Unable to open file: ' . $filename); |
| | | return $err; |
| | | } |
| | | |
| | | // Write message headers into file (skipping Content-* headers) |
| | | $head = $this->txtHeaders($headers, $overwrite, true); |
| | | if (fwrite($fh, $head) === false) { |
| | | $err = PEAR::raiseError('Error writing to file: ' . $filename); |
| | | return $err; |
| | | } |
| | | |
| | | fclose($fh); |
| | | |
| | | if ($magic_quote_setting) { |
| | | @ini_set('magic_quotes_runtime', $magic_quote_setting); |
| | | } |
| | | |
| | | // Write the rest of the message into file |
| | | $res = $this->get($params, $filename); |
| | | |
| | | return $res ? $res : true; |
| | | } |
| | | |
| | | /** |
| | | * Writes (appends) the complete e-mail body into file. |
| | | * |
| | | * @param string $filename Output file location |
| | | * @param array $params The Build parameters passed to the |
| | | * &get() function. See &get for more info. |
| | | * |
| | | * @return mixed True or PEAR error object |
| | | * @access public |
| | | * @since 1.6.0 |
| | | */ |
| | | function saveMessageBody($filename, $params = null) |
| | | { |
| | | // Check state of file and raise an error properly |
| | | if (file_exists($filename) && !is_writable($filename)) { |
| | | $err = PEAR::raiseError('File is not writable: ' . $filename); |
| | | return $err; |
| | | } |
| | | |
| | | // Temporarily reset magic_quotes_runtime and read file contents |
| | | if ($magic_quote_setting = get_magic_quotes_runtime()) { |
| | | @ini_set('magic_quotes_runtime', 0); |
| | | } |
| | | |
| | | if (!($fh = fopen($filename, 'ab'))) { |
| | | $err = PEAR::raiseError('Unable to open file: ' . $filename); |
| | | return $err; |
| | | } |
| | | |
| | | // Write the rest of the message into file |
| | | $res = $this->get($params, $filename, true); |
| | | |
| | | return $res ? $res : true; |
| | | } |
| | | |
| | | /** |
| | | * Builds the multipart message from the list ($this->_parts) and |
| | | * returns the mime content. |
| | | * |
| | | * @param array Build parameters that change the way the email |
| | | * is built. Should be associative. Can contain: |
| | | * text_encoding - What encoding to use for plain text |
| | | * Default is 7bit |
| | | * html_encoding - What encoding to use for html |
| | | * Default is quoted-printable |
| | | * 7bit_wrap - Number of characters before text is |
| | | * wrapped in 7bit encoding |
| | | * Default is 998 |
| | | * html_charset - The character set to use for html. |
| | | * Default is iso-8859-1 |
| | | * text_charset - The character set to use for text. |
| | | * Default is iso-8859-1 |
| | | * head_charset - The character set to use for headers. |
| | | * Default is iso-8859-1 |
| | | * @return string The mime content |
| | | * @param array $params Build parameters that change the way the email |
| | | * is built. Should be associative. See $_build_params. |
| | | * @param resource $filename Output file where to save the message instead of |
| | | * returning it |
| | | * @param boolean $skip_head True if you want to return/save only the message |
| | | * without headers |
| | | * |
| | | * @return mixed The MIME message content string, null or PEAR error object |
| | | * @access public |
| | | */ |
| | | function &get($build_params = null) |
| | | function &get($params = null, $filename = null, $skip_head = false) |
| | | { |
| | | if (isset($build_params)) { |
| | | while (list($key, $value) = each($build_params)) { |
| | | if (isset($params)) { |
| | | while (list($key, $value) = each($params)) { |
| | | $this->_build_params[$key] = $value; |
| | | } |
| | | } |
| | | |
| | | if (!empty($this->_html_images) AND isset($this->_htmlbody)) { |
| | | foreach ($this->_html_images as $value) { |
| | | $regex = '#(\s)((?i)src|background|href(?-i))\s*=\s*(["\']?)' . preg_quote($value['name'], '#') . |
| | | '\3#'; |
| | | $rep = '\1\2=\3cid:' . $value['cid'] .'\3'; |
| | | $this->_htmlbody = preg_replace($regex, $rep, |
| | | $this->_htmlbody |
| | | ); |
| | | if (isset($this->_headers['From'])) { |
| | | // Bug #11381: Illegal characters in domain ID |
| | | if (preg_match('#(@[0-9a-zA-Z\-\.]+)#', $this->_headers['From'], $matches)) { |
| | | $domainID = $matches[1]; |
| | | } else { |
| | | $domainID = '@localhost'; |
| | | } |
| | | foreach ($this->_html_images as $i => $img) { |
| | | $cid = $this->_html_images[$i]['cid']; |
| | | if (!preg_match('#'.preg_quote($domainID).'$#', $cid)) { |
| | | $this->_html_images[$i]['cid'] = $cid . $domainID; |
| | | } |
| | | } |
| | | } |
| | | |
| | | if (count($this->_html_images) && isset($this->_htmlbody)) { |
| | | foreach ($this->_html_images as $key => $value) { |
| | | $regex = array(); |
| | | $regex[] = '#(\s)((?i)src|background|href(?-i))\s*=\s*(["\']?)' . |
| | | preg_quote($value['name'], '#') . '\3#'; |
| | | $regex[] = '#(?i)url(?-i)\(\s*(["\']?)' . |
| | | preg_quote($value['name'], '#') . '\1\s*\)#'; |
| | | |
| | | $rep = array(); |
| | | $rep[] = '\1\2=\3cid:' . $value['cid'] .'\3'; |
| | | $rep[] = 'url(\1cid:' . $value['cid'] . '\1)'; |
| | | |
| | | $this->_htmlbody = preg_replace($regex, $rep, $this->_htmlbody); |
| | | $this->_html_images[$key]['name'] |
| | | = $this->_basename($this->_html_images[$key]['name']); |
| | | } |
| | | } |
| | | |
| | | $this->_checkParams(); |
| | | |
| | | $null = null; |
| | | $attachments = !empty($this->_parts) ? true : false; |
| | | $html_images = !empty($this->_html_images) ? true : false; |
| | | $html = !empty($this->_htmlbody) ? true : false; |
| | | $text = (!$html AND !empty($this->_txtbody)) ? true : false; |
| | | $attachments = count($this->_parts) ? true : false; |
| | | $html_images = count($this->_html_images) ? true : false; |
| | | $html = strlen($this->_htmlbody) ? true : false; |
| | | $text = (!$html && strlen($this->_txtbody)) ? true : false; |
| | | |
| | | switch (true) { |
| | | case $text AND !$attachments: |
| | | case $text && !$attachments: |
| | | $message =& $this->_addTextPart($null, $this->_txtbody); |
| | | break; |
| | | |
| | | case !$text AND !$html AND $attachments: |
| | | case !$text && !$html && $attachments: |
| | | $message =& $this->_addMixedPart(); |
| | | for ($i = 0; $i < count($this->_parts); $i++) { |
| | | $this->_addAttachmentPart($message, $this->_parts[$i]); |
| | | } |
| | | break; |
| | | |
| | | case $text AND $attachments: |
| | | case $text && $attachments: |
| | | $message =& $this->_addMixedPart(); |
| | | $this->_addTextPart($message, $this->_txtbody); |
| | | for ($i = 0; $i < count($this->_parts); $i++) { |
| | |
| | | } |
| | | break; |
| | | |
| | | case $html AND !$attachments AND !$html_images: |
| | | case $html && !$attachments && !$html_images: |
| | | if (isset($this->_txtbody)) { |
| | | $message =& $this->_addAlternativePart($null); |
| | | $this->_addTextPart($message, $this->_txtbody); |
| | |
| | | } |
| | | break; |
| | | |
| | | case $html AND !$attachments AND $html_images: |
| | | case $html && !$attachments && $html_images: |
| | | // * Content-Type: multipart/alternative; |
| | | // * text |
| | | // * Content-Type: multipart/related; |
| | | // * html |
| | | // * image... |
| | | if (isset($this->_txtbody)) { |
| | | $message =& $this->_addAlternativePart($null); |
| | | $this->_addTextPart($message, $this->_txtbody); |
| | | $related =& $this->_addRelatedPart($message); |
| | | |
| | | $ht =& $this->_addRelatedPart($message); |
| | | $this->_addHtmlPart($ht); |
| | | for ($i = 0; $i < count($this->_html_images); $i++) { |
| | | $this->_addHtmlImagePart($ht, $this->_html_images[$i]); |
| | | } |
| | | } else { |
| | | // * Content-Type: multipart/related; |
| | | // * html |
| | | // * image... |
| | | $message =& $this->_addRelatedPart($null); |
| | | $related =& $message; |
| | | $this->_addHtmlPart($message); |
| | | for ($i = 0; $i < count($this->_html_images); $i++) { |
| | | $this->_addHtmlImagePart($message, $this->_html_images[$i]); |
| | | } |
| | | } |
| | | $this->_addHtmlPart($related); |
| | | /* |
| | | // #13444, #9725: the code below was a non-RFC compliant hack |
| | | // * Content-Type: multipart/related; |
| | | // * Content-Type: multipart/alternative; |
| | | // * text |
| | | // * html |
| | | // * image... |
| | | $message =& $this->_addRelatedPart($null); |
| | | if (isset($this->_txtbody)) { |
| | | $alt =& $this->_addAlternativePart($message); |
| | | $this->_addTextPart($alt, $this->_txtbody); |
| | | $this->_addHtmlPart($alt); |
| | | } else { |
| | | $this->_addHtmlPart($message); |
| | | } |
| | | for ($i = 0; $i < count($this->_html_images); $i++) { |
| | | $this->_addHtmlImagePart($related, $this->_html_images[$i]); |
| | | $this->_addHtmlImagePart($message, $this->_html_images[$i]); |
| | | } |
| | | */ |
| | | break; |
| | | |
| | | case $html AND $attachments AND !$html_images: |
| | | case $html && $attachments && !$html_images: |
| | | $message =& $this->_addMixedPart(); |
| | | if (isset($this->_txtbody)) { |
| | | $alt =& $this->_addAlternativePart($message); |
| | |
| | | } |
| | | break; |
| | | |
| | | case $html AND $attachments AND $html_images: |
| | | case $html && $attachments && $html_images: |
| | | $message =& $this->_addMixedPart(); |
| | | if (isset($this->_txtbody)) { |
| | | $alt =& $this->_addAlternativePart($message); |
| | |
| | | |
| | | } |
| | | |
| | | if (isset($message)) { |
| | | $output = $message->encode(); |
| | | $this->_headers = array_merge($this->_headers, |
| | | $output['headers']); |
| | | return $output['body']; |
| | | if (!isset($message)) { |
| | | $ret = null; |
| | | return $ret; |
| | | } |
| | | |
| | | // Use saved boundary |
| | | if (!empty($this->_build_params['boundary'])) { |
| | | $boundary = $this->_build_params['boundary']; |
| | | } else { |
| | | return false; |
| | | $boundary = null; |
| | | } |
| | | |
| | | // Write output to file |
| | | if ($filename) { |
| | | // Append mimePart message headers and body into file |
| | | $headers = $message->encodeToFile($filename, $boundary, $skip_head); |
| | | if (PEAR::isError($headers)) { |
| | | return $headers; |
| | | } |
| | | $this->_headers = array_merge($this->_headers, $headers); |
| | | $ret = null; |
| | | return $ret; |
| | | } else { |
| | | $output = $message->encode($boundary, $skip_head); |
| | | if (PEAR::isError($output)) { |
| | | return $output; |
| | | } |
| | | $this->_headers = array_merge($this->_headers, $output['headers']); |
| | | $body = $output['body']; |
| | | return $body; |
| | | } |
| | | } |
| | | |
| | |
| | | * (MIME-Version and Content-Type). Format of argument is: |
| | | * $array['header-name'] = 'header-value'; |
| | | * |
| | | * @param array $xtra_headers Assoc array with any extra headers. |
| | | * Optional. |
| | | * @return array Assoc array with the mime headers |
| | | * @param array $xtra_headers Assoc array with any extra headers (optional) |
| | | * (Don't set Content-Type for multipart messages here!) |
| | | * @param bool $overwrite Overwrite already existing headers. |
| | | * @param bool $skip_content Don't return content headers: Content-Type, |
| | | * Content-Disposition and Content-Transfer-Encoding |
| | | * |
| | | * @return array Assoc array with the mime headers |
| | | * @access public |
| | | */ |
| | | function &headers($xtra_headers = null) |
| | | function &headers($xtra_headers = null, $overwrite = false, $skip_content = false) |
| | | { |
| | | // Content-Type header should already be present, |
| | | // So just add mime version header |
| | | // Add mime version header |
| | | $headers['MIME-Version'] = '1.0'; |
| | | if (isset($xtra_headers)) { |
| | | |
| | | // Content-Type and Content-Transfer-Encoding headers should already |
| | | // be present if get() was called, but we'll re-set them to make sure |
| | | // we got them when called before get() or something in the message |
| | | // has been changed after get() [#14780] |
| | | if (!$skip_content) { |
| | | $headers += $this->_contentHeaders(); |
| | | } |
| | | |
| | | if (!empty($xtra_headers)) { |
| | | $headers = array_merge($headers, $xtra_headers); |
| | | } |
| | | $this->_headers = array_merge($headers, $this->_headers); |
| | | |
| | | return $this->_encodeHeaders($this->_headers); |
| | | if ($overwrite) { |
| | | $this->_headers = array_merge($this->_headers, $headers); |
| | | } else { |
| | | $this->_headers = array_merge($headers, $this->_headers); |
| | | } |
| | | |
| | | $headers = $this->_headers; |
| | | |
| | | if ($skip_content) { |
| | | unset($headers['Content-Type']); |
| | | unset($headers['Content-Transfer-Encoding']); |
| | | unset($headers['Content-Disposition']); |
| | | } else if (!empty($this->_build_params['ctype'])) { |
| | | $headers['Content-Type'] = $this->_build_params['ctype']; |
| | | } |
| | | |
| | | $encodedHeaders = $this->_encodeHeaders($headers); |
| | | return $encodedHeaders; |
| | | } |
| | | |
| | | /** |
| | | * Get the text version of the headers |
| | | * (usefull if you want to use the PHP mail() function) |
| | | * |
| | | * @param array $xtra_headers Assoc array with any extra headers. |
| | | * Optional. |
| | | * @return string Plain text headers |
| | | * @param array $xtra_headers Assoc array with any extra headers (optional) |
| | | * (Don't set Content-Type for multipart messages here!) |
| | | * @param bool $overwrite Overwrite the existing headers with new. |
| | | * @param bool $skip_content Don't return content headers: Content-Type, |
| | | * Content-Disposition and Content-Transfer-Encoding |
| | | * |
| | | * @return string Plain text headers |
| | | * @access public |
| | | */ |
| | | function txtHeaders($xtra_headers = null) |
| | | function txtHeaders($xtra_headers = null, $overwrite = false, $skip_content = false) |
| | | { |
| | | $headers = $this->headers($xtra_headers); |
| | | $ret = ''; |
| | | foreach ($headers as $key => $val) { |
| | | $ret .= "$key: $val" . MAIL_MIME_CRLF; |
| | | $headers = $this->headers($xtra_headers, $overwrite, $skip_content); |
| | | |
| | | // Place Received: headers at the beginning of the message |
| | | // Spam detectors often flag messages with it after the Subject: as spam |
| | | if (isset($headers['Received'])) { |
| | | $received = $headers['Received']; |
| | | unset($headers['Received']); |
| | | $headers = array('Received' => $received) + $headers; |
| | | } |
| | | |
| | | $ret = ''; |
| | | $eol = $this->_build_params['eol']; |
| | | |
| | | foreach ($headers as $key => $val) { |
| | | if (is_array($val)) { |
| | | foreach ($val as $value) { |
| | | $ret .= "$key: $value" . $eol; |
| | | } |
| | | } else { |
| | | $ret .= "$key: $val" . $eol; |
| | | } |
| | | } |
| | | |
| | | return $ret; |
| | | } |
| | | |
| | | /** |
| | | * Sets message Content-Type header. |
| | | * Use it to build messages with various content-types e.g. miltipart/raport |
| | | * not supported by _contentHeaders() function. |
| | | * |
| | | * @param string $type Type name |
| | | * @param array $params Hash array of header parameters |
| | | * |
| | | * @return void |
| | | * @access public |
| | | * @since 1.7.0 |
| | | */ |
| | | function setContentType($type, $params = array()) |
| | | { |
| | | $header = $type; |
| | | |
| | | $eol = !empty($this->_build_params['eol']) |
| | | ? $this->_build_params['eol'] : "\r\n"; |
| | | |
| | | // add parameters |
| | | $token_regexp = '#([^\x21,\x23-\x27,\x2A,\x2B,\x2D' |
| | | . ',\x2E,\x30-\x39,\x41-\x5A,\x5E-\x7E])#'; |
| | | if (is_array($params)) { |
| | | foreach ($params as $name => $value) { |
| | | if ($name == 'boundary') { |
| | | $this->_build_params['boundary'] = $value; |
| | | } |
| | | if (!preg_match($token_regexp, $value)) { |
| | | $header .= ";$eol $name=$value"; |
| | | } else { |
| | | $value = addcslashes($value, '\\"'); |
| | | $header .= ";$eol $name=\"$value\""; |
| | | } |
| | | } |
| | | } |
| | | |
| | | // add required boundary parameter if not defined |
| | | if (preg_match('/^multipart\//i', $type)) { |
| | | if (empty($this->_build_params['boundary'])) { |
| | | $this->_build_params['boundary'] = '=_' . md5(rand() . microtime()); |
| | | } |
| | | |
| | | $header .= ";$eol boundary=\"".$this->_build_params['boundary']."\""; |
| | | } |
| | | |
| | | $this->_build_params['ctype'] = $header; |
| | | } |
| | | |
| | | /** |
| | | * Sets the Subject header |
| | | * |
| | | * @param string $subject String to set the subject to |
| | | * access public |
| | | * @param string $subject String to set the subject to. |
| | | * |
| | | * @return void |
| | | * @access public |
| | | */ |
| | | function setSubject($subject) |
| | | { |
| | |
| | | /** |
| | | * Set an email to the From (the sender) header |
| | | * |
| | | * @param string $email The email direction to add |
| | | * @param string $email The email address to use |
| | | * |
| | | * @return void |
| | | * @access public |
| | | */ |
| | | function setFrom($email) |
| | |
| | | } |
| | | |
| | | /** |
| | | * Add an email to the To header |
| | | * (multiple calls to this method are allowed) |
| | | * |
| | | * @param string $email The email direction to add |
| | | * |
| | | * @return void |
| | | * @access public |
| | | */ |
| | | function addTo($email) |
| | | { |
| | | if (isset($this->_headers['To'])) { |
| | | $this->_headers['To'] .= ", $email"; |
| | | } else { |
| | | $this->_headers['To'] = $email; |
| | | } |
| | | } |
| | | |
| | | /** |
| | | * Add an email to the Cc (carbon copy) header |
| | | * (multiple calls to this method are allowed) |
| | | * |
| | | * @param string $email The email direction to add |
| | | * @param string $email The email direction to add |
| | | * |
| | | * @return void |
| | | * @access public |
| | | */ |
| | | function addCc($email) |
| | |
| | | * Add an email to the Bcc (blank carbon copy) header |
| | | * (multiple calls to this method are allowed) |
| | | * |
| | | * @param string $email The email direction to add |
| | | * @param string $email The email direction to add |
| | | * |
| | | * @return void |
| | | * @access public |
| | | */ |
| | | function addBcc($email) |
| | |
| | | } |
| | | |
| | | /** |
| | | * Encodes a header as per RFC2047 |
| | | * |
| | | * @param string $input The header data to encode |
| | | * @return string Encoded data |
| | | * @access private |
| | | */ |
| | | function _encodeHeaders($input) |
| | | * Since the PHP send function requires you to specify |
| | | * recipients (To: header) separately from the other |
| | | * headers, the To: header is not properly encoded. |
| | | * To fix this, you can use this public method to |
| | | * encode your recipients before sending to the send |
| | | * function |
| | | * |
| | | * @param string $recipients A comma-delimited list of recipients |
| | | * |
| | | * @return string Encoded data |
| | | * @access public |
| | | */ |
| | | function encodeRecipients($recipients) |
| | | { |
| | | foreach ($input as $hdr_name => $hdr_value) { |
| | | preg_match_all('/([\w\-]*[\x80-\xFF]+[\w\-]*(\s+[\w\-]*[\x80-\xFF]+[\w\-]*)*)\s*/', |
| | | $hdr_value, $matches); |
| | | foreach ($matches[1] as $value) { |
| | | switch ($head_encoding = $this->_build_params['head_encoding']) { |
| | | case 'base64': |
| | | $symbol = 'B'; |
| | | $replacement = base64_encode($value); |
| | | break; |
| | | $input = array("To" => $recipients); |
| | | $retval = $this->_encodeHeaders($input); |
| | | return $retval["To"] ; |
| | | } |
| | | |
| | | default: |
| | | if ($head_encoding != 'quoted-printable') { |
| | | PEAR::raiseError('Invalid header encoding specified; using `quoted-printable` instead', |
| | | NULL, |
| | | PEAR_ERROR_TRIGGER, |
| | | E_USER_WARNING); |
| | | } |
| | | |
| | | $symbol = 'Q'; |
| | | $replacement = preg_replace('/([\s_=\?\x80-\xFF])/e', '"=" . strtoupper(dechex(ord("\1")))', $value); |
| | | } |
| | | $hdr_value = str_replace($value, '=?' . $this->_build_params['head_charset'] . '?' . $symbol . '?' . $replacement . '?=', $hdr_value); |
| | | } |
| | | $input[$hdr_name] = $hdr_value; |
| | | /** |
| | | * Encodes headers as per RFC2047 |
| | | * |
| | | * @param array $input The header data to encode |
| | | * @param array $params Extra build parameters |
| | | * |
| | | * @return array Encoded data |
| | | * @access private |
| | | */ |
| | | function _encodeHeaders($input, $params = array()) |
| | | { |
| | | $build_params = $this->_build_params; |
| | | while (list($key, $value) = each($params)) { |
| | | $build_params[$key] = $value; |
| | | } |
| | | |
| | | |
| | | foreach ($input as $hdr_name => $hdr_value) { |
| | | if (is_array($hdr_value)) { |
| | | foreach ($hdr_value as $idx => $value) { |
| | | $input[$hdr_name][$idx] = $this->encodeHeader( |
| | | $hdr_name, $value, |
| | | $build_params['head_charset'], $build_params['head_encoding'] |
| | | ); |
| | | } |
| | | } else { |
| | | $input[$hdr_name] = $this->encodeHeader( |
| | | $hdr_name, $hdr_value, |
| | | $build_params['head_charset'], $build_params['head_encoding'] |
| | | ); |
| | | } |
| | | } |
| | | |
| | | return $input; |
| | | } |
| | | |
| | | /** |
| | | * Set the object's end-of-line and define the constant if applicable |
| | | * Encodes a header as per RFC2047 |
| | | * |
| | | * @param string $eol End Of Line sequence |
| | | * @param string $name The header name |
| | | * @param string $value The header data to encode |
| | | * @param string $charset Character set name |
| | | * @param string $encoding Encoding name (base64 or quoted-printable) |
| | | * |
| | | * @return string Encoded header data (without a name) |
| | | * @access public |
| | | * @since 1.5.3 |
| | | */ |
| | | function encodeHeader($name, $value, $charset, $encoding) |
| | | { |
| | | return Mail_mimePart::encodeHeader( |
| | | $name, $value, $charset, $encoding, $this->_build_params['eol'] |
| | | ); |
| | | } |
| | | |
| | | /** |
| | | * Get file's basename (locale independent) |
| | | * |
| | | * @param string $filename Filename |
| | | * |
| | | * @return string Basename |
| | | * @access private |
| | | */ |
| | | function _setEOL($eol) |
| | | function _basename($filename) |
| | | { |
| | | $this->_eol = $eol; |
| | | if (!defined('MAIL_MIME_CRLF')) { |
| | | define('MAIL_MIME_CRLF', $this->_eol, true); |
| | | // basename() is not unicode safe and locale dependent |
| | | if (stristr(PHP_OS, 'win') || stristr(PHP_OS, 'netware')) { |
| | | return preg_replace('/^.*[\\\\\\/]/', '', $filename); |
| | | } else { |
| | | return preg_replace('/^.*[\/]/', '', $filename); |
| | | } |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Get Content-Type and Content-Transfer-Encoding headers of the message |
| | | * |
| | | * @return array Headers array |
| | | * @access private |
| | | */ |
| | | function _contentHeaders() |
| | | { |
| | | $attachments = count($this->_parts) ? true : false; |
| | | $html_images = count($this->_html_images) ? true : false; |
| | | $html = strlen($this->_htmlbody) ? true : false; |
| | | $text = (!$html && strlen($this->_txtbody)) ? true : false; |
| | | $headers = array(); |
| | | |
| | | // See get() |
| | | switch (true) { |
| | | case $text && !$attachments: |
| | | $headers['Content-Type'] = 'text/plain'; |
| | | break; |
| | | |
| | | case !$text && !$html && $attachments: |
| | | case $text && $attachments: |
| | | case $html && $attachments && !$html_images: |
| | | case $html && $attachments && $html_images: |
| | | $headers['Content-Type'] = 'multipart/mixed'; |
| | | break; |
| | | |
| | | case $html && !$attachments && !$html_images && isset($this->_txtbody): |
| | | case $html && !$attachments && $html_images && isset($this->_txtbody): |
| | | $headers['Content-Type'] = 'multipart/alternative'; |
| | | break; |
| | | |
| | | case $html && !$attachments && !$html_images && !isset($this->_txtbody): |
| | | $headers['Content-Type'] = 'text/html'; |
| | | break; |
| | | |
| | | case $html && !$attachments && $html_images && !isset($this->_txtbody): |
| | | $headers['Content-Type'] = 'multipart/related'; |
| | | break; |
| | | |
| | | default: |
| | | return $headers; |
| | | } |
| | | |
| | | $this->_checkParams(); |
| | | |
| | | $eol = !empty($this->_build_params['eol']) |
| | | ? $this->_build_params['eol'] : "\r\n"; |
| | | |
| | | if ($headers['Content-Type'] == 'text/plain') { |
| | | // single-part message: add charset and encoding |
| | | $charset = 'charset=' . $this->_build_params['text_charset']; |
| | | // place charset parameter in the same line, if possible |
| | | // 26 = strlen("Content-Type: text/plain; ") |
| | | $headers['Content-Type'] |
| | | .= (strlen($charset) + 26 <= 76) ? "; $charset" : ";$eol $charset"; |
| | | $headers['Content-Transfer-Encoding'] |
| | | = $this->_build_params['text_encoding']; |
| | | } else if ($headers['Content-Type'] == 'text/html') { |
| | | // single-part message: add charset and encoding |
| | | $charset = 'charset=' . $this->_build_params['html_charset']; |
| | | // place charset parameter in the same line, if possible |
| | | $headers['Content-Type'] |
| | | .= (strlen($charset) + 25 <= 76) ? "; $charset" : ";$eol $charset"; |
| | | $headers['Content-Transfer-Encoding'] |
| | | = $this->_build_params['html_encoding']; |
| | | } else { |
| | | // multipart message: and boundary |
| | | if (!empty($this->_build_params['boundary'])) { |
| | | $boundary = $this->_build_params['boundary']; |
| | | } else if (!empty($this->_headers['Content-Type']) |
| | | && preg_match('/boundary="([^"]+)"/', $this->_headers['Content-Type'], $m) |
| | | ) { |
| | | $boundary = $m[1]; |
| | | } else { |
| | | $boundary = '=_' . md5(rand() . microtime()); |
| | | } |
| | | |
| | | $this->_build_params['boundary'] = $boundary; |
| | | $headers['Content-Type'] .= ";$eol boundary=\"$boundary\""; |
| | | } |
| | | |
| | | return $headers; |
| | | } |
| | | |
| | | /** |
| | | * Validate and set build parameters |
| | | * |
| | | * @return void |
| | | * @access private |
| | | */ |
| | | function _checkParams() |
| | | { |
| | | $encodings = array('7bit', '8bit', 'base64', 'quoted-printable'); |
| | | |
| | | $this->_build_params['text_encoding'] |
| | | = strtolower($this->_build_params['text_encoding']); |
| | | $this->_build_params['html_encoding'] |
| | | = strtolower($this->_build_params['html_encoding']); |
| | | |
| | | if (!in_array($this->_build_params['text_encoding'], $encodings)) { |
| | | $this->_build_params['text_encoding'] = '7bit'; |
| | | } |
| | | if (!in_array($this->_build_params['html_encoding'], $encodings)) { |
| | | $this->_build_params['html_encoding'] = '7bit'; |
| | | } |
| | | |
| | | // text body |
| | | if ($this->_build_params['text_encoding'] == '7bit' |
| | | && !preg_match('/ascii/i', $this->_build_params['text_charset']) |
| | | && preg_match('/[^\x00-\x7F]/', $this->_txtbody) |
| | | ) { |
| | | $this->_build_params['text_encoding'] = 'quoted-printable'; |
| | | } |
| | | // html body |
| | | if ($this->_build_params['html_encoding'] == '7bit' |
| | | && !preg_match('/ascii/i', $this->_build_params['html_charset']) |
| | | && preg_match('/[^\x00-\x7F]/', $this->_htmlbody) |
| | | ) { |
| | | $this->_build_params['html_encoding'] = 'quoted-printable'; |
| | | } |
| | | } |
| | | |
| | | } // End of class |
| | | ?> |