Personal tools
Namespaces

Variants
Actions

Email Notifications Organizer For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(Created page with "<meta name="keywords" content="client area designer for whmcs, client area designer configuration, whmcs client area designer management, whmcs client area designer installati...")
 
(→‎About Email Notifications Organizer For WHMCS)
(43 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="client area designer for whmcs, client area designer configuration, whmcs client area designer management, whmcs client area designer installation, whmcs client area designer common problems, about whmcs client area designer, whmcs client client area designer documentation, whmcs client area designer faq, whmcs client area designer help, whmcs client area designer guide, whmcs client area designer wiki, whmcs client area designer tutorial, whmcs client area designer tips, whmcs client area designer wiki"></meta>
+
<meta name="keywords" content="email notifications organizer for whmcs, email notifications organizer configuration, whmcs email notifications organizer management, whmcs email notifications organizer installation, whmcs email notifications organizer common problems, about whmcs email notifications organizer, whmcs email notifications organizer documentation, whmcs email notifications organizer faq, whmcs email notifications organizer help, whmcs email notifications organizer guide, whmcs email notifications organizer wiki, whmcs email notifications organizer tutorial, whmcs email notifications organizer tips, whmcs email notifications organizer wiki"></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Client Area Designer For WHMCS Module."></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Client Area Designer For WHMCS Module."></meta>
  
−
=About [https://www.modulesgarden.com/products/whmcs/client-area-designer Client Area Designer For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/email-notifications-organizer Email Notifications Organizer For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Client Area Designer For WHMCS''' will allow you to tailor the view of your entire WHMCS client area.<br/>
+
|style="padding: 10px 0px 10px 0px;"|'''Email Notifications Organizer For WHMCS''' is a simple module designed to reduce the number of email notifications delivered to your clients.<br/> Keep a tight rein on the number of email messages your clients receive regarding domains that are about to expire and invoices with upcoming due date.<br/>
−
The module will let you alter the order and visibility of displayed elements, adjust existing widgets and add new ones, or even create customizable slideshows.<br/>
+
Use this tool to take full control over the consolidate messages management.
−
Additionally, you may set up restrictions rules to show the particular components to selected clients only.
+
 
|}
 
|}
 
<!-- fixed -->
 
<!-- fixed -->
 
*'''Module Features:'''
 
*'''Module Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Customize Your Client Area By Modifying:
+
|style="padding: 10px 0px 0px 30px;"|✔ Combine WHMCS Email Notifications Into Single Messages Including:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Navbar Elements
+
|style="padding: 0px 0px 0px 45px;"|✔ Domains Close To Specified Expiration Date
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Sidebar Elements
+
|style="padding: 0px 0px 0px 45px;"|✔ Unpaid Invoices With Specified Due Date
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Homepage Widgets
+
|style="padding: 0px 0px 0px 30px;"|✔ View Summaries Of Delivered And Blocked Email Notifications For:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Add Your Own Elements And Widgets
+
|style="padding: 0px 0px 0px 45px;"|✔ Today
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Scan Your Client Area In Search Of Custom Elements And Widgets
+
|style="padding: 0px 0px 0px 45px;"|✔ Last Week
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ View And Modify List Of Known Locations In Your Client Area
+
|style="padding: 0px 0px 0px 45px;"|✔ Last Month
 
|}
 
|}
−
*'''Navbar Element Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Define Name
+
|style="padding: 0px 0px 0px 45px;"|✔ Last Year
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define URI
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Domain And Invoice Notifications Settings:
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Icon
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Elements Display
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Visibility For:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Logged In Clients
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Non-Logged In Clients
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ All Clients
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Display Rules:
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Sending Notifications Frequency Details:
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Client Owns Domain
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Client Owns Product
+
|style="padding: 0px 0px 0px 60px;"|✔ Daily
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Client Is In Location
+
|style="padding: 0px 0px 0px 60px;"|✔ Weekly
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Additional Conditions:
+
|style="padding: 0px 0px 0px 60px;"|✔ Monthly
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Active Products/Domains/Addons
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Inactive Products/Domains/Addons
+
|style="padding: 0px 0px 0px 60px;"|✔ In Specified Day Of Month
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Minimum And Maximum Customer Revenue
+
|style="padding: 0px 0px 0px 60px;"|✔ In Specified Day Of Week
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Add Multiple Links To Element
+
|style="padding: 0px 0px 0px 45px;"|✔ Specify Expiration Time Of Domains
 
|}
 
|}
−
 
−
*'''Sidebar Element Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Define Name
+
|style="padding: 0px 0px 0px 45px;"|✔ Specify Maximum Due Date Of Unpaid Invoices
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Icon
+
|style="padding: 0px 0px 0px 45px;"|✔ Select Custom Email Template
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Elements Display
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Visibility For:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Logged In Clients
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Non-Logged In Clients
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ All Clients
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Display Rules:
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Client Owns Domain
+
|style="padding: 0px 0px 0px 30px;"|✔ Select Email Templates To Block And Replace With Configured Notifications
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Client Owns Product
+
|style="padding: 0px 0px 10px 30px;"|✔ View Module Logs
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Client Is In Location
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Additional Conditions:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Active Products/Domains/Addons
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Inactive Products/Domains/Addons
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Minimum And Maximum Customer Revenue
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Add Multiple Links To Element
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Customize Body And Footer Content - Supports HTML, CSS, JavaScript And Smarty
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Add Content Rotator:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Include Multiple Body Contents And Image Items
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Autoplay
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Autoplay Speed
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Dots Display
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Arrows Display
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Infinite Rotation
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 45px;"|✔ Customize HTML Footer
+
 
|}
 
|}
  
−
*'''Homepage Widget Features:'''
 
−
{|
 
−
|style="padding: 10px 0px 0px 30px;"|✔ Define Name
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Icon
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Elements Display
 
−
|} 
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Style Color
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Widget Button
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Add Multiple Links To Element
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Customize Body And Footer Content - Supports HTML, CSS, JavaScript And Smarty
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Add Content Rotator:
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Include Multiple Body Contents And Image Items
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Autoplay
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Autoplay Speed
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Dots Display
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Arrows Display
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Infinite Rotation
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 10px 45px;"|✔ Customize HTML Footer
 
−
|}
 
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Supports Smarty Template Engine
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six" And "Twenty-One"
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 7.2 Up To PHP 7.4
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.9 Back To WHMCS V8.6
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.1 And Later
+
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V12 Or Later
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Easy Module Upgrade To [https://www.modulesgarden.com/products/whmcs/client-area-designer#open-source-version Open Source Version]
+
|style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/email-notifications-organizer#open-source-version Open Source Version]
 
|}
 
|}
  
−
=Installation=
+
=Installation & Configuration=
 
{|
 
{|
−
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/client-area-designer Client Area Designer For WHMCS.]''' <br/>
+
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/email-notifications-organizer Email Notifications Organizer For WHMCS.]''' <br/>
 
We will guide you step by step through the whole installation and configuration process.  
 
We will guide you step by step through the whole installation and configuration process.  
 
|}
 
|}
Line 236: Line 96:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ENO_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''2. Extract the package and upload its content into the main WHMCS directory.<br/>
−
In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.<br/> <!-- If you need a package for the previous versions of PHP, please [https://www.modulesgarden.com/support/ticket/general-support contact our support]. -->
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PHP72_74.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/>
+
−
The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4.<br/>
+
−
'''''Note:''' Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released any more. Find more info [http://php.net/supported-versions.php here].''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_74.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 15px;"|<!-- '' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/client-area-designer#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>'' -->'''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the package and upload its content into the main WHMCS directory.<br/>
+
 
The content of the package to upload should look like this.  
 
The content of the package to upload should look like this.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:etrer.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ENO_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Client Area Designer For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Email Notifications Organizer For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br/>
−
File is located in '' 'modules/addons/ClientAreaDesigner/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
The file is located in '' 'modules/addons/EmailNotificationsOrganizer/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ENO_3.png]]
 
|}
 
|}
 
{|
 
{|
Line 275: Line 117:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ENO_4.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system. '''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''5. Now, set up the '' 'storage' '' folder as recursively writable.'''<br />
−
Log in to your WHMCS admin area. Go to '' 'System Settings' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Client Area Designer' '' and press '' 'Activate' '' button.
+
This folder is available at '' 'your_whmcs/modules/addons/EmailNotificationsOrganizer/'.''  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_5.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ENO_5.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br/>
+
−
To do so, click on '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes'. ''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_6.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Client Area Designer For WHMCS!'''<br/>
+
−
You can access your module under '' 'Addons' '' → '' 'Client Area Designer'.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_7.png]]
+
 
|}
 
|}
  
−
=Configuration and Management=
+
==Configuration of Addon==
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Client Area Designer For WHMCS is a module which allows you to adjust the layout of any panels available on your client area as well as add new widgets.'''<br/>
+
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
−
The module does not require highly advanced configuration.<br/>That is why we will immediately move to the most crucial aspect, which is customizing the panels layout.
+
Log in to your WHMCS admin area. Go to '' 'System Settings' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Product Free Trial Manager' '' and press the '' 'Activate' '' button.
 
|}
 
|}
−
 
−
==Panels==
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Under '' 'Panels' '' tab you will find three sections dedicated to the visibility of different types of panels in your client area.
+
|style="padding: 0px 0px 20px 25px;"|[[File:ENO_6.png]]
−
*Navbars - Management of positions available on the navigation bar in your client area
+
−
*Sidebars - Management of panels available on the left sidebar in your client area
+
−
*Homepage Widgets - Modify and create new widgets available on your home page
+
 
|}
 
|}
−
===Navbars===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|On the first sight you will see two tables, each related to Primary Navbar Left or Right side.<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
−
There are already all the predefined sections outlined with their official names and positions.<br/>
+
To do so, click on the '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes'. ''
−
''Info:
+
−
If you already see that you have more elements than it is visible in the addon, then use '' 'Scanner' '' to search for them.<br/> Read more about scanning option [[#Scanner|here]].''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ENo_7.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Those are the below navbar panels visible in the client area.
+
|style="padding: 0px 0px 15px 15px;"|'''8. Congratulations, you have just successfully installed Email Notifications Organizer For WHMCS!'''<br/>
 +
You can access your module under '' 'Addons' '' → '' 'Email Notifications Organizer'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_9.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ENO_8.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|First of all, you may change the position of the elements.<br/>
+
−
Drag one panel and drop it in the required place.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_10.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Use action buttons to:
+
−
*edit the section
+
−
*delete '''(only custom elements)'''
+
−
*view child elements
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_11.png]]
+
−
|}
+
−
====Edit Element====
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|When you are editing an existing parent element, you may:
+
−
*Name - change existing or provide a new element name.<br/>'' '''Note''' that displayed name in the client area of a '''default''' WHMCS element will still be taken from the chosen client's language file, so you need also to modify it accordingly.''
+
−
*URI - provide a URI
+
−
*Icon - add an icon
+
−
*Display - hide an element
+
−
*Visible - select who it will be visible for: logged in clients, not logged or all clients
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_12.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|You may also provide some display rules. Only the clients who fulfill the rules will see the element.<br/>
+
−
If you leave this part empty, the element will be visible to all clients without limitations.
+
−
*Domains - select the domains which clients must own
+
−
*Products - point the products which clients must own
+
−
*Locations - choose the location which clients must enter<br/>
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_13.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|In the last tab, you can specify what conditions have to be met to display an element.<br/>
+
−
If you leave this part empty, the element will be visible to all clients without limitations.
+
−
*Active - choose which services from at least one of each types customers should have active
+
−
*Inactive - choose which services from at least one of each types customers should have inactive (terminated, cancelled, suspended or expired)
+
−
*Revenue - define the minimum and maximum revenue earned from the customer to display an element<br/>
+
−
Do not forget to save changes after specifying the conditions.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_13_2.png]]
+
 
|}
 
|}
  
−
====New Parent Element====
+
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|It is possible add a completely new parent element either on left or right side.<br/> To do so, press '' 'Add'.''
+
|style="padding: 10px 0px 30px 15px;"|'''Email Notifications Organizer For WHMCS is a module which allows to control the number of email notifications sent from your system and block the outgoing ones.'''<br/>
 +
Read the below guidelines to get clear insight into the module assignments.
 
|}
 
|}
 +
==Addon Management==
 +
===Dashboard===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_14.png]]
+
|style="padding: 10px 0px 30px 15px;"|The very first section includes a short but fully detailed and comprehensive summary of the module actions. Take a look at the tables to check:
 +
* how many email notifications, related to domains, have been successfully delivered in the provided time frames
 +
* the number of email notifications, related to invoices, have been successfully delivered in the provided time frames
 +
* the statistics of email messages blocked by the module
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Then you will have to fill out all the general info, content and display rules.<br/>
+
|style="padding: 0px 0px 30px 25px;"|[[File:ENO_9.png]]
−
Start with '' 'General'.'' Provide:
+
−
*name visible for clients
+
−
*unique for the system identifier
+
−
*URI
+
−
*select icon from available
+
−
*select '' 'Display' '' to make the panel visible
+
−
*finally decide who it will be visible for: logged in clients, not logged in or all clients
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_15.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|If you want only some of the clients to see the panel, then set up the '' 'Display Rules'.''<br/>
+
−
In our case, we decided to select products a client must own to get access to '' 'Support Chat'.''<br/>
+
−
Save changes.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_16.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|This is what our new panel looks like in the client area:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_17.png]]
+
 
|}
 
|}
  
−
====New Child Element====
+
===Settings===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Let's now add one more element to the already existing '' 'Support' '' panel.
+
|style="padding: 10px 0px 15px 15px;"|The '' 'Settings' '' section allows easy configuration of the module behavior. Define settings to compose bundled messages with domain and invoice notifications.<br/>
 +
This is where you may also select which of the currently used email templates shall be blocked and based on them emails seized from being sent.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_18.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ENO_10.png]]
 
|}
 
|}
 +
====Domain Notifications====
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You have to fill out the same data as in case of parent element:<br/>
+
|style="padding: 10px 0px 20px 15px;"|If you wish to combine numerous email notifications informing about domains close to their expiration, here you may set up the rules.<br/>  
−
*name
+
−
*identifier
+
−
*URI
+
−
*icon
+
−
*select '' 'Display' '' to make it visible
+
−
*finally select who it will be visible for: logged in clients, not logged or all clients
+
−
<br/>
+
−
This time we want all the clients to have access to our FAQ site, so we do no set any '' 'Display Rules'. ''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_19.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|As a custom element, you may delete it completely or edit.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_20.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Let's take a look at the new position in the client area:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_21.png]]
+
−
|}
+
  
−
===Sidebar Panels===
+
'''1.''' Select the '''Time Interval''' of sending your bundled emails, choose from the following options:
−
{|
+
*Daily
−
|style="padding: 10px 0px 15px 15px;"|Sidebar panels section refers to the elements located on the left side of your client area.<br/>
+
*Weekly
−
Generally, management of sidebars is very similar to the Navbar panels described in the previous section.
+
*Monthly
−
|}
+
*In Specified Day Of Month
−
{|
+
*In Specified Day Of Week
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_24.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Available actions:
+
−
*change positioning by dragging and dropping elements in the selected place
+
−
*edit the section - change name, icon, content (if possible), display rules and conditions
+
−
*delete elements - this option is available for custom entries only
+
−
*view child elements
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_23.png]]
+
−
|}
+
  
−
====Edit Element====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|'''General''' section:
 
−
*provide a new display name
 
−
*add icon
 
−
*hide/show the element
 
−
*change visibility
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_25.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|'''Content:'''
 
−
You can add two types of content - ''HTML'' and ''Content Rotator''.<br/>
 
−
'' Note that it is possible only if the element has no child elements.''
 
−
*''HTML'' - simply change the ''Body'' or ''Footer'' content.<br/>
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_26.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|
 
−
*''Content Rotator'' - define how many elements can rotate within specified time intervals and choose the panel navigation elements.<br/>
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_26_2.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Here is an example of a simple effect that you can achieve with the content rotator.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_26_3.gif]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|'''Display Rules''' - only clients who fulfill the rules will see the element.<br/>
 
−
If you leave this part empty, the element will be visible for all clients without limitations.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_27.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|'''Conditions''' - specify what conditions have be met to display an element.<br/>
 
−
If you leave this part empty, the element will be visible to all clients without limitations.
 
−
*Active - choose which services from at least one of each types customers should have active
 
−
*Inactive - choose which services from at least one of each types customers should have inactive (terminated, cancelled, suspended or expired)
 
−
*Revenue - define the minimum and maximum revenue earned from the customers to display an element<br/>
 
−
Do not forget to save changes after specifying the conditions.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_27_2.png]]
 
−
|}
 
  
−
====New Parent Element====
+
'''2.''' Next, in the ''' 'Frequency' ''' field enter the number that will specify the frequency of sent notifications.<br/> For example, enter "2" to send the email:
−
{|
+
* every two days (for '' 'Daily' '' time interval)
−
|style="padding: 10px 0px 15px 15px;"|You may add a completely new parent element either on left or right side.<br/>Press '' 'Add'.''  
+
* every two months (for '' 'Monthly' '' time interval)
−
|}
+
* on the second day of every month (for '' 'Day Of Month' '' time interval), etc
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_28.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Then you will have to fill out all the general info, content and display rules.<br/>
+
−
Start with '' 'General'.'' Provide:
+
−
*name visible for clients
+
−
*unique for the system identifier
+
−
*select icon from available
+
−
*select '' 'Display' '' to make the panel visible
+
−
*finally decide who it should be visible for: logged in clients, not logged in or all
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_29.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Select content ''Type'' and define ''Body'' and ''Footer'' content.<br/>
+
−
''Note: If you provide the content here, you will not be able to add child elements to this item.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_30.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|If you want only the specified clients to see the panel, set up the '' 'Display Rules' '' or '' 'Conditions' ''.<br/>
+
−
Save changes.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_31.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|This is what our new panel looks like in the client area:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_32.png]]
+
−
|}
+
  
−
====New Child Element====
 
−
{|
 
−
|style="padding: 10px 0px 20px 15px;"|Let's now add one child element to client's '' 'Shortcuts'.''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_33.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Fill out all the required data to crate a correct link:<br/>
 
−
*name
 
−
*identifier
 
−
*URI
 
−
*icon
 
−
*select '' 'Display' ''
 
−
*define visibility
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_34.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Any custom element can be deleted. In contrast to the default ones which may be only edited and hidden.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_35.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Now, you see an additional link under '' 'Shortcuts'.''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_36.png]]
 
−
|}
 
  
−
===Homepage Widgets===
+
'''3. 'Include Domains Expiring Within X Days' ''' - enter here a number that will stand for the '''X''' number of days.<br/> Information on domains that are expected to expire within that number of days will be included in the email notification.  
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|The last type of panels are homepage widgets.<br/>
+
−
Available actions:
+
−
*change positioning by dragging and dropping elements in the selected place
+
−
*edit the widget
+
−
*view child elements if there are any
+
−
*delete custom widgets
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_37.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|To visualize, these are the client area widgets we are going to alter in a moment:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_38.png]]
+
−
|}
+
  
−
====Edit widget====
+
 
−
{|
+
'''4. 'Email Template' ''' - select one of the available email templates, it will be used to remind clients about their domains that are about to expire soon.<br/> You may use a predefined module template called: '' 'Multiple Domains Notification' '' or any other customized for your needs template. <br/> Move to the [[#Email_Notifications|Email Notifications]] section to learn more about the module email templates.
−
|style="padding: 10px 0px 15px 15px;"|'''General:'''
+
−
*provide a new display name
+
−
*change icon
+
−
*hide the element
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_39.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ENO_11.png]]
 
|}
 
|}
 +
====Invoice Notifications====
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Under '' 'Content' '' section you can overwrite the default text.<br/>
+
|style="padding: 10px 0px 20px 15px;"|Alike the above described Domain Notifications, set up here the rules of sending bundled email notifications informing about invoices which due date is coming closer.<br/>  
−
We will leave it empty as we do not want to change the content, just the look and feel of the widget.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_39_1.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''Extras''' - here you can change the visual parts:
+
−
*widget color
+
−
*button name, URI and icon
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_40.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|That is what our adjusted widget looks like now:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_41.png]]
+
−
|}
+
  
−
====Add New Widget====
+
'''1.''' Select the '''Time Interval''' of sending your bundled emails, choose from the following options:
−
{|
+
*Daily
−
|style="padding: 10px 0px 15px 15px;"|For presentation purposes, we will create now a completely new widget.<br/>It will include a button redirection to our Knowledgebase and two links to FAQ and Upload Files form.<br/>
+
*Weekly
−
To start, simply press '' 'Add' '' button.
+
*Monthly
−
|}
+
*In Specified Day Of Month
−
{|
+
*In Specified Day Of Week
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_42.png]]
+
 
−
|}
+
 
−
{|
+
'''2.''' Next, in the ''' 'Frequency' ''' field enter the number that will specify the frequency of sent notifications.<br/> For example, enter "2" to send the email:
−
|style="padding: 0px 0px 15px 15px;"|Then fill out all the general info, content and extras.<br/>
+
* every two days (for '' 'Daily' '' time interval)
−
Start with '' 'General','' provide:
+
* every two months (for '' 'Monthly' '' time interval)
−
*widget name
+
* on the second day of every month (for '' 'Day Of Month' '' time interval), etc
−
*unique for the system identifier
+
 
−
*select icon from available
+
 
−
*finally select '' 'Display' '' to make the panel visible
+
'''3. 'Include  Invoices With Due Date Within X Days' ''' - enter here a number that will stand for the '''X''' number of days.<br/> Information on invoices which due date is within that number of days will be included in the email notification.  
−
|}
+
 
−
{|
+
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_43.png]]
+
'''4. 'Email Template' ''' - select one of the available email templates, it will be used to remind clients about the incoming due date of their invoices.<br/> You may use a predefined module template called: '' 'Multiple Invoices Notification' '' or any other customized for your needs template. <br/> Move to the [[#Email_Notifications|Email Notifications]] section to learn more about the module email templates.
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|As we are going to add two links inside the widget, so we have to skip this section.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_44.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Finally, customize your widget by defining color and button details.
+
−
Save changes.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_45.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ENO_12.png]]
 
|}
 
|}
  
−
====New Child Widget====
+
====Blocked Email Templates====
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Let's now add a child element to the just created '' 'Knowledgebase'.''
+
|style="padding: 10px 0px 15px 15px;"|Select here all the email templates that you wish to stop from being individually sent to your clients. They will be replaced with the module pre-configured multiple notifications.<br/>
 +
Please do not forget to press the '' 'Save Changes' '' button when you are ready with your configuration.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_46.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ENO_13.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Fill out the required data:<br/>
+
−
*name
+
−
*identifier
+
−
*URI
+
−
*icon
+
−
*select '' 'Display' ''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_47.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|As you can see, we added two new entries under the '' 'Knowledgebase' '' widget.<br/>
+
−
Surely, you can edit each one of them or delete.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_48.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Here is a final view of our customized client area with new elements:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_49.png]]
+
 
|}
 
|}
  
−
==Locations==
+
===Logs===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In this you will find an extended list of all standard locations in your client area with its common name and URI.<br/>
+
|style="padding: 10px 0px 20px 15px;"|All the information about attempts, bot the successful and unsuccessful ones, are logged in the module '' 'Logs' '' section.
−
These locations are searched through by the module scanner in search of custom panels and are available in the '' 'Locations' '' field when setting up '' 'Display Rules'. ''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_50.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Press the button with pencil icon next to the location you are interested in editing.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_51.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|There you can edit the name of existing location and its URI.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_52.png]]
+
−
|}
+
−
===New Location===
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|You may also add new if you have some custom locations and you wish to use them in our module.<br/>
+
−
Please note that your locations have to be manageable by WHMCS.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_53.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Provide a location name and URI.<br/>
+
−
When ready, your new location will be from now on used by Client Area Designer module.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_54.png]]
+
−
|}
+
  
−
==Scanner==
+
* Find here entries on:
−
{|
+
** domains related notifications
−
|style="padding: 10px 0px 15px 15px;"|Scanner is a tool that allows our module to carefully browse through a chosen client's client area in search of any elements in known locations.<br/>
+
** invoices related notifications
−
Select a client to log in as one and run the scanner.
+
** blocked messages with specified email template name that was to be used
 +
* Check the action type: '' 'Success', 'Info', 'Error' ''
 +
* Check the action date and hour
 +
* Delete single logs or use mass action to delete numerous entries at once
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_59.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ENO_14.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|You will see a preview of all locations. When the scan is finished, you will see a summary with the number of found panels.<br/> All newly found elements will be automatically added to proper positions in the addon.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_60.png]]
+
 
|}
 
|}
  
−
==Documentation==
+
===Documentation===
 
{|
 
{|
 
|style="padding: 10px 0px 20px 15px;"|The last position in your navigation menu, when pressed, redirects to the article you are currently reading.
 
|style="padding: 10px 0px 20px 15px;"|The last position in your navigation menu, when pressed, redirects to the article you are currently reading.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_55.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ENO_15.png]]
 
|}
 
|}
−
==Smarty Tags==
+
 
 +
==Email Notifications==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Starting with the 1.1.0 version, the module allows you to use ''[https://www.smarty.net/ Smarty]'' tags in HTML content.<br/>
+
|style="padding: 10px 0px 15px 15px;"|The email notifications setup and sent to clients by the module can be found at '' 'System Settings' → 'Email Templates' → 'Domain Messages'.'' <br/> Open your email template to check what data exactly will be sent to clients, surely you may alter the message content according to your needs. <br/>
−
For example, if you use ''{$client.firstname}'', ''{$client.lastname}'' and ''{$client.credit}'' in the following code:
+
'''''Note:''' Please bear in mind that '''no attachments''' are sent altogether the email message in contrary to the replaced WHMCS invoice notifications.''
−
<pre>Hello <b>{$client.firstname} {$client.lastname}!</b><br/><br/>
+
−
You still have <b>${$client.credit}</b> funds on your account.<br/>
+
−
Find out what you can do with them!
+
−
<br/></pre>
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_57.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ENO_16.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|The result will be as follows:
+
|style="padding: 0px 0px 20px 25px;"|[[File:ENO_17.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_58.png]]
+
|style="padding: 0px 0px 20px 15px;"|That is how the exemplary email messages regarding the unpaid invoices and domains about to expire might look like once delivered and opened by the client.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You can, of course, use the full scope of ''Smarty'' tags, such as [https://www.smarty.net/docsv2/en/language.function.if.tpl conditional instructions]:
+
|style="padding: 0px 0px 20px 25px;"|[[File:ENO_18.png]]
−
<pre>
+
−
Hello <b>{$client.firstname} {$client.lastname}!</b><br/><br/>
+
−
{if $client.credit gt 0}
+
−
You still have <b>${$client.credit}</b> funds on your account. <br/>
+
−
Find out what you can do with them!<br/>
+
−
{else}Sorry you have no funds!<br/>
+
−
{/if}
+
−
</pre>
+
−
In this example, if the customer does not have any credit, he will see something like this:
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_58_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ENO_19.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Of course, this is just a very simple example that will only work for the clients who are logged in. In order to build more advanced elements, please check out the [https://www.smarty.net/documentation Smarty documentation].<br/>
+
−
'' '''Note:''' Remember that the incorrect use of ''Smarty'' tags may lead to a website not operating properly.''<br/>
+
−
If you need to use a more advanced code using ''{php}'' tags, make sure that you have enabled the relevant option in the '' 'General Settings' '' → '' 'Security' ''.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_56.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 15px;"|For example, you can list all of the template variables using:
+
−
<pre><pre>{php}print_r($template->getTemplateVars());{/php}</pre>
+
 
|}
 
|}
  
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 15px;"|1. When you are adding a new element into your client area, you may add the langs used in the lang file to enable translations and changes.<br/>
+
|style="padding: 10px 0px 30px 15px;"|1. The '''Email Notifications Organizer''' module uses the standard WHMCS daily cron job. You do not need to set up any other crons to take all the advantages of the module options.
−
To do so:<br/>
+
−
*open your english.php file
+
−
*type in a new line in format:
+
−
$_LANG['element name'] = 'Element Name';
+
−
*to change/translate it, simply change the content after the '' '=' '' sign.
+
 
|}
 
|}
−
{|
+
<!--
−
|style="padding: 0px 0px 30px 15px;"|2. Client Area Designer module supports only WHMCS template Six and any custom modification that is based on this template and has been customized according to this  [https://developers.whmcs.com/themes/ documentation]. 
+
−
|}
+
−
 
+
 
=Update Instructions=
 
=Update Instructions=
 
{|
 
{|
Line 829: Line 293:
 
To take advantage of it, simply use the '''License Upgrade''' button located on the product's page and a discounted invoice will be generated automatically.<br/>
 
To take advantage of it, simply use the '''License Upgrade''' button located on the product's page and a discounted invoice will be generated automatically.<br/>
 
|}
 
|}
 +
-->
 +
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|

Revision as of 08:57, 23 February 2024

Contents

About Email Notifications Organizer For WHMCS

Email Notifications Organizer For WHMCS is a simple module designed to reduce the number of email notifications delivered to your clients.
Keep a tight rein on the number of email messages your clients receive regarding domains that are about to expire and invoices with upcoming due date.

Use this tool to take full control over the consolidate messages management.

  • Module Features:
✔ Combine WHMCS Email Notifications Into Single Messages Including:
✔ Domains Close To Specified Expiration Date
✔ Unpaid Invoices With Specified Due Date
✔ View Summaries Of Delivered And Blocked Email Notifications For:
✔ Today
✔ Last Week
✔ Last Month
✔ Last Year
✔ Configure Domain And Invoice Notifications Settings:
✔ Define Sending Notifications Frequency Details:
✔ Daily
✔ Weekly
✔ Monthly
✔ In Specified Day Of Month
✔ In Specified Day Of Week
✔ Specify Expiration Time Of Domains
✔ Specify Maximum Due Date Of Unpaid Invoices
✔ Select Custom Email Template
✔ Select Email Templates To Block And Replace With Configured Notifications
✔ View Module Logs
  • General Info:
✔ Multi-Language Support
✔ Supports PHP 8.1 Back To PHP 7.4
✔ Supports WHMCS V8.9 Back To WHMCS V8.6
✔ Requires ionCube Loader V12 Or Later
✔ Easy Module Upgrade To Open Source Version

Installation & Configuration

This tutorial will show you how to successfully install and configure Email Notifications Organizer For WHMCS.

We will guide you step by step through the whole installation and configuration process.

1. Log in to our client area and download the module.
ENO 1.png
2. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

ENO 2.png
4. When you install Email Notifications Organizer For WHMCS for the first time you have to rename 'license_RENAME.php' file.

The file is located in 'modules/addons/EmailNotificationsOrganizer/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

ENO 3.png
5. In order to configure your license key, you have to edit the previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.

ENO 4.png
5. Now, set up the 'storage' folder as recursively writable.

This folder is available at 'your_whmcs/modules/addons/EmailNotificationsOrganizer/'.

ENO 5.png

Configuration of Addon

6. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'System Settings' → 'Addon Modules'. Afterwards, find 'Product Free Trial Manager' and press the 'Activate' button.

ENO 6.png
7. In the next step you need to permit access to this module.

To do so, click on the 'Configure' button, tick 'Full Administrator' and press 'Save Changes'.

ENo 7.png
8. Congratulations, you have just successfully installed Email Notifications Organizer For WHMCS!

You can access your module under 'Addons' → 'Email Notifications Organizer'.

ENO 8.png

Management

Email Notifications Organizer For WHMCS is a module which allows to control the number of email notifications sent from your system and block the outgoing ones.

Read the below guidelines to get clear insight into the module assignments.

Addon Management

Dashboard

The very first section includes a short but fully detailed and comprehensive summary of the module actions. Take a look at the tables to check:
  • how many email notifications, related to domains, have been successfully delivered in the provided time frames
  • the number of email notifications, related to invoices, have been successfully delivered in the provided time frames
  • the statistics of email messages blocked by the module
ENO 9.png

Settings

The 'Settings' section allows easy configuration of the module behavior. Define settings to compose bundled messages with domain and invoice notifications.

This is where you may also select which of the currently used email templates shall be blocked and based on them emails seized from being sent.

ENO 10.png

Domain Notifications

If you wish to combine numerous email notifications informing about domains close to their expiration, here you may set up the rules.

1. Select the Time Interval of sending your bundled emails, choose from the following options:

  • Daily
  • Weekly
  • Monthly
  • In Specified Day Of Month
  • In Specified Day Of Week


2. Next, in the 'Frequency' field enter the number that will specify the frequency of sent notifications.
For example, enter "2" to send the email:

  • every two days (for 'Daily' time interval)
  • every two months (for 'Monthly' time interval)
  • on the second day of every month (for 'Day Of Month' time interval), etc


3. 'Include Domains Expiring Within X Days' - enter here a number that will stand for the X number of days.
Information on domains that are expected to expire within that number of days will be included in the email notification.


4. 'Email Template' - select one of the available email templates, it will be used to remind clients about their domains that are about to expire soon.
You may use a predefined module template called: 'Multiple Domains Notification' or any other customized for your needs template.
Move to the Email Notifications section to learn more about the module email templates.

ENO 11.png

Invoice Notifications

Alike the above described Domain Notifications, set up here the rules of sending bundled email notifications informing about invoices which due date is coming closer.

1. Select the Time Interval of sending your bundled emails, choose from the following options:

  • Daily
  • Weekly
  • Monthly
  • In Specified Day Of Month
  • In Specified Day Of Week


2. Next, in the 'Frequency' field enter the number that will specify the frequency of sent notifications.
For example, enter "2" to send the email:

  • every two days (for 'Daily' time interval)
  • every two months (for 'Monthly' time interval)
  • on the second day of every month (for 'Day Of Month' time interval), etc


3. 'Include Invoices With Due Date Within X Days' - enter here a number that will stand for the X number of days.
Information on invoices which due date is within that number of days will be included in the email notification.


4. 'Email Template' - select one of the available email templates, it will be used to remind clients about the incoming due date of their invoices.
You may use a predefined module template called: 'Multiple Invoices Notification' or any other customized for your needs template.
Move to the Email Notifications section to learn more about the module email templates.

ENO 12.png

Blocked Email Templates

Select here all the email templates that you wish to stop from being individually sent to your clients. They will be replaced with the module pre-configured multiple notifications.

Please do not forget to press the 'Save Changes' button when you are ready with your configuration.

ENO 13.png

Logs

All the information about attempts, bot the successful and unsuccessful ones, are logged in the module 'Logs' section.
  • Find here entries on:
    • domains related notifications
    • invoices related notifications
    • blocked messages with specified email template name that was to be used
  • Check the action type: 'Success', 'Info', 'Error'
  • Check the action date and hour
  • Delete single logs or use mass action to delete numerous entries at once
ENO 14.png

Documentation

The last position in your navigation menu, when pressed, redirects to the article you are currently reading.
ENO 15.png

Email Notifications

The email notifications setup and sent to clients by the module can be found at 'System Settings' → 'Email Templates' → 'Domain Messages'.
Open your email template to check what data exactly will be sent to clients, surely you may alter the message content according to your needs.

Note: Please bear in mind that no attachments are sent altogether the email message in contrary to the replaced WHMCS invoice notifications.

ENO 16.png
ENO 17.png
That is how the exemplary email messages regarding the unpaid invoices and domains about to expire might look like once delivered and opened by the client.
ENO 18.png
ENO 19.png

Tips

1. The Email Notifications Organizer module uses the standard WHMCS daily cron job. You do not need to set up any other crons to take all the advantages of the module options.

Common Problems

1. In case of connection problems, please check whether your SELinux or firewall does not block ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Email_Notifications_Organizer_For_WHMCS&oldid=65221"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Email Notifications Organizer For WHMCS