Personal tools
Namespaces

Variants
Actions

Emoji Picker For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Common Problems)
(→‎About Emoji Picker For WHMCS)
 
(59 intermediate revisions by 7 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="emoji for whmcs, whmcs emoji configuration, whmcs emoji management, whmcs emoji installation, whmcs emoji common problems, about whmcs emoji, whmcs emoji documentation, whmcs emoji faq, whmcs emoji help, whmcs emoji guide, whmcs emoji wiki, whmcs emoji tutorial, whmcs emoji tips, whmcs emoji wiki, emoticons for whmcs, whmcs emoticons configuration, whmcs emoticons management, whmcs emoticons installation, whmcs emoticons common problems, about whmcs emoticons, whmcs emoticons documentation, whmcs emoticons faq, whmcs emoticons help, whmcs emoticons guide, whmcs emoticons wiki, whmcs emoticons tutorial, whmcs emoticons tips, whmcs emoticons wiki"></meta>
+
<meta name="keywords" content="emoji picker for whmcs, whmcs emoji picker configuration, whmcs emoji picker management, whmcs emoji picker installation, whmcs emoji picker common problems, about whmcs emoji picker, whmcs emoji picker documentation, whmcs emoji picker faq, whmcs emoji picker help, whmcs emoji picker guide, whmcs emoji picker wiki, whmcs emoji picker tutorial, whmcs emoji picker tips, emoticons for whmcs, whmcs emoticons configuration, whmcs emoticons management, whmcs emoticons installation, emoji whmcs, emoji whmcs, emoticon whmcs, EmojiOne, JoyPixels"></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Emoji Picker For WHMCS Module."></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Emoji Picker For WHMCS Module."></meta>
  
 
=About [https://www.modulesgarden.com/products/whmcs/emoji-picker Emoji Picker For WHMCS]=
 
=About [https://www.modulesgarden.com/products/whmcs/emoji-picker Emoji Picker For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 0px;"|'''Emoji Picker For WHMCS''' xxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxx<br/> xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxx
+
|style="padding: 10px 0px 5px 0px;"|'''Emoji Picker For WHMCS''' will let both your clients and support teams add emojis to ticket conversations.<br />
 +
You will be empowered to choose support departments that should display emojis and decide whether these symbols shall be visible in the admin area.<br />
 +
The module also provides support for emoji domains, allowing conversion of your clients' domain names from a Punycode format to emoji artworks.
 
|}
 
|}
 
*'''Client Area Features:'''
 
*'''Client Area Features:'''
Line 40: Line 42:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Emoji Visibility In Admin Area  
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Emoji Search Picker In Text Area
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Emoji Search Picker In Toolbar
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Emoji Visibility In Admin Area
 
|}
 
|}
 
{|
 
{|
Line 53: Line 61:
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Converting Of Punycode To Emoji Domains
 
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Converting Of Punycode To Emoji Domains
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Specify Number Of Characters For Popup Display
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Use Unicode Or Image Type Of Emojis In Emails
 
|}
 
|}
 
{|
 
{|
Line 60: Line 74:
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Supports Emoji Artworks Provided By [https://www.emojione.com/ EmojiOne]
+
|style="padding: 10px 0px 0px 30px;"|✔ Supports Emoji Artworks Provided By [https://www.joypixels.com// JoyPixels]
 
|}
 
|}
 
{|
 
{|
Line 69: Line 83:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Six
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six" And "Twenty-One"
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7.2 And Later
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.10 Back To WHMCS V8.6
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V12 Or Later
 +
|}
 +
{|
 +
|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/emoji-picker#open-source-version Open Source Version]
 
|}
 
|}
  
 
=Installation and Configuration=
 
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure Emoji Picker 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/emoji-picker Emoji Picker 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 91: Line 111:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
−
'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' › 'System' › 'PHP Info'.'''
+
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:PHP56_72.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP72_74.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/>
−
The content of PHP version files should look like this.  
+
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/emoji-picker#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.
 
|}
 
|}
 
{|
 
{|
Line 105: Line 136:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Emoji Picker 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 Emoji Picker For WHMCS for the first time, you have to rename the '' 'license_RENAME.php' '' file.'''<br />
−
File is located in '' 'yourWHMCS/modules/addons/Emoji/license_RENAME.php'.'' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
This file is located in '' 'yourWHMCS/modules/addons/Emoji/license_RENAME.php'.'' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 
|}
 
|}
 
{|
 
{|
Line 113: Line 144:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit the previously renamed '' 'license.php' file. '' '''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit the previously renamed '' 'license.php' file. '' '''<br />
−
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'. ''  
+
Enter your license key between the quotation marks as presented on the following screen. You can find your license key in our client area → '' 'My Products'. ''  
 
|}
 
|}
 
{|
 
{|
Line 130: Line 161:
 
|style="padding: 10px 0px 15px 15px;"|'''7. Now, you have to activate the module in your WHMCS system.'''<br />
 
|style="padding: 10px 0px 15px 15px;"|'''7. Now, you have to activate the module in your WHMCS system.'''<br />
 
Log in to your WHMCS admin area and proceed to '' 'Setup' '' → '' 'Addon Modules'. ''<br />
 
Log in to your WHMCS admin area and proceed to '' 'Setup' '' → '' 'Addon Modules'. ''<br />
−
Afterward, find '' 'Emoji Picker' '' and press '' 'Activate' '' button.
+
Afterward, find '' 'Emoji Picker' '' and press the '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
Line 143: Line 174:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|'''9. You have just successfully installed Emoji Picker For WHMCS!'''
+
|style="padding: 0px 0px 30px 15px;"|'''9. Congratulations, you have just successfully installed Emoji Picker For WHMCS!'''
 
|}
 
|}
  
 
==Configuration==
 
==Configuration==
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Now you have to configure your newly installed module.'''<br/>
+
|style="padding: 10px 0px 30px 15px;"|'''Now you need to configure your newly installed module.'''<br/>
 
|}
 
|}
 
===Settings===
 
===Settings===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Proceed to '' 'Addons' → 'Emoji' → 'Settings', '' here you have to configure the following:
+
|style="padding: 10px 0px 15px 15px;"|Proceed to '' 'Addons' → 'Emoji' → 'Settings' '' to configure the following options:
  
−
* '''Support Department Settings''' - choose for which of your supports departments the emojis will be available to use by your clients.<br/>Your clients can use them when creating or replying tickets as well as view emojis in email notifications.<br/>''Note that you can also change multiple departments status by using mass actions as well.''
+
* '''Support Department Settings''' - choose which of your support departments will display emojis.<br/> Your clients will be able to use emojis while creating or replying in tickets, as well as view emojis in email notifications.<br/>''Note that you can change the status of multiple departments at once by using mass actions.''
  
−
* '''Emoji In Admin Area''' - toggle if you want the administrators to also view and use emojis when creating and replying to tickets.<br/>Otherwise the emojis will be visible only to the clients, and in the admin area they will be visible only in the form of emoji codes.<br/>''Note that your support can still type emoji codes from memory which will continue to be visible as artworks for your clients.
+
* '''Emoji Search Picker In Text Area''' - if enabled, the emoji popup will be displayed when entering the emoji code in the ticket.
  
−
* '''Replace Domains With Emoji''' - toggle if you want have [https://en.wikipedia.org/wiki/Emoji_domain emoji domains] support.<br/>This will allow your clients view already provided domains in [https://en.wikipedia.org/wiki/Punycode Punycode] format (''for example www.xn--qei8618mfvb.tld'') with [https://unicode.org/emoji/charts/emoji-list.html unicode emoji] (''for example www.''❤🍺😉''.tld'') in their client area<br/>''Note that this will also convert Punycode to the unicode emoji on the related domains emails as well as on their HTML invoices.''
+
* '''Emoji Search Picker In Toolbar ''' - if enabled, the button with emoji search picker will be displayed in the ticket editor toolbar.
 +
 
 +
* '''Emoji In Admin Area''' - toggle on if you want the administrators to view and use emojis when creating and replying to tickets.<br/>If disabled, they will be visible in the admin area only in the form of emoji codes.<br/>''Note that your support can still type remembered emoji codes which will continue to be visible as artworks for your clients.
 +
 
 +
* '''Replace Domains With Emoji''' - toggle on if you want to have support for [https://en.wikipedia.org/wiki/Emoji_domain emoji domains].<br/>This will allow your clients to view already provided domains in [https://en.wikipedia.org/wiki/Punycode Punycode] format (''for example www.xn--qei8618mfvb.tld'') with [https://unicode.org/emoji/charts/emoji-list.html unicode emoji] (''for example www.''❤🍺😉''.tld'') in your client area<br/>''Note that this will also convert Punycode to the unicode emoji in the domain-related emails as well as on the HTML invoices.''
 +
 
 +
* ''' Characters Number For Popup Display''' - specify the minimum number of characters that are required after the colon in order to display the emoji popup.<br/>E.g. if set to '' '0', '' emoji picker will be displayed immediately after entering the colon character. For '' '1', '' only first emoji character will have to be entered after the colon etc.<br/>''Note that the 'Emoji Search Picker In Text Area' option must be enabled for emoji popup to work.''
 +
 
 +
* ''' Emoji Conversion Type In Email''' - specify whether to use Unicode or Image type emojis in email messages<br/>e.g. if '' 'Images' '' selected, emoji picker will be converted into an image in an eamil message. If '' 'Unicode', ''has been selected the emoij will be converted and dispalyed as such in an email message.
 
|}
 
|}
 
{|
 
{|
Line 166: Line 205:
 
===Logs===
 
===Logs===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In logs you can view for which orders of domains, invoices or email massages the emojis have been successfully applied or if any errors occurred.
+
|style="padding: 10px 0px 20px 15px;"|The logs provide data about particular domain orders, invoices or email massages to which emojis have been successfully applied. The section also includes information concerning any existing errors.
 
|}
 
|}
 
{|
 
{|
Line 174: Line 213:
 
=Management=
 
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Once Emoji Picker For WHMCS is installed and configured, you can use emoji in tickets as well as view them in domains instead in Punycode format.'''<br/>
+
|style="padding: 10px 0px 30px 15px;"|'''Once Emoji Picker For WHMCS is installed and configured, you can use emoji in tickets as well as view them in domain names instead of a Punycode format.'''<br/>
 
|}
 
|}
 
==Support Tickets==
 
==Support Tickets==
 
===Client Area===
 
===Client Area===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Once you are in client area, you can open a ticket in one of your departments where you enabled emoji support.
+
|style="padding: 10px 0px 20px 15px;"|In the client area, you can use emojis in tickets submitted in any of support departments with enabled emoji support.
 
|}
 
|}
 
{|
 
{|
Line 185: Line 224:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|When you start composing a message you can insert emoji by pressing ''':''' (colon).<br/>This will start showing the list of available emojis. Continue typing the name to search for available emoji.<br/>When ready, click on the chosen emoji to insert it or finish its name using ''':''' (colon) again.
+
|style="padding: 0px 0px 15px 15px;"|When you compose a message and the '' 'Emoji Search Picker In Text Area' '' option is enabled in [https://www.docs.modulesgarden.com/Emoji_Picker_For_WHMCS#Settings settings], you can insert emoji by pressing ''':''' (colon).<br/>This will display a list of available emojis depending on the '' 'Characters Number For Popup Display' '' setting.<br/>Continue typing the name to search for the desired emoji.<br/>When ready, click on the chosen emoji to insert it or simply end its name with ''':''' (colon).
 
|}
 
|}
 
{|
 
{|
Line 191: Line 230:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You can also view, browse and search through all available symbols by clicking on emoji picker.
+
|style="padding: 0px 0px 20px 15px;"|You can also view, browse and search through all available symbols by clicking on emoji picker if the '' 'Emoji Search Picker In Toolbar' '' option is enabled in [https://www.docs.modulesgarden.com/Emoji_Picker_For_WHMCS#Settings settings].
 
|}
 
|}
 
{|
 
{|
Line 197: Line 236:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|When the composed massage is send the inserted emoji codes will be replaced to emoji artworks.
+
|style="padding: 0px 0px 20px 15px;"|When the composed massage is sent, the inserted emoji codes are replaced with emoji artworks.
 
|}
 
|}
 
{|
 
{|
Line 203: Line 242:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|This also includes the tickets notifications emails.
+
|style="padding: 0px 0px 15px 15px;"|This also applies to the tickets-related email notifications.<br/> Underneath, there is an email notification view with '' 'Images' '' selected as a conversion type of emojis in emails.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:EM_14.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:EM_14.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Here you can see a standard email notification with '' 'Unicode' '' selected as a conversion type of emojis in emails.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:EM_14_1.png]]
 
|}
 
|}
  
 
===Admin Area===
 
===Admin Area===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|If you enabled the '' 'Emoji In Admin Area' '' option in the addon [https://www.docs.modulesgarden.com/Emoji_Picker_For_WHMCS#Settings settings], your support administrators can view and use emojis in their tickets replies as well. <br/>
+
|style="padding: 10px 0px 15px 15px;"|If you have the '' 'Emoji In Admin Area' '' option enabled in the addon [https://www.docs.modulesgarden.com/Emoji_Picker_For_WHMCS#Settings settings], your support administrators can view and use emojis in their tickets as well. <br/>
 +
'' '''Note''' that the 'Emoji Search Picker In Text Area' and 'Emoji Search Picker In Toolbar' options are also applied for this area.
 
|}
 
|}
 
{|
 
{|
Line 217: Line 263:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Otherwise, your support administrators will not be able to enter emojis freely, as well as will not see them as artworks in messages.<br/>
+
|style="padding: 0px 0px 15px 15px;"|Otherwise, your support administrators will not be able to enter emojis, neither they will see them as artworks in messages.<br/>
−
'' '''Note''' that your support can still then type emoji codes from memory which will continue to be visible as artworks but only for the clients.''
+
'' '''Note''' that your support can still type remembered emoji codes which will continue to be visible as artworks for your clients.''
 
|}
 
|}
 
{|
 
{|
Line 226: Line 272:
 
==Domains==
 
==Domains==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|The module can convert domains in Punycode format, to emoji ones, if they contain them.<br/>This applies to client area domain lists, service lists with domains, their details, as well as HTML invoices and email notifications related to them.<br/>
+
|style="padding: 10px 0px 15px 15px;"|The module can convert domains in the Punycode format to emoji domains.<br/>This applies to client area domain lists, service lists with domains, their details, as well as HTML invoices and email notifications related to domains.<br/>
  
−
'' '''Important:''' Read the second point of [https://www.docs.modulesgarden.com/Emoji_Picker_For_WHMCS#Common_Problems common problems] section related to WHMCS problems with registration of emoji domains.''
+
'' '''Important:''' Read the second point of [https://www.docs.modulesgarden.com/Emoji_Picker_For_WHMCS#Common_Problems common problems] section explaining WHMCS problems with registration of emoji domains.''
 
<br/><br/>
 
<br/><br/>
−
For example, by default, WHMCS displays a list of emoji domains in they original Punycode format.
+
For example, WHMCS displays a list of emoji domains in their original Punycode format by deafult.
 
|}
 
|}
 
{|
 
{|
Line 236: Line 282:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|When you enable the '' 'Replace Domains With Emoji' '' option in addon [https://www.docs.modulesgarden.com/Emoji_Picker_For_WHMCS#Settings settings], the Punycode will be replaced in client area with emoji format.<br/>
+
|style="padding: 0px 0px 15px 15px;"|When you enable the '' 'Replace Domains With Emoji' '' option in the addon [https://www.docs.modulesgarden.com/Emoji_Picker_For_WHMCS#Settings settings], the Punycode will be replaced in the client area with the emoji format.<br/>
−
'' '''Note:''' The domains are using [https://unicode.org/emoji/charts/full-emoji-list.html unicode emoji], not the graphical artworks as presented in tickets. This means that their appearance may differ depending on the web browser.''
+
'' '''Note:''' The domains use [https://unicode.org/emoji/charts/full-emoji-list.html unicode emoji], not the graphical artworks as presented in tickets. This means that their appearance may differ depending on the web browser.''
 
|}
 
|}
 
{|
 
{|
Line 243: Line 289:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|This will also apply to several email notifications related to the domains. Note that currently the supported email templates are:
+
|style="padding: 0px 0px 15px 15px;"|This will also apply to several email notifications related to the domains. Currently, the supported email templates are:
 
*Support Ticket Reply
 
*Support Ticket Reply
 
*Support Ticket Opened
 
*Support Ticket Opened
Line 255: Line 301:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|As we as for HTML invoices.<br/>
+
|style="padding: 0px 0px 15px 15px;"|The same goes for HTML invoices.<br/>
−
'' '''Note:''' Currently in the PDF invoices the domains will still be shown in the Punycode format.''
+
'' '''Note:''' Currently, the domains on the PDF invoices will still be shown in the Punycode format.''
 
|}
 
|}
 
{|
 
{|
Line 264: Line 310:
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|1. The module supports only the WHMCS '''built-in''' ticket system.<br/>Separate ticketing systems such as [https://www.modulesgarden.com/products/whmcs/zendesk Zendesk], [https://www.modulesgarden.com/products/whmcs/kayako Kayako], [https://www.modulesgarden.com/products/whmcs/freshdesk Freshdesk] etc. are '''not''' supported by this module.
+
|style="padding: 10px 0px 10px 15px;"|1. The module supports only '''the WHMCS built-in ticket system'''.<br/>Separate ticketing systems such as [https://www.modulesgarden.com/products/whmcs/zendesk Zendesk] or [https://www.modulesgarden.com/products/whmcs/freshdesk Freshdesk] etc. are '''not''' supported by this module.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|2. If you are planing to use emoji domains, it is recommended that the  '' '[https://docs.whmcs.com/Domains_Tab#Allow_IDN_Domains Allow IDN Domains]' '' option is enabled in your WHMCS general settings.
+
|style="padding: 0px 0px 10px 15px;"|2. If you plan to use emoji domains, it is recommended that the  '' '[https://docs.whmcs.com/Domains_Tab#Allow_IDN_Domains Allow IDN Domains]' '' option is enabled in your WHMCS general settings.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|3. The replacing domains with emoji feature works only for the client area.<br/>In admin area these domains will still display as Punycode.
+
|style="padding: 0px 0px 30px 15px;"|3. The feature of replacing domains with emoji works only for the client area.<br/>In the admin area, these domains will be still displayed using Punycode.
 
|}
 
|}
  
 
=Update Instructions=
 
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/>
+
|style="padding: 10px 0px 30px 15px;"|An essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/>
−
Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!<br/>
+
Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.<br/> Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.
−
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/>
+
 
|}
 
|}
 +
=Upgrade Guide=
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.<br/>
 +
 +
Opt for the [https://www.modulesgarden.com/products/whmcs/emoji-picker#open-source-version Open Source version] of your Emoji Picker For WHMCS module to unlock these benefits.<br/> Simply click on either the '''Get Source Code''' or '''Upgrade To Lifetime''' button found on the product's page in our client area to complete the one-step upgrade process, with a '''dedicated discount''' already applied.<br/>
 +
 +
Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module comprehensive guide] covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.
 +
|}
 +
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
+
|style="padding: 10px 0px 10px 15px;"|'''1. In case of connection problems, please check whether your SELinux or firewall does not block ports.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|2. This module '''does not''' fix the problem of broken emoji domain registration system occurring directly in WHMCS.<br/>It is due to WHMCS solely that the registration attempt of a domain with emoji artworks or with emoji already converted to Punycode is automatically cleared from the '' 'Domain' '' field after placing an order.<br/>Our module only converts the already properly applied Punycode domain into emoji (e.g. when a client uses the existing domain for their service or the Punycode is placed manually into the domain field by the administrator).
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|2. This module does '''not''' fix the broken emoji domain registration system in WHMCS itself.<br/>It is a WHMCS problem that the registration attempt of a domain with emoji artworks or with emoji already converted to Punycode is automatically cleared from the '' 'Domain' '' field after placing an order.<br/>Our module only converts the already properly applied Punycode domain into the emoji one (e.g. when client use the existing domain for their service or the Punycode is placed manually into domain field by administrator)
+
|style="padding: 0px 0px 10px 15px;"|3. The 1.0 version does not replace the domain Punycode format on PDF invoices. This feature works only with HTML invoices for the time being.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|3. The current version does not yet replace domain Punycode format in PDF invoices. This feature works so-far only in HTML invoices.
+
|style="padding: 0px 0px 10px 15px;"|4. In the WHMCS versions prior to 7.5, the emoji domain replacement will not work on the order summary, and the domain will still be diplayed in the Punycode format there.<br/> This is caused by lack of a required WHMCS hook.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|4. On the WHMCS versions prior to 7.5 the emoji domain replacement will not work on the order summary, so it is diplayed in Punycode format.<br/> This is due to lack of needed WHMCS hook.
+
|style="padding: 0px 0px 10px 15px;"|5. It may turn out that when you preview an email in the WHMCS client's profile in the admin area, the message is suddenly cut off at the point where the emoji domain name should start.<br/>This is a WHMCS bug and despite this inconvenience, the message itself is sent to the client correctly.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|5. It may happen that when you preview an email in the WHMCS client's profile in the admin area, the message is suddenly cut off at the point where the emoji domain name should start.<br/>This is a WHMCS bug and despite this the message itself is sent to the client correctly.
+
|style="padding: 0px 0px 10px 15px;"|6. Emoji Picker For WHMCS is currently '''not''' compatible with [https://www.modulesgarden.com/products/whmcs/multibrand Multibrand For WHMCS] or [https://www.modulesgarden.com/products/whmcs/resellers-center Resellers Center For WHMCS] modules. Do not use these products together.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|6. The module is currently '''not''' compatible with [https://www.modulesgarden.com/products/whmcs/multibrand Multibrand For WHMCS] or with [https://www.modulesgarden.com/products/whmcs/resellers-center Resellers Center For WHMCS] functionality. Do not use this modules together.
+
|style="padding: 0px 0px 30px 15px;"|7. Unicode conversion type in email may not be visible in the email preview in the client's profile in the admin area.<br/> Currently, unicode type emojis are visible for clients only in messages they receive.
 
|}
 
|}

Latest revision as of 12:48, 26 April 2024

Contents

[edit] About Emoji Picker For WHMCS

Emoji Picker For WHMCS will let both your clients and support teams add emojis to ticket conversations.

You will be empowered to choose support departments that should display emojis and decide whether these symbols shall be visible in the admin area.
The module also provides support for emoji domains, allowing conversion of your clients' domain names from a Punycode format to emoji artworks.

  • Client Area Features:
✔ Use Emoji In Tickets By:
✔ Typing Emoji Code
✔ Using Emoji Search Picker
✔ Display Emoji In Ticket-Related Email Notifications
✔ Replace Punycode With Emoji Domains On:
✔ Domains List And Domain Details
✔ Services List And Service Details
✔ HTML Invoice
✔ Specific Email Notifications
  • Admin Area Features:
✔ Toggle Emoji Availability For Each Support Department
✔ Toggle Emoji Search Picker In Text Area
✔ Toggle Emoji Search Picker In Toolbar
✔ Toggle Emoji Visibility In Admin Area
✔ Use Emoji In Tickets By:
✔ Typing Emoji Code
✔ Using Emoji Search Picker
✔ Toggle Converting Of Punycode To Emoji Domains
✔ Specify Number Of Characters For Popup Display
✔ Use Unicode Or Image Type Of Emojis In Emails
✔ View And Delete Logs
  • General Info:
✔ Supports Emoji Artworks Provided By JoyPixels
✔ Custom Templates Support
✔ Multi-Language Support
✔ Supports PHP 8.1 Back To PHP 7.4
✔ Supports WHMCS Themes "Six" And "Twenty-One"
✔ Supports WHMCS V8.10 Back To WHMCS V8.6
✔ Requires ionCube Loader V12 Or Later
✔ Easy Module Upgrade To Open Source Version

[edit] Installation and Configuration

This tutorial will show you how to successfully install and configure Emoji Picker For WHMCS.

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

[edit] Installation

1. Log in to our client area and download the module.
EM 1.png
2. In the downloaded file you might find one or two packages that support different PHP versions.

In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.

PHP72 74.png
Previous updates of the module may contain two packages dedicated to various PHP versions.

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.
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 here.

PHP56 74.png
Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.
3. Extract the package and upload its content into the main WHMCS directory.

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

EM 2.png
4. When you install Emoji Picker For WHMCS for the first time, you have to rename the 'license_RENAME.php' file.

This file is located in 'yourWHMCS/modules/addons/Emoji/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

EM 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 the quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.

EM 4.png
6. Now, set up the 'storage' folder as recursively writable.

This folder is available at 'yourWHMCS/modules/addons/Emoji/' .

EM 5.png

[edit] Activation

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

Log in to your WHMCS admin area and proceed to 'Setup' → 'Addon Modules'.
Afterward, find 'Emoji Picker' and press the 'Activate' button.

EM 6.png
8. In the next step you need to permit access to this module.

To do so, click on the 'Configure' button and tick the checkboxes to assign desired admin roles.

EM 7.png
9. Congratulations, you have just successfully installed Emoji Picker For WHMCS!

[edit] Configuration

Now you need to configure your newly installed module.

[edit] Settings

Proceed to 'Addons' → 'Emoji' → 'Settings' to configure the following options:
  • Support Department Settings - choose which of your support departments will display emojis.
    Your clients will be able to use emojis while creating or replying in tickets, as well as view emojis in email notifications.
    Note that you can change the status of multiple departments at once by using mass actions.
  • Emoji Search Picker In Text Area - if enabled, the emoji popup will be displayed when entering the emoji code in the ticket.
  • Emoji Search Picker In Toolbar - if enabled, the button with emoji search picker will be displayed in the ticket editor toolbar.
  • Emoji In Admin Area - toggle on if you want the administrators to view and use emojis when creating and replying to tickets.
    If disabled, they will be visible in the admin area only in the form of emoji codes.
    Note that your support can still type remembered emoji codes which will continue to be visible as artworks for your clients.
  • Replace Domains With Emoji - toggle on if you want to have support for emoji domains.
    This will allow your clients to view already provided domains in Punycode format (for example www.xn--qei8618mfvb.tld) with unicode emoji (for example www.❤🍺😉.tld) in your client area
    Note that this will also convert Punycode to the unicode emoji in the domain-related emails as well as on the HTML invoices.
  • Characters Number For Popup Display - specify the minimum number of characters that are required after the colon in order to display the emoji popup.
    E.g. if set to '0', emoji picker will be displayed immediately after entering the colon character. For '1', only first emoji character will have to be entered after the colon etc.
    Note that the 'Emoji Search Picker In Text Area' option must be enabled for emoji popup to work.
  • Emoji Conversion Type In Email - specify whether to use Unicode or Image type emojis in email messages
    e.g. if 'Images' selected, emoji picker will be converted into an image in an eamil message. If 'Unicode', has been selected the emoij will be converted and dispalyed as such in an email message.
EM 8.png

[edit] Logs

The logs provide data about particular domain orders, invoices or email massages to which emojis have been successfully applied. The section also includes information concerning any existing errors.
EM 9.png

[edit] Management

Once Emoji Picker For WHMCS is installed and configured, you can use emoji in tickets as well as view them in domain names instead of a Punycode format.

[edit] Support Tickets

[edit] Client Area

In the client area, you can use emojis in tickets submitted in any of support departments with enabled emoji support.
EM 10.png
When you compose a message and the 'Emoji Search Picker In Text Area' option is enabled in settings, you can insert emoji by pressing : (colon).
This will display a list of available emojis depending on the 'Characters Number For Popup Display' setting.
Continue typing the name to search for the desired emoji.
When ready, click on the chosen emoji to insert it or simply end its name with : (colon).
EM 11.png
You can also view, browse and search through all available symbols by clicking on emoji picker if the 'Emoji Search Picker In Toolbar' option is enabled in settings.
EM 12.png
When the composed massage is sent, the inserted emoji codes are replaced with emoji artworks.
EM 13.png
This also applies to the tickets-related email notifications.
Underneath, there is an email notification view with 'Images' selected as a conversion type of emojis in emails.
EM 14.png
Here you can see a standard email notification with 'Unicode' selected as a conversion type of emojis in emails.
EM 14 1.png

[edit] Admin Area

If you have the 'Emoji In Admin Area' option enabled in the addon settings, your support administrators can view and use emojis in their tickets as well.

Note that the 'Emoji Search Picker In Text Area' and 'Emoji Search Picker In Toolbar' options are also applied for this area.

EM 15.png
Otherwise, your support administrators will not be able to enter emojis, neither they will see them as artworks in messages.

Note that your support can still type remembered emoji codes which will continue to be visible as artworks for your clients.

EM 16.png

[edit] Domains

The module can convert domains in the Punycode format to emoji domains.
This applies to client area domain lists, service lists with domains, their details, as well as HTML invoices and email notifications related to domains.

Important: Read the second point of common problems section explaining WHMCS problems with registration of emoji domains.

For example, WHMCS displays a list of emoji domains in their original Punycode format by deafult.

EM 17.png
When you enable the 'Replace Domains With Emoji' option in the addon settings, the Punycode will be replaced in the client area with the emoji format.

Note: The domains use unicode emoji, not the graphical artworks as presented in tickets. This means that their appearance may differ depending on the web browser.

EM 18.gif
This will also apply to several email notifications related to the domains. Currently, the supported email templates are:
  • Support Ticket Reply
  • Support Ticket Opened
  • Support Ticket Opened by Admin
  • Invoice Created
  • Order Confirmation
  • Invoice Payment Confirmation
EM 19.png
The same goes for HTML invoices.

Note: Currently, the domains on the PDF invoices will still be shown in the Punycode format.

EM 20.png

[edit] Tips

1. The module supports only the WHMCS built-in ticket system.
Separate ticketing systems such as Zendesk or Freshdesk etc. are not supported by this module.
2. If you plan to use emoji domains, it is recommended that the 'Allow IDN Domains' option is enabled in your WHMCS general settings.
3. The feature of replacing domains with emoji works only for the client area.
In the admin area, these domains will be still displayed using Punycode.

[edit] Update Instructions

An essential guidance through the process of updating the module is offered here.

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

[edit] Upgrade Guide

Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?
There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.

Opt for the Open Source version of your Emoji Picker For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

[edit] Common Problems

1. In case of connection problems, please check whether your SELinux or firewall does not block ports.
2. This module does not fix the problem of broken emoji domain registration system occurring directly in WHMCS.
It is due to WHMCS solely that the registration attempt of a domain with emoji artworks or with emoji already converted to Punycode is automatically cleared from the 'Domain' field after placing an order.
Our module only converts the already properly applied Punycode domain into emoji (e.g. when a client uses the existing domain for their service or the Punycode is placed manually into the domain field by the administrator).
3. The 1.0 version does not replace the domain Punycode format on PDF invoices. This feature works only with HTML invoices for the time being.
4. In the WHMCS versions prior to 7.5, the emoji domain replacement will not work on the order summary, and the domain will still be diplayed in the Punycode format there.
This is caused by lack of a required WHMCS hook.
5. It may turn out that when you preview an email in the WHMCS client's profile in the admin area, the message is suddenly cut off at the point where the emoji domain name should start.
This is a WHMCS bug and despite this inconvenience, the message itself is sent to the client correctly.
6. Emoji Picker For WHMCS is currently not compatible with Multibrand For WHMCS or Resellers Center For WHMCS modules. Do not use these products together.
7. Unicode conversion type in email may not be visible in the email preview in the client's profile in the admin area.
Currently, unicode type emojis are visible for clients only in messages they receive.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Emoji_Picker_For_WHMCS&oldid=66707"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Emoji Picker For WHMCS