Simple:Press Documentation

Plugin: Moderation Email

Plugin Description –

This Simple:Press plugin automatically provides an email to forum users after their posts needing moderation have been approved.

Note:
There are two (2) permissions in the permission sets which determine whether or not posts require moderation. This plugin only sends emails if BOTH the permissions are NOT selected (NOT allowed) for a usergroup within a forum.

  • A permission is NOT selected if there is NOT a green check mark in the check box associated with the permission.

Under the “Moderation” category they are:

  • Can bypass all post moderation.
  • Can bypass first post moderation.

Permission sets are accessed from the forum Admin menu at Forum > Permissions > Manage Permission Sets

  • followed by clicking on the “Edit Permission” button associated with the permission set of interest.

Plugin Overview

  • Provides options for setting up emails to automatically notify forum users that their posts requiring moderation have been approved.
  • Provides a new section in a forum Admin panel to set up the options.
  • Automatically sends an email to the forum users whose posts have been approved from moderation.

Plugin Features

Installing this Simple:Press plugin adds:

  • A new Moderation Email section in the “Available Plugins – Install Simple:Press Plugins” panel under the forum Admin menu path Forum > Plugins > Available Plugins. From this panel the plugin can be activated, or deleted by the Admin.
  • When properly installed, a new folder in the “forum-plugin” folder named “moderation-email” containing the plugin’s files.

Activating this plugin provides:

  • A change to the new Moderation Email section in the “Available Plugins – Install Simple:Press Plugins” panel under the Admin menu path Forum > Plugins > Available Plugins so the Simple:Press plugin can be deactivated, uninstalled, or have its Options set up.
    • The Options link goes to the existing “Options – Email Settings” forum Admin panel having a new “Moderation Emails” section.
    • The “Getting Started” link associated with the “Deactivate/Uninstall/Options” selections should be selected to view the pertinent information regarding the plugin.
  • A new “Moderation Emails” section in the existing “Options – Email Settings” forum Admin panel where the plugin’s option can be set.
    • The “Options – Email Settings” forum admin panel can be accessed from the Forum Admin menu at:
      • Forum > Options > Email Settings
      • Forum > Plugins > Available Plugins > Moderation Email > Options

There are no new permissions added to the permission sets due to this plugin, but this plugin will only have an effect if both forum post moderation bypass permissions are NOT allowed (NOT selected) for a usergroup within a forum.

  • Can bypass all post moderation.
  • Can bypass first post moderation.

Plugin Requirements

Simple:Press version 5.6.7 and above is required.

This plugin must be installed, activated, and its options set before it is operational.

As part of the installation, a “Moderation Email” section is added to the Plugin Management panel under the admin menu Forum > Plugins > Available Plugins. From this panel the plugin can be activated, deactivated, uninstalled, deleted, or its options set using its “Activate/Delete” and “Deactivate/Uninstall/Options” selections.

  • The Options link goes to the existing “Options – Email Settings” forum Admin panel with its new “Moderation Emails” section.

There are no new permissions added to the permission sets due to this plugin, but this plugin will only have an effect if both forum post moderation bypass permissions are NOT allowed (NOT selected) for a usergroup within a forum.

  • Can bypass all post moderation.
  • Can bypass first post moderation.

The plugin does not have template tags so no recommendation regarding Custom or Child Themes is being made.

Plugin Installation and Activation

Please see Using Plugins on how to obtain and install this Simple:Press plugin.

  • Whatever method is used to add the Simple:Press plugin, the folder that should have been added to the forum plugin folder is named “moderation-email“.
  • If using the “Simple:Press Upload Plugin – Upload a Simple:Press Plugin” panel at the forum Admin menu Forum > Plugins > Plugin Uploader, the folder to browse for after downloading it from the Simple:Press site is “moderation-email.zip” before clicking the “Upload Now” button.

As mentioned there the default location for Simple:Press plugin folders is …/wp-content/sp-resources/forum-plugins. If this path is changed, it is important to note that the plugin’s folder and its content need to reside in the forum plugins folder wherever it has been moved and however it has been renamed. See Storage Locations for more information.

Activation is accomplished from the Admin Dashboard panel menu by selecting Forum > Plugins > Available Plugins from the drop down forum Admin menu. On the “Available Plugins – Install Simple:Press Plugins” panel select the Moderation Email plugin and click on “Activate”. The “Activate/Delete” label changes to “Deactivate/Uninstall/Options” with a “Getting Started” Link.

  • The “Getting Started” link associated with the “Deactivate/Uninstall/Options” selections should be selected to view the pertinent information regarding the plugin.

To deactivate the plugin, click on “Deactivate”. The “Deactivate/Uninstall/Options” label changes to “Activate/Delete”.
To re-activated the plugin, click on on “Activate”. The “Activate/Delete” label changes to “Deactivate/Uninstall/Options”.

Plugin Administrative Options

Note:
There are two (2) permissions in the permission sets which determine whether or not posts require moderation. This plugin only sends emails if BOTH the permissions are NOT selected (NOT allowed) for a usergroup within a forum.

  • A permission is NOT selected if there is NOT a green check mark in the check box associated with the permission.

Under the “Moderation” category they are:

  • Can bypass all post moderation.
  • Can bypass first post moderation.

Permission sets are accessed from the forum Admin menu at Forum > Permissions > Manage Permission Sets

  • followed by clicking on the “Edit Permission” button associated with the permission set of interest.

After activation, a) on the aforementioned “Available Plugins – Install Simple:Press Plugins” panel, click “Options” on the Moderation Email plugin section or b) under the Options entry on the forum menu on the left side forum admin page click the Email Settings sub-menu item to get the “Options – Email Settings” Admin panel with the “Moderation Emails” section.

    • Moderation Email Section Set Up

In this section basis moderation email options are set up.

      • Go to the “Moderation Emails” section of the Admin panel.
        • Please click on the section’s “Help” link for more information on this section’s feature(s).
      • Click the check box to the left of “Send Emails to users when their posts are approved from moderation” to select this option
Note:
If it is preferred the standard WordPress email version be used – or if another plugin that is capable of generating the email is being used, then turn the forum option off and the alternative version will be used in it’s place.
        • The check box is selected if it contains a green check mark.
        • Clicking the check box containing a green check mark deselects the check box and removes the green check mark.
Note:
The following keywords can be used as placeholders within the email and will be replaced by their values when the email is sent. It is very important to enter these into the message text exactly as shown:%USERNAME% %BLOGNAME% %SITEURL% %POSTURL% %NEWLINE%

Note the use of %NEWLINE% to end paragraphs.

      • In the text input box to the right of “Email Subject Line:” input the text be used in the email’s subject line.
        • The default is: “Forum Post at %BLOGNAME% Approved”.
      • In the text input box below “Email message (no html):” input the text be used in the email’s message.
Note:
Because emails are sent plain text, HMTL is NOT allowed in the message.
      • The default is: “Congratulations %USERNAME%. Your forum post %POSTURL% made on %POSTDATE% has been approved and is now viewable.”

To be complete for multilingual forums, the language translation files for this plugin should be installed or downloaded/properly placed in the appropriate forum-language folder for SP plugins using one of the procedures below in the “Plugin Language Translation” section of this page.

Plugin Language Translation

A plugin may not have language translation files, but in general each Simple:Press plugin has its own language translation files each with multiple pages for translating the forum plugin’s message strings.

Forum Plugin translation files are to reside in a unique forum folder location as defined by the “Simple:Press Plugin Language Files” entry on the “Integration – Storage Locations” forum Admin panel available through the forum Admin menu at Forum > Integration > Storage Locations.

  • The default location for forum plugin translation files is the folder “…/wp-content/sp-resources/forum-language/sp-plugins”.

Information regarding downloading language files, “mo’ language file placement, and translation (language localization) is found at Localization.

WARNING: On the Localization page, the Language Translation “.mo” Files Overview should be reviewed and well understood for naming convention and language translation file placement.

More information is available regarding translation files at Simple:Press Translations. which is the repository for Simple:Press language translation files. On the base page, select the “Getting Started Guide” link for basics about it’s use. On that page, select the “register a username here” link to obtain a password to the site. Use the “Contact Form” link to request the desired language if it is not currently available. The “Contact Form” link may also be used to volunteer to be a validator for a translation project.

This plugin’s available language translation files with translation statistics, and message translations can be viewed at Moderation Email within the repository for Simple:Press language translation files.

  • Installing this Simple:Press Plugin’s Language Translation “.mo” files
    The plugin’s language translations files for each language can be correctly located in two ways.

    • Using the Admin Word:Press “Site Language” and Simple:Press “Language Translation” Features
      WARNING: On the Localization codex page, the Language Translation “.mo” Files Overview should be reviewed and well understood for naming convention and language translation file placement.
        • Under the “Language Translation Selection Sequences” heading, the “Coordinated Language Translation File Download Using the Simple:Press ‘Language Translation’ Selection” section, follow the instructions at “Adding its Translation File(s) After Downloading/Activating a Simple:Press Theme or Simple:Press Plugin”.
          • Follow the instructions to select the “Site Language” and then get to the admin page with the “Integration – Language Translations” section where there should be an entry for “Moderation Email” along with an “Install” button.
          • Click on the “Install” button for this plugin to install the language translation file for the current “Site Language” language.
            • Note: If the message “No Translation Project Exists” is displayed rather than the “Install” button, a translation file for that language could not be found in GlotPress at this time. Consider posting in the Simple:Press forum if it is felt there needs to be one added.
          • Be sure to verify the locale (filename) for the “.mo” file matches the language code for the language as referenced in the “Warning” above. If it does not, change it to match.
          • As called out in the section, continue to change the “Site Language” language and repeat the process until all desired translation files for this plugin have been installed.

       

    • Manually Finding and Storing Simple:Press Plugin’s Language Translation ‘mo’ files
    • WARNING: On the Localization codex page, the Language Translation “.mo” Files Overview should be reviewed and well understood for naming convention and language translation file placement.
    • After reviewing the material discussed under the “Language Translation Selection Sequences” heading, the “Manual Installation of Simple:Press Language Translation Files section, follow the steps outlined at “Finding and Storing ANY Simple:Press Plugin’s Language Translation ‘mo’ files”.
    • Each time through the process at the step, “Scroll down the list and click on the name of the plugin whose language files are being sought to see the translation file Version Number available”, substitute “Moderation Email” for the phrase “the name of the plugin whose language files are being sought”.
    • Be sure to verify the locale (filename) for the “.mo” file matches the language code for the language as referenced in the “Warning” above. If it does not, change it to match.
    • Repeat the steps for each language it is desired to have a translation file (french, spanish, etc.) for the plugin on the website.

Plugin Special Notes

None

Plugin Usage

Forum Admin or moderators use the plugin to automatically send emails to forum user whose posts have been approved from moderation.

Forum users do not use the plugin directly, but automatically receive emails when their posts have been approved from moderation.

Template Tags Used in the Plugin

There are no Template Tags used in this plugin.

Actions and Hooks Used in the Plugin

There are no Actions and Hooks available in Template Tags for this plugin.

There are no other Actions and Hooks available for this plugin.

Plugin and Template Tag Changelog

Since Simple:Press version 5.6.7

Codex page sync’d to code version 5.6.7 and plugin version 1.0.0.

More Topics In SimplePress: Plugins


Copyright © 2006-2019 Simple:Press. All Rights Reserved.