Source for file Deliver_SendMail.class.php

Documentation is available at Deliver_SendMail.class.php

  1. <?php
  2.  
  3. /**
  4.  * Deliver_SendMail.class.php
  5.  *
  6.  * Delivery backend for the Deliver class.
  7.  *
  8.  * @author Marc Groot Koerkamp
  9.  * @copyright 1999-2014 The SquirrelMail Project Team
  10.  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  11.  * @version $Id: Deliver_SendMail.class.php 14436 2014-01-21 21:30:59Z pdontthink $
  12.  * @package squirrelmail
  13.  */
  14.  
  15.  
  16. /** This of course depends upon Deliver */
  17. require_once(SM_PATH 'class/deliver/Deliver.class.php');
  18.  
  19. /**
  20.  * Delivers messages using the sendmail binary
  21.  * @package squirrelmail
  22.  */
  23. class Deliver_SendMail extends Deliver {
  24.     /**
  25.      * Extra sendmail arguments
  26.      *
  27.      * Parameter can be set in class constructor function.
  28.      *
  29.      * WARNING: Introduction of this parameter broke backwards compatibility
  30.      * with workarounds specific to qmail-inject.
  31.      *
  32.      * If parameter needs some security modifications, it should be set to
  33.      * private in PHP 5+ in order to prevent uncontrolled access.
  34.      * @var string 
  35.      * @since 1.5.1 and 1.4.8
  36.      */
  37.     var $sendmail_args = '-i -t';
  38.  
  39.     /**
  40.      * Stores used sendmail command
  41.      * Private variable that is used to inform about used sendmail command.
  42.      * @var string 
  43.      * @since 1.5.1 and 1.4.8
  44.      */
  45.     var $sendmail_command = '';
  46.  
  47.     /**
  48.      * Constructor function
  49.      * @param array configuration options. array key = option name,
  50.      *  array value = option value.
  51.      * @return void 
  52.      * @since 1.5.1 and 1.4.8
  53.      */
  54.     function Deliver_SendMail($params=array()) {
  55.         if (!empty($params&& is_array($params)) {
  56.             // set extra sendmail arguments
  57.             if (isset($params['sendmail_args'])) {
  58.                 $this->sendmail_args = $params['sendmail_args'];
  59.             }
  60.         }
  61.     }
  62.  
  63.    /**
  64.     * function preWriteToStream
  65.     *
  66.     * Sendmail needs LF's as line endings instead of CRLF.
  67.     * This function translates the line endings to LF and should be called
  68.     * before each line is written to the stream.
  69.     *
  70.     * @param string $s Line to process
  71.     * @return void 
  72.     * @access private
  73.     */
  74.     function preWriteToStream(&$s{
  75.        if ($s{
  76.            $s str_replace("\r\n""\n"$s);
  77.        }
  78.     }
  79.  
  80.    /**
  81.     * function initStream
  82.     *
  83.     * Initialise the sendmail connection.
  84.     *
  85.     * @param Message $message Message object containing the from address
  86.     * @param string $sendmail_path Location of sendmail binary
  87.     * @param mixed $ignore Eight extra arguments that the parent class
  88.     *                       requires which are not used here
  89.     * @return void 
  90.     * @access public
  91.     */
  92.     function initStream($message$sendmail_path$ignore=0$ignore=''$ignore=''$ignore=''$ignore=''$ignore=false$ignore=''$ignore=array()) {
  93.         $rfc822_header $message->rfc822_header;
  94.         $from $rfc822_header->from[0];
  95.         $envelopefrom trim($from->mailbox.'@'.$from->host);
  96.         $envelopefrom str_replace(array("\0","\n"),array('',''),$envelopefrom);
  97.         // save executed command for future reference
  98.         $this->sendmail_command = "$sendmail_path $this->sendmail_args -f$envelopefrom";
  99.         // open process handle for writing
  100.         $stream popen(escapeshellcmd($this->sendmail_command)"w");
  101.         return $stream;
  102.     }
  103.  
  104.    /**
  105.     * function finalizeStream
  106.     *
  107.     * Close the stream.
  108.     *
  109.     * @param resource $stream 
  110.     * @return boolean 
  111.     * @access public
  112.     */
  113.     function finalizeStream($stream{
  114.         $ret true;
  115.         $status pclose($stream);
  116.         // check pclose() status.
  117.         if ($status!=0{
  118.             $ret false;
  119.             $this->dlv_msg=_("Email delivery error");
  120.             $this->dlv_ret_nr=$status;
  121.             // we can get better error messsage only if we switch to php 4.3+ and proc_open().
  122.             $this->dlv_server_msg=sprintf(_("Can't execute command '%s'."),$this->sendmail_command);
  123.         }
  124.         return $ret;
  125.     }
  126.  
  127.    /**
  128.     * function getBcc
  129.     *
  130.     * In case of sendmail, the rfc822header must contain the bcc header.
  131.     *
  132.     * @return boolean true if rfc822header should include the bcc header.
  133.     * @access private
  134.     */
  135.     function getBcc({
  136.         return true;
  137.     }
  138.  
  139.    /**
  140.     * function clean_crlf
  141.     *
  142.     * Cleans each line to only end in a LF
  143.     * Returns the length of the line including a CR,
  144.     * so that length is correct when the message is saved to imap
  145.     * Implemented to fix sendmail->postfix rejection of messages with
  146.     * attachments because of stray LF's
  147.     *
  148.     * @param string $s string to strip of CR's
  149.     * @return integer length of string including a CR for each LF
  150.     * @access private
  151.     */
  152.     function clean_crlf(&$s{
  153.         $s str_replace("\r\n""\n"$s);
  154.         $s str_replace("\r""\n"$s);
  155.         $s2 str_replace("\n""\r\n"$s);
  156.         return strlen($s2);
  157.     }
  158.  
  159.  
  160. }

Documentation generated on Sat, 20 Dec 2014 04:20:44 +0100 by phpDocumentor 1.4.3