Moodle PHP Documentation 4.4
Moodle 4.4.9+ (Build: 20250711) (4ea86454947)
core\test\email_catcher Interface Reference
Inheritance diagram for core\test\email_catcher:
core\test\mailpit_email_catcher

Public Member Functions

 delete_all ()
 Delete all messages from the mailpit server.
 
 get_messages (bool $showdetails=false)
 Get a list of messages from the mailpit server.
 
 search (string $query)
 Search for a message in the mailpit server.
 

Detailed Description

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

Member Function Documentation

◆ delete_all()

core\test\email_catcher::delete_all ( )

Delete all messages from the mailpit server.

Implemented in core\test\mailpit_email_catcher.

◆ get_messages()

core\test\email_catcher::get_messages ( bool $showdetails = false)

Get a list of messages from the mailpit server.

Parameters
bool$showdetailsOptional. Whether to include detailed information in the messages. Default is false.
Return values
iterable<message>

Implemented in core\test\mailpit_email_catcher.

◆ search()

core\test\email_catcher::search ( string $query)

Search for a message in the mailpit server.

Parameters
string$queryThe search query.
Return values
iterable

Implemented in core\test\mailpit_email_catcher.


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