classes/email.php-class

   1 <?php
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  *
   4  * The contents of this file are subject to Austrian copyright reegulations
   5  * ("Urheberrecht"); you may not use this file except in compliance with
   6  * those laws.
   7  * This contents and any derived work, if it gets distributed in any way,
   8  * is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND,
   9  * either express or implied.
  10  *
  11  * The Original Code is KaiRo's E-Mail module.
  12  *
  13  * The Initial Developer of the Original Code is
  14  * KaiRo - Robert Kaiser.
  15  * Portions created by the Initial Developer are Copyright (C) 2003-2006
  16  * the Initial Developer. All Rights Reserved.
  17  *
  18  * Contributor(s): Robert Kaiser <kairo@kairo.at>
  19  *
  20  * ***** END LICENSE BLOCK ***** */
  21
  22 class email {
  23   // email PHP class
  24   // class/object for creating a new mail and send it
  25   //
  26   // function __construct()
  27   //   CONSTRUCTOR
  28   //
  29   // private $debug_toSingleAddress
  30   //   address to send mail to in debug mode
  31   //
  32   // private $subject
  33   //   the mail's subject line
  34   //
  35   // private $sender
  36   //   the mail's sender (array; fields see recipients)
  37   //
  38   // private $replyto
  39   //   Reply-to address (array; fields see recipients)
  40   //
  41   // private $recipients
  42   //   array of recipients (To: line)
  43   //   fields: name - real name
  44   //           mail - email address
  45   //
  46   // private $cc
  47   //   array of CC recipients (fields like recipients)
  48   //
  49   // private $bcc
  50   //   array of BCC recipients (fields like recipients)
  51   //
  52   // private $headers
  53   //   array containing all additional headers
  54   //   fields: name - headers name
  55   //           content - header content
  56   //
  57   // private $content_type
  58   //   the mail's content type (MIME-type) [default: text/plain]
  59   //
  60   // private $charset
  61   //   the mail's charset [default: iso-8859-15]
  62   //
  63   // private $mailtext
  64   //   the main mail body
  65   //
  66   // private $attachments
  67   //   array containing all attachments
  68   //   fields: name - attachment name
  69   //           content - attachment content
  70   //           type - MIME type of that attachment
  71   //
  72   // public function setDebugAddress($debug_email)
  73   //   debug mode: send only to this address
  74   //
  75   // public function setSubject($newsubject)
  76   //   set subject of mail
  77   //
  78   // public function setSender($email, [$name])
  79   //   set sender of mail
  80   //
  81   // public function setReplyTo($email, [$name])
  82   //   set reply-to address
  83   //
  84   // public function addRecipient($email, [$name])
  85   //   add a recipient to the mail
  86   //
  87   // public function addCC($email, [$name])
  88   //   add a CC recipient to the mail
  89   //
  90   // public function addBCC($email, [$name])
  91   //   add a BCC recipient to the mail
  92   //
  93   // public function addHeader($hname, [$hcontent])
  94   //   add a header to the mail
  95   //
  96   // public function addHeaderAddress($hname, $email, [$name])
  97   //   add an address header to the mail, possibly with both name and mail parts
  98   //
  99   // public function setCharset($newcharset)
 100   //   set charset for this mail
 101   //
 102   // public function addMailText($textpart)
 103   //   add some text to the mail
 104   //
 105   // public function addAttachment($aname, $acontent, [$atype])
 106   //   add an attachment to the mail, use given file name, content and MIME type (defaults to application/octet-stream)
 107   //
 108   // public function getAddresses([$addrtype])
 109   //   returns an array of all addresses this mail gets sent to
 110   //     fields: email, name, addrtype
 111   //       addrtype is one of to/cc/bcc
 112   //       the $addrtype parameter is a comma-separated list of such types, default: all of them
 113   //
 114   // public function send()
 115   //   really send the mail
 116   //
 117   // private function mimeencode($fieldtext, [$stringescape])
 118   //   helper function:
 119   //     encode given field text, ready to be placed into an e-mail MIME header
 120   //     if the boolean $stringescape is true, make sure this is sent as a single word in RFC2822 context (e.g. for names)
 121   //     see http://www.ietf.org/rfc/rfc2822.txt for the RFC in question
 122
 123   private $debug_toSingleAddress = '';
 124   private $subject;
 125   private $sender = array();
 126   private $replyto = array();
 127   private $recipients = array();
 128   private $cc = array();
 129   private $bcc = array();
 130   private $headers = array();
 131   private $content_type = 'text/plain';
 132   private $charset = 'iso-8859-15';
 133   private $mailtext = '';
 134   private $attachments = array();
 135
 136   function __construct() {
 137     // *** constructor ***
 138   }
 139
 140   public function setDebugAddress($debug_email) { $this->debug_toSingleAddress = $debug_email; }
 141
 142   public function setSubject($newsubject) { $this->subject = $newsubject; }
 143
 144   public function setSender($email, $name = '') { $this->sender = array('mail' => $email, 'name' => $name); }
 145
 146   public function setReplyTo($email, $name = '') { $this->replyto = array('mail' => $email, 'name' => $name); }
 147
 148   public function addRecipient($email, $name = '') {
 149     $this->recipients[] = array('mail' => $email, 'name' => $name);
 150   }
 151
 152   public function addCC($email, $name = '') {
 153     $this->cc[] = array('mail' => $email, 'name' => $name);
 154   }
 155
 156   public function addBCC($email, $name = '') {
 157     $this->bcc[] = array('mail' => $email, 'name' => $name);
 158   }
 159
 160   public function addHeader($hname, $hcontent = '') {
 161     $this->headers[] = array('name' => $hname, 'content' => $hcontent);
 162   }
 163
 164   public function addHeaderAddress($hname, $email, $name = '') {
 165     if (strlen($name)) { $hcontent = $this->mimeencode($name, true).' <'.$email.'>'; }
 166     else { $hcontent = $email; }
 167     $this->headers[] = array('name' => $hname, 'content' => $hcontent);
 168   }
 169
 170   public function setCharset($newcharset) { $this->charset = $newcharset; }
 171
 172   public function addMailText($textpart) { $this->mailtext .= $textpart; }
 173
 174   public function addAttachment($aname, $acontent, $atype = 'application/octet-stream') {
 175     $this->attachments[] = array('name' => $aname, 'content' => $acontent, 'type' => $atype);
 176   }
 177
 178   public function getAddresses($addrtype = null) {
 179     // returns all addresses this mail gets sent to
 180     if (!is_array($addrtype)) {
 181       if (strlen($addrtype)) { $addrtype = explode(',', strtolower($addrtype)); }
 182       else { $addrtype = array('to','cc','bcc'); }
 183     }
 184     $mailaddresses = array();
 185
 186     if (in_array('to', $addrtype)) {
 187       foreach ($this->recipients as $address) {
 188         if (strlen(@$address['mail'])) {
 189           $mailaddresses[] = array('mail'=>$address['mail'],
 190                                    'name'=>strlen($address['name'])?$address['name']:'',
 191                                    'addrtype'=>'to');
 192         }
 193       }
 194     }
 195     if (in_array('cc', $addrtype)) {
 196       foreach ($this->cc as $address) {
 197         if (strlen(@$address['mail'])) {
 198           $mailaddresses[] = array('mail'=>$address['mail'],
 199                                    'name'=>strlen($address['name'])?$address['name']:'',
 200                                    'addrtype'=>'cc');
 201         }
 202       }
 203     }
 204     if (in_array('bcc', $addrtype)) {
 205       foreach ($this->bcc as $address) {
 206         if (strlen(@$address['mail'])) {
 207           $mailaddresses[] = array('mail'=>$address['mail'],
 208                                    'name'=>strlen($address['name'])?$address['name']:'',
 209                                    'addrtype'=>'bcc');
 210         }
 211       }
 212     }
 213
 214     return $mailaddresses;
 215   }
 216
 217   public function send() {
 218     global $util;
 219     $mtxt = '';
 220     $hdrs = 'MIME-Version: 1.0'."\n";
 221     $subj = $this->mimeencode($this->subject);
 222     if (strlen($this->sender['name'])) {
 223       $hdrs .= 'From: '.$this->mimeencode($this->sender['name'], true).' <'.$this->sender['mail'].'>'."\n";
 224     }
 225     else { $hdrs .= 'From: '.$this->sender['mail']."\n"; }
 226     if (count($this->replyto)) {
 227       if (strlen($this->replyto['name'])) {
 228         $hdrs .= 'Reply-to: '.$this->mimeencode($this->replyto['name'], true).' <'.$this->replyto['mail'].'>'."\n";
 229       }
 230       else { $hdrs .= 'Reply-to: '.$this->replyto['mail']."\n"; }
 231     }
 232     if (count($this->recipients)) {
 233       $recpt = '';
 234       foreach ($this->recipients as $address) {
 235         if (strlen(@$address['mail'])) {
 236           if (strlen($address['name'])) { $recpt .= $this->mimeencode($address['name'], true).' <'.$address['mail'].'>,'; }
 237           else { $recpt .= $address['mail'].','; }
 238         }
 239       }
 240       $recpt = preg_replace('/,$/', '', $recpt);
 241     }
 242     if (!strlen($recpt)) {
 243       return null;
 244     }
 245     if (count($this->cc)) {
 246       $adrs = '';
 247       foreach ($this->cc as $address) {
 248         if (strlen($address['name'])) { $adrs .= $this->mimeencode($address['name'], true).' <'.$address['mail'].'>,'; }
 249         else { $adrs .= $address['mail'].','; }
 250       }
 251       $adrs = preg_replace('/,$/', '', $adrs);
 252       $hdrs .= (strlen($this->debug_toSingleAddress)?'X-Real-':'').'Cc: '.$adrs."\n";
 253     }
 254     if (count($this->bcc)) {
 255       $adrs = '';
 256       foreach ($this->bcc as $address) {
 257         if (strlen($address['name'])) { $adrs .= $this->mimeencode($address['name'], true).' <'.$address['mail'].'>,'; }
 258         else { $adrs .= $address['mail'].','; }
 259       }
 260       $adrs = preg_replace('/,$/', '', $adrs);
 261       $hdrs .= (strlen($this->debug_toSingleAddress)?'X-Real-':'').'Bcc: '.$adrs."\n";
 262     }
 263     if (count($this->headers)) {
 264       foreach ($this->headers as $header) {
 265         $hdrs .= $header['name'].': '.$header['content']."\n";
 266       }
 267     }
 268     if (count($this->attachments)) {
 269       // create random boundary, 20 chars, always beginning with KaiRo ;-)
 270       $boundary = 'KaiRo';
 271       for ($i = 1; $i <= 15; $i++)      {
 272         $r = rand(0, 61);
 273         if ($r < 10) { $boundary .= chr($r + 48); }
 274         elseif ($r < 36) { $boundary .= chr($r + 55); }
 275         elseif ($r < 62) { $boundary .= chr($r + 61); }
 276       }
 277       $hdrs .= 'Content-Type: multipart/mixed; boundary="'.$boundary.'";'."\n";
 278       $hdrs .= 'Content-Transfer-Encoding: 7bit'."\n";
 279       $mtxt .= 'This part of the E-mail should never be seen. If'."\n";
 280       $mtxt .= 'you are reading this, consider upgrading your e-mail'."\n";
 281       $mtxt .= 'client to a MIME-compatible client.'."\n";
 282       $mtxt .= "\n".'--'.$boundary."\n";
 283       if (preg_match('|^text/|', $this->content_type)) {
 284         $mtxt .= 'Content-Type: '.$this->content_type.'; charset="'.$this->charset.'"'."\n";
 285       }
 286       else {
 287         $mtxt .= 'Content-Type: '.$this->content_type."\n";
 288       }
 289       $mtxt .= 'Content-Transfer-Encoding: 8bit'."\n\n";
 290     }
 291     else {
 292       if (preg_match('|^text/|', $this->content_type)) {
 293         $hdrs .= 'Content-Type: '.$this->content_type.'; charset="'.$this->charset.'"'."\n";
 294       }
 295       else {
 296         $hdrs .= 'Content-Type: '.$this->content_type."\n";
 297       }
 298       $hdrs .= 'Content-Transfer-Encoding: 8bit'."\n";
 299     }
 300     $mtxt .= stripslashes($this->mailtext);
 301     if (count($this->attachments)) {
 302       foreach ($this->attachments as $attach) {
 303         $mtxt .= "\n".'--'.$boundary."\n";
 304         $mtxt .= 'Content-Type: '.$attach['type'].'; name="'.$attach['name'].'";'."\n";
 305         if (preg_match('/^(text|message)\//', $attach['type'])) {
 306           $mtxt .= 'Content-Transfer-Encoding: 8bit'."\n";
 307           $mtxt .= 'Content-Disposition: attachment'."\n\n";
 308           $mtxt .= $attach['content'];
 309           $mtxt .= "\n";
 310         }
 311         else {
 312           $mtxt .= 'Content-Transfer-Encoding: base64'."\n";
 313           $mtxt .= 'Content-Disposition: attachment'."\n\n";
 314           $mtxt .= rtrim(chunk_split(base64_encode($attach['content']), 76)); ;
 315           $mtxt .= "\n";
 316         }
 317       }
 318       $mtxt .= '--'.$boundary.'--'."\n";
 319     }
 320
 321     if (strlen($this->debug_toSingleAddress)) {
 322       $hdrs .= 'X-Real-To: '.$recpt."\n";
 323       $recpt = $this->debug_toSingleAddress;
 324     }
 325
 326     //print('Subject: '.$util->htmlify($subj).'<br>'."\n");
 327     //print('To: '.$util->htmlify($recpt).'<br>'."\n");
 328     //print(nl2br($util->htmlify($hdrs)));
 329     //print(nl2br($util->htmlify($mtxt)));
 330     return mail($recpt, $subj, $mtxt, $hdrs);
 331   }
 332
 333   private function mimeencode($fieldtext, $stringescape = false) {
 334     $mText = imap_8bit($fieldtext);
 335     $is_qpformat = ($mText != $fieldtext);
 336     if ($stringescape && preg_match('/[^\w !#$%&\'*+\/=?^`{|}~-]/', $mText)) {
 337       // if needed, make this a quoted-string instead of an atom (to speak in RFC2822 language)
 338       $mText = '"'.strtr($mText, array('"' => '\"', '\\' => '\\\\')).'"';
 339     }
 340     if ($is_qpformat) {
 341       $mText = strtr($mText, array('_' => '=5F', ' ' => '_', '?' => '=3F'));
 342       $mText = '=?'.strtoupper($this->charset).'?Q?'.$mText.'?=';
 343     }
 344   return $mText;
 345   }
 346 }
 347 ?>