mail.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # Iris Studios Shared Object Framework [#]version[#]
   5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
   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               Iris Studios, Inc.
  36 * @copyright    Copyright ©2002 - [#]year[#], Iris Studios, Inc.
  37 * @version              $Revision$
  38 * @package              ISSO
  39 *
  40 */
  41 class Mail
  42 {
  43         /**
  44         * Framework registry object
  45         * @var  object
  46         * @access       private
  47         */
  48         var $registry = null;
  49
  50         /**
  51         * The message recipient's email address in the form of array(email => name)
  52         * @var  array
  53         * @access       private
  54         */
  55         var $to = array();
  56
  57         /**
  58         * The subject of the message
  59         * @var  string
  60         * @access       private
  61         */
  62         var $subject = '';
  63
  64         /**
  65         * Body plain-text of the message
  66         * @var  string
  67         * @access       private
  68         */
  69         var $bodytext = '';
  70
  71         /**
  72         * HTML multi-part body of the message
  73         * @var  string
  74         * @access       private
  75         */
  76         var $bodyhtml = '';
  77
  78         /**
  79         * The message sender's email address
  80         * @var  string
  81         * @access       private
  82         */
  83         var $from = '';
  84
  85         /**
  86         * The message sender's display name
  87         * @var  string
  88         * @access       private
  89         */
  90         var $fromname = '';
  91
  92         /**
  93         * Additional message headers
  94         * @var  string
  95         * @access       private
  96         */
  97         var $headers = '';
  98
  99         /**
 100         * Whether to send the message as HTML or plain-text
 101         * @var  bool
 102         * @access       private
 103         */
 104         var $sendhtml = false;
 105
 106         /**
 107         * Fields array that is used in this module
 108         * @var  array
 109         * @access       private
 110         */
 111         var $fields = array(
 112                 'subject'       => array(REQ_YES,       null,   false),
 113                 'bodytext'      => array(REQ_YES,       null,   false),
 114                 'bodyhtml'      => array(REQ_NO,        null,   false),
 115                 'from'          => array(REQ_YES,       null,   false),
 116                 'fromname'      => array(REQ_NO,        null,   false),
 117                 'headers'       => array(REQ_NO,        null,   false),
 118                 'sendhtml'      => array(REQ_NO,        null,   false)
 119         );
 120
 121         // ###################################################################
 122         /**
 123         * Constructor
 124         */
 125         function __construct(&$registry)
 126         {
 127                 $this->registry =& $registry;
 128         }
 129
 130         // ###################################################################
 131         /**
 132         * (PHP 4) Constructor
 133         */
 134         function Mail(&$registry)
 135         {
 136                 $this->__construct($registry);
 137         }
 138
 139         // ###################################################################
 140         /**
 141         * Sets an ISSO field
 142         *
 143         * @access       public
 144         *
 145         * @param        string  Field name
 146         * @param        mixed   Value of the field
 147         */
 148         function set($name, $value)
 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         * @return       bool    Status of the message
 231         */
 232         function send()
 233         {
 234                 $this->registry->check_isso_fields(get_class($this));
 235
 236                 if (!@ini_get('sendmail_path'))
 237                 {
 238                         $this->registry->debug("email: no sendmail -> not sending");
 239                         return false;
 240                 }
 241
 242                 $this->to = $this->_fetch_first_line($this->to);
 243                 $this->from = $this->_fetch_first_line($this->from);
 244
 245                 if (!$this->from)
 246                 {
 247                         $this->registry->debug("email: no from -> not sending");
 248                         return false;
 249                 }
 250                 else
 251                 {
 252                         $this->from = trim($this->registry->unsanitize($this->from));
 253                 }
 254
 255                 if (!$this->fromname)
 256                 {
 257                         $this->fromname = $this->from;
 258                 }
 259                 else
 260                 {
 261                         $this->fromname = trim($this->registry->unsanitize($this->fromname));
 262                 }
 263
 264                 if (!$this->to)
 265                 {
 266                         $this->registry->debug("email: no recipient -> not sending");
 267                         return false;
 268                 }
 269                 else
 270                 {
 271                         $this->to = trim($this->registry->unsanitize($this->to));
 272                 }
 273
 274                 if (!$this->subject)
 275                 {
 276                         $this->registry->debug("email: no subject -> not sending");
 277                         return false;
 278                 }
 279                 else
 280                 {
 281                         $this->subject = trim($this->registry->unsanitize($this->_fetch_first_line($this->subject)));
 282                 }
 283
 284                 if (!$this->body)
 285                 {
 286                         $this->registry->debug("email: no body -> not sending");
 287                         return false;
 288                 }
 289                 else
 290                 {
 291                         $this->body = $this->registry->modules['functions']->convert_line_breaks($this->body);
 292                         $this->body = trim($this->registry->unsanitize($this->body, true));
 293                 }
 294
 295                 $this->headers = $this->registry->modules['functions']->convert_line_breaks($this->headers);
 296                 $this->headers .= "From: \"{$this->fromname}\" <{$this->from}>\n";
 297                 $this->headers .= "Return-Path: {$this->from}\n";
 298                 $this->headers .= "X-Mailer: ISSO Mail Framework \$Revision$\n";
 299                 $this->headers .= "Content-Type: text/plain; charset=\"iso-8859-1\"\n";
 300                 $this->headers .= "Content-Transfer-Encoding: 7bit\n";
 301
 302                 if (mail($this->to, $this->subject, $this->body, trim($this->headers), "-f {$this->from}"))
 303                 {
 304                         $this->registry->debug("email: sent -> good");
 305                         return true;
 306                 }
 307                 else
 308                 {
 309                         $this->registry->debug("email: sent -> error");
 310                         return false;
 311                 }
 312         }
 313
 314         // ###################################################################
 315         /**
 316         * Fetches the first line of a string
 317         *
 318         * @access       private
 319         *
 320         * @param        string  A string
 321         *
 322         * @return       string  The first line of the string
 323         */
 324         function _fetch_first_line($string)
 325         {
 326                 $string = $this->registry->modules['functions']->convert_line_breaks($string);
 327                 $broken = explode("\n", $string);
 328                 return $broken[0];
 329         }
 330 }
 331
 332 /*=====================================================================*\
 333 || ###################################################################
 334 || # $HeadURL$
 335 || # $Id$
 336 || ###################################################################
 337 \*=====================================================================*/
 338 ?>