Improved SMTP script for sending mails. Now using the PEAR::Net_SMTP class

thomascube

2005-09-30 968bdc7c90f718560b84eb3b7e8e1d02cf4270f3

Improved SMTP script for sending mails. Now using the PEAR::Net_SMTP class

 UPGRADING

@@ -14,6 +14,7 @@
  $rcmail_config['default_imap_folders'] = array('INBOX', 'Drafts', 'Sent', 'Junk', 'Trash');
  $rcmail_config['prefer_html'] = TRUE;
  $rcmail_config['prettydate'] = TRUE;
  $rcmail_config['smtp_port'] = 25;


from version 0.1-20050820
@@ -21,4 +22,4 @@
- replace all files in folder /program/
- add these line to /config/main.inc.php
  $rcmail_config['prettydate'] = TRUE;

  $rcmail_config['smtp_port'] = 25;

 config/main.inc.php.dist

@@ -15,7 +15,7 @@
$rcmail_config = array();


// system error reporting: 1 = log; 2 = report (not implemented yet), 4 = show
// system error reporting: 1 = log; 2 = report (not implemented yet), 4 = show, 8 = trace
$rcmail_config['debug_level'] = 5;

// automatically create a new user when log-in the first time
@@ -31,6 +31,9 @@
// if left blank, the PHP mail() function is used
$rcmail_config['smtp_server'] = '';

// SMTP port (default is 25)
$rcmail_config['smtp_port'] = 25;

// SMTP username (if required)
$rcmail_config['smtp_user'] = '';


 logs/errors

@@ -0,0 +1,10 @@
[30-Sep-2005 23:12:17 +0200] SMTP Error: Connection failed: SMTP: Failed to send data
 in /www/roundcube/webmail/program/steps/mail/sendmail.inc on line 198
[30-Sep-2005 23:18:44 +0200] SMTP Error: Connection failed: SMTP: Failed to send data
 in /www/roundcube/webmail/program/steps/mail/sendmail.inc on line 198
[30-Sep-2005 23:26:41 +0200] SMTP Error: Connection failed: SMTP: Failed to send data
 in /www/roundcube/webmail/program/steps/mail/sendmail.inc on line 198
[30-Sep-2005 23:31:29 +0200] SMTP Error: Connection failed: SMTP: Failed to send data
 in /www/roundcube/webmail/program/steps/mail/sendmail.inc on line 198
[30-Sep-2005 23:31:56 +0200] SMTP Error: Connection failed: SMTP: Failed to send data
 in /www/roundcube/webmail/program/steps/mail/sendmail.inc on line 198

 logs/sendmail

@@ -0,0 +1,8 @@
[30-Sep-2005 23:13:28 +0200] User: 2; Message for Thomas Bruderli <thomas@brotherli.ch>; Subject: Testmail form RoundCube I
[30-Sep-2005 23:28:29 +0200] User: 2; Message for Thomas Brüderli <thomas@brotherli.ch>; Subject: Testmail form RoundCube II
[30-Sep-2005 23:33:23 +0200] User: 2; Message for Thomas Brüderli <thomas@brotherli.ch>; Subject: Testmail form RoundCube III
[30-Sep-2005 23:34:23 +0200] User: 2; Message for Thomas Brüderli <thomas@brotherli.ch>; Subject: Testmail form RoundCube IV
[30-Sep-2005 23:44:40 +0200] User: 2; Message for Thomas Brüderli <thomas@brotherli.ch>, tb@localhost; Subject: Testmail V
[30-Sep-2005 23:45:38 +0200] User: 2; Message for Thomas Brüderli <thomas@brotherli.ch>, roundcube@gmail.com; Subject: Testmail VI
[30-Sep-2005 23:54:05 +0200] User: 2; Message for Thomas Brüderli <thomas@brotherli.ch>; Subject: Testmail VII
[30-Sep-2005 23:55:08 +0200] User: 2; Message for Thomas Brüderli <thomas@brotherli.ch>; Subject: Testmail VII

 program/include/rcube_smtp.inc

New file
@@ -0,0 +1,324 @@
<?

/*
 +-----------------------------------------------------------------------+
 | program/include/rcube_smtp.inc                                        |
 |                                                                       |
 | This file is part of the RoundCube Webmail client                     |
 | Copyright (C) 2005, RoundCube Dev. - Switzerland                      |
 | Licensed under the GNU GPL                                            |
 |                                                                       |
 | PURPOSE:                                                              |
 |   Provide SMTP functionality using socket connections                 |
 |                                                                       |
 +-----------------------------------------------------------------------+
 | Author: Thomas Bruederli <roundcube@gmail.com>                        |
 +-----------------------------------------------------------------------+

 $Id$

*/


// include required PEAR classes
require_once('Net/SMTP.php');


// define headers delimiter
define('SMTP_MIME_CRLF', "\r\n");

$SMTP_CONN = null;

/**
 * Function for sending mail using SMTP.
 *
 * @param string Sender e-Mail address
 *
 * @param mixed  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 mixed  The message headers to send with the mail
 *               Either as an associative array or a finally
 *               formatted string
 *
 * @param string The full text of the message body, including any Mime parts, etc.
 *
 * @return bool  Returns TRUE on success, or FALSE on error
 * @access public
 */
function smtp_mail($from, $recipients, $headers, $body)
  {
  global $SMTP_CONN, $CONFIG, $SMTP_ERROR;
  $smtp_timeout = null;
  $smtp_port = is_numeric($CONFIG['smtp_port']) ? $CONFIG['smtp_port'] : 25;
  
  // create Net_SMTP object and connect to server
  if (!is_object($smtp_conn))
    {
    $SMTP_CONN = new Net_SMTP($CONFIG['smtp_server'], $smtp_port, 'localhost');

    // set debugging
    if ($CONFIG['debug_level'] & 8)
      $SMTP_CONN->setDebug(TRUE);


    // try to connect to server and exit on failure
    if (PEAR::isError($SMTP_CONN->connect($smtp_timeout)))
      {
      $SMTP_CONN = null;
      $SMTP_ERROR .= "Connection failed\n";
      return FALSE;
      }


    // attempt to authenticate to the SMTP server
    if ($CONFIG['smtp_user'] && $CONFIG['smtp_pass'])
      {
      if (PEAR::isError($SMTP_CONN->auth($CONFIG['smtp_user'], $CONFIG['smtp_pass'])))
        {
        smtp_reset();
        $SMTP_ERROR .= "authentication failure\n";
        return FALSE;
        }
      }
    }


  // prepare message headers as string
  if (is_array($headers))
    {
    $headerElements = smtp_prepare_headers($headers);
    if (!$headerElements)
      {
      smtp_reset();
      return FALSE;
      }

    list($from, $text_headers) = $headerElements;
    }
  else if (is_string($headers))
    $text_headers = $headers;
  else
    {
    smtp_reset();
    $SMTP_ERROR .= "Invalid message headers\n";
    return FALSE;
    }

  // exit if no from address is given
  if (!isset($from))
    {
    smtp_reset();
    $SMTP_ERROR .= "No From address has been provided\n";
    return FALSE;
    }


  // set From: address
  if (PEAR::isError($SMTP_CONN->mailFrom($from)))
    {
    smtp_reset();
    $SMTP_ERROR .= "Failed to set sender '$from'\n";
    return FALSE;
    }


  // prepare list of recipients
  $recipients = smtp_parse_rfc822($recipients);
  if (PEAR::isError($recipients))
    {
    smtp_reset();
    return FALSE;
    }


  // set mail recipients
  foreach ($recipients as $recipient)
    {
    if (PEAR::isError($SMTP_CONN->rcptTo($recipient)))
      {
      smtp_reset();
      $SMTP_ERROR .= "Failed to add recipient '$recipient'\n";
      return FALSE;
      }
    }


  // Send the message's headers and the body as SMTP data.
  if (PEAR::isError($SMTP_CONN->data("$text_headers\r\n$body")))
    {
    smtp_reset();
    $SMTP_ERROR .= "Failed to send data\n";
    return FALSE;
    }


  return TRUE;
  }



/**
 * Reset the global SMTP connection
 * @access public
 */
function smtp_reset()
  {
  global $SMTP_CONN;

  if (is_object($SMTP_CONN))
    {
    $SMTP_CONN->rset();
    smtp_disconnect();
    }
  }



/**
 * Disconnect the global SMTP connection and destroy object
 * @access public
 */
function smtp_disconnect()
  {
  global $SMTP_CONN;

  if (is_object($SMTP_CONN))
    {
    $SMTP_CONN->disconnect();
    $SMTP_CONN = null;
    }
  }


/**
 * Take an array of mail headers and return a string containing
 * text usable in sending a message.
 *
 * @param array $headers The array of headers to prepare, 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'.
 *
 * @return mixed Returns false if it encounters a bad address,
 *               otherwise returns an array containing two
 *               elements: Any From: address found in the headers,
 *               and the plain text version of the headers.
 * @access private
 */
function smtp_prepare_headers($headers)
  {
  $lines = array();
  $from = null;

  foreach ($headers as $key => $value)
    {
    if (strcasecmp($key, 'From') === 0)
      {
      $addresses = smtp_parse_rfc822($value);

      if (is_array($addresses))
        $from = $addresses[0];

      // Reject envelope From: addresses with spaces.
      if (strstr($from, ' '))
        return FALSE;


      $lines[] = $key . ': ' . $value;
      }
    else if (strcasecmp($key, 'Received') === 0)
      {
      $received = array();
      if (is_array($value))
        {
        foreach ($value as $line)
          $received[] = $key . ': ' . $line;
        }
      else
        {
        $received[] = $key . ': ' . $value;
        }

      // Put Received: headers at the top.  Spam detectors often
      // flag messages with Received: headers after the Subject:
      // as spam.
      $lines = array_merge($received, $lines);
      }

    else
      {
      // If $value is an array (i.e., a list of addresses), convert
      // it to a comma-delimited string of its elements (addresses).
      if (is_array($value))
        $value = implode(', ', $value);

      $lines[] = $key . ': ' . $value;
      }
    }

  return array($from, join(SMTP_MIME_CRLF, $lines) . SMTP_MIME_CRLF);
  }



/**
 * Take a set of recipients and parse them, returning an array of
 * bare addresses (forward paths) that can be passed to sendmail
 * or an smtp server with the rcpt to: command.
 *
 * @param mixed Either a comma-seperated list of recipients
 *              (RFC822 compliant), or an array of recipients,
 *              each RFC822 valid.
 *
 * @return array An array of forward paths (bare addresses).
 * @access private
 */
function smtp_parse_rfc822($recipients)
  {
  // if we're passed an array, assume addresses are valid and implode them before parsing.
  if (is_array($recipients))
    $recipients = implode(', ', $recipients);
    
  $addresses = array();
  $recipients = smtp_explode_quoted_str(",", $recipients);
  
  reset($recipients);
  while (list($k, $recipient) = each($recipients))
    {
    $a = explode(" ", $recipient);
    while (list($k2, $word) = each($a))
      {
      if ((strpos($word, "@") > 0) && (strpos($word, "\"")===false))
        {
        $word = ereg_replace('^<|>$', '', trim($word));
        if (in_array($word, $addresses)===false)
          array_push($addresses, $word);
        }
      }
    }
  return $addresses;
  }


function smtp_explode_quoted_str($delimiter, $string)
  {
  $quotes=explode("\"", $string);
  while ( list($key, $val) = each($quotes))
    if (($key % 2) == 1) 
      $quotes[$key] = str_replace($delimiter, "_!@!_", $quotes[$key]);
    $string=implode("\"", $quotes);
	
    $result=explode($delimiter, $string);
    while (list($key, $val) = each($result))
      $result[$key] = str_replace("_!@!_", $delimiter, $result[$key]);

  return $result;
  }	


?>

 program/lib/Mail/mime.php

@@ -119,7 +119,7 @@
        $this->_build_params = array(
                                     'text_encoding' => '7bit',
                                     'html_encoding' => 'quoted-printable',
                                     'header_encoding' => 'quoted-printable',
                                     'head_encoding' => 'quoted-printable',
                                     '7bit_wrap'     => 998,
                                     'html_charset'  => 'ISO-8859-1',
                                     'text_charset'  => 'ISO-8859-1',

 program/lib/smtp.inc

File was deleted

 program/steps/mail/sendmail.inc

@@ -21,7 +21,8 @@
*/


require_once('lib/smtp.inc');
//require_once('lib/smtp.inc');
require_once('include/rcube_smtp.inc');
require_once('Mail/mime.php');


@@ -155,30 +156,28 @@
// send thru SMTP server using cusotm SMTP library
if ($CONFIG['smtp_server'])
  {
  // connect to SMTP server
  $smtp_conn = smtp_connect($CONFIG['smtp_server'], '25', $CONFIG['smtp_user'], $CONFIG['smtp_pass']);
	
  if ($smtp_conn)
    {
    // generate list of recipients
    $recipients = $mailto.', '.$headers['Cc'].', '.$headers['Bcc'];
    $a_recipients = smtp_expand($recipients);
  // generate list of recipients
  $a_recipients = array($mailto);

    // generate message headers
    $header_str = $MAIL_MIME->txtHeaders($headers);
	
    // send message
    $sent = smtp_mail($smtp_conn, $from, $a_recipients, $header_str."\r\n".$msg_body, FALSE);
    }
	
  if (strlen($headers['Cc']))
    $a_recipients[] = $headers['Cc'];
  if (strlen($headers['Bcc']))
    $a_recipients[] = $headers['Bcc'];

  // generate message headers
  $header_str = $MAIL_MIME->txtHeaders($headers);

  // send message
  $sent = smtp_mail($from, $a_recipients, $header_str, $msg_body);

  // log error
  if (!$smtp_conn || !$sent)
  if (!$sent)
    {
    raise_error(array('code' => 800,
                      'type' => 'smtp',
                      'line' => __LINE__,
                      'file' => __FILE__,
                      'message' => "Connection failed: $smtp_error"), TRUE, FALSE);
                      'message' => "SMTP error: $SMTP_ERROR"), TRUE, FALSE);
    }
  }