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

Class: Mail_mock

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

Class Overview


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



  • $Revision$



Inherited Variables

Class: Mail


Inherited Methods

Class: Mail

Provides an interface for generating Mail:: objects of various types
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.
Take an array of mail headers and return a string containing text usable in sending a message.
Implements Mail::send() function using php's built-in mail() command.
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 54]
Mock implementation of the PEAR Mail:: interface for testing.
  • Version: $Revision$
  • Access: public

[ Top ]

Class Variables

$sentMessages = array()

[line 61]

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

Type:   array

[ Top ]

$_postSendCallback =

[line 75]

Callback after sending mai.
  • Access: protected

Type:   callback

[ Top ]

$_preSendCallback =

[line 68]

Callback before sending mail.
  • Access: protected

Type:   callback

[ Top ]

Method Detail

__construct (Constructor)   [line 87]

Mail_mock __construct( array $params)


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


array   $params   —  Hash containing any parameters.

[ Top ]

send   [line 124]

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.)


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 Tue, 11 Apr 2017 18:00:03 +0000 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.