Messaging settings: Difference between revisions

Latest revision as of 12:57, 24 July 2023

Messaging settings for all users

Users can decide how they want to be notified of new messages and event notifications by editing their messaging preferences page, which they can access either from the Preferences link in the user menu or from the gear icon in the messaging/notifications menus. See Messaging and Notifications for more information.
Which options they see there depend on what has been enabled by the administrator. For example, the mobile option is only available if the site is enabled for the mobile app.

Enabling / disabling messaging site wide

The personal messaging system in Moodle is enabled by default. It may be disabled by a site administrator from Site administration > Advanced features.

From 'Messaging settings', the administrator can "Allow site-wide messaging" (disabled by default). If this setting is enabled, users on the site can view all other users when selecting someone to message and can choose to accept messages from anyone on the site.

Notification settings

Messaging system default settings are set in 'Notification settings' in Site administration / Messaging

There are three default types of notification plugins: web, email and mobile.

By default, web and email are both enabled, although email will only work of course if the site has been properly configured to deliver email. Mobile notifications are off by default and need to be configured first.

Jabber

Note: The Jabber message output has been removed from new installations of Moodle 4.0.

The code for the Jabber message output is currently available from the Plugins directory.

Mobile notifications

The administrator can configure the site to push messages to mobile devices. Moodle pushes messages to a messaging server, which then pushes it to Apple or Google depending on the platform the target device is using (iOS or Android).

Registered sites can make use of the default messaging server https://messages.moodle.net/ which is maintained by moodle.com. To connect to this, click 'Request access key' and then add it to the Airnotifier access key field.

Alternatively, you may install your own private Air notifier server and use that instead. See https://github.com/dongsheng/airnotifier for details.

Default notification preferences

You can specify the default notification preferences for each type of message in Site administration / Messaging / Notification settings.

You can also set to what degree each type of message is enabled, and whether users are able to change these default settings in their profiles:

Enabled - Users are permitted or allowed to change the settings. When the user account is created, the new user will inherit the settings the administrator sets here, but will be allowed to change them afterwards in their Messaging settings. Messages will be delivered as the user sets them on their own Messaging settings page.

Locked - Users are not permitted or allowed to change these settings. When the user account is created, the new user will inherit the settings the administrator sets here and will never be allowed to change them. Messages will be delivered for all users as you set them on this page.

Ordering of messaging settings

Because users might have many different messaging options, they are ordered into different components - for example, activities, system, enrolments etc.

Part of the Notification preferences screen for a teacher

List of message types

Except for 'Personal messages between users', which refers to the interaction messaging tool on a user profile, the other messages are generated by events in Moodle.

Output Name	Description	Recipients
Assignment notifications	Student has submitted an assignment	Teacher
Warning when your quiz attempt becomes overdue	See Quiz settings	Student
Available update notifications	Notice of new releases of Moodle code	Site administrators
Backup notifications	Automated backup schedule run completed	Site administrators
Badge creator notifications	Notify creator of a badge when it is awarded to someone	Any badge creator (typically Teacher or Manager role)
Badge recipient notifications	Notify recipient of a badge when it is awarded to them	Any badge recipient (typically Student role)
Comment posted on a learning plan	?	?
Comment posted on a competency	?	?
Confirmation of your own quiz submissions	Notice your quiz was successfully submitted	Student
Course creation request approval notification	Notice a requested course has been approved	User who requested the course
Course creation request notification	Notice a course has been requested - See Course request	Defined in Site admin > Courses > Course request > Course request notification
Course creation request rejection notification	Notice a requested course has been rejected	User who requested the course
Subscribed forum digests	Sets default for this for user profiles	Authenticated users
Important errors with the site	Important errors - See also Debugging	Site administrators
Manual enrolment expiry notifications	Notice if Manual enrolment about to expire	Manual enrolees
Self enrolment expiry notifications	Notify users when their enrolment expires	Enroller only, or Enroller & Enrolled user
Lesson essay graded notification	Notify students a teacher has graded a Lesson essay question	Student
Personal messages between users	Using the Messaging interface tool	Authenticated Users
Message to confirm that an inbound message came from you	See Incoming mail configuration	Authenticated Users
Feedback reminder	Feedback non-respondent reminder message	Student feedback activity non-responders
Warning when an inbound message could not be processed	See Incoming mail configuration	Authenticated Users
Confirmation that a message was successfully processed	See Incoming mail configuration	Authenticated Users
Notices about minor problems		Site administrators
Notification of rule subscriptions	Notifications from Event monitoring rules	Event rule subscribers
Subscribed forum posts	Default for forum subscription handling	Anyone subscribed to a forum
Feedback notifications	Notices from setting Enable notification of submissions	Teacher, Feedback administrator
Notification of quiz submissions	Message that student has submitted a quiz	Teacher
Course completed	Automatic notification (congratulations note) about completing the course - sent to the student after all the course completion criteria have been achieved.	Student

Roles and Messaging capabilities

The following capabilities can be applied as permissions to make custom changes to roles affecting messaging.

Email

All email messages and notifications go to the email address set in a user's profile. The administrator can optionally allow users to choose to have notifications sent to a different email address. This is off by default and can be enabled in Site administration > Messaging settings.

Users can then enter their alternative email address under Preferences/User account/Notification preferences: Click on the gear icon next to "Email" in the table header and enter the alternative email.

Note: The 'messagingallowemailoverride' setting does not affect failed log in notifications as they do not go through the messaging system, and will therefore still go to the original email specified.

@@ Line 1: / Line 1: @@
 {{Messaging}}
-==Enabling / disabling instant messaging==
+==Messaging settings for all users==
+*Users can decide how they want to be notified of new messages and event notifications by editing their messaging preferences page, which they can access either from the Preferences link in the user menu or from the gear icon in the messaging/notifications menus. See [[Messaging]] and [[Notifications]] for more information.
+*Which options they see there depend on what has been enabled by the administrator. For example, the mobile option is only available if the site is enabled for the mobile app.
+==Enabling / disabling messaging site wide==
+The personal messaging system in Moodle is enabled by default. It may be disabled by a site administrator from Site administration > Advanced features.
-The instant messaging system in Moodle is enabled by default. It may be disabled by a site administrator in ''Settings > Site administration > Advanced features''.
+From 'Messaging settings', the administrator can "Allow site-wide messaging" (disabled by default). If this setting is enabled, users on the site can view all other users when selecting someone to message and can choose to accept messages from anyone on the site.
-==My profile settings==
+==Notification settings ==
+Messaging system default settings are set in 'Notification settings' in Site administration / Messaging
-Users can receive message alerts for a number of different reasons and can also send and receive instant messages. How a user receives notification of incoming messages can be set in ''Settings > My profile > Messaging''.
+There are three default types of notification plugins: web, email and mobile.
-*This brings up a screen with check boxes where users can choose how they wish to be notified both when logged in and logged out. They can choose between a pop up,Jabber message or an email.
+By default, web and email are both enabled, although email will only work of course if the site has been properly configured to deliver email. Mobile notifications are off by default and need to be configured first.
+[[File:NotificationPlugins4.png|center|thumb|500px]]
-[[File:Messagingnotifications.png]]
+==== Jabber ====
-*'''Note:''' The choices a user has on this screen depends on their role and permissions within Moodle. For example, an administrator would see options for notifications about backups or important errors with the site.
+{{Note|The Jabber message output has been removed from new installations of Moodle 4.0.}}
+The code for the Jabber message output is currently available from the [https://moodle.org/plugins/message_jabber Plugins directory.]
-===Pop up===
+====Mobile notifications====
-When a user is logged into Moodle, the message will pop up from the bottom right corner of the page. The user can choose to read the message immediately or to ignore it. If they choose to ignore it, the message returns until it is read.
+[[File:mobilenotifications.png]]
-===Jabber===
+The administrator can configure the site to push messages to mobile devices. Moodle pushes messages to a messaging server, which then pushes it to Apple or Google depending on the platform the target device is using (iOS or Android).
-If the Jabber server has been configured, Jabber messages can be sent.The Jabber ID can be set at the bottom of the screen.
-===Email===
+[[Site registration|Registered sites]] can make use of the default messaging server https://messages.moodle.net/ which is maintained by moodle.com. To connect to this, click 'Request access key' and then add it to the Airnotifier access key field.
-There is a box at the bottom of this settings screen which allows for a different email address from the default to be chosen for receiving notifications.
-===Prevent non-contacts from messaging me===
+Alternatively, you may install your own private Air notifier server and use that instead. See https://github.com/dongsheng/airnotifier for details.
-Non-contacts can be prevented from sending messages by ticking this box in General Settings at the bottom of the screen.
+===Default notification preferences===
+You can specify the default notification preferences for each type of message in Site administration / Messaging / Notification settings.
-==Site administration settings==
+You can also set to what degree each type of message is enabled, and whether users are able to change these default settings in their profiles:
-Message outputs - popup, jabber and email - can be configured by a site administrator in ''Settings > Site administration > Plugins > Message outputs > Manage message outputs''.
+* ''Enabled'' - Users are permitted or allowed to change the settings. When the user account is created, the new user will inherit the settings the administrator sets here, but will be allowed to change them afterwards in their Messaging settings. Messages will be delivered as the user sets them on their own Messaging settings page.
-Default message outputs can be set in ''Settings > Site administration > Plugins > Message outputs > Default message outputs'', also whether each output is permitted, disallowed or forced.
+* ''Locked'' - Users are not permitted or allowed to change these settings. When the user account is created, the new user will inherit the settings the administrator sets here and will never be allowed to change them. Messages will be delivered for all users as you set them on this page.
+====Ordering of messaging settings====
+Because users might have many different messaging options, they are ordered into different components - for example, activities, system, enrolments etc.
+[[File:Notification4.png|thumb|600px|center|Part of the Notification preferences screen for a teacher]]
-===Email settings===
+==== List of message types====
+Except for 'Personal messages between users', which refers to the interaction messaging tool on a user profile, the other messages are generated by events in Moodle.
+{| class="wikitable"
+|-
+! Output Name !! Description !! Recipients
+|-
+| Assignment notifications || Student has submitted an [[Assignment activity|assignment]]|| Teacher
+|-
+| Warning when your quiz attempt becomes overdue || See [[Quiz settings]] || Student
+|-
+| Available update notifications || Notice of new releases of Moodle code || Site administrators
+|-
+| Backup notifications || Automated backup schedule run completed || Site administrators
+|-
+| Badge creator notifications || Notify creator of a badge when it is awarded to someone || Any badge creator (typically Teacher or Manager role)
+|-
+| Badge recipient notifications || Notify recipient of a badge when it is awarded to them || Any badge recipient (typically Student role)
+|-
+| Comment posted on a learning plan || ? || ?
+|-
+| Comment posted on a competency || ? || ?
+|-
+| Confirmation of your own quiz submissions || Notice your quiz was successfully submitted || Student
+|-
+| Course creation request approval notification || Notice a requested course has been approved || User who requested the course
+|-
+| Course creation request notification || Notice a course has been requested - See [[Course request]] || Defined in ''Site admin > Courses > Course request > Course request notification''
+|-
+| Course creation request rejection notification || Notice a requested course has been rejected || User who requested the course
+|-
+| Subscribed forum digests || Sets default for this for user profiles || Authenticated users
+|-
+| Important errors with the site || Important errors - See also [[Debugging]] || Site administrators
+|-
+| Manual enrolment expiry notifications || Notice if [[Manual enrolment]] about to expire || Manual enrolees
+|-
+| Self enrolment expiry notifications || Notify users when their enrolment expires || Enroller only, or Enroller & Enrolled user
+|-
+| Lesson essay graded notification || Notify students a teacher has graded a Lesson essay question || Student
+|-
+| Personal messages between users || Using the Messaging interface tool || Authenticated Users
+|-
+| Message to confirm that an inbound message came from you || See [[Incoming mail configuration]]  || Authenticated Users
+|-
+| Feedback reminder ||  [[Feedback activity|Feedback]] non-respondent reminder message  || Student feedback activity non-responders
+|-
+| Warning when an inbound message could not be processed || See [[Incoming mail configuration]] || Authenticated Users
+|-
+| Confirmation that a message was successfully processed ||  See [[Incoming mail configuration]] || Authenticated Users
+|-
+| Notices about minor problems || || Site administrators
+|-
+| Notification of rule subscriptions || Notifications from [[Event monitoring]] rules || Event rule subscribers
+|-
+| Subscribed forum posts || Default for forum subscription handling || Anyone subscribed to a forum
+|-
+| Feedback notifications ||  Notices from setting Enable notification of submissions || Teacher, Feedback administrator
+|-
+| Notification of quiz submissions || Message that student has submitted a quiz || Teacher
+|-
+|Course completed
+|Automatic notification (congratulations note) about completing the course - sent to the student after all the course completion criteria have been achieved.
+|Student
+|}
-====SMTP hosts====
+==Roles and Messaging capabilities==
+The following capabilities can be applied as permissions to make custom changes to roles affecting messaging.
-SMTP stands for Simple Mail Transfer Protocol. The SMTP host is an email relay that will take the email from Moodle and send it to users. You will need to set this only if your server does not allow mail relay. Otherwise, PHP will send out the mail using its built-in mail server. All the email sent by forums and other modules will be sent through this host.
+* [[Capabilities/moodle/course:bulkmessaging|course:bulkmessaging - Send a message to many people]]
+* [[Capabilities/moodle/site:readallmessages|site:readallmessages - Read all messages on site]]
-Most SMTP hosts make use of the default port 25 to for listening email traffic. However, occasionally a non-default port is used. In such cases, entering an SMTP host followed by a colon (i.e. :) and the port number should work. For example, if my SMTP host is myemailserver.com and it listens on port 587 or 465 (most common) instead of port 25 I would enter the SMTP host as myemailserver.com:587. Currently, the parameter check is too strict to allow this via the Moodle UI; however, MDL-15923 has been created and resolved to address this.  Until then, it can be set via phpMyAdmin using a query statement like:
+* [[Capabilities/moodle/site:sendmessage|site:sendmessage - Send messages to any user]]
-<code mysql> UPDATE mdl_config SET value='myemailserver.com:587' WHERE name='smtphosts';</code>
+* [[Capabilities/moodle/user:editownmessageprofile|user:editownmessageprofile - Edit own user messaging profile]]
+* [[Capabilities/moodle/user:editmessageprofile|user:editmessageprofile - Edit user messaging profile]]
-====Secure SMTP hosts with SSL/TLS====
+===Email===
+All email messages and notifications go to the email address set in a user's profile. The administrator can optionally allow users to choose to have notifications sent to a different email address. This is off by default and can be enabled in ''Site administration > Messaging settings''.
-For SMTP hosts that require secure authentication, SSL or TLS you must run the following query:
-<code mysql> UPDATE mdl_config SET value='ssl://myemailserver.com:465' WHERE name='smtphosts';</code>
-====Configure HTTPD/SELinux on CentOS/Red Hat (RHEL) 6.2/6.1/6====
-Most new installations of Centos/Red Hat have SELinux activated and is configured by default, rather strictly. In this state SELinux does not allow Apache (httpd,phpmailer) to use the sendmail function and make any sort of network connection.
-If you continue to have problems with sending/authenticating use the '''getsebool''' command to find out if SELinux is one of the culprits. When the '''getsebool''' command is issued it returns ''on'' or ''off''.
-Type to check if your Apache is allowed to send mail and make a connection over the network
-*''getsebool httpd_can_sendmail''
-*''getsebool httpd_can_network_connect''
-You will receive the values of ''httpd_can_sendmail'' and ''httpd_can_network_connect''. Let's assume both options are off:
-*''httpd_can_sendmail -->off''
-*''httpd_can_network_connect -->off''
-We need to change the values from ''off'' to ''on'' by using '''setsebool'''. Number 1 = on and 0 = off. Type the following:
-*''setsebool -P httpd_can_sendmail 1''
-*''setsebool -P httpd_can_network_connect 1''
-You will not receive a response. You can double check if the '''setsebool''' command worked by using '''getsebool''' and see if the values changed from ''-->off'' to ''-->on''.
-==Messaging capabilities==
-* [[Capabilities/moodle/course:bulkmessaging|Send a message to many people]]
-* [[Capabilities/moodle/site:readallmessages|Read all messages on site]]
-* [[Capabilities/moodle/site:sendmessage|Send messages to any user]]
-*[[Capabilities/moodle/user:editownmessageprofile|Edit own user messaging profile]]
-*[[Capabilities/moodle/user:editmessageprofile|Edit user messaging profile]]
-==See also==
-*[[:dev:Messaging 2.0|Messaging developer documentation]]
+Users can then enter their alternative email address under Preferences/User account/Notification preferences: Click on the gear icon next to "Email" in the table header and enter the alternative email.
-[[de:Mitteilungen konfigurieren]]
+Note: The 'messagingallowemailoverride' setting does not affect failed log in notifications as they do not go through the messaging system, and will therefore still go to the original email specified.
+[[fr:Paramètres de messagerie]]
+[[de:Einstellungen für Mitteilungen]]
+[[es:Configuraciones de mensajería]]

Documentation