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

Class: Mail_sendmail

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

Class Overview

Mail
   |
   --Mail_sendmail

Sendmail implementation of the PEAR Mail:: interface.


Author(s):

Version:

  • $Revision$

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::parseRecipients()
Take a set of recipients and parse them, returning an array of bare addresses (forward paths) that can be passed to sendmail or an smtp server with the rcpt to: command.
Mail::prepareHeaders()
Take an array of mail headers and return a string containing text usable in sending a message.
Mail::send()
Implements Mail::send() function using php's built-in mail() command.
Mail::_sanitizeHeaders()
Sanitize an array of mail headers by removing any additional header strings present in a legitimate header's value. The goal of this filter is to prevent mail injection attacks.

Class Details

[line 25]
Sendmail implementation of the PEAR Mail:: interface.
  • Version: $Revision$
  • 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

__construct (Constructor)   [line 58]

Mail_sendmail __construct( 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 103]

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 Sun, 31 Jan 2016 22:00:02 +0000 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.