Private Messages Setup

Overview

This document provides instructions on our Private Messages extension.

Contents

Settings #

Extension's settings #

When the extension Private Messages is activated, it adds a Messaging tab to the page [Ultimate Member > Settings > Extension]. In the Messaging tab you should see the following options:

  • Show messages button in member directory - Enable/disable buttons "Message" on the Members page. Note: "Message" buttons can be disabled for a certain directory using the "Hide message button in the directory" option.
  • Show unread messages first - Show conversation with unread messages first.
  • Hide a "Download Chats History" link - Enable/disable the download history in the messages profile tab.
  • Message character limit - You can set the maximum number of characters allowed in each conversation reply.
  • Block users from sending/receiving messages - You can add user IDs that cannot send or received messages on the site. Use a comma to separate the list.
  • Primary color - You can also select the color of the message box outline, links, and send message button.
  • How often do you want the AJAX refresh conversation (in seconds) - AJAX timeout. Too small a value may slow down the site.
  • Send email notifications If user did not login for - You can set the last log-in time period to send email notifications about new messages if the user's last login time exceeds that period.
  • Send email notifications If user didn't read message for [n] hours - Send email notifications about the unread messages if the user didn't read it during that period.
  • Send email notifications not more then [m] times - Email notifications about unread messages will be sent every [n] hour but no more than [m] times.
  • Show messages button in individual job post - When enabled, the user can message the job author.

Image - The page [wp-admin > Ultimate Member > Settings > Extensions > Private Messaging]

Profile Menu settings #

The extension adds settings to the page [wp-admin > Ultimate Member > Settings > Appearance > Profile Menu]. These settings allow you to manage the "Messages" item in the profile menu:

  • Messages Tab – Allows enabling/disabling the "Messages" item in the Profile menu.
    Note: only profile owners and administrators can see the "Messages" item in the Profile menu.

User Role settings #

The extension allows you to control private messages on specific user roles. To modify the settings on a specific role, go to the page [wp-admin > Ultimate Member > User Roles] and choose the user role to modify. You will be navigated to the page "Edit Role". On this page scroll down to the Private Messages options:

  • Enable Messaging feature? - Enable or disable a messaging feature for this role.
  • Can start conversations? - Allow this role to start a conversation with other users.
  • Can start conversations with - Allow users to start conversations with everyone or specific user roles.
  • Can start conversations with selected user roles - When a specific user role is selected, you can select which role the user can start a conversation with.
  • Can read private messages? - Allow this role to read private messages from other users.
  • Can reply private messages? - Allow this role to reply to other users.
  • Maximum number of messages they can send - Limit the maximum number of messages a user can send.

Image - The page [wp-admin > Ultimate Member > User Roles > Edit Role]

Member Directories settings #

The extension may add the button "Message" to each member card on the members' directory. There are two settings that allow enabling/disable these buttons:

  • Show messages button in member directory on the page [Ultimate Member > Settings > Extensions > Private Messaging] - enable/disable buttons "Message" for all member directories;

  • Hide message button in the directory on the page [Ultimate Member > Member Directories > Edit Member Directory>Profile Card section] - disable buttons "Message" for the certain directory.

Image - Buttons "Message" on the members' directory

User Profile #

The extension adds these front-end elements:

  • "Messages" tab on member Profile page;
  • Button "Message" on other members Profile pages;
  • Select "Who can send me private messages?" on the Account page.

Users can send private messages by clicking the button "Message" on the user profile page or the member directory. Once the message button is clicked, a pop-up window will appear where users can easily exchange texts, links, and emojis.

Note: The button "Message" is shown for guests and logged-in members with proper settings. The button is hidden if:
 - current user is a recipient;
 - current user or recipient is blocked by the setting "Block users from sending/receiving messages";
 - current user is blocked by recipient or recipient is blocked by the current user;
 - the messaging feature is blocked by the setting "Who can send me private messages?" in the recipient's account;
 - the messaging feature is disabled for the current user role or for the recipient user role;
 - the recipient user role can't read private messages;

Image - The tab "Messages" on the Profile page

Image - The button "Message" on the other member Profile page.

Image - Select  "Who can send me private messages?" on the Account page.

If the UM-Followers extension is integrated on your site, users are given the option to control who can send them private messages, user can select followers and only I follow.

UM-Real-time notifications extension is activated, the user can control if they want to receive email notifications for new messages directly on their account settings. Users can turn on/off receiving an e-mail notification for new conversations. Go to user's account page> Web notifications.

Users can block someone in messages by clicking on the block icon. They can review the blocked and unblocked users in the account page> Privacy.

Configure notifications #

The extension has two email templates:

  • New Message Notification (new_message) - notification sent to users when they receive new private messages;
  • New Message Reminder (new_message_reminder) - notification sent to users when they have unread private messages.

The extension sends the email New Message Notification immediately if:

  • the first message is added in a new conversation;
  • the second (or next) message is added in the existing conversation and the recipient did not login for the period selected by the setting "Send email notifications If user did not login for".

The extension sends the email New Message Reminder periodically with timeout selected by the setting "Send email notifications If user didn't read message for [n] hours" several times. The maximum number of reminders depends on "Send email notifications not more than [m] times". The extension stops sending reminder email once the recipient read the message.

Administrators can edit email templates: enable, disable, change subject or body. Go to the admin page [Ultimate Member > Settings > Email], find the needed email template, and click the button "Edit" (gear icon). You'll see email template settings. Change what you want and save changes. 

Image - The page [wp-admin > Ultimate Member > Settings > Email] 

You can show unread message count in your menu easily using the {new_messages} tag. Read the instructions here.

Additional features

Users that are active show a green dot next to their name to indicate that they are online. This will only work when UM-Online Users plugin is installed and activated.

Shortcode #

The extension adds these shortcodes:

You can put these shortcodes to the post (page) content or to the sidebar text widget.

[ultimatemember_message_button] #

Used for: Show the message button of a specific user.

Example:

[ultimatemember_message_button user_id="123"]

The shortcode attributes:

  • user_id (integer) - the identification number of the user - recipient. Required. Default value: the post author ID (if post or page) or 0.

[ultimatemember_message_count] #

Used for: Show the total unread messages of a specific user.

Example:

[ultimatemember_message_count user_id="123"]

The shortcode attributes:

  • user_id (integer) - the identification number of the user. Required. Default value: current user ID.

[ultimatemember_messages] #

Used for: Show the message box of a specific user.

Example:

[ultimatemember_messages user_id="123"]

The shortcode attributes:

  • user_id (integer) - the identification number of the user - recipient. Required. Default value: current user ID.