Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Files | Namespaces | Classes | Functions | Variables
message_email

Files

file  email_digest.php
 Email digest renderable.
 
file  event_observers.php
 Contains an observer class containing methods for handling events.
 
file  events.php
 This file defines what events we wish to observe and the method responsible for handling the event.
 
file  install.php
 Installation code for the email message processor.
 
 
file  provider.php
 Privacy class for requesting user data.
 
file  renderer.php
 Contains renderer class.
 
file  renderer.php
 Email digest as html renderer.
 
file  renderer_textemail.php
 Email digest as text renderer.
 
 
file  tasks.php
 This file defines tasks performed by the plugin.
 
file  upgrade.php
 Upgrade code for email message processor.
 
file  version.php
 Email processor version information.
 

Namespaces

 
 
 
 
 

Classes

class  message_email\event_observers
 Observer class containing methods for handling events. More...
 
class  message_email\output\email\renderer
 Email digest as html renderer. More...
 
class  message_email\output\email\renderer_textemail
 Email digest as text renderer. More...
 
class  message_email\output\email_digest
 Email digest renderable. More...
 
class  message_email\output\renderer
 Renderer class. More...
 
class  message_email\privacy\provider
 Privacy class for requesting user data. More...
 
class  message_email\task\send_email_task
 Class responsible for sending emails as a digest. More...
 
class  message_output_email
 The email message processor. More...
 

Functions

 xmldb_message_email_install ()
 Install the email message processor.
 
 xmldb_message_email_upgrade ($oldversion)
 Upgrade code for the email message processor. More...
 

Variables

 $observers
 
 $tasks
 
$plugin component = 'message_email'
 
$plugin requires = 2019111200
 
$plugin version = 2019111800
 

Detailed Description

Function Documentation

◆ xmldb_message_email_upgrade()

xmldb_message_email_upgrade (   $oldversion)

Upgrade code for the email message processor.

Parameters
int$oldversionThe version that we are upgrading from

Variable Documentation

◆ $observers

$observers
Initial value:
= [
[
'eventname' => '\core\event\message_viewed',
'callback' => '\message_email\event_observers::message_viewed',
],
]

◆ $tasks

$tasks
Initial value:
= array(
array(
'classname' => 'message_email\task\send_email_task',
'blocking' => 0,
'minute' => 0,
'hour' => 22,
'day' => '*',
'dayofweek' => '*',
'month' => '*'
)
)