Note: You are currently viewing documentation for Moodle 3.8. Up-to-date documentation for the latest stable version of Moodle may be available here: Messaging settings.

Messaging settings: Difference between revisions

From MoodleDocs
(update)
(removing out-of-date screenshots)
 
(13 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Messaging}}
{{Messaging}}
==Messaging settings for all users==
==Messaging settings for all users==


Line 8: Line 7:
==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 'Advanced features' in Site administration.
The personal messaging system in Moodle is enabled by default. It may be disabled by a site administrator from Site administration > Messaging > Messaging settings.


==Message outputs ==
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.


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


There are four default types of output methods for messaging: web, Jabber, email and mobile.
Messaging system default settings are set in 'Notification settings' in Site administration / Messaging
 
There are four default types of notification plugins: web, Jabber, email and mobile.


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.
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]]
[[File:NotificationPlugins.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.
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]]


Jabber must be configured before use.
The user must also choose which notifications to receive using Jabber:


''(Could someone with working settings fill this out with example?)''
[[File:Jabber_notification_preferences.png]]


*Host - The server to connect to to send jabber message notifications - full hostname (e.g. jabber.org)
Users may also choose to receive Moodle messages via Jabber.
*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
*Password - The password to use when connecting to the Jabber server
*Port - defaults to 5222


====Mobile notifications====
====Mobile notifications====
Line 38: Line 51:
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).


The default messaging server is a free [https://github.com/dongsheng/airnotifier Airnotifier server] maintained by moodle.com which registered sites may use for testing (be aware that all your messages will go via this server). 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.
[[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.  


Users will need to connect at least once with the latest version of the mobile app to register their phones with the site.  
Alternatively, you may install your own private Air notifier server and use that instead.  See https://github.com/dongsheng/airnotifier for details.


===Default message outputs===
===Default notification preferences===


You can specify the default outputs for each type of message that Moodle can send in 'Default message outputs' in Site administration.
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:
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:
Line 50: Line 63:
* ''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.
* ''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.


* ''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.
* ''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 afterwards in their Messaging settings. Messages will be delivered as the user sets them on their own Messaging settings page.


* ''Forced'' - 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====
====Logged in/Offline====
Line 66: Line 79:
==== 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. These are set in the system by the Administrator in ''Site administration > Plugins > Message outputs > Default message outputs''.
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"
{| class="wikitable"
Line 138: Line 151:


===Email===
===Email===
Users cannot by default automatically choose to have notifications sent to a different email address from their official Moodle email. However, the administrator has the option to override this so that users can have an alternative email. This is done by ticking the 'Notification email override' (messagingallowemailoverride) box in 'Advanced features' in the Site administration.
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''.
 
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.


[[de:Mitteilungen konfigurieren]]
[[fr:Paramètres de messagerie]]
[[de:Einstellungen für Mitteilungen]]
[[es:Configuraciones de mensajería]]
[[es:Configuraciones de mensajería]]

Latest revision as of 15:16, 2 September 2020

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 > Messaging > Messaging settings.

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 four default types of notification plugins: web, Jabber, email and mobile.

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.

NotificationPlugins.png

Jabber

Jabber is the original name of the Extensible Messaging and Presence Protocol (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 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

Jabber configuration.png

After the Jabber service has been configured, it must also be enabled.

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:

jabber user account.png

The user must also choose which notifications to receive using Jabber:

Jabber notification preferences.png

Users may also choose to receive Moodle messages via Jabber.

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:

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

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

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

Example notifications preferences screen - student view

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 Defined in Site admin > Courses > Course request > Course request notification
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 Defined in Site admin > Courses > Course request > Course request notification
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

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 > Advanced features > Notification email override.

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.