Unsubscribe Email Plugin

Document created by Ryan Rutan on Mar 17, 2012Last modified by max.calderon on Dec 16, 2013
Version 12Show Document
  • View in full screen mode


Adds the ability for users to unsubscribe their email notifications from a Jive powered community without having to log in.


Official plugin of The specified item was not found.


Plugin Support

This plugin IS NOT supported by Jive, and use of this plugin should be done at the user's discretion, or as advised by their Jive Support representative.

Copyright and License

Copyright 2012 Ryan Rutan under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License athttp://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License


  • When verified, this plugin will disable all email preferences for the verified user.  If enabled, it will also disable the account per the user's request.  (see Optional Configurations below)


Optional Configurations

  • Plugin Installs via the Admin Console (Restart Required to take affect)
  • System Admin configuration screen available under System > Settings > Configure Unsubscribe Plugin
    • Global Enable/Disable (default: enabled) - Standard kill switch
    • Allow Disable Account (default: false) - Offers option to end-users to "abandon" account permanently.
    • Reset Interval (default: 30000 ms, a.k.a. 5 min) - Minimum time between unsubscribe requests
  • Customizing Unsubscribe Experience
    • The Unsubscribe experience text can be completely customized via the Theme Manager in the Admin Console.
      • See FAQ (below) for sample instructions
    • The following token keys can be used to customize the Unsubscribe UI:
      • unsubscribe.action.title - header title
      • unsubscribe.action.description - header text below title
      • unsubscribe.action.verify.lbl - verify button label
      • unsubscribe.action.verify.description - verify help text (below email)
      • unsubscribe.action.confirmationCode.lbl - confirmation code label
      • unsubscribe.action.confirmationCode.description - confirmation code help text (below confirmation code)
      • unsubscribe.action.abandonAccount.lbl - abandon account label
      • unsubscribe.action.abandonAccount.description - abandon account help text (below abandon account)
      • unsubscribe.action.abandonAccount.confirm.msg - javascript confirmation message
      • unsubscribe.action.unsubscribe.lbl - unsubscribe button label
      • unsubscribe.action.msg.successfulUnsubscribe - Successful Unsubscription Message
      • unsubscribe.action.msg.successfullyAbandonedAccount - Successful Abandon Account Message
      • unsubscribe.action.msg.verificationEmailSent - Verification Email Sent Message
      • unsubscribe.action.error.unsubscribeEmailMismatch - Logged in User and Email provided do not match
      • unsubscribe.action.error.resetIntervalProtection - Unsubscribe in progress Message
      • unsubscribe.action.error.invalidUserVerificationCode  - Invalid Verification Code Message
    • In addition to customizing the UI, you can customize the verification email content.  To do so, go to:
      Admin Console  > System > Settings > Message Templates > Unsubscribe (Plugin) - Email Verification
  • To include this link at the bottom of your emails, you can edit any of the out-of-the-box message templates, such as:
    • Admin Console  > System > Settings > Message Templates >Email Digest (Daily, SemiWeekly, Weekly)
    • Note: You can also link straight to the URL from a relevant point in your navigation, perhaps with QuickTemplates - Plugin




Unsubscribe UI


Sample Verification Email:



Known Issues

  • 03/19/2012 - Released an untested version for 4.5.x for iterative development.  Once confirmed, this message will be removed.



  • How do I change the label for the Links drop down?
    • Go to the Theme Manager in the Admin Console > System > Settings > Themes
    • Click on your Global Theme (Edit Icon)
    • Towards the bottom, look for Phrase Substitutions and click Edit Rules
    • Select the locale (top), and then click Add Rule (bottom)
    • In this example, we are renaming it to "Favorites"



  • - March 17th, 2012
    • Verification Email Confirmation Process
    • Reset / Disable Notification Preferences
    • Disable Account upon User Request (configurable)


Next Features

  • Undetermined.


Please vote on this idea if you like this plugin, or even the concept:

Feature Discussion: Help people unsubscribe easier