Moodle PHP Documentation 5.1
Moodle 5.1dev (Build: 20250706) (a6b17d8f6bd)
core\test\message Interface Reference
Inheritance diagram for core\test\message:
core\test\mailpit_message

Public Member Functions

 get_bcc ()
 Get the message cc recipients.
 
 get_body_html ()
 Get the HTML representation of the body, if one was provided.
 
 get_body_text ()
 Get the text representation of the body, if one was provided.
 
 get_cc ()
 Get the message cc recipients.
 
 get_recipients ()
 Get the message recipients.
 
 get_sender ()
 Get the message sender.
 
 get_subject ()
 Get the message subject.
 
 has_recipient (string $email)
 Whether the message has the specified recipient.
 

Detailed Description

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

Member Function Documentation

◆ get_bcc()

core\test\message::get_bcc ( )

Get the message cc recipients.

Return values
iterable<message_user>

Implemented in core\test\mailpit_message.

◆ get_body_html()

core\test\message::get_body_html ( )

Get the HTML representation of the body, if one was provided.

Return values
null|string

Implemented in core\test\mailpit_message.

◆ get_body_text()

core\test\message::get_body_text ( )

Get the text representation of the body, if one was provided.

Return values
null|string

Implemented in core\test\mailpit_message.

◆ get_cc()

core\test\message::get_cc ( )

Get the message cc recipients.

Return values
iterable<message_user>

Implemented in core\test\mailpit_message.

◆ get_recipients()

core\test\message::get_recipients ( )

Get the message recipients.

Return values
iterable<message_user>

Implemented in core\test\mailpit_message.

◆ get_sender()

core\test\message::get_sender ( )

Get the message sender.

Return values
message_user

Implemented in core\test\mailpit_message.

◆ get_subject()

core\test\message::get_subject ( )

Get the message subject.

Return values
string

Implemented in core\test\mailpit_message.

◆ has_recipient()

core\test\message::has_recipient ( string $email)

Whether the message has the specified recipient.

Parameters
string$emailThe email address.
Return values
bool

Implemented in core\test\mailpit_message.


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