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

Class: Mail_mail

Source Location: /Mail-1.2.0/Mail/mail.php

Class Overview

Mail
   |
   --Mail_mail

internal PHP-mail() implementation of the PEAR Mail:: interface.


Author(s):

Version:

  • $Revision: 294747 $

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 51]
internal PHP-mail() implementation of the PEAR Mail:: interface.
  • Version: $Revision: 294747 $


[ Top ]


Method Detail

Mail_mail (Constructor)   [line 67]

Mail_mail Mail_mail( [array $params = null])

Constructor.

Instantiates a new Mail_mail:: object based on the parameters passed in.


Parameters:

array   $params     Extra arguments for the mail() function.

[ Top ]

send   [line 115]

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

Implements Mail_mail::send() function using php's built-in mail() command.
  • 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 Mon, 01 Mar 2010 13:00:02 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.