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

Class: Mail_mock

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

Class Overview

Mail
   |
   --Mail_mock

Mock implementation of the PEAR Mail:: interface for testing.


Author(s):

Version:

  • $Revision: 294747 $

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 52]
Mock implementation of the PEAR Mail:: interface for testing.
  • Version: $Revision: 294747 $
  • Access: public


[ Top ]


Class Variables

$sentMessages = array()

[line 60]

Array of messages that have been sent with the mock.
  • Access: public

Type:   array


[ Top ]



Method Detail

Mail_mock (Constructor)   [line 87]

Mail_mock Mail_mock( array $params)

Constructor.

Instantiates a new Mail_mock:: object based on the parameters passed in. It looks for the following parameters, both optional: preSendCallback Called before an email would be sent. postSendCallback Called after an email would have been sent.

  • Access: public

Parameters:

array   $params     Hash containing any parameters.

[ Top ]

send   [line 125]

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

Implements Mail_mock::send() function. Silently discards all mail.
  • 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.