mail.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # Blue Static ISSO Framework [#]issoversion[#]
   5 || # Copyright ©2002-[#]year[#] Blue Static
   6 || #
   7 || # This program is free software; you can redistribute it and/or modify
   8 || # it under the terms of the GNU General Public License as published by
   9 || # the Free Software Foundation; version [#]gpl[#] of the License.
  10 || #
  11 || # This program is distributed in the hope that it will be useful, but
  12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  14 || # more details.
  15 || #
  16 || # You should have received a copy of the GNU General Public License along
  17 || # with this program; if not, write to the Free Software Foundation, Inc.,
  18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  19 || ###################################################################
  20 \*=====================================================================*/
  21
  22 /**
  23 * Mail Sender
  24 * mail.php
  25 *
  26 * @package      ISSO
  27 */
  28
  29 /**
  30 * Mail Sender
  31 *
  32 * This framework is a wrapper for the PHP mail function that properly
  33 * sends mail with full email headers.
  34 *
  35 * @author               Blue Static
  36 * @copyright    Copyright ©2002 - [#]year[#], Blue Static
  37 * @version              $Revision$
  38 * @package              ISSO
  39 *
  40 */
  41 class Mail
  42 {
  43         /**
  44         * Framework registry object
  45         * @var  object
  46         */
  47         private $registry = null;
  48
  49         /**
  50         * The message recipient's email address in the form of array(email => name)
  51         * @var  array
  52         */
  53         private $to = array();
  54
  55         /**
  56         * The subject of the message
  57         * @var  string
  58         */
  59         private $subject = '';
  60
  61         /**
  62         * Body plain-text of the message
  63         * @var  string
  64         */
  65         private $bodytext = '';
  66
  67         /**
  68         * HTML multi-part body of the message
  69         * @var  string
  70         */
  71         private $bodyhtml = '';
  72
  73         /**
  74         * The message sender's email address
  75         * @var  string
  76         */
  77         private $from = '';
  78
  79         /**
  80         * The message sender's display name
  81         * @var  string
  82         */
  83         private $fromname = '';
  84
  85         /**
  86         * Additional message headers
  87         * @var  string
  88         */
  89         private $headers = '';
  90
  91         /**
  92         * Whether to send the message as HTML or plain-text
  93         * @var  bool
  94         */
  95         private $sendhtml = false;
  96
  97         /**
  98         * The new line delimiter used in the message
  99         * @var  string
 100         */
 101         private $delim = "\n";
 102
 103         /**
 104         * Character set used to send messages with
 105         * @var  string
 106         */
 107         public $charset = 'utf-8'; // should we be using iso-8859-1 ?
 108
 109         /**
 110         * Fields array that is used in this module
 111         * @var  array
 112         */
 113         private $fields = array(
 114                 'subject'       => array(REQ_YES,       null,   false),
 115                 'bodytext'      => array(REQ_YES,       null,   false),
 116                 'bodyhtml'      => array(REQ_NO,        null,   false),
 117                 'from'          => array(REQ_YES,       null,   false),
 118                 'fromname'      => array(REQ_NO,        null,   false),
 119                 'headers'       => array(REQ_NO,        null,   false),
 120                 'sendhtml'      => array(REQ_NO,        null,   false),
 121                 'delim'         => array(REQ_YES,       null,   true),
 122                 'charset'       => array(REQ_YES,       null,   true)
 123         );
 124
 125         // ###################################################################
 126         /**
 127         * Constructor
 128         */
 129         function __construct(&$registry)
 130         {
 131                 $this->registry =& $registry;
 132         }
 133
 134         // ###################################################################
 135         /**
 136         * Sets an ISSO field
 137         *
 138         * @access       public
 139         *
 140         * @param        string  Field name
 141         * @param        mixed   Value of the field
 142         */
 143         function set($name, $value)
 144         {
 145                 if (empty($value) AND $this->fields["$name"][0] == REQ_YES)
 146                 {
 147                         trigger_error('Field ' . $name . ' cannot be empty', E_USER_ERROR);
 148                 }
 149
 150                 $this->registry->do_set($name, $value, 'mail');
 151         }
 152
 153         // ###################################################################
 154         /**
 155         * Gets an ISSO field
 156         *
 157         * @access       public
 158         *
 159         * @param        string  Field name
 160         *
 161         * @return       mixed   Value of the field
 162         */
 163         function get($fieldname)
 164         {
 165                 return $this->registry->do_get($fieldname, 'mail');
 166         }
 167
 168         // ###################################################################
 169         /**
 170         * Adds a to address
 171         *
 172         * @access       public
 173         *
 174         * @param        string  Name to send to
 175         * @param        string  Email address
 176         */
 177         function to_add($name, $address)
 178         {
 179                 if (isset($this->to["$address"]) AND $name !== null)
 180                 {
 181                         return;
 182                 }
 183
 184                 if ($this->registry->modules['functions']->is_valid_email($address))
 185                 {
 186                         $this->to["$address"] = $name;
 187                 }
 188         }
 189
 190         // ###################################################################
 191         /**
 192         * Removes a to address by email; if FALSE, it will clear the array
 193         *
 194         * @access       public
 195         *
 196         * @param        string  Email address to remove, or FALSE to clear array
 197         */
 198         function to_remove($address)
 199         {
 200                 if ($address === false)
 201                 {
 202                         $this->to = array();
 203                 }
 204                 else
 205                 {
 206                         unset($this->to["$address"]);
 207                 }
 208         }
 209
 210         // ###################################################################
 211         /**
 212         * Returns the list of "to" addresses
 213         *
 214         * @access       public
 215         *
 216         * @return       array   List of to-addresses
 217         */
 218         function to_fetch()
 219         {
 220                 return $this->to;
 221         }
 222
 223         // ###################################################################
 224         /**
 225         * Sends an email to the specified address with the specified
 226         * sender, subject, and body.
 227         *
 228         * @access       public
 229         *
 230         * @param        bool    Clear the "to" list after sending?
 231         *
 232         * @return       bool    Status of the message
 233         */
 234         function send($cleartos = false)
 235         {
 236                 // check the required stuff
 237                 $this->registry->check_isso_fields(get_class($this));
 238                 if (sizeof($this->to) < 1)
 239                 {
 240                         trigger_error('You need at least one email address to send to', E_USER_ERROR);
 241                         return false;
 242                 }
 243
 244                 // make sure we have a mailer
 245                 // #*# add support for SMTP
 246                 if (!@ini_get('sendmail_path'))
 247                 {
 248                         $this->registry->debug("email: no sendmail -> not sending");
 249                         return false;
 250                 }
 251
 252                 // sort out the to addresses
 253                 $tolist = array();
 254                 foreach ($this->to AS $address => $name)
 255                 {
 256                         $address = $this->_fetch_first_line($address);
 257                         $address = trim($this->registry->unsanitize($address));
 258                         $name = $this->_fetch_first_line($name);
 259                         $name = trim($this->registry->unsanitize($name));
 260
 261                         if ($name == null)
 262                         {
 263                                 $tolist[] = $address;
 264                         }
 265                         else
 266                         {
 267                                 $tolist[] = "\"$name\" <$address>";
 268                         }
 269                 }
 270
 271                 // sanitize the from field
 272                 $this->from = $this->_fetch_first_line($this->from);
 273                 $this->from = trim($this->registry->unsanitize($this->from));
 274
 275                 // sanitize the from name
 276                 $this->fromname = $this->_fetch_first_line($this->fromname);
 277                 $this->fromname = ($this->fromname == '' ? $this->from : trim($this->registry->unsanitize($this->fromname)));
 278
 279                 // sanitize the subject
 280                 $this->subject = $this->_fetch_first_line($this->subject);
 281                 $this->subject = trim($this->registry->unsanitize($this->subject));
 282
 283                 // sanitize the body
 284                 $this->bodytext = $this->registry->modules['functions']->convert_line_breaks($this->bodytext, $this->delim);
 285                 $this->bodytext = trim($this->registry->unsanitize($this->bodytext, true));
 286
 287                 // attach additional headers
 288                 $this->headers = $this->registry->modules['functions']->convert_line_breaks($this->headers, $this->delim);
 289                 $this->headers .= ((!preg_match("#{$this->delim}$#", $this->headers) AND $this->headers != '') ? "\n" : '') . "From: \"{$this->fromname}\" <{$this->from}>" . $this->delim;
 290                 $this->headers .= "Return-Path: {$this->from}" . $this->delim;
 291                 $this->headers .= "X-Mailer: ISSO Mail Framework \$Revision$" . $this->delim;
 292                 $this->headers .= "MIME-Version: 1.0" . $this->delim;
 293
 294                 // see if we need to use mime/multipart
 295                 if ($this->sendhtml AND $this->fields['bodyhtml'][2] == true)
 296                 {
 297                         $boundary = 'ISSO-MULTIPART-' . $this->registry->modules['functions']->rand(10);
 298                         $this->headers .= "Content-Type: multipart/alternative; boundary=\"$boundary\"" . $this->delim;
 299
 300                         $this->bodyhtml = $this->registry->modules['functions']->convert_line_breaks($this->bodyhtml, $this->delim);
 301
 302                         // first part of the message (plaintext)
 303                         $body = "--$boundary" . $this->delim;
 304                         $body .= "Content-Type: text/plain; charset=\"" . $this->charset . "\"" . $this->delim;
 305                         $body .= "Content-Transfer-Encoding: 8bit" . $this->delim . $this->delim;
 306                         $body .= $this->bodytext . $this->delim;
 307
 308                         // add some space between the parts
 309                         $body .= $this->delim . $this->delim . $this->delim;
 310
 311                         // second part (html)
 312                         $body .= "--$boundary" . $this->delim;
 313                         $body .= "Content-Type: text/html; charset=\"" . $this->charset . "\"" . $this->delim;
 314                         $body .= "Content-Transfer-Encoding: 8bit" . $this->delim;
 315                         $body .= "Content-Disposition: inline" . $this->delim . $this->delim;
 316                         $body .= $this->bodyhtml . $this->delim;
 317                         $body .= "--$boundary--";
 318                 }
 319                 else
 320                 {
 321                         $this->headers .= "Content-Type: text/plain; charset=\"" . $this->charset . "\"" . $this->delim;
 322                         $body = $this->bodytext;
 323                 }
 324                 $this->headers .= "Content-Transfer-Encoding: 8bit" . $this->delim;
 325
 326                 $this->headers = trim($this->headers);
 327
 328                 // attempt to send the mail!
 329                 foreach ($tolist AS $address)
 330                 {
 331                         if (mail($address, $this->subject, $body, $this->headers, "-f {$this->from}"))
 332                         {
 333                                 $this->registry->debug("email: sent to $address");
 334                         }
 335                         else
 336                         {
 337                                 $this->registry->debug("email: error sending to $address");
 338                         }
 339                 }
 340
 341                 if ($cleartos)
 342                 {
 343                         $this->to = array();
 344                 }
 345         }
 346
 347         // ###################################################################
 348         /**
 349         * Fetches the first line of a string
 350         *
 351         * @access       private
 352         *
 353         * @param        string  A string
 354         *
 355         * @return       string  The first line of the string
 356         */
 357         function _fetch_first_line($string)
 358         {
 359                 $string = $this->registry->modules['functions']->convert_line_breaks($string);
 360                 $broken = explode("\n", $string);
 361                 return $broken[0];
 362         }
 363 }
 364
 365 /*=====================================================================*\
 366 || ###################################################################
 367 || # $HeadURL$
 368 || # $Id$
 369 || ###################################################################
 370 \*=====================================================================*/
 371 ?>