Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
/message/output/email/ -> message_output_email.php (source)

[Source view]

Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403]

Contains the definiton of the email message processors (sends messages to users via email)

Copyright: 2008 Luis Rodrigues and Martin Dougiamas
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 228 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

message_output_email:: (6 methods):
  send_message()
  config_form()
  process_form()
  get_default_messaging_settings()
  load_data()
  can_send_to_any_users()


Class: message_output_email  - X-Ref

The email message processor

send_message($eventdata)   X-Ref
Processes the message (sends by email).

param: object $eventdata the event data submitted by the message sender plus $eventdata->savedmessageid

config_form($preferences)   X-Ref
Creates necessary fields in the messaging config form.

param: array $preferences An array of user preferences

process_form($form, &$preferences)   X-Ref
Parses the submitted form data and saves it into preferences array.

param: stdClass $form preferences form class
param: array $preferences preferences array

get_default_messaging_settings()   X-Ref
Returns the default message output settings for this output

return: int The default settings

load_data(&$preferences, $userid)   X-Ref
Loads the config data from database to put on the form during initial form display

param: array $preferences preferences array
param: int $userid the user id

can_send_to_any_users()   X-Ref
Returns true as message can be sent to internal support user.

return: bool