core\message\inbound\handler Class Reference

Inheritance diagram for core\message\inbound\handler:

Public Member Functions
	__get ($key)
	Magic getter to fetch the specified key. More...
	can_change_defaultexpiration ()
	Whether the current handler allows changes to expiry of the generated email address. More...
	can_change_enabled ()
	Whether this handler can be disabled (or enabled). More...
	can_change_validateaddress ()
	Whether the current handler allows changes to the address validation setting. More...
	get_success_message (\stdClass $messagedata, $handlerresult)
	Return the content of any success notification to be sent. More...
	process_message (\stdClass $record, stdClass $messagedata)
	Process the message against the current handler. More...
	set_component ($component)
	Set the component name. More...
	set_defaultexpiration ($period)
	Set the default validity for new keys. More...
	set_enabled ($enabled)
	Set the enabled name. More...
	set_id ($id)
	Set the id name. More...
	set_validateaddress ($validateaddress)
	Set whether validation of the address is required. More...

Protected Member Functions
	get_description ()
	Return a description for the current handler. More...
	get_name ()
	Return a name for the current handler. More...

Static Protected Member Functions
static	remove_quoted_text ($messagedata)
	Remove quoted message string from the text (NOT HTML) message. More...

Member Function Documentation

__get()

core\message\inbound\handler::__get

(

$key

)

Magic getter to fetch the specified key.

Parameters

string

$key

The name of the key to retrieve

can_change_defaultexpiration()

core\message\inbound\handler::can_change_defaultexpiration

(

)

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

(

)

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

core\message\inbound\handler::can_change_validateaddress

(

)

Whether the current handler allows changes to the address validation setting.

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

Return values

boolean

Reimplemented in tool_messageinbound\message\inbound\invalid_recipient_handler.

get_description()

core\message\inbound\handler::get_description ( )

abstractprotected

Return a description for the current handler.

Return values

string

Reimplemented in mod_forum\message\inbound\reply_handler, core\message\inbound\private_files_handler, and tool_messageinbound\message\inbound\invalid_recipient_handler.

get_name()

core\message\inbound\handler::get_name ( )

abstractprotected

Return a name for the current handler.

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

Return values

string

Reimplemented in mod_forum\message\inbound\reply_handler, core\message\inbound\private_files_handler, and tool_messageinbound\message\inbound\invalid_recipient_handler.

get_success_message()

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

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	$messagedata	The message data.
stdClass	$handlerresult	The record for the newly created post.

Return values

stdClass

with keys html and plain.

Reimplemented in mod_forum\message\inbound\reply_handler.

process_message()

core\message\inbound\handler::process_message ( \stdClass  $record, stdClass  $messagedata  )

abstract

Process the message against the current handler.

Parameters

stdClass	$record	The Inbound Message Handler record
stdClass	$messagedata	The message data

Reimplemented in mod_forum\message\inbound\reply_handler, core\message\inbound\private_files_handler, and tool_messageinbound\message\inbound\invalid_recipient_handler.

remove_quoted_text()

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

staticprotected

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

Parameters

stdClass

$messagedata

The Inbound Message record

Return values

array

message and message format to use.

set_component()

core\message\inbound\handler::set_component

(

$component

)

Set the component name.

Parameters

string

$component

The component to set

Return values

string

The newly set component

set_defaultexpiration()

core\message\inbound\handler::set_defaultexpiration

(

$period

)

Set the default validity for new keys.

Parameters

int

$period

The time in seconds before a key expires

Return values

int

set_enabled()

core\message\inbound\handler::set_enabled

(

$enabled

)

Set the enabled name.

Parameters

bool

$enabled

The new state of enabled

Return values

bool

set_id()

core\message\inbound\handler::set_id

(

$id

)

Set the id name.

Parameters

int

$id

The id to set

Return values

int	The newly set id

set_validateaddress()

core\message\inbound\handler::set_validateaddress

(

$validateaddress

)

Set whether validation of the address is required.

Parameters

bool

$validateaddress

The new state of validateaddress

Return values

bool

---

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

• lib/classes/message/inbound/handler.php