Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
tool_messageinbound\message\inbound\invalid_recipient_handler Class Reference

A Handler to re-process messages which previously failed sender verification. More...

Inheritance diagram for tool_messageinbound\message\inbound\invalid_recipient_handler:
core\message\inbound\handler

Public Member Functions

 __get ($key)
 Magic getter to fetch the specified key.
 
 can_change_defaultexpiration ()
 Whether the current handler allows changes to expiry of the generated email address.
 
 can_change_enabled ()
 Whether this handler can be disabled (or enabled).
 
 can_change_validateaddress ()
 Do not allow changes to the address validation setting.
 
 get_description ()
 Return a description for the current handler.
 
 get_name ()
 Return a name for the current handler.
 
 get_success_message (\stdClass $messagedata, $handlerresult)
 Return the content of any success notification to be sent.
 
 process_message (\stdClass $record, stdClass $data)
 Process a message received and validated by the Inbound Message processor.
 
 set_component ($component)
 Set the component name.
 
 set_defaultexpiration ($period)
 Set the default validity for new keys.
 
 set_enabled ($enabled)
 Set the enabled name.
 
 set_id ($id)
 Set the id name.
 
 set_validateaddress ($validateaddress)
 Set whether validation of the address is required.
 

Static Protected Member Functions

static remove_quoted_text ($messagedata)
 Remove quoted message string from the text (NOT HTML) message.
 

Detailed Description

A Handler to re-process messages which previously failed sender verification.

This may happen if the user did not use their registerd e-mail address, the verification hash used had expired, or if some erroneous content was introduced into the content hash.

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

Member Function Documentation

◆ __get()

core\message\inbound\handler::__get ( $key)
inherited

Magic getter to fetch the specified key.

Parameters
string$keyThe name of the key to retrieve

◆ can_change_defaultexpiration()

core\message\inbound\handler::can_change_defaultexpiration ( )
inherited

Whether the current handler allows changes to expiry of the generated email address.

By default this will return true, but for some handlers it may be necessary to disallow such changes.

Return values
boolean

Reimplemented in core\message\inbound\private_files_handler.

◆ can_change_enabled()

core\message\inbound\handler::can_change_enabled ( )
inherited

Whether this handler can be disabled (or enabled).

By default this will return true, but for some handlers it may be necessary to disallow such changes. For example, a core handler to handle rejected mail validation should not be disabled.

Return values
boolean

◆ can_change_validateaddress()

tool_messageinbound\message\inbound\invalid_recipient_handler::can_change_validateaddress ( )

Do not allow changes to the address validation setting.

Reimplemented from core\message\inbound\handler.

◆ get_description()

tool_messageinbound\message\inbound\invalid_recipient_handler::get_description ( )

Return a description for the current handler.

Return values
string

Reimplemented from core\message\inbound\handler.

◆ get_name()

tool_messageinbound\message\inbound\invalid_recipient_handler::get_name ( )

Return a name for the current handler.

This appears in the admin pages as a human-readable name.

Return values
string

Reimplemented from core\message\inbound\handler.

◆ get_success_message()

core\message\inbound\handler::get_success_message ( \stdClass $messagedata,
$handlerresult )
inherited

Return the content of any success notification to be sent.

Both an HTML and Plain Text variant must be provided.

If this handler does not need to send a success notification, then it should return a falsey value.

Parameters
stdClass$messagedataThe message data.
stdClass$handlerresultThe record for the newly created post.
Return values
stdClasswith keys html and plain.

Reimplemented in mod_forum\message\inbound\reply_handler.

◆ process_message()

tool_messageinbound\message\inbound\invalid_recipient_handler::process_message ( \stdClass $record,
stdClass $data )

Process a message received and validated by the Inbound Message processor.

Parameters
stdClass$recordThe Inbound Message record
stdClass$dataThe message data packet.
Return values
boolWhether the message was successfully processed.
Exceptions
core\message\inbound\processing_failed_exceptionwhen the message can not be found.

Reimplemented from core\message\inbound\handler.

◆ remove_quoted_text()

static core\message\inbound\handler::remove_quoted_text ( $messagedata)
staticprotectedinherited

Remove quoted message string from the text (NOT HTML) message.

Parameters
stdClass$messagedataThe Inbound Message record
Return values
arraymessage and message format to use.

◆ set_component()

core\message\inbound\handler::set_component ( $component)
inherited

Set the component name.

Parameters
string$componentThe component to set
Return values
stringThe newly set component

◆ set_defaultexpiration()

core\message\inbound\handler::set_defaultexpiration ( $period)
inherited

Set the default validity for new keys.

Parameters
int$periodThe time in seconds before a key expires
Return values
int

◆ set_enabled()

core\message\inbound\handler::set_enabled ( $enabled)
inherited

Set the enabled name.

Parameters
bool$enabledThe new state of enabled
Return values
bool

◆ set_id()

core\message\inbound\handler::set_id ( $id)
inherited

Set the id name.

Parameters
int$idThe id to set
Return values
intThe newly set id

◆ set_validateaddress()

core\message\inbound\handler::set_validateaddress ( $validateaddress)
inherited

Set whether validation of the address is required.

Parameters
bool$validateaddressThe new state of validateaddress
Return values
bool

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