]>
src.bluestatic.org Git - isso.git/blob - mail.php
2 /*=====================================================================*\
3 || ###################################################################
4 || # Blue Static ISSO Framework [#]issoversion[#]
5 || # Copyright ©2002-[#]year[#] Blue Static
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.
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
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 \*=====================================================================*/
32 * This framework is a wrapper for the PHP mail function that properly
33 * sends mail with full email headers.
36 * @copyright Copyright ©2002 - [#]year[#], Blue Static
44 * Framework registry object
47 private $registry = null;
50 * The message recipient's email address in the form of array(email => name)
53 private $to = array();
56 * The subject of the message
59 private $subject = '';
62 * Body plain-text of the message
65 private $bodytext = '';
68 * HTML multi-part body of the message
71 private $bodyhtml = '';
74 * The message sender's email address
80 * The message sender's display name
83 private $fromname = '';
86 * Additional message headers
89 private $headers = '';
92 * Whether to send the message as HTML or plain-text
95 private $sendhtml = false;
98 * The new line delimiter used in the message
101 private $delim = "\n";
104 * Character set used to send messages with
107 public $charset = 'utf-8'; // should we be using iso-8859-1 ?
110 * Fields array that is used in this module
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)
125 // ###################################################################
129 public function __construct(&$registry)
131 $this->registry
=& $registry;
134 // ###################################################################
138 * @param string Field name
139 * @param mixed Value of the field
141 public function set($name, $value)
143 if (empty($value) AND $this->fields
["$name"][0] == REQ_YES)
145 trigger_error('Field ' . $name . ' cannot be empty', E_USER_ERROR);
148 $this->registry->do_set($name, $value, 'mail');
151 // ###################################################################
155 * @param string Field name
157 * @return mixed Value of the field
159 public function get($fieldname)
161 return $this->registry->do_get($fieldname, 'mail');
164 // ###################################################################
168 * @param string Name to send to
169 * @param string Email address
171 public function to_add($name, $address)
173 if (isset($this->to["$address"]) AND $name !== null)
178 if ($this->registry
->modules
['functions']->is_valid_email($address))
180 $this->to
["$address"] = $name;
184 // ###################################################################
186 * Removes a to address by email; if FALSE, it will clear the array
188 * @param string Email address to remove, or FALSE to clear array
190 public function to_remove($address)
192 if ($address === false)
198 unset($this->to["$address"]);
202 // ###################################################################
204 * Returns the list of "to" addresses
206 * @return array List of to-addresses
208 public function to_fetch()
213 // ###################################################################
215 * Sends an email to the specified address with the specified
216 * sender, subject, and body.
218 * @param bool Clear the "to" list after sending?
220 * @return bool Status of the message
222 public function send($cleartos = false)
224 // check the required stuff
225 $this->registry
->check_isso_fields(get_class($this));
226 if (sizeof($this->to
) < 1)
228 trigger_error('You need at least one email address to send to', E_USER_ERROR
);
232 // make sure we have a mailer
233 // #*# add support for SMTP
234 if (!@ini_get('sendmail_path'))
236 $this->registry
->debug("email: no sendmail -> not sending");
240 // sort out the to addresses
242 foreach ($this->to
AS $address => $name)
244 $address = $this->_fetch_first_line($address);
245 $address = trim($this->registry
->unsanitize($address));
246 $name = $this->_fetch_first_line($name);
247 $name = trim($this->registry
->unsanitize($name));
251 $tolist[] = $address;
255 $tolist[] = "\"$name\" <$address>";
259 // sanitize the from field
260 $this->from
= $this->_fetch_first_line($this->from
);
261 $this->from
= trim($this->registry
->unsanitize($this->from
));
263 // sanitize the from name
264 $this->fromname
= $this->_fetch_first_line($this->fromname
);
265 $this->fromname
= ($this->fromname
== '' ? $this->from
: trim($this->registry
->unsanitize($this->fromname
)));
267 // sanitize the subject
268 $this->subject
= $this->_fetch_first_line($this->subject
);
269 $this->subject
= trim($this->registry
->unsanitize($this->subject
));
272 $this->bodytext
= $this->registry
->modules
['functions']->convert_line_breaks($this->bodytext
, $this->delim
);
273 $this->bodytext
= trim($this->registry
->unsanitize($this->bodytext
, true));
275 // attach additional headers
276 $this->headers
= $this->registry
->modules
['functions']->convert_line_breaks($this->headers
, $this->delim
);
277 $this->headers
.= ((!preg_match("#{$this->delim}$#", $this->headers
) AND $this->headers
!= '') ? "\n" : '') . "From: \"{$this->fromname}\" <{$this->from}>" . $this->delim
;
278 $this->headers
.= "Return-Path: {$this->from}" . $this->delim
;
279 $this->headers
.= "X-Mailer: ISSO Mail Framework \$Revision$" . $this->delim;
280 $this->headers .= "MIME
-Version
: 1.0" . $this->delim;
282 // see if we need to use mime/multipart
283 if ($this->sendhtml AND $this->fields['bodyhtml'][2] == true)
285 $boundary = 'ISSO-MULTIPART-' . $this->registry->modules['functions']->rand(10);
286 $this->headers .= "Content
-Type
: multipart
/alternative
; boundary
=\"$boundary\"" . $this->delim;
288 $this->bodyhtml = $this->registry->modules['functions']->convert_line_breaks($this->bodyhtml, $this->delim);
290 // first part of the message (plaintext)
291 $body = "--$boundary" . $this->delim
;
292 $body .= "Content-Type: text/plain; charset=\"" . $this->charset
. "\"" . $this->delim
;
293 $body .= "Content-Transfer-Encoding: 8bit" . $this->delim
. $this->delim
;
294 $body .= $this->bodytext
. $this->delim
;
296 // add some space between the parts
297 $body .= $this->delim
. $this->delim
. $this->delim
;
299 // second part (html)
300 $body .= "--$boundary" . $this->delim;
301 $body .= "Content
-Type
: text
/html
; charset
=\"" . $this->charset . "\"
" . $this->delim;
302 $body .= "Content
-Transfer
-Encoding
: 8bit
" . $this->delim;
303 $body .= "Content
-Disposition
: inline
" . $this->delim . $this->delim;
304 $body .= $this->bodyhtml . $this->delim;
305 $body .= "--$boundary--";
309 $this->headers
.= "Content-Type: text/plain; charset=\"" . $this->charset
. "\"" . $this->delim
;
310 $body = $this->bodytext
;
312 $this->headers
.= "Content-Transfer-Encoding: 8bit" . $this->delim
;
314 $this->headers
= trim($this->headers
);
316 // attempt to send the mail!
317 foreach ($tolist AS $address)
319 if (mail($address, $this->subject
, $body, $this->headers
, "-f {$this->from}"))
321 $this->registry
->debug("email: sent to $address");
325 $this->registry->debug("email
: error sending to
$address");
335 // ###################################################################
337 * Fetches the first line of a string
339 * @param string A string
341 * @return string The first line of the string
343 private function _fetch_first_line($string)
345 $string = $this->registry
->modules
['functions']->convert_line_breaks($string);
346 $broken = explode("\n", $string);
351 /*=====================================================================*\
352 || ###################################################################
355 || ###################################################################
356 \*=====================================================================*/