Private Message

The Private Message module allows for private messages between users on a site. It has been written to be fully extendable using Drupal 8 APIs.

For a full description of the module, visit the project page.

Submit bug reports and feature suggestions, or track changes in the issue queue.

Table of contents

• Requirements
• Installation
• Configuration
• Maintainers

Requirements

This module requires no modules outside of Drupal core.

Installation

Install as you would normally install a contributed Drupal module. For further information, see Installing Drupal Modules.

Configuration

1. Navigate to Administration > Extend and enable the Private Message module.
2. Navigate to Administration > People > Permissions and give the two permissions (use private messaging system, access user profiles) to the roles that should use the messaging system. Save permissions.
3. To write a private message to another user, navigate to the path /private-messages.

Configuring the Private Message Inbox Block

1. Navigate to Administration > Structure > Block Layout.
2. Find the Private Message Inbox Block and select the Configure button.
3. Give the block a title.
4. Select the number of threads to show in the block.
5. Select the number of threads to be loaded with ajax.
6. Select an Ajax refresh rate. This is the number of seconds between checks if there are any new messages. Note: setting this number to zero will disable refresh and the inbox will only be refreshed upon page refresh.
7. In the Visibility horizontal tab section there are three options for visibility: Content types, Pages and Roles.
8. The user may also want to set the block to only show on the following paths:
   • /private-messages
   • /private-messages/* This will limit the block to only show on private message thread pages.
9. Select to region for block display from the Region dropdown.
10. Save block.

Configuring the Private Message Notification Block

1. Navigate to Administration > Structure > Block Layout.
2. Find the Private Message Notification Block and select the Configure button.
3. Give the block a title.
4. Select an Ajax refresh rate. This is the number of seconds between checks if there are any new messages. Note: setting this number to zero will disable refresh and the inbox will only be refreshed upon page refresh.
5. In the Visibility horizontal tab section there are three options for visibility: Content types, Pages and Roles.
6. Select to region for block display from the Region dropdown.
7. Save block.

To Configure Private Message Threads

1. Navigate to Administration > Structure > Privates Messages > Private Message Threads.
2. Select the Manage fields tab and fields can be added as with any other entity.
3. Select the Manage display to order the items in a thread.
4. Save block.

For other use stories and configurations, please visit https://www.drupal.org/node/2871948

Note: if Bartik is not the enabled theme, the Private Message Inbox block will need to be placed in a region somewhere on the page.

Maintainers

• Artem Sylchuk - artem_sylchuk
• Jay Friendly - Jaypan
• Philippe Joulot - phjou
• Lucas Hedding - heddn
• Anmol Goel - anmolgoyal74
• Eduardo Telaya - edutrul

Supporting organizations:

• Jaypan