Messaging settings: Difference between revisions

From MoodleDocs
(→‎Mobile notifications: rewording and removing mention of testing)
m (fix a row spacing error)
 
(22 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Messaging}}
{{Messaging}}
==Messaging settings for all users==
==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.
*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.
*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==
==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 personal messaging system in Moodle is enabled by default. It may be disabled by a site administrator from 'Advanced features' in Site administration.
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.


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


Messaging system default settings are set in 'Message outputs' in Site administration.
There are three default types of notification plugins: web, email and mobile.


There are four default types of output methods for messaging: web, Jabber, 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.
 
[[File:NotificationPlugins4.png|center|thumb|500px]]
By default web and email are both enabled, though email will only work of course if the site has been properly configured to deliver email. Jabber and Mobile notifications are off by default and need to be configured first.
 
[[File:moodle23-manage-message-outputs.png|center|thumb|500px]]


==== Jabber ====
==== Jabber ====
Jabber is the original name of the Extensible Messaging and Presence Protocol ([https://en.wikipedia.org/wiki/XMPP XMPP]), an open standard instant messaging protocol.
The Jabber service on the Moodle server must be configured before use. To configure Jabber, an XMPP account should be created that is specific to the Moodle server, either on a locally hosted XMPP server or on one of many [https://xmpp.net/directory.php public servers]. The information for this account is entered in Site administration / Plugins / Message outputs / Jabber:
*Host - The server to connect to to send jabber message notifications - this is entered as the full hostname (e.g. jabber.org) with no protocol (i.e. no "https://")
*Server - XMPP host ID (can be left empty if the same as Jabber host)
*Username - The user name to use when connecting to the Jabber server as the Moodle site, without domain name
*Password - The password to use when connecting to the Jabber server as the Moodle site.
*Port - defaults to 5222
[[File:Jabber_configuration.png]]
After the Jabber service has been configured, it must also be enabled:
[[File:jabber_enable.png]]
Each Moodle user wishing to receive instant message notifications through Jabber must create an account on a Jabber server and must configure their Moodle account to include those details:
[[File:jabber_user_account.png]]
The user must also choose which notifications to receive using Jabber:


[[File:Jabber_notification_preferences.png]]
{{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.]
Users may also choose to receive Moodle messages via Jabber:
 
[[File:Jabber_messages_on.png]]


====Mobile notifications====
====Mobile notifications====
[[File:mobilenotifications.png]]
[[File:mobilenotifications.png]]


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


[[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.  
[[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.  


Alternatively, you may install your own private Airnotifier server and use that instead. See https://github.com/dongsheng/airnotifier for details.
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===
===Default message outputs===
You can specify the default notification preferences for each type of message in Site administration / Messaging / Notification settings.
 
You can specify the default outputs for each type of message that Moodle can send in 'Default message outputs' in Site administration.


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:
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:


* ''Disallowed'' - This particular type of message is not allowed at all and users will not see any settings related to them. Message of the chosen type will never be delivered.
* ''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.
 
* ''Permitted'' - 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 afterward 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.
* ''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.
====Logged in/Offline====
You can set whether each of these will be sent when the user is online through the messaging system interface available to users in their profiles, and/or whether each output is sent via email.
====Ordering of messaging settings====
====Ordering of messaging settings====
 
Because users might have many different messaging options, they are ordered into different components - for example, activities, system, enrolments etc.
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]]
 
[[File:ExampleStudentNotification.png|thumb|600px|center|Example notifications preferences screen - student view]]


==== List of message types====
==== 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.  
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. These are set in the system by the Administrator in ''Site administration > Plugins > Message outputs > Default message outputs''.


{| class="wikitable"
{| class="wikitable"
|-
|-
! Output Name !! Description !! Recipients
! Module !! Output Name !! Description !! Recipients  
|-
|Assignment||Assignment notifications||You have/Student has submitted an [[Assignment activity|assignment]] and Student has received a grade/feedback||Student, Teacher
|-
|Feedback||Feedback notifications||Notices from setting Enable notification of submissions in [[Feedback settings]]||Teacher, Feedback administrator
|-
|Feedback||Feedback reminder||[[Feedback activity|Feedback]] non-respondent reminder message|| Student feedback activity non-responders
|-
|Forum||Subscribed forum posts||Default for forum subscription handling||Anyone subscribed to a forum
|-
|Forum||Subscribed forum digests||A digest of forum subjects or subjects and posts if enabled in User - Forum Preferences, Set default for this in [[User default preferences]]|| Authenticated users
|-
|Lesson||Lesson essay graded notification||Notify students a teacher has graded a Lesson essay question||Student
|-
|Quiz||Notification of your student's quiz submissions||Message that student has submitted a quiz||Teacher
|-
|Quiz||Confirmation of your own quiz submissions||Notice to student that your quiz was successfully submitted||Student
|-
|Quiz||Warning when your quiz attempt becomes overdue||See [[Quiz settings]]||Student
|-
|Quiz||Notification that your attempt has been graded||Message that a teacher has posted feedback on an [[Quiz activity]]||Student
|-
|System||Notices about minor problems||?||Site administrators
|-
|System||Important errors with the site||Important errors - See also [[Debugging]]||Site administrators
|-
|System||Available update notifications||Notice of new releases of Moodle code||Site administrators
|-
|-
| Assignment notifications || Student has submitted an [[Assignment activity|assignment]]|| Teacher
|System||Personal messages between users||Using the Messaging interface tool||Authenticated Users
|-
|-
| Warning when your quiz attempt becomes overdue || See [[Quiz settings]] || Student
|System||Backup notifications||Automated backup schedule run completed||Site administrators
|-
|-
| Available update notifications || Notice of new releases of Moodle code || Site administrators
|System||Course creation request notification||Notice a course has been requested - See [[Course request]]||Defined in ''Site admin > Courses > Course request > Course request notification''
|-
|-
| Backup notifications || Automated backup schedule run completed || Site administrators
|System||Course creation request approval notification ||Notice a requested course has been approved||User who requested the course
|-
|-
| Badge creator notifications || Notify creator of a badge when it is awarded to someone || Any badge creator (typically Teacher or Manager role)
|System||Course creation request rejection notification||Notice a requested course has been rejected||User who requested the course
|-
|-
| Badge recipient notifications || Notify recipient of a badge when it is awarded to them || Any badge recipient (typically Student role)
|System||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 || ? || ?
|System||Badge creator notifications|| Notify creator of a badge when it is awarded to someone||Any badge creator (typically Teacher or Manager role)
|-
|-
| Comment posted on a competency || ? || ?
|System||Comment posted on a learning plan||?||?
|-
|-
| Confirmation of your own quiz submissions || Notice your quiz was successfully submitted || Student
|System||Comment posted on a competency ||? ||?
|-
|-
| Course creation request approval notification || Notice a requested course has been approved || Defined in ''Site admin > Courses > Course request > Course request notification''
|System||Insights generated by prediction models||Notice of users that meet the Analytics criteria, see [[Managing Analytics]]||Teacher
|-
|-
| Course creation request notification || Notice a course has been requested - See [[Course request]] || Defined in ''Site admin > Courses > Course request > Course request notification''
|System||Message contact requests notification||Notifies users when a non-contact user attempts to send them a message||Authenticated users
|-
|-
| Course creation request rejection notification || Notice a requested course has been rejected || Defined in ''Site admin > Courses > Course request > Course request notification''
|System||Asynchronous backup/restore notifications||Notifies users when a backup/restore is completed message, see [[Course backup]]||Authenticated users
|-
|-
| Subscribed forum digests || Sets default for this for user profiles || Authenticated users
|System||Grade notifications||Message that a teacher has posted feedback on an [[Assignment activity|assignment]]||Student
|-
|-
| Important errors with the site || Important errors - See also [[Debugging]] || Site administrators
|System||Course completed||Automatic notification (congratulations note) about completing the course - sent to the student after all the course completion criteria have been achieved||Student
|-
|-
| Manual enrolment expiry notifications || Notice if [[Manual enrolment]] about to expire || Manual enrolees
|System||Antivirus failure notifications.||Warning message for Site Admin, see [[Antivirus plugins]]||Site Administrator
|-
|-
| Self enrolment expiry notifications || Notify users when their enrolment expires || Enroller only, or Enroller & Enrolled user
|System||New login notifications||Warns a user if there was a failed login attempt with their username||Authenticated Users
|-
|-
| Lesson essay graded notification || Notify students a teacher has graded a Lesson essay question || Student  
|System||Course content changes||Message that alerts students that a course activity was updated - activity title only, does not provide details about what has change)||Student
|-
|-
| Personal messages between users || Using the Messaging interface tool || Authenticated Users
|System||Custom report builder schedules||Notification of Report subscriptions, see [[Custom reports]]||usually Teacher or Manager
|-
|-
| Message to confirm that an inbound message came from you || See [[Incoming mail configuration]] || Authenticated Users
|Manual enrollments||Manual enrolment expiry notifications|| Notice if [[Manual enrolment]] is about to expire||Manual enrolees
|-
|-
| Feedback reminder || [[Feedback activity|Feedback]] non-respondent reminder message  || Student feedback activity non-responders
|Self enrollments||Self enrolment expiry notifications||Notify users when if [[Self enrolment]] is about to expire|| Enroller only, or Enroller & Enrolled user
|-
|-
| Warning when an inbound message could not be processed || See [[Incoming mail configuration]] || Authenticated Users
|Data privacy||Data request||Message that data review has been requested, see [[Data privacy]]||Privacy Officer
|-
|-
| Confirmation that a message was successfully processed || See [[Incoming mail configuration]] || Authenticated Users
|Data privacy||Data request processing results||Message that data review has been received and is processing, see [[Data privacy]]||Authenticated User
|-
|-
| Notices about minor problems || || Site administrators
|Data privacy||Data requests exceptions notifications||?||?
|-
|-
| Notification of rule subscriptions || Notifications from [[Event monitoring]] rules || Event rule subscribers
|Inbound message configuration||Message to confirm that an inbound message came from you||See [[Incoming mail configuration]]||Authenticated Users
|-
|-
| Subscribed forum posts || Default for forum subscription handling || Anyone subscribed to a forum
|Inbound message configuration||Warning when an inbound message could not be processed||See [[Incoming mail configuration]]||Authenticated Users
|-
|-
| Feedback notifications || Notices from setting Enable notification of submissions || Teacher, Feedback administrator
|Inbound message configuration||Confirmation that a message was successfully processed||See [[Incoming mail configuration]]||Authenticated Users
|-
|-
| Notification of quiz submissions || Message that student has submitted a quiz || Teacher
|Event monitoring||Notification of rule subscriptions||Notifications from [[Event monitoring]] rules||Event rule subscribers
|}
|}


==Roles and Messaging capabilities==
==Roles and Messaging capabilities==
The following capabilities can be applied as permissions to make custom changes to roles affecting messaging.
The following capabilities can be applied as permissions to make custom changes to roles affecting messaging.
* [[Capabilities/moodle/course:bulkmessaging|course:bulkmessaging - Send a message to many people]]
* [[Capabilities/moodle/course:bulkmessaging|course:bulkmessaging - Send a message to many people]]
* [[Capabilities/moodle/site:readallmessages|site:readallmessages - Read all messages on site]]
* [[Capabilities/moodle/site:readallmessages|site:readallmessages - Read all messages on site]]
Line 151: Line 136:
* [[Capabilities/moodle/user:editownmessageprofile|user:editownmessageprofile - Edit own user messaging profile]]
* [[Capabilities/moodle/user:editownmessageprofile|user:editownmessageprofile - Edit own user messaging profile]]
* [[Capabilities/moodle/user:editmessageprofile|user:editmessageprofile - Edit user messaging profile]]
* [[Capabilities/moodle/user:editmessageprofile|user:editmessageprofile - Edit user messaging profile]]
===Email===
===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 > Advanced features > Notification email override''.
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.
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.
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]]
[[de:Einstellungen für Mitteilungen]]
[[es:Configuraciones de mensajería]]
[[es:Configuraciones de mensajería]]

Latest revision as of 14:59, 11 April 2024

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.

NotificationPlugins4.png

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

mobilenotifications.png

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.

Module Output Name Description Recipients
Assignment Assignment notifications You have/Student has submitted an assignment and Student has received a grade/feedback Student, Teacher
Feedback Feedback notifications Notices from setting Enable notification of submissions in Feedback settings Teacher, Feedback administrator
Feedback Feedback reminder Feedback non-respondent reminder message Student feedback activity non-responders
Forum Subscribed forum posts Default for forum subscription handling Anyone subscribed to a forum
Forum Subscribed forum digests A digest of forum subjects or subjects and posts if enabled in User - Forum Preferences, Set default for this in User default preferences Authenticated users
Lesson Lesson essay graded notification Notify students a teacher has graded a Lesson essay question Student
Quiz Notification of your student's quiz submissions Message that student has submitted a quiz Teacher
Quiz Confirmation of your own quiz submissions Notice to student that your quiz was successfully submitted Student
Quiz Warning when your quiz attempt becomes overdue See Quiz settings Student
Quiz Notification that your attempt has been graded Message that a teacher has posted feedback on an Quiz activity Student
System Notices about minor problems ? Site administrators
System Important errors with the site Important errors - See also Debugging Site administrators
System Available update notifications Notice of new releases of Moodle code Site administrators
System Personal messages between users Using the Messaging interface tool Authenticated Users
System Backup notifications Automated backup schedule run completed Site administrators
System Course creation request notification Notice a course has been requested - See Course request Defined in Site admin > Courses > Course request > Course request notification
System Course creation request approval notification Notice a requested course has been approved User who requested the course
System Course creation request rejection notification Notice a requested course has been rejected User who requested the course
System Badge recipient notifications Notify recipient of a badge when it is awarded to them Any badge recipient (typically Student role)
System Badge creator notifications Notify creator of a badge when it is awarded to someone Any badge creator (typically Teacher or Manager role)
System Comment posted on a learning plan ? ?
System Comment posted on a competency ? ?
System Insights generated by prediction models Notice of users that meet the Analytics criteria, see Managing Analytics Teacher
System Message contact requests notification Notifies users when a non-contact user attempts to send them a message Authenticated users
System Asynchronous backup/restore notifications Notifies users when a backup/restore is completed message, see Course backup Authenticated users
System Grade notifications Message that a teacher has posted feedback on an assignment Student
System Course completed Automatic notification (congratulations note) about completing the course - sent to the student after all the course completion criteria have been achieved Student
System Antivirus failure notifications. Warning message for Site Admin, see Antivirus plugins Site Administrator
System New login notifications Warns a user if there was a failed login attempt with their username Authenticated Users
System Course content changes Message that alerts students that a course activity was updated - activity title only, does not provide details about what has change) Student
System Custom report builder schedules Notification of Report subscriptions, see Custom reports usually Teacher or Manager
Manual enrollments Manual enrolment expiry notifications Notice if Manual enrolment is about to expire Manual enrolees
Self enrollments Self enrolment expiry notifications Notify users when if Self enrolment is about to expire Enroller only, or Enroller & Enrolled user
Data privacy Data request Message that data review has been requested, see Data privacy Privacy Officer
Data privacy Data request processing results Message that data review has been received and is processing, see Data privacy Authenticated User
Data privacy Data requests exceptions notifications ? ?
Inbound message configuration Message to confirm that an inbound message came from you See Incoming mail configuration Authenticated Users
Inbound message configuration Warning when an inbound message could not be processed See Incoming mail configuration Authenticated Users
Inbound message configuration Confirmation that a message was successfully processed See Incoming mail configuration Authenticated Users
Event monitoring Notification of rule subscriptions Notifications from Event monitoring rules Event rule subscribers

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.