芝麻web文件管理V1.00
编辑当前文件:/home/mgatv524/public_html/avenida/views/Mail.tar
mail.php 0000644 00000014404 14716356152 0006214 0 ustar 00 * @copyright 2010-2017 Chuck Hagenbuch * @license http://opensource.org/licenses/BSD-3-Clause New BSD License * @version CVS: $Id$ * @link http://pear.php.net/package/Mail/ */ /** * internal PHP-mail() implementation of the PEAR Mail:: interface. * @package Mail * @version $Revision$ */ class Mail_mail extends Mail { /** * Any arguments to pass to the mail() function. * @var string */ var $_params = ''; /** * Constructor. * * Instantiates a new Mail_mail:: object based on the parameters * passed in. * * @param array $params Extra arguments for the mail() function. */ public function __construct($params = null) { // The other mail implementations accept parameters as arrays. // In the interest of being consistent, explode an array into // a string of parameter arguments. if (is_array($params)) { $this->_params = join(' ', $params); } else { $this->_params = $params; } /* Because the mail() function may pass headers as command * line arguments, we can't guarantee the use of the standard * "\r\n" separator. Instead, we use the system's native line * separator. */ if (defined('PHP_EOL')) { $this->sep = PHP_EOL; } else { $this->sep = (strpos(PHP_OS, 'WIN') === false) ? "\n" : "\r\n"; } } /** * Implements Mail_mail::send() function using php's built-in mail() * command. * * @param mixed $recipients Either a comma-seperated list of recipients * (RFC822 compliant), or an array of recipients, * each RFC822 valid. This may contain recipients not * specified in the headers, for Bcc:, resending * messages, etc. * * @param array $headers The array of headers to send with the mail, in an * associative array, where the array key is the * header name (ie, 'Subject'), and the array value * is the header value (ie, 'test'). The header * produced from those values would be 'Subject: * test'. * * @param string $body The full text of the message body, including any * Mime parts, etc. * * @return mixed Returns true on success, or a PEAR_Error * containing a descriptive error message on * failure. */ public function send($recipients, $headers, $body) { if (!is_array($headers)) { return PEAR::raiseError('$headers must be an array'); } $result = $this->_sanitizeHeaders($headers); if (is_a($result, 'PEAR_Error')) { return $result; } // If we're passed an array of recipients, implode it. if (is_array($recipients)) { $recipients = implode(', ', $recipients); } // Get the Subject out of the headers array so that we can // pass it as a seperate argument to mail(). $subject = ''; if (isset($headers['Subject'])) { $subject = $headers['Subject']; unset($headers['Subject']); } // Also remove the To: header. The mail() function will add its own // To: header based on the contents of $recipients. unset($headers['To']); // Flatten the headers out. $headerElements = $this->prepareHeaders($headers); if (is_a($headerElements, 'PEAR_Error')) { return $headerElements; } list(, $text_headers) = $headerElements; // We only use mail()'s optional fifth parameter if the additional // parameters have been provided and we're not running in safe mode. if (empty($this->_params) || ini_get('safe_mode')) { $result = mail($recipients, $subject, $body, $text_headers); } else { $result = mail($recipients, $subject, $body, $text_headers, $this->_params); } // If the mail() function returned failure, we need to create a // PEAR_Error object and return it instead of the boolean result. if ($result === false) { $result = PEAR::raiseError('mail() returned failure'); } return $result; } } sendmail.php 0000644 00000017005 14716356152 0007066 0 ustar 00 * @author Chuck Hagenbuch
* @copyright 2010-2017 Chuck Hagenbuch * @license http://opensource.org/licenses/BSD-3-Clause New BSD License * @version CVS: $Id$ * @link http://pear.php.net/package/Mail/ */ /** * Sendmail implementation of the PEAR Mail:: interface. * @access public * @package Mail * @version $Revision$ */ class Mail_sendmail extends Mail { /** * The location of the sendmail or sendmail wrapper binary on the * filesystem. * @var string */ var $sendmail_path = '/usr/sbin/sendmail'; /** * Any extra command-line parameters to pass to the sendmail or * sendmail wrapper binary. * @var string */ var $sendmail_args = '-i'; /** * Constructor. * * Instantiates a new Mail_sendmail:: object based on the parameters * passed in. It looks for the following parameters: * sendmail_path The location of the sendmail binary on the * filesystem. Defaults to '/usr/sbin/sendmail'. * * sendmail_args Any extra parameters to pass to the sendmail * or sendmail wrapper binary. * * If a parameter is present in the $params array, it replaces the * default. * * @param array $params Hash containing any parameters different from the * defaults. */ public function __construct($params) { if (isset($params['sendmail_path'])) { $this->sendmail_path = $params['sendmail_path']; } if (isset($params['sendmail_args'])) { $this->sendmail_args = $params['sendmail_args']; } /* * Because we need to pass message headers to the sendmail program on * the commandline, we can't guarantee the use of the standard "\r\n" * separator. Instead, we use the system's native line separator. */ if (defined('PHP_EOL')) { $this->sep = PHP_EOL; } else { $this->sep = (strpos(PHP_OS, 'WIN') === false) ? "\n" : "\r\n"; } } /** * Implements Mail::send() function using the sendmail * command-line binary. * * @param mixed $recipients Either a comma-seperated list of recipients * (RFC822 compliant), or an array of recipients, * each RFC822 valid. This may contain recipients not * specified in the headers, for Bcc:, resending * messages, etc. * * @param array $headers The array of headers to send with the mail, in an * associative array, where the array key is the * header name (ie, 'Subject'), and the array value * is the header value (ie, 'test'). The header * produced from those values would be 'Subject: * test'. * * @param string $body The full text of the message body, including any * Mime parts, etc. * * @return mixed Returns true on success, or a PEAR_Error * containing a descriptive error message on * failure. */ public function send($recipients, $headers, $body) { if (!is_array($headers)) { return PEAR::raiseError('$headers must be an array'); } $result = $this->_sanitizeHeaders($headers); if (is_a($result, 'PEAR_Error')) { return $result; } $recipients = $this->parseRecipients($recipients); if (is_a($recipients, 'PEAR_Error')) { return $recipients; } $recipients = implode(' ', array_map('escapeshellarg', $recipients)); $headerElements = $this->prepareHeaders($headers); if (is_a($headerElements, 'PEAR_Error')) { return $headerElements; } list($from, $text_headers) = $headerElements; /* Since few MTAs are going to allow this header to be forged * unless it's in the MAIL FROM: exchange, we'll use * Return-Path instead of From: if it's set. */ if (!empty($headers['Return-Path'])) { $from = $headers['Return-Path']; } if (!isset($from)) { return PEAR::raiseError('No from address given.'); } elseif (strpos($from, ' ') !== false || strpos($from, ';') !== false || strpos($from, '&') !== false || strpos($from, '`') !== false) { return PEAR::raiseError('From address specified with dangerous characters.'); } $from = escapeshellarg($from); // Security bug #16200 $mail = @popen($this->sendmail_path . (!empty($this->sendmail_args) ? ' ' . $this->sendmail_args : '') . " -f$from -- $recipients", 'w'); if (!$mail) { return PEAR::raiseError('Failed to open sendmail [' . $this->sendmail_path . '] for execution.'); } // Write the headers following by two newlines: one to end the headers // section and a second to separate the headers block from the body. fputs($mail, $text_headers . $this->sep . $this->sep); fputs($mail, $body); $result = pclose($mail); if (version_compare(phpversion(), '4.2.3') == -1) { // With older php versions, we need to shift the pclose // result to get the exit code. $result = $result >> 8 & 0xFF; } if ($result != 0) { return PEAR::raiseError('sendmail returned error code ' . $result, $result); } return true; } } null.php 0000644 00000006466 14716356152 0006255 0 ustar 00 * @copyright 2010-2017 Phil Kernick * @license http://opensource.org/licenses/BSD-3-Clause New BSD License * @version CVS: $Id$ * @link http://pear.php.net/package/Mail/ */ /** * Null implementation of the PEAR Mail:: interface. * @access public * @package Mail * @version $Revision$ */ class Mail_null extends Mail { /** * Implements Mail_null::send() function. Silently discards all * mail. * * @param mixed $recipients Either a comma-seperated list of recipients * (RFC822 compliant), or an array of recipients, * each RFC822 valid. This may contain recipients not * specified in the headers, for Bcc:, resending * messages, etc. * * @param array $headers The array of headers to send with the mail, in an * associative array, where the array key is the * header name (ie, 'Subject'), and the array value * is the header value (ie, 'test'). The header * produced from those values would be 'Subject: * test'. * * @param string $body The full text of the message body, including any * Mime parts, etc. * * @return mixed Returns true on success, or a PEAR_Error * containing a descriptive error message on * failure. */ public function send($recipients, $headers, $body) { return true; } } mock.php 0000644 00000011766 14716356152 0006233 0 ustar 00 * @copyright 2010-2017 Chuck Hagenbuch * @license http://opensource.org/licenses/BSD-3-Clause New BSD License * @version CVS: $Id$ * @link http://pear.php.net/package/Mail/ */ /** * Mock implementation of the PEAR Mail:: interface for testing. * @access public * @package Mail * @version $Revision$ */ class Mail_mock extends Mail { /** * Array of messages that have been sent with the mock. * * @var array */ public $sentMessages = array(); /** * Callback before sending mail. * * @var callback */ protected $_preSendCallback; /** * Callback after sending mai. * * @var callback */ protected $_postSendCallback; /** * Constructor. * * Instantiates a new Mail_mock:: object based on the parameters * passed in. It looks for the following parameters, both optional: * preSendCallback Called before an email would be sent. * postSendCallback Called after an email would have been sent. * * @param array Hash containing any parameters. */ public function __construct($params) { if (isset($params['preSendCallback']) && is_callable($params['preSendCallback'])) { $this->_preSendCallback = $params['preSendCallback']; } if (isset($params['postSendCallback']) && is_callable($params['postSendCallback'])) { $this->_postSendCallback = $params['postSendCallback']; } } /** * Implements Mail_mock::send() function. Silently discards all * mail. * * @param mixed $recipients Either a comma-seperated list of recipients * (RFC822 compliant), or an array of recipients, * each RFC822 valid. This may contain recipients not * specified in the headers, for Bcc:, resending * messages, etc. * * @param array $headers The array of headers to send with the mail, in an * associative array, where the array key is the * header name (ie, 'Subject'), and the array value * is the header value (ie, 'test'). The header * produced from those values would be 'Subject: * test'. * * @param string $body The full text of the message body, including any * Mime parts, etc. * * @return mixed Returns true on success, or a PEAR_Error * containing a descriptive error message on * failure. */ public function send($recipients, $headers, $body) { if ($this->_preSendCallback) { call_user_func_array($this->_preSendCallback, array(&$this, $recipients, $headers, $body)); } $entry = array('recipients' => $recipients, 'headers' => $headers, 'body' => $body); $this->sentMessages[] = $entry; if ($this->_postSendCallback) { call_user_func_array($this->_postSendCallback, array(&$this, $recipients, $headers, $body)); } return true; } } RFC822.php 0000644 00000077461 14716356152 0006154 0 ustar 00 * @author Chuck Hagenbuch
(A comment), ted@example.com (Ted Bloggs), Barney;'; * $structure = Mail_RFC822::parseAddressList($address_string, 'example.com', true) * print_r($structure); * * @author Richard Heyes
* @author Chuck Hagenbuch
* @version $Revision$ * @license BSD * @package Mail */ class Mail_RFC822 { /** * The address being parsed by the RFC822 object. * @var string $address */ var $address = ''; /** * The default domain to use for unqualified addresses. * @var string $default_domain */ var $default_domain = 'localhost'; /** * Should we return a nested array showing groups, or flatten everything? * @var boolean $nestGroups */ var $nestGroups = true; /** * Whether or not to validate atoms for non-ascii characters. * @var boolean $validate */ var $validate = true; /** * The array of raw addresses built up as we parse. * @var array $addresses */ var $addresses = array(); /** * The final array of parsed address information that we build up. * @var array $structure */ var $structure = array(); /** * The current error message, if any. * @var string $error */ var $error = null; /** * An internal counter/pointer. * @var integer $index */ var $index = null; /** * The number of groups that have been found in the address list. * @var integer $num_groups * @access public */ var $num_groups = 0; /** * A variable so that we can tell whether or not we're inside a * Mail_RFC822 object. * @var boolean $mailRFC822 */ var $mailRFC822 = true; /** * A limit after which processing stops * @var int $limit */ var $limit = null; /** * Sets up the object. The address must either be set here or when * calling parseAddressList(). One or the other. * * @param string $address The address(es) to validate. * @param string $default_domain Default domain/host etc. If not supplied, will be set to localhost. * @param boolean $nest_groups Whether to return the structure with groups nested for easier viewing. * @param boolean $validate Whether to validate atoms. Turn this off if you need to run addresses through before encoding the personal names, for instance. * * @return object Mail_RFC822 A new Mail_RFC822 object. */ public function __construct($address = null, $default_domain = null, $nest_groups = null, $validate = null, $limit = null) { if (isset($address)) $this->address = $address; if (isset($default_domain)) $this->default_domain = $default_domain; if (isset($nest_groups)) $this->nestGroups = $nest_groups; if (isset($validate)) $this->validate = $validate; if (isset($limit)) $this->limit = $limit; } /** * Starts the whole process. The address must either be set here * or when creating the object. One or the other. * * @param string $address The address(es) to validate. * @param string $default_domain Default domain/host etc. * @param boolean $nest_groups Whether to return the structure with groups nested for easier viewing. * @param boolean $validate Whether to validate atoms. Turn this off if you need to run addresses through before encoding the personal names, for instance. * * @return array A structured array of addresses. */ public function parseAddressList($address = null, $default_domain = null, $nest_groups = null, $validate = null, $limit = null) { if (!isset($this) || !isset($this->mailRFC822)) { $obj = new Mail_RFC822($address, $default_domain, $nest_groups, $validate, $limit); return $obj->parseAddressList(); } if (isset($address)) $this->address = $address; if (isset($default_domain)) $this->default_domain = $default_domain; if (isset($nest_groups)) $this->nestGroups = $nest_groups; if (isset($validate)) $this->validate = $validate; if (isset($limit)) $this->limit = $limit; $this->structure = array(); $this->addresses = array(); $this->error = null; $this->index = null; // Unfold any long lines in $this->address. $this->address = preg_replace('/\r?\n/', "\r\n", $this->address); $this->address = preg_replace('/\r\n(\t| )+/', ' ', $this->address); while ($this->address = $this->_splitAddresses($this->address)); if ($this->address === false || isset($this->error)) { require_once 'PEAR.php'; return PEAR::raiseError($this->error); } // Validate each address individually. If we encounter an invalid // address, stop iterating and return an error immediately. foreach ($this->addresses as $address) { $valid = $this->_validateAddress($address); if ($valid === false || isset($this->error)) { require_once 'PEAR.php'; return PEAR::raiseError($this->error); } if (!$this->nestGroups) { $this->structure = array_merge($this->structure, $valid); } else { $this->structure[] = $valid; } } return $this->structure; } /** * Splits an address into separate addresses. * * @param string $address The addresses to split. * @return boolean Success or failure. */ protected function _splitAddresses($address) { if (!empty($this->limit) && count($this->addresses) == $this->limit) { return ''; } if ($this->_isGroup($address) && !isset($this->error)) { $split_char = ';'; $is_group = true; } elseif (!isset($this->error)) { $split_char = ','; $is_group = false; } elseif (isset($this->error)) { return false; } // Split the string based on the above ten or so lines. $parts = explode($split_char, $address); $string = $this->_splitCheck($parts, $split_char); // If a group... if ($is_group) { // If $string does not contain a colon outside of // brackets/quotes etc then something's fubar. // First check there's a colon at all: if (strpos($string, ':') === false) { $this->error = 'Invalid address: ' . $string; return false; } // Now check it's outside of brackets/quotes: if (!$this->_splitCheck(explode(':', $string), ':')) { return false; } // We must have a group at this point, so increase the counter: $this->num_groups++; } // $string now contains the first full address/group. // Add to the addresses array. $this->addresses[] = array( 'address' => trim($string), 'group' => $is_group ); // Remove the now stored address from the initial line, the +1 // is to account for the explode character. $address = trim(substr($address, strlen($string) + 1)); // If the next char is a comma and this was a group, then // there are more addresses, otherwise, if there are any more // chars, then there is another address. if ($is_group && substr($address, 0, 1) == ','){ $address = trim(substr($address, 1)); return $address; } elseif (strlen($address) > 0) { return $address; } else { return ''; } // If you got here then something's off return false; } /** * Checks for a group at the start of the string. * * @param string $address The address to check. * @return boolean Whether or not there is a group at the start of the string. */ protected function _isGroup($address) { // First comma not in quotes, angles or escaped: $parts = explode(',', $address); $string = $this->_splitCheck($parts, ','); // Now we have the first address, we can reliably check for a // group by searching for a colon that's not escaped or in // quotes or angle brackets. if (count($parts = explode(':', $string)) > 1) { $string2 = $this->_splitCheck($parts, ':'); return ($string2 !== $string); } else { return false; } } /** * A common function that will check an exploded string. * * @param array $parts The exloded string. * @param string $char The char that was exploded on. * @return mixed False if the string contains unclosed quotes/brackets, or the string on success. */ protected function _splitCheck($parts, $char) { $string = $parts[0]; for ($i = 0; $i < count($parts); $i++) { if ($this->_hasUnclosedQuotes($string) || $this->_hasUnclosedBrackets($string, '<>') || $this->_hasUnclosedBrackets($string, '[]') || $this->_hasUnclosedBrackets($string, '()') || substr($string, -1) == '\\') { if (isset($parts[$i + 1])) { $string = $string . $char . $parts[$i + 1]; } else { $this->error = 'Invalid address spec. Unclosed bracket or quotes'; return false; } } else { $this->index = $i; break; } } return $string; } /** * Checks if a string has unclosed quotes or not. * * @param string $string The string to check. * @return boolean True if there are unclosed quotes inside the string, * false otherwise. */ protected function _hasUnclosedQuotes($string) { $string = trim($string); $iMax = strlen($string); $in_quote = false; $i = $slashes = 0; for (; $i < $iMax; ++$i) { switch ($string[$i]) { case '\\': ++$slashes; break; case '"': if ($slashes % 2 == 0) { $in_quote = !$in_quote; } // Fall through to default action below. default: $slashes = 0; break; } } return $in_quote; } /** * Checks if a string has an unclosed brackets or not. IMPORTANT: * This function handles both angle brackets and square brackets; * * @param string $string The string to check. * @param string $chars The characters to check for. * @return boolean True if there are unclosed brackets inside the string, false otherwise. */ protected function _hasUnclosedBrackets($string, $chars) { $num_angle_start = substr_count($string, $chars[0]); $num_angle_end = substr_count($string, $chars[1]); $this->_hasUnclosedBracketsSub($string, $num_angle_start, $chars[0]); $this->_hasUnclosedBracketsSub($string, $num_angle_end, $chars[1]); if ($num_angle_start < $num_angle_end) { $this->error = 'Invalid address spec. Unmatched quote or bracket (' . $chars . ')'; return false; } else { return ($num_angle_start > $num_angle_end); } } /** * Sub function that is used only by hasUnclosedBrackets(). * * @param string $string The string to check. * @param integer &$num The number of occurences. * @param string $char The character to count. * @return integer The number of occurences of $char in $string, adjusted for backslashes. */ protected function _hasUnclosedBracketsSub($string, &$num, $char) { $parts = explode($char, $string); for ($i = 0; $i < count($parts); $i++){ if (substr($parts[$i], -1) == '\\' || $this->_hasUnclosedQuotes($parts[$i])) $num--; if (isset($parts[$i + 1])) $parts[$i + 1] = $parts[$i] . $char . $parts[$i + 1]; } return $num; } /** * Function to begin checking the address. * * @param string $address The address to validate. * @return mixed False on failure, or a structured array of address information on success. */ protected function _validateAddress($address) { $is_group = false; $addresses = array(); if ($address['group']) { $is_group = true; // Get the group part of the name $parts = explode(':', $address['address']); $groupname = $this->_splitCheck($parts, ':'); $structure = array(); // And validate the group part of the name. if (!$this->_validatePhrase($groupname)){ $this->error = 'Group name did not validate.'; return false; } else { // Don't include groups if we are not nesting // them. This avoids returning invalid addresses. if ($this->nestGroups) { $structure = new stdClass; $structure->groupname = $groupname; } } $address['address'] = ltrim(substr($address['address'], strlen($groupname . ':'))); } // If a group then split on comma and put into an array. // Otherwise, Just put the whole address in an array. if ($is_group) { while (strlen($address['address']) > 0) { $parts = explode(',', $address['address']); $addresses[] = $this->_splitCheck($parts, ','); $address['address'] = trim(substr($address['address'], strlen(end($addresses) . ','))); } } else { $addresses[] = $address['address']; } // Trim the whitespace from all of the address strings. array_map('trim', $addresses); // Validate each mailbox. // Format could be one of: name
// geezer@domain.com // geezer // ... or any other format valid by RFC 822. for ($i = 0; $i < count($addresses); $i++) { if (!$this->validateMailbox($addresses[$i])) { if (empty($this->error)) { $this->error = 'Validation failed for: ' . $addresses[$i]; } return false; } } // Nested format if ($this->nestGroups) { if ($is_group) { $structure->addresses = $addresses; } else { $structure = $addresses[0]; } // Flat format } else { if ($is_group) { $structure = array_merge($structure, $addresses); } else { $structure = $addresses; } } return $structure; } /** * Function to validate a phrase. * * @param string $phrase The phrase to check. * @return boolean Success or failure. */ protected function _validatePhrase($phrase) { // Splits on one or more Tab or space. $parts = preg_split('/[ \\x09]+/', $phrase, -1, PREG_SPLIT_NO_EMPTY); $phrase_parts = array(); while (count($parts) > 0){ $phrase_parts[] = $this->_splitCheck($parts, ' '); for ($i = 0; $i < $this->index + 1; $i++) array_shift($parts); } foreach ($phrase_parts as $part) { // If quoted string: if (substr($part, 0, 1) == '"') { if (!$this->_validateQuotedString($part)) { return false; } continue; } // Otherwise it's an atom: if (!$this->_validateAtom($part)) return false; } return true; } /** * Function to validate an atom which from rfc822 is: * atom = 1*
* * If validation ($this->validate) has been turned off, then * validateAtom() doesn't actually check anything. This is so that you * can split a list of addresses up before encoding personal names * (umlauts, etc.), for example. * * @param string $atom The string to check. * @return boolean Success or failure. */ protected function _validateAtom($atom) { if (!$this->validate) { // Validation has been turned off; assume the atom is okay. return true; } // Check for any char from ASCII 0 - ASCII 127 if (!preg_match('/^[\\x00-\\x7E]+$/i', $atom, $matches)) { return false; } // Check for specials: if (preg_match('/[][()<>@,;\\:". ]/', $atom)) { return false; } // Check for control characters (ASCII 0-31): if (preg_match('/[\\x00-\\x1F]+/', $atom)) { return false; } return true; } /** * Function to validate quoted string, which is: * quoted-string = <"> *(qtext/quoted-pair) <"> * * @param string $qstring The string to check * @return boolean Success or failure. */ protected function _validateQuotedString($qstring) { // Leading and trailing " $qstring = substr($qstring, 1, -1); // Perform check, removing quoted characters first. return !preg_match('/[\x0D\\\\"]/', preg_replace('/\\\\./', '', $qstring)); } /** * Function to validate a mailbox, which is: * mailbox = addr-spec ; simple address * / phrase route-addr ; name and route-addr * * @param string &$mailbox The string to check. * @return boolean Success or failure. */ public function validateMailbox(&$mailbox) { // A couple of defaults. $phrase = ''; $comment = ''; $comments = array(); // Catch any RFC822 comments and store them separately. $_mailbox = $mailbox; while (strlen(trim($_mailbox)) > 0) { $parts = explode('(', $_mailbox); $before_comment = $this->_splitCheck($parts, '('); if ($before_comment != $_mailbox) { // First char should be a (. $comment = substr(str_replace($before_comment, '', $_mailbox), 1); $parts = explode(')', $comment); $comment = $this->_splitCheck($parts, ')'); $comments[] = $comment; // +2 is for the brackets $_mailbox = substr($_mailbox, strpos($_mailbox, '('.$comment)+strlen($comment)+2); } else { break; } } foreach ($comments as $comment) { $mailbox = str_replace("($comment)", '', $mailbox); } $mailbox = trim($mailbox); // Check for name + route-addr if (substr($mailbox, -1) == '>' && substr($mailbox, 0, 1) != '<') { $parts = explode('<', $mailbox); $name = $this->_splitCheck($parts, '<'); $phrase = trim($name); $route_addr = trim(substr($mailbox, strlen($name.'<'), -1)); if ($this->_validatePhrase($phrase) === false || ($route_addr = $this->_validateRouteAddr($route_addr)) === false) { return false; } // Only got addr-spec } else { // First snip angle brackets if present. if (substr($mailbox, 0, 1) == '<' && substr($mailbox, -1) == '>') { $addr_spec = substr($mailbox, 1, -1); } else { $addr_spec = $mailbox; } if (($addr_spec = $this->_validateAddrSpec($addr_spec)) === false) { return false; } } // Construct the object that will be returned. $mbox = new stdClass(); // Add the phrase (even if empty) and comments $mbox->personal = $phrase; $mbox->comment = isset($comments) ? $comments : array(); if (isset($route_addr)) { $mbox->mailbox = $route_addr['local_part']; $mbox->host = $route_addr['domain']; $route_addr['adl'] !== '' ? $mbox->adl = $route_addr['adl'] : ''; } else { $mbox->mailbox = $addr_spec['local_part']; $mbox->host = $addr_spec['domain']; } $mailbox = $mbox; return true; } /** * This function validates a route-addr which is: * route-addr = "<" [route] addr-spec ">" * * Angle brackets have already been removed at the point of * getting to this function. * * @param string $route_addr The string to check. * @return mixed False on failure, or an array containing validated address/route information on success. */ protected function _validateRouteAddr($route_addr) { // Check for colon. if (strpos($route_addr, ':') !== false) { $parts = explode(':', $route_addr); $route = $this->_splitCheck($parts, ':'); } else { $route = $route_addr; } // If $route is same as $route_addr then the colon was in // quotes or brackets or, of course, non existent. if ($route === $route_addr){ unset($route); $addr_spec = $route_addr; if (($addr_spec = $this->_validateAddrSpec($addr_spec)) === false) { return false; } } else { // Validate route part. if (($route = $this->_validateRoute($route)) === false) { return false; } $addr_spec = substr($route_addr, strlen($route . ':')); // Validate addr-spec part. if (($addr_spec = $this->_validateAddrSpec($addr_spec)) === false) { return false; } } if (isset($route)) { $return['adl'] = $route; } else { $return['adl'] = ''; } $return = array_merge($return, $addr_spec); return $return; } /** * Function to validate a route, which is: * route = 1#("@" domain) ":" * * @param string $route The string to check. * @return mixed False on failure, or the validated $route on success. */ protected function _validateRoute($route) { // Split on comma. $domains = explode(',', trim($route)); foreach ($domains as $domain) { $domain = str_replace('@', '', trim($domain)); if (!$this->_validateDomain($domain)) return false; } return $route; } /** * Function to validate a domain, though this is not quite what * you expect of a strict internet domain. * * domain = sub-domain *("." sub-domain) * * @param string $domain The string to check. * @return mixed False on failure, or the validated domain on success. */ protected function _validateDomain($domain) { // Note the different use of $subdomains and $sub_domains $subdomains = explode('.', $domain); while (count($subdomains) > 0) { $sub_domains[] = $this->_splitCheck($subdomains, '.'); for ($i = 0; $i < $this->index + 1; $i++) array_shift($subdomains); } foreach ($sub_domains as $sub_domain) { if (!$this->_validateSubdomain(trim($sub_domain))) return false; } // Managed to get here, so return input. return $domain; } /** * Function to validate a subdomain: * subdomain = domain-ref / domain-literal * * @param string $subdomain The string to check. * @return boolean Success or failure. */ protected function _validateSubdomain($subdomain) { if (preg_match('|^\[(.*)]$|', $subdomain, $arr)){ if (!$this->_validateDliteral($arr[1])) return false; } else { if (!$this->_validateAtom($subdomain)) return false; } // Got here, so return successful. return true; } /** * Function to validate a domain literal: * domain-literal = "[" *(dtext / quoted-pair) "]" * * @param string $dliteral The string to check. * @return boolean Success or failure. */ protected function _validateDliteral($dliteral) { return !preg_match('/(.)[][\x0D\\\\]/', $dliteral, $matches) && ((! isset($matches[1])) || $matches[1] != '\\'); } /** * Function to validate an addr-spec. * * addr-spec = local-part "@" domain * * @param string $addr_spec The string to check. * @return mixed False on failure, or the validated addr-spec on success. */ protected function _validateAddrSpec($addr_spec) { $addr_spec = trim($addr_spec); // Split on @ sign if there is one. if (strpos($addr_spec, '@') !== false) { $parts = explode('@', $addr_spec); $local_part = $this->_splitCheck($parts, '@'); $domain = substr($addr_spec, strlen($local_part . '@')); // No @ sign so assume the default domain. } else { $local_part = $addr_spec; $domain = $this->default_domain; } if (($local_part = $this->_validateLocalPart($local_part)) === false) return false; if (($domain = $this->_validateDomain($domain)) === false) return false; // Got here so return successful. return array('local_part' => $local_part, 'domain' => $domain); } /** * Function to validate the local part of an address: * local-part = word *("." word) * * @param string $local_part * @return mixed False on failure, or the validated local part on success. */ protected function _validateLocalPart($local_part) { $parts = explode('.', $local_part); $words = array(); // Split the local_part into words. while (count($parts) > 0) { $words[] = $this->_splitCheck($parts, '.'); for ($i = 0; $i < $this->index + 1; $i++) { array_shift($parts); } } // Validate each word. foreach ($words as $word) { // word cannot be empty (#17317) if ($word === '') { return false; } // If this word contains an unquoted space, it is invalid. (6.2.4) if (strpos($word, ' ') && $word[0] !== '"') { return false; } if ($this->_validatePhrase(trim($word)) === false) return false; } // Managed to get here, so return the input. return $local_part; } /** * Returns an approximate count of how many addresses are in the * given string. This is APPROXIMATE as it only splits based on a * comma which has no preceding backslash. Could be useful as * large amounts of addresses will end up producing *large* * structures when used with parseAddressList(). * * @param string $data Addresses to count * @return int Approximate count */ public function approximateCount($data) { return count(preg_split('/(?@
. This can be sufficient for most * people. Optional stricter mode can be utilised which restricts * mailbox characters allowed to alphanumeric, full stop, hyphen * and underscore. * * @param string $data Address to check * @param boolean $strict Optional stricter mode * @return mixed False if it fails, an indexed array * username/domain if it matches */ public function isValidInetAddress($data, $strict = false) { $regex = $strict ? '/^([.0-9a-z_+-]+)@(([0-9a-z-]+\.)+[0-9a-z]{2,})$/i' : '/^([*+!.$|\'\\%\/0-9a-z^_`{}=?~:-]+)@(([0-9a-z-]+\.)+[0-9a-z]{2,})$/i'; if (preg_match($regex, trim($data), $matches)) { return array($matches[1], $matches[2]); } else { return false; } } } smtp.php 0000644 00000042211 14716356152 0006252 0 ustar 00 * @author Chuck Hagenbuch
* @copyright 2010-2021 Chuck Hagenbuch * @license http://opensource.org/licenses/BSD-3-Clause New BSD License * @version CVS: $Id$ * @link http://pear.php.net/package/Mail/ */ /** Error: Failed to create a Net_SMTP object */ define('PEAR_MAIL_SMTP_ERROR_CREATE', 10000); /** Error: Failed to connect to SMTP server */ define('PEAR_MAIL_SMTP_ERROR_CONNECT', 10001); /** Error: SMTP authentication failure */ define('PEAR_MAIL_SMTP_ERROR_AUTH', 10002); /** Error: No From: address has been provided */ define('PEAR_MAIL_SMTP_ERROR_FROM', 10003); /** Error: Failed to set sender */ define('PEAR_MAIL_SMTP_ERROR_SENDER', 10004); /** Error: Failed to add recipient */ define('PEAR_MAIL_SMTP_ERROR_RECIPIENT', 10005); /** Error: Failed to send data */ define('PEAR_MAIL_SMTP_ERROR_DATA', 10006); /** * SMTP implementation of the PEAR Mail interface. Requires the Net_SMTP class. * @access public * @package Mail * @version $Revision$ */ class Mail_smtp extends Mail { /** * SMTP connection object. * * @var object * @access private */ var $_smtp = null; /** * The list of service extension parameters to pass to the Net_SMTP * mailFrom() command. * * @var array */ var $_extparams = array(); /** * The SMTP host to connect to. * * @var string */ var $host = 'localhost'; /** * The port the SMTP server is on. * * @var integer */ var $port = 25; /** * Should STARTTLS connection be used? * * This value may be set to true or false. * * If the value is set to true, the Net_SMTP package will attempt to use * a STARTTLS encrypted connection. * * If the value is set to false, the Net_SMTP package will avoid * a STARTTLS encrypted connection. * * NULL indicates only STARTTLS if $auth is set. * * PEAR/Net_SMTP >= 1.10.0 required. * * @var boolean */ var $starttls = null; /** * Should SMTP authentication be used? * * This value may be set to true, false or the name of a specific * authentication method. * * If the value is set to true, the Net_SMTP package will attempt to use * the best authentication method advertised by the remote SMTP server. * * @var mixed */ var $auth = false; /** * The username to use if the SMTP server requires authentication. * * @var string */ var $username = ''; /** * The password to use if the SMTP server requires authentication. * * @var string */ var $password = ''; /** * Hostname or domain that will be sent to the remote SMTP server in the * HELO / EHLO message. * * @var string */ var $localhost = 'localhost'; /** * SMTP connection timeout value. NULL indicates no timeout. * * @var integer */ var $timeout = null; /** * Turn on Net_SMTP debugging? * * @var boolean $debug */ var $debug = false; /** * Indicates whether or not the SMTP connection should persist over * multiple calls to the send() method. * * @var boolean */ var $persist = false; /** * Use SMTP command pipelining (specified in RFC 2920) if the SMTP server * supports it. This speeds up delivery over high-latency connections. By * default, use the default value supplied by Net_SMTP. * * @var boolean */ var $pipelining; /** * The list of socket options * * @var array */ var $socket_options = array(); /** * Constructor. * * Instantiates a new Mail_smtp:: object based on the parameters * passed in. It looks for the following parameters: * host The server to connect to. Defaults to localhost. * port The port to connect to. Defaults to 25. * auth SMTP authentication. Defaults to none. * starttls Should STARTTLS connection be used? No default. PEAR/Net_SMTP >= 1.10.0 required. * username The username to use for SMTP auth. No default. * password The password to use for SMTP auth. No default. * localhost The local hostname / domain. Defaults to localhost. * timeout The SMTP connection timeout. Defaults to none. * verp Whether to use VERP or not. Defaults to false. * DEPRECATED as of 1.2.0 (use setMailParams()). * debug Activate SMTP debug mode? Defaults to false. * persist Should the SMTP connection persist? * pipelining Use SMTP command pipelining * * If a parameter is present in the $params array, it replaces the * default. * * @param array Hash containing any parameters different from the * defaults. */ public function __construct($params) { if (isset($params['host'])) $this->host = $params['host']; if (isset($params['port'])) $this->port = $params['port']; if (isset($params['auth'])) $this->auth = $params['auth']; if (isset($params['starttls'])) $this->starttls = $params['starttls']; if (isset($params['username'])) $this->username = $params['username']; if (isset($params['password'])) $this->password = $params['password']; if (isset($params['localhost'])) $this->localhost = $params['localhost']; if (isset($params['timeout'])) $this->timeout = $params['timeout']; if (isset($params['debug'])) $this->debug = (bool)$params['debug']; if (isset($params['persist'])) $this->persist = (bool)$params['persist']; if (isset($params['pipelining'])) $this->pipelining = (bool)$params['pipelining']; if (isset($params['socket_options'])) $this->socket_options = $params['socket_options']; // Deprecated options if (isset($params['verp'])) { $this->addServiceExtensionParameter('XVERP', is_bool($params['verp']) ? null : $params['verp']); } } /** * Destructor implementation to ensure that we disconnect from any * potentially-alive persistent SMTP connections. */ public function __destruct() { $this->disconnect(); } /** * Implements Mail::send() function using SMTP. * * @param mixed $recipients Either a comma-seperated list of recipients * (RFC822 compliant), or an array of recipients, * each RFC822 valid. This may contain recipients not * specified in the headers, for Bcc:, resending * messages, etc. * * @param array $headers The array of headers to send with the mail, in an * associative array, where the array key is the * header name (e.g., 'Subject'), and the array value * is the header value (e.g., 'test'). The header * produced from those values would be 'Subject: * test'. * * @param string $body The full text of the message body, including any * MIME parts, etc. * * @return mixed Returns true on success, or a PEAR_Error * containing a descriptive error message on * failure. */ public function send($recipients, $headers, $body) { $result = $this->send_or_fail($recipients, $headers, $body); /* If persistent connections are disabled, destroy our SMTP object. */ if ($this->persist === false) { $this->disconnect(); } return $result; } protected function send_or_fail($recipients, $headers, $body) { /* If we don't already have an SMTP object, create one. */ $result = $this->getSMTPObject(); if (PEAR::isError($result)) { return $result; } if (!is_array($headers)) { return PEAR::raiseError('$headers must be an array'); } $this->_sanitizeHeaders($headers); $headerElements = $this->prepareHeaders($headers); if (is_a($headerElements, 'PEAR_Error')) { $this->_smtp->rset(); return $headerElements; } list($from, $textHeaders) = $headerElements; /* Since few MTAs are going to allow this header to be forged * unless it's in the MAIL FROM: exchange, we'll use * Return-Path instead of From: if it's set. */ if (!empty($headers['Return-Path'])) { $from = $headers['Return-Path']; } if (!isset($from)) { $this->_smtp->rset(); return PEAR::raiseError('No From: address has been provided', PEAR_MAIL_SMTP_ERROR_FROM); } $params = ''; if (!empty($this->_extparams)) { foreach ($this->_extparams as $key => $val) { $params .= ' ' . $key . (is_null($val) ? '' : '=' . $val); } } if (PEAR::isError($res = $this->_smtp->mailFrom($from, ltrim($params)))) { $error = $this->_error("Failed to set sender: $from", $res); $this->_smtp->rset(); return PEAR::raiseError($error, PEAR_MAIL_SMTP_ERROR_SENDER); } $recipients = $this->parseRecipients($recipients); if (is_a($recipients, 'PEAR_Error')) { $this->_smtp->rset(); return $recipients; } foreach ($recipients as $recipient) { $res = $this->_smtp->rcptTo($recipient); if (is_a($res, 'PEAR_Error')) { $error = $this->_error("Failed to add recipient: $recipient", $res); $this->_smtp->rset(); return PEAR::raiseError($error, PEAR_MAIL_SMTP_ERROR_RECIPIENT); } } /* Send the message's headers and the body as SMTP data. */ $res = $this->_smtp->data($body, $textHeaders); list(,$args) = $this->_smtp->getResponse(); if (preg_match("/ queued as (.*)/", $args, $queued)) { $this->queued_as = $queued[1]; } /* we need the greeting; from it we can extract the authorative name of the mail server we've really connected to. * ideal if we're connecting to a round-robin of relay servers and need to track which exact one took the email */ $this->greeting = $this->_smtp->getGreeting(); if (is_a($res, 'PEAR_Error')) { $error = $this->_error('Failed to send data', $res); $this->_smtp->rset(); return PEAR::raiseError($error, PEAR_MAIL_SMTP_ERROR_DATA); } return true; } /** * Connect to the SMTP server by instantiating a Net_SMTP object. * * @return mixed Returns a reference to the Net_SMTP object on success, or * a PEAR_Error containing a descriptive error message on * failure. * * @since 1.2.0 */ public function getSMTPObject() { if (is_object($this->_smtp) !== false) { return $this->_smtp; } include_once 'Net/SMTP.php'; $this->_smtp = new Net_SMTP($this->host, $this->port, $this->localhost, $this->pipelining, 0, $this->socket_options); /* If we still don't have an SMTP object at this point, fail. */ if (is_object($this->_smtp) === false) { return PEAR::raiseError('Failed to create a Net_SMTP object', PEAR_MAIL_SMTP_ERROR_CREATE); } /* Configure the SMTP connection. */ if ($this->debug) { $this->_smtp->setDebug(true); } /* Attempt to connect to the configured SMTP server. */ if (PEAR::isError($res = $this->_smtp->connect($this->timeout))) { $error = $this->_error('Failed to connect to ' . $this->host . ':' . $this->port, $res); return PEAR::raiseError($error, PEAR_MAIL_SMTP_ERROR_CONNECT); } /* Attempt to authenticate if authentication has been enabled. */ if ($this->auth) { $method = is_string($this->auth) ? $this->auth : ''; $tls = $this->starttls === false ? false : true; if (PEAR::isError($res = $this->_smtp->auth($this->username, $this->password, $method, $tls))) { $error = $this->_error("$method authentication failure", $res); $this->_smtp->rset(); return PEAR::raiseError($error, PEAR_MAIL_SMTP_ERROR_AUTH); } } /* Attempt to establish a TLS encrypted connection. PEAR/Net_SMTP >= 1.10.0 required. */ if ($this->starttls && !$this->auth) { $starttls = $this->_smtp->starttls(); if (PEAR::isError($starttls)) { return PEAR::raiseError($starttls); } elseif ($starttls === false) { return PEAR::raiseError('STARTTLS failed'); } } return $this->_smtp; } /** * Add parameter associated with a SMTP service extension. * * @param string Extension keyword. * @param string Any value the keyword needs. * * @since 1.2.0 */ public function addServiceExtensionParameter($keyword, $value = null) { $this->_extparams[$keyword] = $value; } /** * Disconnect and destroy the current SMTP connection. * * @return boolean True if the SMTP connection no longer exists. * * @since 1.1.9 */ public function disconnect() { /* If we have an SMTP object, disconnect and destroy it. */ if (is_object($this->_smtp) && $this->_smtp->disconnect()) { $this->_smtp = null; } /* We are disconnected if we no longer have an SMTP object. */ return ($this->_smtp === null); } /** * Build a standardized string describing the current SMTP error. * * @param string $text Custom string describing the error context. * @param object $error Reference to the current PEAR_Error object. * * @return string A string describing the current SMTP error. * * @since 1.1.7 */ protected function _error($text, $error) { /* Split the SMTP response into a code and a response string. */ list($code, $response) = $this->_smtp->getResponse(); /* Build our standardized error string. */ return $text . ' [SMTP: ' . $error->getMessage() . " (code: $code, response: $response)]"; } } mime.php 0000644 00000153254 14716356152 0006230 0 ustar 00 * Copyright (c) 2003-2006, PEAR
* 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
* @author Tomas V.V. Cox
* @author Cipriano Groenendal
* @author Sean Coates
* @author Aleksander Machniak
* @copyright 2003-2006 PEAR
* @license http://www.opensource.org/licenses/bsd-license.php BSD License * @version Release: @package_version@ * @link http://pear.php.net/package/Mail_mime * * This class is based on HTML Mime Mail class from * Richard Heyes
which was based also * in the mime_mail.class by Tobias Ratschiller
* and Sascha Schumann
*/ require_once 'PEAR.php'; 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. * * @category Mail * @package Mail_Mime * @author Richard Heyes
* @author Tomas V.V. Cox
* @author Cipriano Groenendal
* @author Sean Coates
* @copyright 2003-2006 PEAR
* @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 */ protected $txtbody = ''; /** * Contains the html part of the email * * @var string */ protected $htmlbody = ''; /** * Contains the text/calendar part of the email * * @var string */ protected $calbody = ''; /** * List of the attached images * * @var array */ protected $html_images = array(); /** * List of the attachements * * @var array */ protected $parts = array(); /** * Headers for the mail * * @var array */ protected $headers = array(); /** * Build parameters * * @var array */ protected $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', // What encoding to use for calendar part // Options: 7bit, 8bit, base64, or quoted-printable 'calendar_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 calendar part 'calendar_charset' => 'UTF-8', // 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, // Default calendar method 'calendar_method' => 'request', // multipart part preamble (RFC2046 5.1.1) 'preamble' => '', ); /** * 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 */ public function __construct($params = array()) { // 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)) { $this->build_params = array_merge($this->build_params, $params); } } /** * Set build parameter value * * @param string $name Parameter name * @param string $value Parameter value * * @return void * @since 1.6.0 */ public function setParam($name, $value) { $this->build_params[$name] = $value; } /** * Get build parameter value * * @param string $name Parameter name * * @return mixed Parameter value * @since 1.6.0 */ public function getParam($name) { return isset($this->build_params[$name]) ? $this->build_params[$name] : null; } /** * Accessor function to set the body text. Body text is used if * it's not an html mail being sent or else is used to fill the * 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 */ public function setTXTBody($data, $isfile = false, $append = false) { return $this->setBody('txtbody', $data, $isfile, $append); } /** * Get message text body * * @return string Text body * @since 1.6.0 */ public 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 or PEAR_Error object */ public function setHTMLBody($data, $isfile = false) { return $this->setBody('htmlbody', $data, $isfile); } /** * Get message HTML body * * @return string HTML body * @since 1.6.0 */ public function getHTMLBody() { return $this->htmlbody; } /** * Function to set a body of text/calendar part (not attachment) * * @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 * @param string $method iCalendar object method * @param string $charset iCalendar character set * @param string $encoding Transfer encoding * * @return mixed True on success or PEAR_Error object * @since 1.9.0 */ public function setCalendarBody($data, $isfile = false, $append = false, $method = 'request', $charset = 'UTF-8', $encoding = 'quoted-printable' ) { $result = $this->setBody('calbody', $data, $isfile, $append); if ($result === true) { $this->build_params['calendar_method'] = $method; $this->build_params['calendar_charset'] = $charset; $this->build_params['calendar_encoding'] = $encoding; } } /** * Get body of calendar part * * @return string Calendar part body * @since 1.9.0 */ public function getCalendarBody() { return $this->calbody; } /** * Adds an image to the list of embedded images. * Images added this way will be added as related parts of the HTML message. * * To correctly match the HTML image with the related attachment * HTML should refer to it by a filename (specified in $file or $name * arguments) or by cid:
(specified in $content_id arg). * * @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. Used to find * the image in HTML content. * @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 */ public 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 (self::isError($filedata = $this->file2str($file))) { return $filedata; } } $filename = $name ? $name : $file; } else { $filedata = $file; $filename = $name; } if (!$content_id) { $content_id = preg_replace('/[^0-9a-zA-Z]/', '', uniqid(time(), true)); } $this->html_images[] = array( '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 mixed $file The file name or the file contents itself, * it can be also Mail_mimePart object * @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 * @param array $add_headers Additional part headers. Array keys can be in form * of
:
* * @return mixed True on success or PEAR_Error object */ public 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, $add_headers = array() ) { if ($file instanceof Mail_mimePart) { $this->parts[] = $file; return true; } $bodyfile = null; if ($isfile) { // Don't load file into memory if ($this->build_params['delay_file_io']) { $filedata = null; $bodyfile = $file; } else { if (self::isError($filedata = $this->file2str($file))) { return $filedata; } } // Force the name the user supplied, otherwise use $file $filename = ($name ? $name : $this->basename($file)); } else { $filedata = $file; $filename = $name; } if (!strlen($filename)) { $msg = "The supplied filename for the attachment can't be empty"; return self::raiseError($msg); } $this->parts[] = array( 'body' => $filedata, 'body_file' => $bodyfile, 'name' => $filename, 'c_type' => $c_type, 'charset' => $charset, 'encoding' => $encoding, 'language' => $language, 'location' => $location, 'disposition' => $disposition, 'description' => $description, 'add_headers' => $add_headers, 'name_encoding' => $n_encoding, 'filename_encoding' => $f_encoding, 'headers_charset' => $h_charset, ); return true; } /** * Checks if the current message has many parts * * @return bool True if the message has many parts, False otherwise. * @since 1.9.0 */ public function isMultipart() { return count($this->parts) > 0 || count($this->html_images) > 0 || (strlen($this->htmlbody) > 0 && strlen($this->txtbody) > 0); } /** * 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 */ protected function file2str($file_name) { // Check state of file and raise an error properly if (!file_exists($file_name)) { return self::raiseError('File not found: ' . $file_name); } if (!is_file($file_name)) { return self::raiseError('Not a regular file: ' . $file_name); } if (!is_readable($file_name)) { return self::raiseError('File is not readable: ' . $file_name); } // Temporarily reset magic_quotes_runtime and read file contents if (version_compare(PHP_VERSION, '5.4.0', '<')) { $magic_quotes = @ini_set('magic_quotes_runtime', 0); } $cont = file_get_contents($file_name); if (isset($magic_quotes)) { @ini_set('magic_quotes_runtime', $magic_quotes); } return $cont; } /** * Adds a text subpart to the mimePart object and * returns it during the build process. * * @param mixed $obj The object to add the part to, or * anything else if a new object is to be created. * * @return object The text mimePart object */ protected function addTextPart($obj = null) { return $this->addBodyPart($obj, $this->txtbody, 'text/plain', 'text'); } /** * Adds a html subpart to the mimePart object and * returns it during the build process. * * @param mixed $obj The object to add the part to, or * anything else if a new object is to be created. * * @return object The html mimePart object */ protected function addHtmlPart($obj = null) { return $this->addBodyPart($obj, $this->htmlbody, 'text/html', 'html'); } /** * Adds a calendar subpart to the mimePart object and * returns it during the build process. * * @param mixed $obj The object to add the part to, or * anything else if a new object is to be created. * * @return object The text mimePart object */ protected function addCalendarPart($obj = null) { $ctype = 'text/calendar; method='. $this->build_params['calendar_method']; return $this->addBodyPart($obj, $this->calbody, $ctype, 'calendar'); } /** * Creates a new mimePart object, using multipart/mixed as * the initial content-type and returns it during the * build process. * * @param array $params Additional part parameters * * @return object The multipart/mixed mimePart object */ protected function addMixedPart($params = array()) { $params['content_type'] = 'multipart/mixed'; $params['eol'] = $this->build_params['eol']; // Create empty multipart/mixed Mail_mimePart object to return return new Mail_mimePart('', $params); } /** * Adds a multipart/alternative part to a mimePart * object (or creates one), and returns it during * the build process. * * @param mixed $obj The object to add the part to, or * anything else if a new object is to be created. * * @return object The multipart/mixed mimePart object */ protected function addAlternativePart($obj = null) { $params['content_type'] = 'multipart/alternative'; $params['eol'] = $this->build_params['eol']; if (is_object($obj)) { $ret = $obj->addSubpart('', $params); } else { $ret = new Mail_mimePart('', $params); } return $ret; } /** * Adds a multipart/related part to a mimePart * object (or creates one), and returns it during * the build process. * * @param mixed $obj The object to add the part to, or * anything else if a new object is to be created * * @return object The multipart/mixed mimePart object */ protected function addRelatedPart($obj = null) { $params['content_type'] = 'multipart/related'; $params['eol'] = $this->build_params['eol']; if (is_object($obj)) { $ret = $obj->addSubpart('', $params); } else { $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 $obj The mimePart to add the image to * @param array $value The image information * * @return object The image mimePart object */ protected function addHtmlImagePart($obj, $value) { $params['content_type'] = $value['c_type']; $params['encoding'] = 'base64'; $params['disposition'] = 'inline'; $params['filename'] = $value['name']; $params['cid'] = $value['cid']; $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']; } return $obj->addSubpart($value['body'], $params); } /** * Adds an attachment subpart to a mimePart object * and returns it during the build process. * * @param object $obj The mimePart to add the image to * @param mixed $value The attachment information array or Mail_mimePart object * * @return object The image mimePart object */ protected function addAttachmentPart($obj, $value) { if ($value instanceof Mail_mimePart) { return $obj->addSubpart($value); } $params['eol'] = $this->build_params['eol']; $params['filename'] = $value['name']; $params['encoding'] = $value['encoding']; $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']; } if (is_array($value['add_headers'])) { $params['headers'] = $value['add_headers']; } return $obj->addSubpart($value['body'], $params); } /** * 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() method. * 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 */ public function getMessage($separation = null, $params = null, $headers = null, $overwrite = false ) { if ($separation === null) { $separation = $this->build_params['eol']; } $body = $this->get($params); if (self::isError($body)) { return $body; } return $this->txtHeaders($headers, $overwrite) . $separation . $body; } /** * 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() method. See get() for more info. * * @return mixed The e-mail body or PEAR error object * @since 1.6.0 */ public 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() method. 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 * @since 1.6.0 */ public 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)) { return self::raiseError('File is not writable: ' . $filename); } // Temporarily reset magic_quotes_runtime and read file contents if (version_compare(PHP_VERSION, '5.4.0', '<')) { $magic_quotes = @ini_set('magic_quotes_runtime', 0); } if (!($fh = fopen($filename, 'ab'))) { return self::raiseError('Unable to open file: ' . $filename); } // Write message headers into file (skipping Content-* headers) $head = $this->txtHeaders($headers, $overwrite, true); if (fwrite($fh, $head) === false) { return self::raiseError('Error writing to file: ' . $filename); } fclose($fh); if (isset($magic_quotes)) { @ini_set('magic_quotes_runtime', $magic_quotes); } // 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 or stream. * * @param mixed $filename Output filename or file pointer where to save * the message instead of returning it * @param array $params The Build parameters passed to the * get() method. See get() for more info. * * @return mixed True or PEAR error object * @since 1.6.0 */ public function saveMessageBody($filename, $params = null) { if (!is_resource($filename)) { // Check state of file and raise an error properly if (!file_exists($filename) || !is_writable($filename)) { return self::raiseError('File is not writable: ' . $filename); } if (!($fh = fopen($filename, 'ab'))) { return self::raiseError('Unable to open file: ' . $filename); } } else { $fh = $filename; } // Temporarily reset magic_quotes_runtime and read file contents if (version_compare(PHP_VERSION, '5.4.0', '<')) { $magic_quotes = @ini_set('magic_quotes_runtime', 0); } // Write the rest of the message into file $res = $this->get($params, $fh, true); if (!is_resource($filename)) { fclose($fh); } if (isset($magic_quotes)) { @ini_set('magic_quotes_runtime', $magic_quotes); } return $res ? $res : true; } /** * Builds the multipart message from the list ($this->parts) and * returns the mime content. * * @param array $params Build parameters that change the way the email * is built. Should be associative. See $_build_params. * @param mixed $filename Output filename or file pointer 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 */ public function get($params = null, $filename = null, $skip_head = false) { if (!empty($params) && is_array($params)) { $this->build_params = array_merge($this->build_params, $params); } 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) && strlen($this->htmlbody) > 0) { foreach ($this->html_images as $key => $value) { $rval = preg_quote($value['name'], '#'); $regex = array( '#(\s)((?i)src|background|href(?-i))\s*=\s*(["\']?)' . $rval . '\3#', '#(?i)url(?-i)\(\s*(["\']?)' . $rval . '\1\s*\)#', ); $rep = array( '\1\2=\3cid:' . $value['cid'] .'\3', '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(); $message = $this->buildBodyPart(); if (!isset($message)) { return null; } // Use saved boundary if (!empty($this->build_params['boundary'])) { $boundary = $this->build_params['boundary']; } else { $boundary = null; } // Write output to file if ($filename) { // Append mimePart message headers and body into file $headers = $message->encodeToFile($filename, $boundary, $skip_head); if (self::isError($headers)) { return $headers; } $this->headers = array_merge($this->headers, $headers); } else { $output = $message->encode($boundary, $skip_head); if (self::isError($output)) { return $output; } $this->headers = array_merge($this->headers, $output['headers']); } // remember the boundary used, in case we'd handle headers() call later if (empty($boundary) && !empty($this->headers['Content-Type'])) { if (preg_match('/boundary="([^"]+)/', $this->headers['Content-Type'], $m)) { $this->build_params['boundary'] = $m[1]; } } return $filename ? null : $output['body']; } /** * Builds the main body MIME part for the email body. It will add a mixed part * if attachments are found. If no attachments are found it will return an * alternative part if several body texts are found (text, html, calendar), * or a single part if only one body text is found. * * @return Mail_mimePart|null The corresponding part for the body or null. * * @see buildAlternativeParts * @see buildHtmlParts */ protected function buildBodyPart() { $parts_count = count($this->parts); $mixed_params = array('preamble' => $this->build_params['preamble']); $message = null; if ($parts_count > 0) { $message = $this->addMixedPart($mixed_params); $this->buildAlternativeParts($message, null); for ($i = 0; $i < $parts_count; $i++) { $this->addAttachmentPart($message, $this->parts[$i]); } } else { $message = $this->buildAlternativeParts(null, $mixed_params); } return $message; } /** * Builds a single text, html, or calendar part only if one of them is found. * If two or more parts are found, then an alternative part containing them is built. * * @param Mail_mimePart|null $parent_part The parent mime part to add * the part or null * @param array $mixed_params The needed params to create the * part when no parent_part is * received. * * @return null|object The main part built inside the method. It will be an * alternative part or text, html, or calendar part. * Null if no body texts are found. */ protected function buildAlternativeParts($parent_part, $mixed_params = null) { $html = strlen($this->htmlbody) > 0; $calendar = strlen($this->calbody) > 0; $has_text = strlen($this->txtbody) > 0; $alternatives_count = $html + $calendar + $has_text; if ($alternatives_count > 1) { $alt_part = $this->addAlternativePart($parent_part ? $parent_part : $mixed_params); } else { $alt_part = null; } $dest_part = $alt_part ? $alt_part : $parent_part; $part = null; if ($has_text) { $part = $this->addTextPart($dest_part); } if ($html) { $part = $this->buildHtmlParts($dest_part); } if ($calendar) { $part = $this->addCalendarPart($dest_part); } return $dest_part ? $dest_part : $part; } /** * Builds html part as a single part or inside a related part with the html * images thar were found. * * @param Mail_mimePart|null $parent_part The object to add the part to, * or anything else if a new object * is to be created. * * @return Mail_mimePart|null The created part or null if no htmlbody found. */ protected function buildHtmlParts($parent_part) { if (!strlen($this->htmlbody)) { return null; } $count_html_images = count($this->html_images); if ($count_html_images > 0) { $part = $this->addRelatedPart($parent_part); $this->addHtmlPart($part); } else { $part = $this->addHtmlPart($parent_part); } for ($i = 0; $i < $count_html_images; $i++) { $this->addHtmlImagePart($part, $this->html_images[$i]); } return $part; } /** * Returns an array with the headers needed to prepend to the email * (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) * (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 */ public function headers($xtra_headers = null, $overwrite = false, $skip_content = false) { // Add mime version header $headers['MIME-Version'] = '1.0'; if (!empty($xtra_headers)) { $headers = array_merge($headers, $xtra_headers); } if ($overwrite) { $this->headers = array_merge($this->headers, $headers); } else { $this->headers = array_merge($headers, $this->headers); } // Always reset Content-Type/Content-Transfer-Encoding headers // In case the message structure changed in meantime unset($this->headers['Content-Type']); unset($this->headers['Content-Transfer-Encoding']); unset($this->headers['Content-Disposition']); $this->headers = array_merge($this->headers, $this->contentHeaders()); $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']; } return $this->encodeHeaders($headers); } /** * 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) * (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 */ public function txtHeaders($xtra_headers = null, $overwrite = false, $skip_content = false) { $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 * @since 1.7.0 */ public 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; } else 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 (stripos($type, 'multipart/') === 0) { 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. * * @return void */ public function setSubject($subject) { $this->headers['Subject'] = $subject; } /** * Set an email to the From (the sender) header * * @param string $email The email address to use * * @return void */ public function setFrom($email) { $this->headers['From'] = $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 */ 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 * * @return void */ public function addCc($email) { if (isset($this->headers['Cc'])) { $this->headers['Cc'] .= ", $email"; } else { $this->headers['Cc'] = $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 * * @return void */ public function addBcc($email) { if (isset($this->headers['Bcc'])) { $this->headers['Bcc'] .= ", $email"; } else { $this->headers['Bcc'] = $email; } } /** * 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 */ public function encodeRecipients($recipients) { $input = array('To' => $recipients); $retval = $this->encodeHeaders($input); return $retval['To'] ; } /** * Encodes headers as per RFC2047 * * @param array $input The header data to encode * @param array $params Extra build parameters * * @return array Encoded data */ protected function encodeHeaders($input, $params = array()) { $build_params = $this->build_params; if (!empty($params)) { $build_params = array_merge($build_params, $params); } 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 if ($hdr_value !== null) { $input[$hdr_name] = $this->encodeHeader( $hdr_name, $hdr_value, $build_params['head_charset'], $build_params['head_encoding'] ); } else { unset($input[$hdr_name]); } } return $input; } /** * Encodes a header as per RFC2047 * * @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) * @since 1.5.3 */ public 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 */ protected function basename($filename) { // 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 */ protected function contentHeaders() { $attachments = count($this->parts) > 0; $html_images = count($this->html_images) > 0; $html = strlen($this->htmlbody) > 0; $calendar = strlen($this->calbody) > 0; $has_text = strlen($this->txtbody) > 0; $has_alternatives = ($html + $calendar + $has_text) > 1; $headers = array(); // See get() switch (true) { case $has_text && !$attachments && !$has_alternatives: $headers['Content-Type'] = 'text/plain'; break; case $html && !$html_images && !$attachments && !$has_alternatives: $headers['Content-Type'] = 'text/html'; break; case $html && $html_images && !$attachments && !$has_alternatives: $headers['Content-Type'] = 'multipart/related'; break; case $calendar && !$attachments && !$has_alternatives: $headers['Content-Type'] = 'text/calendar'; break; case $has_alternatives && !$attachments: $headers['Content-Type'] = 'multipart/alternative'; break; case $attachments: $headers['Content-Type'] = 'multipart/mixed'; break; } // Note: This is outside of the above switch construct to workaround // opcache bug: https://bugzilla.opensuse.org/show_bug.cgi?id=1166235 if (empty($headers)) { 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 if ($this->build_params['text_charset']) { $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 if ($this->build_params['html_charset']) { $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 if ($headers['Content-Type'] == 'text/calendar') { // single-part message: add charset and encoding if ($this->build_params['calendar_charset']) { $charset = 'charset=' . $this->build_params['calendar_charset']; $headers['Content-Type'] .= "; $charset"; } if ($this->build_params['calendar_method']) { $method = 'method=' . $this->build_params['calendar_method']; $headers['Content-Type'] .= "; $method"; } $headers['Content-Transfer-Encoding'] = $this->build_params['calendar_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 */ protected 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']); $this->build_params['calendar_encoding'] = strtolower($this->build_params['calendar_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'; } if (!in_array($this->build_params['calendar_encoding'], $encodings)) { $this->build_params['calendar_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'; } // calendar body if ($this->build_params['calendar_encoding'] == '7bit' && !preg_match('/ascii/i', $this->build_params['calendar_charset']) && preg_match('/[^\x00-\x7F]/', $this->calbody) ) { $this->build_params['calendar_encoding'] = 'quoted-printable'; } } /** * Set body of specified message part * * @param string $type One of: txtbody, calbody, htmlbody * @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 */ protected function setBody($type, $data, $isfile = false, $append = false) { if ($isfile) { $data = $this->file2str($data); if (self::isError($data)) { return $data; } } if (!$append) { $this->{$type} = $data; } else { $this->{$type} .= $data; } return true; } /** * Adds a subpart to the mimePart object and * returns it during the build process. * * @param mixed $obj The object to add the part to, or * anything else if a new object is to be created. * @param string $body Part body * @param string $ctype Part content type * @param string $type Internal part type * * @return object The mimePart object */ protected function addBodyPart($obj, $body, $ctype, $type) { $params['content_type'] = $ctype; $params['encoding'] = $this->build_params[$type . '_encoding']; $params['charset'] = $this->build_params[$type . '_charset']; $params['eol'] = $this->build_params['eol']; if (is_object($obj)) { $ret = $obj->addSubpart($body, $params); } else { $ret = new Mail_mimePart($body, $params); } return $ret; } /** * PEAR::isError implementation * * @param mixed $data Object * * @return bool True if object is an instance of PEAR_Error */ public static function isError($data) { // PEAR::isError() is not PHP 5.4 compatible (see Bug #19473) if (is_a($data, 'PEAR_Error')) { return true; } return false; } /** * PEAR::raiseError implementation * * @param string $message A text error message * * @return PEAR_Error Instance of PEAR_Error */ public static function raiseError($message) { // PEAR::raiseError() is not PHP 5.4 compatible return new PEAR_Error($message); } } smtpmx.php 0000644 00000036475 14716356152 0006636 0 ustar 00 * @copyright 2010-2017 gERD Schaufelberger * @license http://opensource.org/licenses/BSD-3-Clause New BSD License * @version CVS: $Id$ * @link http://pear.php.net/package/Mail/ */ require_once 'Net/SMTP.php'; /** * SMTP MX implementation of the PEAR Mail interface. Requires the Net_SMTP class. * * * @access public * @author gERD Schaufelberger
* @package Mail * @version $Revision$ */ class Mail_smtpmx extends Mail { /** * SMTP connection object. * * @var object * @access private */ var $_smtp = null; /** * The port the SMTP server is on. * @var integer * @see getservicebyname() */ var $port = 25; /** * Hostname or domain that will be sent to the remote SMTP server in the * HELO / EHLO message. * * @var string * @see posix_uname() */ var $mailname = 'localhost'; /** * SMTP connection timeout value. NULL indicates no timeout. * * @var integer */ var $timeout = 10; /** * use either PEAR:Net_DNS or getmxrr * * @var boolean */ var $withNetDns = true; /** * PEAR:Net_DNS_Resolver * * @var object */ var $resolver; /** * Whether to use VERP or not. If not a boolean, the string value * will be used as the VERP separators. * * @var mixed boolean or string */ var $verp = false; /** * Whether to use VRFY or not. * * @var boolean $vrfy */ var $vrfy = false; /** * Switch to test mode - don't send emails for real * * @var boolean $debug */ var $test = false; /** * Turn on Net_SMTP debugging? * * @var boolean $peardebug */ var $debug = false; /** * internal error codes * * translate internal error identifier to PEAR-Error codes and human * readable messages. * * @var boolean $debug * @todo as I need unique error-codes to identify what exactly went wrond * I did not use intergers as it should be. Instead I added a "namespace" * for each code. This avoids conflicts with error codes from different * classes. How can I use unique error codes and stay conform with PEAR? */ var $errorCode = array( 'not_connected' => array( 'code' => 1, 'msg' => 'Could not connect to any mail server ({HOST}) at port {PORT} to send mail to {RCPT}.' ), 'failed_vrfy_rcpt' => array( 'code' => 2, 'msg' => 'Recipient "{RCPT}" could not be veryfied.' ), 'failed_set_from' => array( 'code' => 3, 'msg' => 'Failed to set sender: {FROM}.' ), 'failed_set_rcpt' => array( 'code' => 4, 'msg' => 'Failed to set recipient: {RCPT}.' ), 'failed_send_data' => array( 'code' => 5, 'msg' => 'Failed to send mail to: {RCPT}.' ), 'no_from' => array( 'code' => 5, 'msg' => 'No from address has be provided.' ), 'send_data' => array( 'code' => 7, 'msg' => 'Failed to create Net_SMTP object.' ), 'no_mx' => array( 'code' => 8, 'msg' => 'No MX-record for {RCPT} found.' ), 'no_resolver' => array( 'code' => 9, 'msg' => 'Could not start resolver! Install PEAR:Net_DNS or switch off "netdns"' ), 'failed_rset' => array( 'code' => 10, 'msg' => 'RSET command failed, SMTP-connection corrupt.' ), ); /** * Constructor. * * Instantiates a new Mail_smtp:: object based on the parameters * passed in. It looks for the following parameters: * mailname The name of the local mail system (a valid hostname which matches the reverse lookup) * port smtp-port - the default comes from getservicebyname() and should work fine * timeout The SMTP connection timeout. Defaults to 30 seconds. * vrfy Whether to use VRFY or not. Defaults to false. * verp Whether to use VERP or not. Defaults to false. * test Activate test mode? Defaults to false. * debug Activate SMTP and Net_DNS debug mode? Defaults to false. * netdns whether to use PEAR:Net_DNS or the PHP build in function getmxrr, default is true * * If a parameter is present in the $params array, it replaces the * default. * * @access public * @param array Hash containing any parameters different from the * defaults. * @see _Mail_smtpmx() */ function __construct($params) { if (isset($params['mailname'])) { $this->mailname = $params['mailname']; } else { // try to find a valid mailname if (function_exists('posix_uname')) { $uname = posix_uname(); $this->mailname = $uname['nodename']; } } // port number if (isset($params['port'])) { $this->_port = $params['port']; } else { $this->_port = getservbyname('smtp', 'tcp'); } if (isset($params['timeout'])) $this->timeout = $params['timeout']; if (isset($params['verp'])) $this->verp = $params['verp']; if (isset($params['test'])) $this->test = $params['test']; if (isset($params['peardebug'])) $this->test = $params['peardebug']; if (isset($params['netdns'])) $this->withNetDns = $params['netdns']; } /** * Constructor wrapper for PHP4 * * @access public * @param array Hash containing any parameters different from the defaults * @see __construct() */ function Mail_smtpmx($params) { $this->__construct($params); register_shutdown_function(array(&$this, '__destruct')); } /** * Destructor implementation to ensure that we disconnect from any * potentially-alive persistent SMTP connections. */ function __destruct() { if (is_object($this->_smtp)) { $this->_smtp->disconnect(); $this->_smtp = null; } } /** * Implements Mail::send() function using SMTP direct delivery * * @access public * @param mixed $recipients in RFC822 style or array * @param array $headers The array of headers to send with the mail. * @param string $body The full text of the message body, * @return mixed Returns true on success, or a PEAR_Error */ function send($recipients, $headers, $body) { if (!is_array($headers)) { return PEAR::raiseError('$headers must be an array'); } $result = $this->_sanitizeHeaders($headers); if (is_a($result, 'PEAR_Error')) { return $result; } // Prepare headers $headerElements = $this->prepareHeaders($headers); if (is_a($headerElements, 'PEAR_Error')) { return $headerElements; } list($from, $textHeaders) = $headerElements; // use 'Return-Path' if possible if (!empty($headers['Return-Path'])) { $from = $headers['Return-Path']; } if (!isset($from)) { return $this->_raiseError('no_from'); } // Prepare recipients $recipients = $this->parseRecipients($recipients); if (is_a($recipients, 'PEAR_Error')) { return $recipients; } foreach ($recipients as $rcpt) { list($user, $host) = explode('@', $rcpt); $mx = $this->_getMx($host); if (is_a($mx, 'PEAR_Error')) { return $mx; } if (empty($mx)) { $info = array('rcpt' => $rcpt); return $this->_raiseError('no_mx', $info); } $connected = false; foreach ($mx as $mserver => $mpriority) { $this->_smtp = new Net_SMTP($mserver, $this->port, $this->mailname); // configure the SMTP connection. if ($this->debug) { $this->_smtp->setDebug(true); } // attempt to connect to the configured SMTP server. $res = $this->_smtp->connect($this->timeout); if (is_a($res, 'PEAR_Error')) { $this->_smtp = null; continue; } // connection established if ($res) { $connected = true; break; } } if (!$connected) { $info = array( 'host' => implode(', ', array_keys($mx)), 'port' => $this->port, 'rcpt' => $rcpt, ); return $this->_raiseError('not_connected', $info); } // Verify recipient if ($this->vrfy) { $res = $this->_smtp->vrfy($rcpt); if (is_a($res, 'PEAR_Error')) { $info = array('rcpt' => $rcpt); return $this->_raiseError('failed_vrfy_rcpt', $info); } } // mail from: $args['verp'] = $this->verp; $res = $this->_smtp->mailFrom($from, $args); if (is_a($res, 'PEAR_Error')) { $info = array('from' => $from); return $this->_raiseError('failed_set_from', $info); } // rcpt to: $res = $this->_smtp->rcptTo($rcpt); if (is_a($res, 'PEAR_Error')) { $info = array('rcpt' => $rcpt); return $this->_raiseError('failed_set_rcpt', $info); } // Don't send anything in test mode if ($this->test) { $result = $this->_smtp->rset(); $res = $this->_smtp->rset(); if (is_a($res, 'PEAR_Error')) { return $this->_raiseError('failed_rset'); } $this->_smtp->disconnect(); $this->_smtp = null; return true; } // Send data $res = $this->_smtp->data($body, $textHeaders); if (is_a($res, 'PEAR_Error')) { $info = array('rcpt' => $rcpt); return $this->_raiseError('failed_send_data', $info); } $this->_smtp->disconnect(); $this->_smtp = null; } return true; } /** * Recieve mx rexords for a spciefied host * * The MX records * * @access private * @param string $host mail host * @return mixed sorted */ function _getMx($host) { $mx = array(); if ($this->withNetDns) { $res = $this->_loadNetDns(); if (is_a($res, 'PEAR_Error')) { return $res; } $response = $this->resolver->query($host, 'MX'); if (!$response) { return false; } foreach ($response->answer as $rr) { if ($rr->type == 'MX') { $mx[$rr->exchange] = $rr->preference; } } } else { $mxHost = array(); $mxWeight = array(); if (!getmxrr($host, $mxHost, $mxWeight)) { return false; } for ($i = 0; $i < count($mxHost); ++$i) { $mx[$mxHost[$i]] = $mxWeight[$i]; } } asort($mx); return $mx; } /** * initialize PEAR:Net_DNS_Resolver * * @access private * @return boolean true on success */ function _loadNetDns() { if (is_object($this->resolver)) { return true; } if (!include_once 'Net/DNS.php') { return $this->_raiseError('no_resolver'); } $this->resolver = new Net_DNS_Resolver(); if ($this->debug) { $this->resolver->test = 1; } return true; } /** * raise standardized error * * include additional information in error message * * @access private * @param string $id maps error ids to codes and message * @param array $info optional information in associative array * @see _errorCode */ function _raiseError($id, $info = array()) { $code = $this->errorCode[$id]['code']; $msg = $this->errorCode[$id]['msg']; // include info to messages if (!empty($info)) { $search = array(); $replace = array(); foreach ($info as $key => $value) { array_push($search, '{' . strtoupper($key) . '}'); array_push($replace, $value); } $msg = str_replace($search, $replace, $msg); } return PEAR::raiseError($msg, $code); } } mimePart.php 0000644 00000133512 14716356152 0007052 0 ustar 00 * Copyright (c) 2003-2006, PEAR
* 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
* @author Cipriano Groenendal
* @author Sean Coates
* @author Aleksander Machniak
* @copyright 2003-2006 PEAR
* @license http://www.opensource.org/licenses/bsd-license.php BSD License * @version Release: @package_version@ * @link http://pear.php.net/package/Mail_mime */ /** * Require PEAR * * This package depends on PEAR to raise errors. */ require_once 'PEAR.php'; /** * The Mail_mimePart class is used to create MIME E-mail messages * * This class enables you to manipulate and build a mime email * from the ground up. The Mail_Mime class is a userfriendly api * to this class for people who aren't interested in the internals * of mime mail. * This class however allows full control over the email. * * @category Mail * @package Mail_Mime * @author Richard Heyes
* @author Cipriano Groenendal
* @author Sean Coates
* @author Aleksander Machniak
* @copyright 2003-2006 PEAR
* @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_mimePart { /** * The encoding type of this part * * @var string */ protected $encoding; /** * An array of subparts * * @var array */ protected $subparts = array(); /** * The output of this part after being built * * @var string */ protected $encoded; /** * Headers for this part * * @var array */ protected $headers = array(); /** * The body of this part (not encoded) * * @var string */ protected $body; /** * The location of file with body of this part (not encoded) * * @var string */ protected $body_file; /** * The short text of multipart part preamble (RFC2046 5.1.1) * * @var string */ protected $preamble; /** * The end-of-line sequence * * @var string */ protected $eol = "\r\n"; /** * Constructor. * * Sets up the object. * * @param string $body The body of the mime part if any. * @param array $params An associative array of optional parameters: * - content_type: The content type for this part eg multipart/mixed * - encoding: The encoding to use, 7bit, 8bit, base64, or quoted-printable * - charset: Content character set * - cid: Content ID to apply * - disposition: Content disposition, inline or attachment * - filename: Filename parameter for content disposition * - description: Content description * - name_encoding: Encoding of the attachment name (Content-Type) * By default filenames are encoded using RFC2231 * Here you can set RFC2047 encoding (quoted-printable * or base64) instead * - filename_encoding: Encoding of the attachment filename (Content-Disposition) * See 'name_encoding' * - headers_charset: Charset of the headers e.g. filename, description. * If not set, 'charset' will be used * - eol: End of line sequence. Default: "\r\n" * - headers: Hash array with additional part headers. Array keys * can be in form of
:
* - body_file: Location of file with part's body (instead of $body) * - preamble: short text of multipart part preamble (RFC2046 5.1.1) */ public function __construct($body = '', $params = array()) { if (!empty($params['eol'])) { $this->eol = $params['eol']; } else if (defined('MAIL_MIMEPART_CRLF')) { // backward-copat. $this->eol = MAIL_MIMEPART_CRLF; } // Additional part headers if (!empty($params['headers']) && is_array($params['headers'])) { $headers = $params['headers']; } foreach ($params as $key => $value) { switch ($key) { case 'encoding': $this->encoding = $value; $headers['Content-Transfer-Encoding'] = $value; break; case 'cid': $headers['Content-ID'] = '<' . $value . '>'; break; case 'location': $headers['Content-Location'] = $value; break; case 'body_file': $this->body_file = $value; break; case 'preamble': $this->preamble = $value; break; // for backward compatibility case 'dfilename': $params['filename'] = $value; break; } } // Default content-type if (empty($params['content_type'])) { $params['content_type'] = 'text/plain'; } // Content-Type $headers['Content-Type'] = $params['content_type']; if (!empty($params['charset'])) { $charset = "charset={$params['charset']}"; // place charset parameter in the same line, if possible if ((strlen($headers['Content-Type']) + strlen($charset) + 16) <= 76) { $headers['Content-Type'] .= '; '; } else { $headers['Content-Type'] .= ';' . $this->eol . ' '; } $headers['Content-Type'] .= $charset; // Default headers charset if (!isset($params['headers_charset'])) { $params['headers_charset'] = $params['charset']; } } // header values encoding parameters $h_charset = !empty($params['headers_charset']) ? $params['headers_charset'] : 'US-ASCII'; $h_language = !empty($params['language']) ? $params['language'] : null; $h_encoding = !empty($params['name_encoding']) ? $params['name_encoding'] : null; if (!empty($params['filename'])) { $headers['Content-Type'] .= ';' . $this->eol; $headers['Content-Type'] .= $this->buildHeaderParam( 'name', $params['filename'], $h_charset, $h_language, $h_encoding ); } // Content-Disposition if (!empty($params['disposition'])) { $headers['Content-Disposition'] = $params['disposition']; if (!empty($params['filename'])) { $headers['Content-Disposition'] .= ';' . $this->eol; $headers['Content-Disposition'] .= $this->buildHeaderParam( 'filename', $params['filename'], $h_charset, $h_language, !empty($params['filename_encoding']) ? $params['filename_encoding'] : null ); } // add attachment size $size = $this->body_file ? filesize($this->body_file) : strlen($body); if ($size) { $headers['Content-Disposition'] .= ';' . $this->eol . ' size=' . $size; } } if (!empty($params['description'])) { $headers['Content-Description'] = $this->encodeHeader( 'Content-Description', $params['description'], $h_charset, $h_encoding, $this->eol ); } // Search and add existing headers' parameters foreach ($headers as $key => $value) { $items = explode(':', $key); if (count($items) == 2) { $header = $items[0]; $param = $items[1]; if (isset($headers[$header])) { $headers[$header] .= ';' . $this->eol; } $headers[$header] .= $this->buildHeaderParam( $param, $value, $h_charset, $h_language, $h_encoding ); unset($headers[$key]); } } // Default encoding if (!isset($this->encoding)) { $this->encoding = '7bit'; } // Assign stuff to member variables $this->encoded = array(); $this->headers = $headers; $this->body = $body; } /** * Encodes and returns the email. Also stores * it in the encoded member variable * * @param string $boundary Pre-defined boundary string * * @return An associative array containing two elements, * body and headers. The headers element is itself * an indexed array. On error returns PEAR error object. */ public function encode($boundary=null) { $encoded =& $this->encoded; if (count($this->subparts)) { $boundary = $boundary ? $boundary : '=_' . md5(rand() . microtime()); $eol = $this->eol; $this->headers['Content-Type'] .= ";$eol boundary=\"$boundary\""; $encoded['body'] = ''; if ($this->preamble) { $encoded['body'] .= $this->preamble . $eol . $eol; } for ($i = 0; $i < count($this->subparts); $i++) { $encoded['body'] .= '--' . $boundary . $eol; $tmp = $this->subparts[$i]->encode(); if (is_a($tmp, 'PEAR_Error')) { return $tmp; } foreach ($tmp['headers'] as $key => $value) { $encoded['body'] .= $key . ': ' . $value . $eol; } $encoded['body'] .= $eol . $tmp['body'] . $eol; } $encoded['body'] .= '--' . $boundary . '--' . $eol; } else if ($this->body) { $encoded['body'] = $this->getEncodedData($this->body, $this->encoding); } else if ($this->body_file) { // Temporarily reset magic_quotes_runtime for file reads and writes if (version_compare(PHP_VERSION, '5.4.0', '<')) { $magic_quotes = @ini_set('magic_quotes_runtime', 0); } $body = $this->getEncodedDataFromFile($this->body_file, $this->encoding); if (isset($magic_quotes)) { @ini_set('magic_quotes_runtime', $magic_quotes); } if (is_a($body, 'PEAR_Error')) { return $body; } $encoded['body'] = $body; } else { $encoded['body'] = ''; } // Add headers to $encoded $encoded['headers'] =& $this->headers; return $encoded; } /** * Encodes and saves the email into file or stream. * Data will be appended to the file/stream. * * @param mixed $filename Existing file location * or file pointer resource * @param string $boundary Pre-defined boundary string * @param boolean $skip_head True if you don't want to save headers * * @return array An associative array containing message headers * or PEAR error object * @since 1.6.0 */ public function encodeToFile($filename, $boundary = null, $skip_head = false) { if (!is_resource($filename)) { if (file_exists($filename) && !is_writable($filename)) { $err = self::raiseError('File is not writeable: ' . $filename); return $err; } if (!($fh = fopen($filename, 'ab'))) { $err = self::raiseError('Unable to open file: ' . $filename); return $err; } } else { $fh = $filename; } // Temporarily reset magic_quotes_runtime for file reads and writes if (version_compare(PHP_VERSION, '5.4.0', '<')) { $magic_quotes = @ini_set('magic_quotes_runtime', 0); } $res = $this->encodePartToFile($fh, $boundary, $skip_head); if (!is_resource($filename)) { fclose($fh); } if (isset($magic_quotes)) { @ini_set('magic_quotes_runtime', $magic_quotes); } return is_a($res, 'PEAR_Error') ? $res : $this->headers; } /** * Encodes given email part into file * * @param string $fh Output file handle * @param string $boundary Pre-defined boundary string * @param boolean $skip_head True if you don't want to save headers * * @return array True on sucess or PEAR error object */ protected function encodePartToFile($fh, $boundary = null, $skip_head = false) { $eol = $this->eol; if (count($this->subparts)) { $boundary = $boundary ? $boundary : '=_' . md5(rand() . microtime()); $this->headers['Content-Type'] .= ";$eol boundary=\"$boundary\""; } if (!$skip_head) { foreach ($this->headers as $key => $value) { fwrite($fh, $key . ': ' . $value . $eol); } $f_eol = $eol; } else { $f_eol = ''; } if (count($this->subparts)) { if ($this->preamble) { fwrite($fh, $f_eol . $this->preamble . $eol); $f_eol = $eol; } for ($i = 0; $i < count($this->subparts); $i++) { fwrite($fh, $f_eol . '--' . $boundary . $eol); $res = $this->subparts[$i]->encodePartToFile($fh); if (is_a($res, 'PEAR_Error')) { return $res; } $f_eol = $eol; } fwrite($fh, $eol . '--' . $boundary . '--' . $eol); } else if ($this->body) { fwrite($fh, $f_eol); fwrite($fh, $this->getEncodedData($this->body, $this->encoding)); } else if ($this->body_file) { fwrite($fh, $f_eol); $res = $this->getEncodedDataFromFile( $this->body_file, $this->encoding, $fh ); if (is_a($res, 'PEAR_Error')) { return $res; } } return true; } /** * Adds a subpart to current mime part and returns * a reference to it * * @param mixed $body The body of the subpart or Mail_mimePart object * @param array $params The parameters for the subpart, same * as the $params argument for constructor * * @return Mail_mimePart A reference to the part you just added. */ public function addSubpart($body, $params = null) { if ($body instanceof Mail_mimePart) { $part = $body; } else { $part = new Mail_mimePart($body, $params); } $this->subparts[] = $part; return $part; } /** * Returns encoded data based upon encoding passed to it * * @param string $data The data to encode. * @param string $encoding The encoding type to use, 7bit, base64, * or quoted-printable. * * @return string Encoded data string */ protected function getEncodedData($data, $encoding) { switch ($encoding) { case 'quoted-printable': return self::quotedPrintableEncode($data, 76, $this->eol); break; case 'base64': return rtrim(chunk_split(base64_encode($data), 76, $this->eol)); break; case '8bit': case '7bit': default: return $data; } } /** * Returns encoded data based upon encoding passed to it * * @param string $filename Data file location * @param string $encoding The encoding type to use, 7bit, base64, * or quoted-printable. * @param resource $fh Output file handle. If set, data will be * stored into it instead of returning it * * @return string Encoded data or PEAR error object */ protected function getEncodedDataFromFile($filename, $encoding, $fh = null) { if (!is_readable($filename)) { $err = self::raiseError('Unable to read file: ' . $filename); return $err; } if (!($fd = fopen($filename, 'rb'))) { $err = self::raiseError('Could not open file: ' . $filename); return $err; } $data = ''; switch ($encoding) { case 'quoted-printable': while (!feof($fd)) { $buffer = self::quotedPrintableEncode(fgets($fd), 76, $this->eol); if ($fh) { fwrite($fh, $buffer); } else { $data .= $buffer; } } break; case 'base64': while (!feof($fd)) { // Should read in a multiple of 57 bytes so that // the output is 76 bytes per line. Don't use big chunks // because base64 encoding is memory expensive $buffer = fread($fd, 57 * 9198); // ca. 0.5 MB $buffer = base64_encode($buffer); $buffer = chunk_split($buffer, 76, $this->eol); if (feof($fd)) { $buffer = rtrim($buffer); } if ($fh) { fwrite($fh, $buffer); } else { $data .= $buffer; } } break; case '8bit': case '7bit': default: while (!feof($fd)) { $buffer = fread($fd, 1048576); // 1 MB if ($fh) { fwrite($fh, $buffer); } else { $data .= $buffer; } } } fclose($fd); if (!$fh) { return $data; } } /** * Encodes data to quoted-printable standard. * * @param string $input The data to encode * @param int $line_max Optional max line length. Should * not be more than 76 chars * @param string $eol End-of-line sequence. Default: "\r\n" * * @return string Encoded data */ public static function quotedPrintableEncode($input , $line_max = 76, $eol = "\r\n") { /* // imap_8bit() is extremely fast, but doesn't handle properly some characters if (function_exists('imap_8bit') && $line_max == 76) { $input = preg_replace('/\r?\n/', "\r\n", $input); $input = imap_8bit($input); if ($eol != "\r\n") { $input = str_replace("\r\n", $eol, $input); } return $input; } */ $lines = preg_split("/\r?\n/", $input); $escape = '='; $output = ''; foreach ($lines as $idx => $line) { $newline = ''; $i = 0; while (isset($line[$i])) { $char = $line[$i]; $dec = ord($char); $i++; if (($dec == 32) && (!isset($line[$i]))) { // convert space at eol only $char = '=20'; } elseif ($dec == 9 && isset($line[$i])) { ; // Do nothing if a TAB is not on eol } elseif (($dec == 61) || ($dec < 32) || ($dec > 126)) { // Escape unprintable chars $char = $escape . sprintf('%02X', $dec); } elseif (($dec == 46) && (($newline == '') || ((strlen($newline) + strlen(".=")) > $line_max && isset($line[$i]))) ) { // Bug #9722: convert full-stop at bol, // some Windows servers need this, won't break anything (cipri) // Bug #11731: full-stop at bol also needs to be encoded // if this line would push us over the line_max limit. $char = '=2E'; } // EOL is not counted if ((strlen($newline) + strlen($char) == $line_max) && !isset($line[$i]) ) { ; // no soft break is needed if we're the last char } elseif ((strlen($newline) + strlen($char)) >= $line_max) { // soft line break; " =\r\n" is okay $output .= $newline . $escape . $eol; $newline = ''; } $newline .= $char; } // end of for $output .= $newline . $eol; unset($lines[$idx]); } // Don't want last crlf $output = substr($output, 0, -1 * strlen($eol)); return $output; } /** * Encodes the parameter of a header. * * @param string $name The name of the header-parameter * @param string $value The value of the paramter * @param string $charset The characterset of $value * @param string $language The language used in $value * @param string $encoding Parameter encoding. If not set, parameter value * is encoded according to RFC2231 * @param int $maxLength The maximum length of a line. Defauls to 75 * * @return string */ protected function buildHeaderParam($name, $value, $charset = null, $language = null, $encoding = null, $maxLength = 75 ) { // RFC 2045: // value needs encoding if contains non-ASCII chars or is longer than 78 chars if (!preg_match('#[^\x20-\x7E]#', $value)) { $token_regexp = '#([^\x21\x23-\x27\x2A\x2B\x2D' . '\x2E\x30-\x39\x41-\x5A\x5E-\x7E])#'; if (!preg_match($token_regexp, $value)) { // token if (strlen($name) + strlen($value) + 3 <= $maxLength) { return " {$name}={$value}"; } } else { // quoted-string $quoted = addcslashes($value, '\\"'); if (strlen($name) + strlen($quoted) + 5 <= $maxLength) { return " {$name}=\"{$quoted}\""; } } } // RFC2047: use quoted-printable/base64 encoding if ($encoding == 'quoted-printable' || $encoding == 'base64') { return $this->buildRFC2047Param($name, $value, $charset, $encoding); } // RFC2231: $encValue = preg_replace_callback( '/([^\x21\x23\x24\x26\x2B\x2D\x2E\x30-\x39\x41-\x5A\x5E-\x7E])/', array($this, 'encodeReplaceCallback'), $value ); $value = "$charset'$language'$encValue"; $header = " {$name}*={$value}"; if (strlen($header) <= $maxLength) { return $header; } $preLength = strlen(" {$name}*0*="); $maxLength = max(16, $maxLength - $preLength - 3); $maxLengthReg = "|(.{0,$maxLength}[^\%][^\%])|"; $headers = array(); $headCount = 0; while ($value) { $matches = array(); $found = preg_match($maxLengthReg, $value, $matches); if ($found) { $headers[] = " {$name}*{$headCount}*={$matches[0]}"; $value = substr($value, strlen($matches[0])); } else { $headers[] = " {$name}*{$headCount}*={$value}"; $value = ''; } $headCount++; } $headers = implode(';' . $this->eol, $headers); return $headers; } /** * Encodes header parameter as per RFC2047 if needed * * @param string $name The parameter name * @param string $value The parameter value * @param string $charset The parameter charset * @param string $encoding Encoding type (quoted-printable or base64) * @param int $maxLength Encoded parameter max length. Default: 76 * * @return string Parameter line */ protected function buildRFC2047Param($name, $value, $charset, $encoding = 'quoted-printable', $maxLength = 76 ) { // WARNING: RFC 2047 says: "An 'encoded-word' MUST NOT be used in // parameter of a MIME Content-Type or Content-Disposition field", // but... it's supported by many clients/servers $quoted = ''; if ($encoding == 'base64') { $value = base64_encode($value); $prefix = '=?' . $charset . '?B?'; $suffix = '?='; // 2 x SPACE, 2 x '"', '=', ';' $add_len = strlen($prefix . $suffix) + strlen($name) + 6; $len = $add_len + strlen($value); while ($len > $maxLength) { // We can cut base64-encoded string every 4 characters $real_len = floor(($maxLength - $add_len) / 4) * 4; $_quote = substr($value, 0, $real_len); $value = substr($value, $real_len); $quoted .= $prefix . $_quote . $suffix . $this->eol . ' '; $add_len = strlen($prefix . $suffix) + 4; // 2 x SPACE, '"', ';' $len = strlen($value) + $add_len; } $quoted .= $prefix . $value . $suffix; } else { // quoted-printable $value = $this->encodeQP($value); $prefix = '=?' . $charset . '?Q?'; $suffix = '?='; // 2 x SPACE, 2 x '"', '=', ';' $add_len = strlen($prefix . $suffix) + strlen($name) + 6; $len = $add_len + strlen($value); while ($len > $maxLength) { $length = $maxLength - $add_len; // don't break any encoded letters if (preg_match("/^(.{0,$length}[^\=][^\=])/", $value, $matches)) { $_quote = $matches[1]; } $quoted .= $prefix . $_quote . $suffix . $this->eol . ' '; $value = substr($value, strlen($_quote)); $add_len = strlen($prefix . $suffix) + 4; // 2 x SPACE, '"', ';' $len = strlen($value) + $add_len; } $quoted .= $prefix . $value . $suffix; } return " {$name}=\"{$quoted}\""; } /** * Return charset for mbstring functions. * Replace ISO-2022-JP with ISO-2022-JP-MS to convert Windows dependent * characters. * * @param string $charset A original charset * * @return string A charset for mbstring * @since 1.10.8 */ protected static function mbstringCharset($charset) { $mb_charset = $charset; if ($charset == 'ISO-2022-JP') { $mb_charset = 'ISO-2022-JP-MS'; } return $mb_charset; } /** * Encodes a header as per RFC2047 * * @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) * @param string $eol End-of-line sequence. Default: "\r\n" * * @return string Encoded header data (without a name) * @since 1.6.1 */ public static function encodeHeader($name, $value, $charset = 'ISO-8859-1', $encoding = 'quoted-printable', $eol = "\r\n" ) { // Structured headers $comma_headers = array( 'from', 'to', 'cc', 'bcc', 'sender', 'reply-to', 'resent-from', 'resent-to', 'resent-cc', 'resent-bcc', 'resent-sender', 'resent-reply-to', 'mail-reply-to', 'mail-followup-to', 'return-receipt-to', 'disposition-notification-to', ); $other_headers = array( 'references', 'in-reply-to', 'message-id', 'resent-message-id', ); $name = strtolower($name); if (in_array($name, $comma_headers)) { $separator = ','; } else if (in_array($name, $other_headers)) { $separator = ' '; } if (!$charset) { $charset = 'ISO-8859-1'; } // exploding quoted strings as well as some regexes below do not // work properly with some charset e.g. ISO-2022-JP, we'll use UTF-8 $mb = $charset != 'UTF-8' && function_exists('mb_convert_encoding'); $mb_charset = Mail_mimePart::mbstringCharset($charset); // Structured header (make sure addr-spec inside is not encoded) if (!empty($separator)) { // Simple e-mail address regexp $email_regexp = '([^\s<]+|("[^\r\n"]+"))@[^\s"]+'; if ($mb) { $value = mb_convert_encoding($value, 'UTF-8', $mb_charset); } $parts = Mail_mimePart::explodeQuotedString("[\t$separator]", $value); $value = ''; foreach ($parts as $part) { $part = preg_replace('/\r?\n[\s\t]*/', $eol . ' ', $part); $part = trim($part); if (!$part) { continue; } if ($value) { $value .= $separator == ',' ? $separator . ' ' : ' '; } else { $value = $name . ': '; } // let's find phrase (name) and/or addr-spec if (preg_match('/^<' . $email_regexp . '>$/', $part)) { $value .= $part; } else if (preg_match('/^' . $email_regexp . '$/', $part)) { // address without brackets and without name $value .= $part; } else if (preg_match('/<*' . $email_regexp . '>*$/', $part, $matches)) { // address with name (handle name) $address = $matches[0]; $word = str_replace($address, '', $part); $word = trim($word); // check if phrase requires quoting if ($word) { // non-ASCII: require encoding if (preg_match('#([^\s\x21-\x7E]){1}#', $word)) { if ($word[0] == '"' && $word[strlen($word)-1] == '"') { // de-quote quoted-string, encoding changes // string to atom $word = substr($word, 1, -1); $word = preg_replace('/\\\\([\\\\"])/', '$1', $word); } if ($mb) { $word = mb_convert_encoding($word, $mb_charset, 'UTF-8'); } // find length of last line if (($pos = strrpos($value, $eol)) !== false) { $last_len = strlen($value) - $pos; } else { $last_len = strlen($value); } $word = Mail_mimePart::encodeHeaderValue( $word, $charset, $encoding, $last_len, $eol ); } else if (($word[0] != '"' || $word[strlen($word)-1] != '"') && preg_match('/[\(\)\<\>\\\.\[\]@,;:"]/', $word) ) { // ASCII: quote string if needed $word = '"'.addcslashes($word, '\\"').'"'; } } $value .= $word.' '.$address; } else { if ($mb) { $part = mb_convert_encoding($part, $mb_charset, 'UTF-8'); } // addr-spec not found, don't encode (?) $value .= $part; } // RFC2822 recommends 78 characters limit, use 76 from RFC2047 $value = wordwrap($value, 76, $eol . ' '); } // remove header name prefix (there could be EOL too) $value = preg_replace( '/^'.$name.':('.preg_quote($eol, '/').')* /', '', $value ); } else { // Unstructured header // non-ASCII: require encoding if (preg_match('#([^\s\x21-\x7E]){1}#', $value)) { if ($value[0] == '"' && $value[strlen($value)-1] == '"') { if ($mb) { $value = mb_convert_encoding($value, 'UTF-8', $mb_charset); } // de-quote quoted-string, encoding changes // string to atom $value = substr($value, 1, -1); $value = preg_replace('/\\\\([\\\\"])/', '$1', $value); if ($mb) { $value = mb_convert_encoding($value, $mb_charset, 'UTF-8'); } } $value = Mail_mimePart::encodeHeaderValue( $value, $charset, $encoding, strlen($name) + 2, $eol ); } else if (strlen($name.': '.$value) > 78) { // ASCII: check if header line isn't too long and use folding $value = preg_replace('/\r?\n[\s\t]*/', $eol . ' ', $value); $tmp = wordwrap($name . ': ' . $value, 78, $eol . ' '); $value = preg_replace('/^' . $name . ':\s*/', '', $tmp); // hard limit 998 (RFC2822) $value = wordwrap($value, 998, $eol . ' ', true); } } return $value; } /** * Explode quoted string * * @param string $delimiter Delimiter expression string for preg_match() * @param string $string Input string * * @return array String tokens array */ protected static function explodeQuotedString($delimiter, $string) { $result = array(); $strlen = strlen($string); $quoted_string = '"(?:[^"\\\\]|\\\\.)*"'; for ($p=$i=0; $i < $strlen; $i++) { if ($string[$i] === '"') { $r = preg_match("/$quoted_string/", $string, $matches, 0, $i); if (!$r || empty($matches[0])) { break; } $i += strlen($matches[0]) - 1; } else if (preg_match("/$delimiter/", $string[$i])) { $result[] = substr($string, $p, $i - $p); $p = $i + 1; } } $result[] = substr($string, $p); return $result; } /** * Encodes a header value as per RFC2047 * * @param string $value The header data to encode * @param string $charset Character set name * @param string $encoding Encoding name (base64 or quoted-printable) * @param int $prefix_len Prefix length. Default: 0 * @param string $eol End-of-line sequence. Default: "\r\n" * * @return string Encoded header data * @since 1.6.1 */ public static function encodeHeaderValue($value, $charset, $encoding, $prefix_len = 0, $eol = "\r\n") { // #17311: Use multibyte aware method (requires mbstring extension) if ($result = Mail_mimePart::encodeMB($value, $charset, $encoding, $prefix_len, $eol)) { return $result; } // Generate the header using the specified params and dynamicly // determine the maximum length of such strings. // 75 is the value specified in the RFC. $encoding = $encoding == 'base64' ? 'B' : 'Q'; $prefix = '=?' . $charset . '?' . $encoding .'?'; $suffix = '?='; $maxLength = 75 - strlen($prefix . $suffix); $maxLength1stLine = $maxLength - $prefix_len; if ($encoding == 'B') { // Base64 encode the entire string $value = base64_encode($value); // We can cut base64 every 4 characters, so the real max // we can get must be rounded down. $maxLength = $maxLength - ($maxLength % 4); $maxLength1stLine = $maxLength1stLine - ($maxLength1stLine % 4); $cutpoint = $maxLength1stLine; $output = ''; while ($value) { // Split translated string at every $maxLength $part = substr($value, 0, $cutpoint); $value = substr($value, $cutpoint); $cutpoint = $maxLength; // RFC 2047 specifies that any split header should // be separated by a CRLF SPACE. if ($output) { $output .= $eol . ' '; } $output .= $prefix . $part . $suffix; } $value = $output; } else { // quoted-printable encoding has been selected $value = Mail_mimePart::encodeQP($value); // This regexp will break QP-encoded text at every $maxLength // but will not break any encoded letters. $reg1st = "|(.{0,$maxLength1stLine}[^\=][^\=])|"; $reg2nd = "|(.{0,$maxLength}[^\=][^\=])|"; if (strlen($value) > $maxLength1stLine) { // Begin with the regexp for the first line. $reg = $reg1st; $output = ''; while ($value) { // Split translated string at every $maxLength // But make sure not to break any translated chars. $found = preg_match($reg, $value, $matches); // After this first line, we need to use a different // regexp for the first line. $reg = $reg2nd; // Save the found part and encapsulate it in the // prefix & suffix. Then remove the part from the // $value_out variable. if ($found) { $part = $matches[0]; $len = strlen($matches[0]); $value = substr($value, $len); } else { $part = $value; $value = ''; } // RFC 2047 specifies that any split header should // be separated by a CRLF SPACE if ($output) { $output .= $eol . ' '; } $output .= $prefix . $part . $suffix; } $value = $output; } else { $value = $prefix . $value . $suffix; } } return $value; } /** * Encodes the given string using quoted-printable * * @param string $str String to encode * * @return string Encoded string * @since 1.6.0 */ public static function encodeQP($str) { // Bug #17226 RFC 2047 restricts some characters // if the word is inside a phrase, permitted chars are only: // ASCII letters, decimal digits, "!", "*", "+", "-", "/", "=", and "_" // "=", "_", "?" must be encoded $regexp = '/([\x22-\x29\x2C\x2E\x3A-\x40\x5B-\x60\x7B-\x7E\x80-\xFF])/'; $str = preg_replace_callback( $regexp, array('Mail_mimePart', 'qpReplaceCallback'), $str ); return str_replace(' ', '_', $str); } /** * Encodes the given string using base64 or quoted-printable. * This method makes sure that encoded-word represents an integral * number of characters as per RFC2047. * * @param string $str String to encode * @param string $charset Character set name * @param string $encoding Encoding name (base64 or quoted-printable) * @param int $prefix_len Prefix length. Default: 0 * @param string $eol End-of-line sequence. Default: "\r\n" * * @return string Encoded string * @since 1.8.0 */ public static function encodeMB($str, $charset, $encoding, $prefix_len=0, $eol="\r\n") { if (!function_exists('mb_substr') || !function_exists('mb_strlen')) { return; } $encoding = $encoding == 'base64' ? 'B' : 'Q'; // 75 is the value specified in the RFC $prefix = '=?' . $charset . '?'.$encoding.'?'; $suffix = '?='; $maxLength = 75 - strlen($prefix . $suffix); $mb_charset = Mail_mimePart::mbstringCharset($charset); // A multi-octet character may not be split across adjacent encoded-words // So, we'll loop over each character // mb_stlen() with wrong charset will generate a warning here and return null $length = mb_strlen($str, $mb_charset); $result = ''; $line_length = $prefix_len; if ($encoding == 'B') { // base64 $start = 0; $prev = ''; for ($i=1; $i<=$length; $i++) { // See #17311 $chunk = mb_substr($str, $start, $i-$start, $mb_charset); $chunk = base64_encode($chunk); $chunk_len = strlen($chunk); if ($line_length + $chunk_len == $maxLength || $i == $length) { if ($result) { $result .= "\n"; } $result .= $chunk; $line_length = 0; $start = $i; } else if ($line_length + $chunk_len > $maxLength) { if ($result) { $result .= "\n"; } if ($prev) { $result .= $prev; } $line_length = 0; $start = $i - 1; } else { $prev = $chunk; } } } else { // quoted-printable // see encodeQP() $regexp = '/([\x22-\x29\x2C\x2E\x3A-\x40\x5B-\x60\x7B-\x7E\x80-\xFF])/'; for ($i=0; $i<=$length; $i++) { $char = mb_substr($str, $i, 1, $mb_charset); // RFC recommends underline (instead of =20) in place of the space // that's one of the reasons why we're not using iconv_mime_encode() if ($char == ' ') { $char = '_'; $char_len = 1; } else { $char = preg_replace_callback( $regexp, array('Mail_mimePart', 'qpReplaceCallback'), $char ); $char_len = strlen($char); } if ($line_length + $char_len > $maxLength) { if ($result) { $result .= "\n"; } $line_length = 0; } $result .= $char; $line_length += $char_len; } } if ($result) { $result = $prefix .str_replace("\n", $suffix.$eol.' '.$prefix, $result).$suffix; } return $result; } /** * Callback function to replace extended characters (\x80-xFF) with their * ASCII values (RFC2047: quoted-printable) * * @param array $matches Preg_replace's matches array * * @return string Encoded character string */ protected static function qpReplaceCallback($matches) { return sprintf('=%02X', ord($matches[1])); } /** * Callback function to replace extended characters (\x80-xFF) with their * ASCII values (RFC2231) * * @param array $matches Preg_replace's matches array * * @return string Encoded character string */ protected static function encodeReplaceCallback($matches) { return sprintf('%%%02X', ord($matches[1])); } /** * PEAR::raiseError implementation * * @param string $message A text error message * * @return PEAR_Error Instance of PEAR_Error */ public static function raiseError($message) { // PEAR::raiseError() is not PHP 5.4 compatible return new PEAR_Error($message); } } LICENSE 0000644 00000002777 14716357726 0005610 0 ustar 00 Copyright (c) 1997-2017, Chuck Hagenbuch All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. 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. 3. Neither the name of the copyright holder 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 HOLDER 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. tests/bug17317.phpt 0000644 00000000670 14716357772 0010011 0 ustar 00 --TEST-- Mail_RFC822::parseAddressList invalid periods in mail address --FILE-- 'John Doe', 'email' => 'test@example.com'), array('name' => 'John Doe\\', 'email' => 'test@example.com'), array('name' => 'John "Doe', 'email' => 'test@example.com'), array('name' => 'John "Doe\\', 'email' => 'test@example.com'), ); for ($i = 0; $i < count($addresses); $i++) { // construct the address $address = "\"" . addslashes($addresses[$i]['name']) . "\" ". "<".$addresses[$i]['email'].">"; $parsedAddresses = Mail_RFC822::parseAddressList($address); if (is_a($parsedAddresses, 'PEAR_Error')) { echo $address." :: Failed to validate\n"; } else { echo $address." :: Parsed\n"; } } --EXPECT-- "John Doe"
:: Parsed "John Doe\\"
:: Parsed "John \"Doe"
:: Parsed "John \"Doe\\"
:: Parsed tests/9137_2.phpt 0000644 00000002355 14716357772 0007457 0 ustar 00 --TEST-- Mail: Test for bug #9137, take 2 --FILE-- '"John Doe"
'), array('raw' => '"John Doe' . chr(92) . '"
'), array('raw' => '"John Doe' . chr(92) . chr(92) . '"
'), array('raw' => '"John Doe' . chr(92) . chr(92) . chr(92) . '"
'), array('raw' => '"John Doe' . chr(92) . chr(92) . chr(92) . chr(92) . '"
'), array('raw' => '"John Doe
'), ); for ($i = 0; $i < count($addresses); $i++) { // construct the address $address = $addresses[$i]['raw']; $parsedAddresses = Mail_RFC822::parseAddressList($address); if (PEAR::isError($parsedAddresses)) { echo $address." :: Failed to validate\n"; } else { echo $address." :: Parsed\n"; } } --EXPECT-- "John Doe"
:: Parsed "John Doe\"
:: Failed to validate "John Doe\\"
:: Parsed "John Doe\\\"
:: Failed to validate "John Doe\\\\"
:: Parsed "John Doe
:: Failed to validate tests/bug17178.phpt 0000644 00000000357 14716357772 0010020 0 ustar 00 --TEST-- Mail_RFC822::parseAddressList does not accept RFC-valid group syntax --FILE-- packageExists('Net_SMTP')) die("skip\n"); --FILE-- 'bogus.host.tld'); /* Create our SMTP-based mailer object. */ $mailer = Mail::factory('smtp', $params); /* Attempt to send an empty message in order to trigger an error. */ $e = $mailer->send(array(), array(), ''); if (is_a($e, 'PEAR_Error')) { $err = $e->getMessage(); if (preg_match('/Failed to connect to bogus.host.tld:25 \[SMTP: Failed to connect socket:.*/i', $err)) { echo "OK"; } } --EXPECT-- OK tests/validateQuotedString.phpt 0000644 00000001230 14716357772 0012764 0 ustar 00 --TEST-- Mail_RFC822::parseAddressList simple tests --FILE-- , postmaster@example.com, root'; $address_array = Mail_RFC822::parseAddressList($address_string, "example.com"); foreach ($address_array as $val) { echo "mailbox : " . $val->mailbox . "\n"; echo "host : " . $val->host . "\n"; echo "personal: " . $val->personal . "\n"; } --EXPECT-- mailbox : doe host : example.com personal: "Joe Doe \(from Somewhere\)" mailbox : postmaster host : example.com personal: mailbox : root host : example.com personal: tests/13659.phpt 0000644 00000001242 14716357772 0007314 0 ustar 00 --TEST-- Mail: Test for bug #13659 --FILE-- (test)'; $parser = new Mail_RFC822(); $result = $parser->parseAddressList($address, 'anydomain.com', TRUE); if (!PEAR::isError($result) && is_array($result) && is_object($result[0])) if ($result[0]->personal == '"Test Student"' && $result[0]->mailbox == "test" && $result[0]->host == "mydomain.com" && is_array($result[0]->comment) && $result[0]->comment[0] == 'test') { print("OK"); } ?> --EXPECT-- OK tests/rfc822.phpt 0000644 00000005614 14716357772 0007642 0 ustar 00 --TEST-- Mail_RFC822: Address Parsing --FILE-- parseAddressList($address, null, true, true)); /* Address groups. */ $address = 'My Group: "Richard"
(A comment), ted@example.com (Ted Bloggs), Barney;'; print_r($parser->parseAddressList($address, null, true, true)); /* A valid address with spaces in the local part. */ $address = '<"Jon Parise"@php.net>'; print_r($parser->parseAddressList($address, null, true, true)); /* An invalid address with spaces in the local part. */ $address = '
'; $result = $parser->parseAddressList($address, null, true, true); if (is_a($result, 'PEAR_Error')) echo $result->getMessage() . "\n"; /* A valid address with an uncommon TLD. */ $address = 'jon@host.longtld'; $result = $parser->parseAddressList($address, null, true, true); if (is_a($result, 'PEAR_Error')) echo $result->getMessage() . "\n"; --EXPECT-- Array ( [0] => stdClass Object ( [personal] => [comment] => Array ( ) [mailbox] => user [host] => example.com ) ) Array ( [0] => stdClass Object ( [groupname] => My Group [addresses] => Array ( [0] => stdClass Object ( [personal] => "Richard" [comment] => Array ( [0] => A comment ) [mailbox] => richard [host] => localhost ) [1] => stdClass Object ( [personal] => [comment] => Array ( [0] => Ted Bloggs ) [mailbox] => ted [host] => example.com ) [2] => stdClass Object ( [personal] => [comment] => Array ( ) [mailbox] => Barney [host] => localhost ) ) ) ) Array ( [0] => stdClass Object ( [personal] => [comment] => Array ( ) [mailbox] => "Jon Parise" [host] => php.net ) ) Validation failed for: