core\test\mailpit_email_catcher Class Reference

Mailpit email handling class. More...

Inheritance diagram for core\test\mailpit_email_catcher:

Public Member Functions
	__construct (string $baseuri)
	Constructor.
	delete_all ()
	Delete all messages from the mailpit server.
	get_message_data (string $id)
	Get the message summary for a specific message.
	get_messages (bool $showdetails=false)
	Get a list of messages from the mailpit server.
	reset_after_test ()
	Reset the mailpit server after a test.
	search (string $query)
	Search for a message in the mailpit server.

Protected Attributes
http_client http_client	$httpclient
	The http client object.

Detailed Description

Mailpit email handling class.

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

__construct()

core\test\mailpit_email_catcher::__construct

(

string

$baseuri

)

Constructor.

Parameters

string

$baseuri

The base uri for the mailpit server.

Member Function Documentation

delete_all()

core\test\mailpit_email_catcher::delete_all

(

)

Delete all messages from the mailpit server.

Implements core\test\email_catcher.

get_message_data()

core\test\mailpit_email_catcher::get_message_data

(

string

$id

)

Get the message summary for a specific message.

Parameters

string

$id

The message id.

Return values

stdClass

get_messages()

core\test\mailpit_email_catcher::get_messages

(

bool

$showdetails = false

)

Get a list of messages from the mailpit server.

Parameters

bool

$showdetails

Optional. Whether to include detailed information in the messages. Default is false.

Return values

iterable

Implements core\test\email_catcher.

search()

core\test\mailpit_email_catcher::search

(

string

$query

)

Search for a message in the mailpit server.

Parameters

string

$query

The search query.

Return values

mixed

Implements core\test\email_catcher.

---

The documentation for this class was generated from the following file:

• lib/classes/test/mailpit_email_catcher.php