extlib/Mail/null.php

   1 <?php
   2 //
   3 // +----------------------------------------------------------------------+
   4 // | PHP Version 4                                                        |
   5 // +----------------------------------------------------------------------+
   6 // | Copyright (c) 1997-2003 The PHP Group                                |
   7 // +----------------------------------------------------------------------+
   8 // | This source file is subject to version 2.02 of the PHP license,      |
   9 // | that is bundled with this package in the file LICENSE, and is        |
  10 // | available at through the world-wide-web at                           |
  11 // | http://www.php.net/license/2_02.txt.                                 |
  12 // | If you did not receive a copy of the PHP license and are unable to   |
  13 // | obtain it through the world-wide-web, please send a note to          |
  14 // | license@php.net so we can mail you a copy immediately.               |
  15 // +----------------------------------------------------------------------+
  16 // | Author: Phil Kernick <philk@rotfl.com.au>                            |
  17 // +----------------------------------------------------------------------+
  18 //
  19 // $Id: null.php,v 1.2 2004/04/06 05:19:03 jon Exp $
  20 //
  21
  22 /**
  23  * Null implementation of the PEAR Mail:: interface.
  24  * @access public
  25  * @package Mail
  26  * @version $Revision: 1.2 $
  27  */
  28 class Mail_null extends Mail {
  29
  30     /**
  31      * Implements Mail_null::send() function. Silently discards all
  32      * mail.
  33      *
  34      * @param mixed $recipients Either a comma-seperated list of recipients
  35      *              (RFC822 compliant), or an array of recipients,
  36      *              each RFC822 valid. This may contain recipients not
  37      *              specified in the headers, for Bcc:, resending
  38      *              messages, etc.
  39      *
  40      * @param array $headers The array of headers to send with the mail, in an
  41      *              associative array, where the array key is the
  42      *              header name (ie, 'Subject'), and the array value
  43      *              is the header value (ie, 'test'). The header
  44      *              produced from those values would be 'Subject:
  45      *              test'.
  46      *
  47      * @param string $body The full text of the message body, including any
  48      *               Mime parts, etc.
  49      *
  50      * @return mixed Returns true on success, or a PEAR_Error
  51      *               containing a descriptive error message on
  52      *               failure.
  53      * @access public
  54      */
  55     function send($recipients, $headers, $body)
  56     {
  57         return true;
  58     }
  59
  60 }