Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/cch/www/pear/Mail/sendmail.php
PEAR Repository -

Mail_sendmail

PEAR
   |
  +-- Mail
     |
    +-- Mail_sendmail

Sendmail implementation of the PEAR Mail:: interface.

 

private class Mail_sendmail extends Mail

Sendmail implementation of the PEAR Mail:: interface.

AuthorsStig Bakken <ssb@fast.no>
SincePHP 4.0.2

 

Methods inherited from Mail

factory, prepareheaders, parserecipients

Methods inherited from PEAR

pear, _pear, iserror, pear_error, getmode, getcallback, getmessage, getcode, gettype, getdebuginfo, tostring, _pear_call_destructors

Public Method Summary

void

Mail_sendmail(array $params)

Constructor.
mixed

send(mixed $recipients, array $headers, string $body)

Implements Mail::send() function using the sendmail

Fields inherited from PEAR

$_debug, $error_message_prefix, $error_prepend, $error_append, $mode, $level, $code, $message, $debuginfo, $file, $line

Private Field Summary

string

$sendmail_path

The location of the sendmail binary on the filesystem.

Public Method Details

Mail_sendmail

public void Mail_sendmail( array $params )

  Constructor.

Instantiates a new Mail_sendmail:: object based on the parameters
passed in. It looks for the following parameters:
sendmail_path The location of the sendmail binary on the
filesystem. Defaults to '/usr/sbin/sendmail'.

If a parameter is present in the $params array, it replaces the
default.

Parameter
array $params
Hash containing any parameters different from the
defaults.
Returns void


send

public mixed send( mixed $recipients, array $headers, string $body )

  Implements Mail::send() function using the sendmail
command-line binary.

Parameter
mixed $recipients
Either a comma-seperated list of recipients
(RFC822 compliant), or an array of recipients,
each RFC822 valid. This may contain recipients not
specified in the headers, for Bcc:, resending
messages, etc.
array $headers
The array of headers to send with the mail, in an
associative array, where the array key is the
header name (ie, 'Subject'), and the array value
is the header value (ie, 'test'). The header
produced from those values would be 'Subject:
test'.
string $body
The full text of the message body, including any
Mime parts, etc.
Returns mixed

Returns true on success, or a PEAR_Error
containing a descriptive error message on
failure.


Private Field Details

$sendmail_path

private string $sendmail_path

>>'/usr/sbin/sendmail'<<



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta