Mail
[ class tree: Mail ] [ index: Mail ] [ all elements ]
Packages:
Mail


Classes:
Mail
Mail_mail
Mail_null
Mail_RFC822
Mail_sendmail
Mail_smtp
Files:
Mail.php
mail.php
null.php
RFC822.php
sendmail.php
smtp.php

Class: Mail_sendmail

Source Location: /Mail-1.1.13/Mail/sendmail.php

Class Overview

Mail
   |
   --Mail_sendmail

Sendmail implementation of the PEAR Mail:: interface.


Author(s):

Version:

  • $Revision: 1.17 $

Variables

Methods

Inherited Variables

Class: Mail

Mail::$sep

Inherited Methods

Class: Mail

Mail::factory()
Provides an interface for generating Mail:: objects of various types
Mail::send()
Implements Mail::send() function using php's built-in mail() command.

Class Details

[line 25]
Sendmail implementation of the PEAR Mail:: interface.
  • Version: $Revision: 1.17 $
  • Access: public


[ Top ]

Class Variables

$sendmail_args =  '-i'

[line 39]

Any extra command-line parameters to pass to the sendmail or sendmail wrapper binary.

Type:   string


[ Top ]

$sendmail_path =  '/usr/sbin/sendmail'

[line 32]

The location of the sendmail or sendmail wrapper binary on the filesystem.

Type:   string


[ Top ]


Method Detail

Mail_sendmail (Constructor)   [line 59]

Mail_sendmail 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'.

sendmail_args Any extra parameters to pass to the sendmail or sendmail wrapper binary.

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

  • Access: public

Parameters:

array   $params   —   Hash containing any parameters different from the defaults.

[ Top ]

send   [line 105]

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

Implements Mail::send() function using the sendmail command-line binary.
  • Return: Returns true on success, or a PEAR_Error containing a descriptive error message on failure.
  • Access: public

Overrides Mail::send() (Implements Mail::send() function using php's built-in mail() command.)

Parameters:

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.

[ Top ]
Documentation generated on Fri, 15 Sep 2006 00:04:55 -0400 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.