Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/message/output/email/classes/task/ -> send_email_task.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 39 and 401] [Versions 401 and 402] [Versions 401 and 403]

Contains the class responsible for sending emails as a digest.

Copyright: 2019 Mark Nelson <markn@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 178 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

send_email_task:: (5 methods):
  get_name()
  execute()
  get_unique_users()
  get_conversations_for_user()
  get_users_messages_for_conversation()


Class: send_email_task  - X-Ref

Class responsible for sending emails as a digest.

get_name()   X-Ref
Get a descriptive name for this task (shown to admins).

return: string

execute()   X-Ref
Send out emails.


get_unique_users()   X-Ref
Returns an array of users in the given conversation.

return: moodle_recordset A moodle_recordset instance.

get_conversations_for_user(int $userid)   X-Ref
Returns an array of unique conversations that require processing.

param: int $userid The ID of the user we are sending a digest to.
return: moodle_recordset A moodle_recordset instance.

get_users_messages_for_conversation(int $conversationid, int $userid)   X-Ref
Returns the messages to send to a user for a given conversation

param: int $conversationid
param: int $userid
return: moodle_recordset A moodle_recordset instance.