Update to Mail_Mime 1.8.8

pull/85/head
Aleksander Machniak 11 years ago
parent 2b8eb4a5ed
commit 4c8becbdc0

@ -48,7 +48,7 @@
* @author Aleksander Machniak <alec@php.net> * @author Aleksander Machniak <alec@php.net>
* @copyright 2003-2006 PEAR <pear-group@php.net> * @copyright 2003-2006 PEAR <pear-group@php.net>
* @license http://www.opensource.org/licenses/bsd-license.php BSD License * @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version Release: 1.8.7 * @version CVS: $Id$
* @link http://pear.php.net/package/Mail_mime * @link http://pear.php.net/package/Mail_mime
* *
* This class is based on HTML Mime Mail class from * This class is based on HTML Mime Mail class from
@ -89,7 +89,7 @@ require_once 'Mail/mimePart.php';
* @author Sean Coates <sean@php.net> * @author Sean Coates <sean@php.net>
* @copyright 2003-2006 PEAR <pear-group@php.net> * @copyright 2003-2006 PEAR <pear-group@php.net>
* @license http://www.opensource.org/licenses/bsd-license.php BSD License * @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version Release: 1.8.7 * @version Release: @package_version@
* @link http://pear.php.net/package/Mail_mime * @link http://pear.php.net/package/Mail_mime
*/ */
class Mail_mime class Mail_mime
@ -254,6 +254,7 @@ class Mail_mime
$this->_txtbody .= $cont; $this->_txtbody .= $cont;
} }
} }
return true; return true;
} }
@ -347,7 +348,7 @@ class Mail_mime
} }
if (!$content_id) { if (!$content_id) {
$content_id = md5(uniqid(time())); $content_id = preg_replace('/[^0-9a-zA-Z]/', '', uniqid(time(), true));
} }
$this->_html_images[] = array( $this->_html_images[] = array(
@ -429,8 +430,7 @@ class Mail_mime
if (!strlen($filename)) { if (!strlen($filename)) {
$msg = "The supplied filename for the attachment can't be empty"; $msg = "The supplied filename for the attachment can't be empty";
$err = PEAR::raiseError($msg); return $this->_raiseError($msg);
return $err;
} }
$this->_parts[] = array( $this->_parts[] = array(
@ -465,16 +465,13 @@ class Mail_mime
{ {
// Check state of file and raise an error properly // Check state of file and raise an error properly
if (!file_exists($file_name)) { if (!file_exists($file_name)) {
$err = PEAR::raiseError('File not found: ' . $file_name); return $this->_raiseError('File not found: ' . $file_name);
return $err;
} }
if (!is_file($file_name)) { if (!is_file($file_name)) {
$err = PEAR::raiseError('Not a regular file: ' . $file_name); return $this->_raiseError('Not a regular file: ' . $file_name);
return $err;
} }
if (!is_readable($file_name)) { if (!is_readable($file_name)) {
$err = PEAR::raiseError('File is not readable: ' . $file_name); return $this->_raiseError('File is not readable: ' . $file_name);
return $err;
} }
// Temporarily reset magic_quotes_runtime and read file contents // Temporarily reset magic_quotes_runtime and read file contents
@ -500,7 +497,7 @@ class Mail_mime
* @return object The text mimePart object * @return object The text mimePart object
* @access private * @access private
*/ */
function _addTextPart(&$obj, $text) function &_addTextPart(&$obj = null, $text = '')
{ {
$params['content_type'] = 'text/plain'; $params['content_type'] = 'text/plain';
$params['encoding'] = $this->_build_params['text_encoding']; $params['encoding'] = $this->_build_params['text_encoding'];
@ -509,11 +506,11 @@ class Mail_mime
if (is_object($obj)) { if (is_object($obj)) {
$ret = $obj->addSubpart($text, $params); $ret = $obj->addSubpart($text, $params);
return $ret;
} else { } else {
$ret = new Mail_mimePart($text, $params); $ret = new Mail_mimePart($text, $params);
return $ret;
} }
return $ret;
} }
/** /**
@ -526,7 +523,7 @@ class Mail_mime
* @return object The html mimePart object * @return object The html mimePart object
* @access private * @access private
*/ */
function _addHtmlPart(&$obj) function &_addHtmlPart(&$obj = null)
{ {
$params['content_type'] = 'text/html'; $params['content_type'] = 'text/html';
$params['encoding'] = $this->_build_params['html_encoding']; $params['encoding'] = $this->_build_params['html_encoding'];
@ -535,11 +532,11 @@ class Mail_mime
if (is_object($obj)) { if (is_object($obj)) {
$ret = $obj->addSubpart($this->_htmlbody, $params); $ret = $obj->addSubpart($this->_htmlbody, $params);
return $ret;
} else { } else {
$ret = new Mail_mimePart($this->_htmlbody, $params); $ret = new Mail_mimePart($this->_htmlbody, $params);
return $ret;
} }
return $ret;
} }
/** /**
@ -550,9 +547,8 @@ class Mail_mime
* @return object The multipart/mixed mimePart object * @return object The multipart/mixed mimePart object
* @access private * @access private
*/ */
function _addMixedPart() function &_addMixedPart()
{ {
$params = array();
$params['content_type'] = 'multipart/mixed'; $params['content_type'] = 'multipart/mixed';
$params['eol'] = $this->_build_params['eol']; $params['eol'] = $this->_build_params['eol'];
@ -572,17 +568,18 @@ class Mail_mime
* @return object The multipart/mixed mimePart object * @return object The multipart/mixed mimePart object
* @access private * @access private
*/ */
function _addAlternativePart(&$obj) function &_addAlternativePart(&$obj = null)
{ {
$params['content_type'] = 'multipart/alternative'; $params['content_type'] = 'multipart/alternative';
$params['eol'] = $this->_build_params['eol']; $params['eol'] = $this->_build_params['eol'];
if (is_object($obj)) { if (is_object($obj)) {
return $obj->addSubpart('', $params); $ret = $obj->addSubpart('', $params);
} else { } else {
$ret = new Mail_mimePart('', $params); $ret = new Mail_mimePart('', $params);
return $ret;
} }
return $ret;
} }
/** /**
@ -596,17 +593,18 @@ class Mail_mime
* @return object The multipart/mixed mimePart object * @return object The multipart/mixed mimePart object
* @access private * @access private
*/ */
function _addRelatedPart(&$obj) function &_addRelatedPart(&$obj = null)
{ {
$params['content_type'] = 'multipart/related'; $params['content_type'] = 'multipart/related';
$params['eol'] = $this->_build_params['eol']; $params['eol'] = $this->_build_params['eol'];
if (is_object($obj)) { if (is_object($obj)) {
return $obj->addSubpart('', $params); $ret = $obj->addSubpart('', $params);
} else { } else {
$ret = new Mail_mimePart('', $params); $ret = new Mail_mimePart('', $params);
return $ret;
} }
return $ret;
} }
/** /**
@ -619,7 +617,7 @@ class Mail_mime
* @return object The image mimePart object * @return object The image mimePart object
* @access private * @access private
*/ */
function _addHtmlImagePart(&$obj, $value) function &_addHtmlImagePart(&$obj, $value)
{ {
$params['content_type'] = $value['c_type']; $params['content_type'] = $value['c_type'];
$params['encoding'] = 'base64'; $params['encoding'] = 'base64';
@ -650,7 +648,7 @@ class Mail_mime
* @return object The image mimePart object * @return object The image mimePart object
* @access private * @access private
*/ */
function _addAttachmentPart(&$obj, $value) function &_addAttachmentPart(&$obj, $value)
{ {
$params['eol'] = $this->_build_params['eol']; $params['eol'] = $this->_build_params['eol'];
$params['filename'] = $value['name']; $params['filename'] = $value['name'];
@ -700,9 +698,9 @@ class Mail_mime
* *
* @param string $separation The separation between these two parts. * @param string $separation The separation between these two parts.
* @param array $params The Build parameters passed to the * @param array $params The Build parameters passed to the
* &get() function. See &get for more info. * get() function. See get() for more info.
* @param array $headers The extra headers that should be passed * @param array $headers The extra headers that should be passed
* to the &headers() function. * to the headers() method.
* See that function for more info. * See that function for more info.
* @param bool $overwrite Overwrite the existing headers with new. * @param bool $overwrite Overwrite the existing headers with new.
* *
@ -722,9 +720,7 @@ class Mail_mime
return $body; return $body;
} }
$head = $this->txtHeaders($headers, $overwrite); return $this->txtHeaders($headers, $overwrite) . $separation . $body;
$mail = $head . $separation . $body;
return $mail;
} }
/** /**
@ -732,7 +728,7 @@ class Mail_mime
* mail delivery method. * mail delivery method.
* *
* @param array $params The Build parameters passed to the * @param array $params The Build parameters passed to the
* &get() function. See &get for more info. * get() method. See get() for more info.
* *
* @return mixed The e-mail body or PEAR error object * @return mixed The e-mail body or PEAR error object
* @access public * @access public
@ -748,9 +744,9 @@ class Mail_mime
* *
* @param string $filename Output file location * @param string $filename Output file location
* @param array $params The Build parameters passed to the * @param array $params The Build parameters passed to the
* &get() function. See &get for more info. * get() method. See get() for more info.
* @param array $headers The extra headers that should be passed * @param array $headers The extra headers that should be passed
* to the &headers() function. * to the headers() function.
* See that function for more info. * See that function for more info.
* @param bool $overwrite Overwrite the existing headers with new. * @param bool $overwrite Overwrite the existing headers with new.
* *
@ -762,8 +758,7 @@ class Mail_mime
{ {
// Check state of file and raise an error properly // Check state of file and raise an error properly
if (file_exists($filename) && !is_writable($filename)) { if (file_exists($filename) && !is_writable($filename)) {
$err = PEAR::raiseError('File is not writable: ' . $filename); return $this->_raiseError('File is not writable: ' . $filename);
return $err;
} }
// Temporarily reset magic_quotes_runtime and read file contents // Temporarily reset magic_quotes_runtime and read file contents
@ -772,15 +767,13 @@ class Mail_mime
} }
if (!($fh = fopen($filename, 'ab'))) { if (!($fh = fopen($filename, 'ab'))) {
$err = PEAR::raiseError('Unable to open file: ' . $filename); return $this->_raiseError('Unable to open file: ' . $filename);
return $err;
} }
// Write message headers into file (skipping Content-* headers) // Write message headers into file (skipping Content-* headers)
$head = $this->txtHeaders($headers, $overwrite, true); $head = $this->txtHeaders($headers, $overwrite, true);
if (fwrite($fh, $head) === false) { if (fwrite($fh, $head) === false) {
$err = PEAR::raiseError('Error writing to file: ' . $filename); return $this->_raiseError('Error writing to file: ' . $filename);
return $err;
} }
fclose($fh); fclose($fh);
@ -797,10 +790,10 @@ class Mail_mime
/** /**
* Writes (appends) the complete e-mail body into file. * Writes (appends) the complete e-mail body into file.
* *
* @param string $filename Output file location * @param string $filename Output file location
* @param array $params The Build parameters passed to the * @param array $params The Build parameters passed to the
* &get() function. See &get for more info. * get() method. See get() for more info.
* *
* @return mixed True or PEAR error object * @return mixed True or PEAR error object
* @access public * @access public
@ -810,8 +803,7 @@ class Mail_mime
{ {
// Check state of file and raise an error properly // Check state of file and raise an error properly
if (file_exists($filename) && !is_writable($filename)) { if (file_exists($filename) && !is_writable($filename)) {
$err = PEAR::raiseError('File is not writable: ' . $filename); return $this->_raiseError('File is not writable: ' . $filename);
return $err;
} }
// Temporarily reset magic_quotes_runtime and read file contents // Temporarily reset magic_quotes_runtime and read file contents
@ -820,8 +812,7 @@ class Mail_mime
} }
if (!($fh = fopen($filename, 'ab'))) { if (!($fh = fopen($filename, 'ab'))) {
$err = PEAR::raiseError('Unable to open file: ' . $filename); return $this->_raiseError('Unable to open file: ' . $filename);
return $err;
} }
// Write the rest of the message into file // Write the rest of the message into file
@ -844,7 +835,7 @@ class Mail_mime
* @return mixed The MIME message content string, null or PEAR error object * @return mixed The MIME message content string, null or PEAR error object
* @access public * @access public
*/ */
function &get($params = null, $filename = null, $skip_head = false) function get($params = null, $filename = null, $skip_head = false)
{ {
if (isset($params)) { if (isset($params)) {
while (list($key, $value) = each($params)) { while (list($key, $value) = each($params)) {
@ -1004,8 +995,7 @@ class Mail_mime
} }
if (!isset($message)) { if (!isset($message)) {
$ret = null; return null;
return $ret;
} }
// Use saved boundary // Use saved boundary
@ -1023,16 +1013,14 @@ class Mail_mime
return $headers; return $headers;
} }
$this->_headers = array_merge($this->_headers, $headers); $this->_headers = array_merge($this->_headers, $headers);
$ret = null; return null;
return $ret;
} else { } else {
$output = $message->encode($boundary, $skip_head); $output = $message->encode($boundary, $skip_head);
if ($this->_isError($output)) { if ($this->_isError($output)) {
return $output; return $output;
} }
$this->_headers = array_merge($this->_headers, $output['headers']); $this->_headers = array_merge($this->_headers, $output['headers']);
$body = $output['body']; return $output['body'];
return $body;
} }
} }
@ -1050,7 +1038,7 @@ class Mail_mime
* @return array Assoc array with the mime headers * @return array Assoc array with the mime headers
* @access public * @access public
*/ */
function &headers($xtra_headers = null, $overwrite = false, $skip_content = false) function headers($xtra_headers = null, $overwrite = false, $skip_content = false)
{ {
// Add mime version header // Add mime version header
$headers['MIME-Version'] = '1.0'; $headers['MIME-Version'] = '1.0';
@ -1473,7 +1461,7 @@ class Mail_mime
} }
/** /**
* PEAR::isError wrapper * PEAR::isError implementation
* *
* @param mixed $data Object * @param mixed $data Object
* *
@ -1490,4 +1478,18 @@ class Mail_mime
return false; return false;
} }
/**
* PEAR::raiseError implementation
*
* @param $message A text error message
*
* @return PEAR_Error Instance of PEAR_Error
* @access private
*/
function _raiseError($message)
{
// PEAR::raiseError() is not PHP 5.4 compatible
return new PEAR_Error($message);
}
} // End of class } // End of class

@ -48,7 +48,7 @@
* @author Aleksander Machniak <alec@php.net> * @author Aleksander Machniak <alec@php.net>
* @copyright 2003-2006 PEAR <pear-group@php.net> * @copyright 2003-2006 PEAR <pear-group@php.net>
* @license http://www.opensource.org/licenses/bsd-license.php BSD License * @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version Release: 1.8.7 * @version CVS: $Id$
* @link http://pear.php.net/package/Mail_mime * @link http://pear.php.net/package/Mail_mime
*/ */
@ -70,7 +70,7 @@
* @author Aleksander Machniak <alec@php.net> * @author Aleksander Machniak <alec@php.net>
* @copyright 2003-2006 PEAR <pear-group@php.net> * @copyright 2003-2006 PEAR <pear-group@php.net>
* @license http://www.opensource.org/licenses/bsd-license.php BSD License * @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version Release: 1.8.7 * @version Release: @package_version@
* @link http://pear.php.net/package/Mail_mime * @link http://pear.php.net/package/Mail_mime
*/ */
class Mail_mimePart class Mail_mimePart
@ -368,12 +368,12 @@ class Mail_mimePart
function encodeToFile($filename, $boundary=null, $skip_head=false) function encodeToFile($filename, $boundary=null, $skip_head=false)
{ {
if (file_exists($filename) && !is_writable($filename)) { if (file_exists($filename) && !is_writable($filename)) {
$err = PEAR::raiseError('File is not writeable: ' . $filename); $err = $this->_raiseError('File is not writeable: ' . $filename);
return $err; return $err;
} }
if (!($fh = fopen($filename, 'ab'))) { if (!($fh = fopen($filename, 'ab'))) {
$err = PEAR::raiseError('Unable to open file: ' . $filename); $err = $this->_raiseError('Unable to open file: ' . $filename);
return $err; return $err;
} }
@ -456,7 +456,7 @@ class Mail_mimePart
* @param array $params The parameters for the subpart, same * @param array $params The parameters for the subpart, same
* as the $params argument for constructor. * as the $params argument for constructor.
* *
* @return Mail_mimePart A reference to the part you just added. It is * @return Mail_mimePart A reference to the part you just added. In PHP4, it is
* crucial if using multipart/* in your subparts that * crucial if using multipart/* in your subparts that
* you use =& in your script when calling this function, * you use =& in your script when calling this function,
* otherwise you will not be able to add further subparts. * otherwise you will not be able to add further subparts.
@ -464,8 +464,8 @@ class Mail_mimePart
*/ */
function &addSubpart($body, $params) function &addSubpart($body, $params)
{ {
$this->_subparts[] = new Mail_mimePart($body, $params); $this->_subparts[] = $part = new Mail_mimePart($body, $params);
return $this->_subparts[count($this->_subparts) - 1]; return $part;
} }
/** /**
@ -511,12 +511,12 @@ class Mail_mimePart
function _getEncodedDataFromFile($filename, $encoding, $fh=null) function _getEncodedDataFromFile($filename, $encoding, $fh=null)
{ {
if (!is_readable($filename)) { if (!is_readable($filename)) {
$err = PEAR::raiseError('Unable to read file: ' . $filename); $err = $this->_raiseError('Unable to read file: ' . $filename);
return $err; return $err;
} }
if (!($fd = fopen($filename, 'rb'))) { if (!($fd = fopen($filename, 'rb'))) {
$err = PEAR::raiseError('Could not open file: ' . $filename); $err = $this->_raiseError('Could not open file: ' . $filename);
return $err; return $err;
} }
@ -648,7 +648,7 @@ class Mail_mimePart
} }
/** /**
* Encodes the paramater of a header. * Encodes the parameter of a header.
* *
* @param string $name The name of the header-parameter * @param string $name The name of the header-parameter
* @param string $value The value of the paramter * @param string $value The value of the paramter
@ -1013,7 +1013,7 @@ class Mail_mimePart
$value = substr($value, $cutpoint); $value = substr($value, $cutpoint);
$cutpoint = $maxLength; $cutpoint = $maxLength;
// RFC 2047 specifies that any split header should // RFC 2047 specifies that any split header should
// be seperated by a CRLF SPACE. // be separated by a CRLF SPACE.
if ($output) { if ($output) {
$output .= $eol . ' '; $output .= $eol . ' ';
} }
@ -1055,7 +1055,7 @@ class Mail_mimePart
} }
// RFC 2047 specifies that any split header should // RFC 2047 specifies that any split header should
// be seperated by a CRLF SPACE // be separated by a CRLF SPACE
if ($output) { if ($output) {
$output .= $eol . ' '; $output .= $eol . ' ';
} }
@ -1227,7 +1227,7 @@ class Mail_mimePart
} }
/** /**
* PEAR::isError wrapper * PEAR::isError implementation
* *
* @param mixed $data Object * @param mixed $data Object
* *
@ -1244,4 +1244,18 @@ class Mail_mimePart
return false; return false;
} }
/**
* PEAR::raiseError implementation
*
* @param $message A text error message
*
* @return PEAR_Error Instance of PEAR_Error
* @access private
*/
function _raiseError($message)
{
// PEAR::raiseError() is not PHP 5.4 compatible
return new PEAR_Error($message);
}
} // End of class } // End of class

Loading…
Cancel
Save