Personal tools
Namespaces

Variants
Actions

Proxmox Mail Gateway For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Configuration of Product)
 
(35 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
<meta name="keywords" content="proxmox mail gateway for whmcs,proxmox mail gateway configuration, whmcs proxmox mail gateway management, whmcs proxmox mail gateway installation, whmcs proxmox mail gateway common problems, about whmcs proxmox mail gateway, whmcs proxmox mail gateway documentation, whmcs proxmox mail gateway faq, whmcs proxmox mail gateway help, whmcs proxmox mail gateway guide, whmcs proxmox mail gateway wiki, whmcs proxmox mail gateway tutorial, whmcs proxmox mail gateway tips, whmcs proxmox mail gateway wiki"></meta>
 
<meta name="keywords" content="proxmox mail gateway for whmcs,proxmox mail gateway configuration, whmcs proxmox mail gateway management, whmcs proxmox mail gateway installation, whmcs proxmox mail gateway common problems, about whmcs proxmox mail gateway, whmcs proxmox mail gateway documentation, whmcs proxmox mail gateway faq, whmcs proxmox mail gateway help, whmcs proxmox mail gateway guide, whmcs proxmox mail gateway wiki, whmcs proxmox mail gateway tutorial, whmcs proxmox mail gateway tips, whmcs proxmox mail gateway wiki"></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Proxmox Mail Gateway For WHMCS Module."></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Proxmox Mail Gateway For WHMCS Module."></meta>
 +
 +
<p style="border: 1px solid #6f0000; padding: 8px 14px; display: inline-block; font-size: 16px; color: #6f0000;"><strong>Proxmox Mail Gateway For WHMCS</strong> has reached <strong>End of Support (EOS)</strong> and is no longer actively maintained. The module remains available for purchase, including the Open Source version and License Upgrade at a <strong>discounted price</strong>. Current license subscriptions continue and stay valid for future renewals.</p>
  
 
=About [https://www.modulesgarden.com/products/whmcs/proxmox-mail-gateway Proxmox Mail Gateway For WHMCS]=
 
=About [https://www.modulesgarden.com/products/whmcs/proxmox-mail-gateway Proxmox Mail Gateway For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Proxmox Mail Gateway For WHMCS''' is a tool allows to deliver Proxmox Mail Gateway security solution to protect clients mail servers against threats
+
|style="padding: 10px 0px 10px 0px;"|'''Proxmox Mail Gateway For WHMCS''' is a modern security tool that assures protection to mail servers from any kind of threats.<br/>
 +
The module allows to perform the core management actions on the Proxmox Mail Gateway services directly from your WHMCS, from both the admin and the client side.<br/><br/>
 +
ModulesGarden is official [https://www.proxmox.com/en/partners/all/partner/modulesgarden '''Proxmox Solution Partner''']. Our products and services are recommended by '''Proxmox Server Solutions GmbH.'''
 
|}
 
|}
 
<!-- This is a comment -->
 
<!-- This is a comment -->
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔  
+
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate Service
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔  
+
|style="padding: 0px 0px 0px 30px;"|✔ View/Edit Service Configuration:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔
+
|style="padding: 0px 0px 0px 45px;"|✔ Domain Name
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔  
+
|style="padding: 0px 0px 0px 45px;"|✔ Transport Host/Port/Protocol
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔
+
|style="padding: 0px 0px 0px 45px;"|✔ MX Usage Status
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Configure Product Details
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Allow User To Change Domain Name
 +
|}
 +
 
*'''Client Area Features:'''
 
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔  
+
|style="padding: 10px 0px 0px 30px;"|✔ Order Service For Mail Server Domain
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔  
+
|style="padding: 0px 0px 0px 30px;"|✔ View/Edit Service Configuration:
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Domain Name
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Transport Host/Port/Protocol
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 45px;"|✔ MX Usage Status
 +
|}
 +
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔  
+
|style="padding: 10px 0px 0px 30px;"|✔ Deliver Proxmox Mail Gateway Security Solution To Protect Clients Mail Servers Against Threats
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔
+
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports Proxmox Mail Gateway 7.X And Later
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.2 Back To PHP 8.1
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔  
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six" And "Twenty-One"
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.0 And Later
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.12 Back To WHMCS V8.9
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Easy Module Upgrade To [https://www.modulesgarden.com/products/whmcs/proxmox-mail-gateway#open-source-version Open Source Version]
+
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V13 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/proxmox-mail-gateway#open-source-version Open Source Version]
 
|}
 
|}
  
 
=Installation and Configuration=
 
=Installation and Configuration=
 +
 +
<p style="border: 1px solid #6f0000; padding: 8px 14px; display: inline-block; font-size: 16px; color: #6f0000;"><strong>Proxmox Mail Gateway For WHMCS</strong> has reached <strong>End of Support (EOS)</strong> and is no longer actively maintained. The module remains available for purchase, including the Open Source version and License Upgrade at a <strong>discounted price</strong>. Current license subscriptions continue and stay valid for future renewals.</p>
 +
 
{|
 
{|
 
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/proxmox-mail-gateway Proxmox Mail Gateway For WHMCS.]''' <br />
 
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/proxmox-mail-gateway Proxmox Mail Gateway For WHMCS.]''' <br />
Line 97: Line 124:
 
==Server Configuration==
 
==Server Configuration==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''10. Now, we will show you how to configure a new server.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''6. Now, we will show you how to configure a new server.'''<br />
 
To do so, log into your WHMCS and go to '' 'System Settings' '' → '' 'Servers'.''<br />
 
To do so, log into your WHMCS and go to '' 'System Settings' '' → '' 'Servers'.''<br />
 
Once you are there, press '' 'Add New Server'. ''
 
Once you are there, press '' 'Add New Server'. ''
Line 105: Line 132:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''11. Next, enter your server name, hostname and IP address, username and password. Choose '' 'ProxmoxMailGateway' '' from a dropdown menu.'''''<br/>
+
|style="padding: 0px 0px 20px 15px;"|'''7. Next, enter your server name, hostname and IP address, username and password. Choose '' 'ProxmoxMailGateway' '' from a dropdown menu.'''''<br/>
 
If you want to provide data for a Linux user account in '' 'Authentication' '' select '' 'Linux PAM standard authentication' '', and for ProxmoxMailGateway user select '' 'Proxmox Mail Gateway authentication server'. '' <br/> Remember to save the changes when ready.
 
If you want to provide data for a Linux user account in '' 'Authentication' '' select '' 'Linux PAM standard authentication' '', and for ProxmoxMailGateway user select '' 'Proxmox Mail Gateway authentication server'. '' <br/> Remember to save the changes when ready.
 
|}
 
|}
Line 112: Line 139:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''12. After you configure your server correctly, you will see the following screen.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. After you configure your server correctly, you will see the following screen.'''<br />
 
At this point, you need to create a new group for your server. For that purpose, press '' 'Create New Group'. ''
 
At this point, you need to create a new group for your server. For that purpose, press '' 'Create New Group'. ''
 
|}
 
|}
Line 119: Line 146:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''13. Enter the name, click on your previously created server, press '' 'Add' '' and then '' 'Save Changes'. '''''
+
|style="padding: 0px 0px 20px 15px;"|'''9. Enter the name, click on your previously created server, press '' 'Add' '' and then '' 'Save Changes'. '''''
 
|}
 
|}
 
{|
 
{|
Line 153: Line 180:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''14. At this moment, in the product '' 'Details','' you may also check the '' 'Require Domain' '' option as a domain must be a required step in the product order.'''<br/> Alternatively, you may add an adequate custom field to let the clients enter the relay domain ''(see step 17'').
+
|style="padding: 0px 0px 15px 15px;"|'''14. At this moment, in the product '' 'Details','' you may also check the '' 'Require Domain' '' option as providing a domain must be a required step in the service ordering process.'''<br/> Alternatively, you may add an adequate custom field to let the clients enter the domain name there ''(see step 17'').
 
|}
 
|}
 
{|
 
{|
Line 166: Line 193:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''16. Now, let's start configuring the product settings. Choose whether you wish to allow your clients to change the domain name or not.'''<br/> Toggle the '' 'Change Domain Name' '' option and save the changes.
+
|style="padding: 0px 0px 20px 15px;"|'''16. Let's start configuring the product settings finally. Choose whether you wish to allow your clients to change the domain name or not.'''<br/> Toggle the '' 'Change Domain Name' '' option and save the changes.
 
|}
 
|}
 
{|
 
{|
Line 172: Line 199:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''17. In case you did not mark the '' 'Require Domain' '' option in the product '' 'Details' '' move to the '' 'Custom Fields' '' tab and create a 'domain|Domain' custom field.''' <br/> Do not forget to mark it as a '' 'Required Field' '' and  '' 'Show On Order Form'.'' Only then your clients will be able to successfully order and use this security tool for their relay domains.
+
|style="padding: 0px 0px 15px 15px;"|'''17. In case you did not mark the '' 'Require Domain' '' option in the product '' 'Details' (step '14th'),'' move to the '' 'Custom Fields' '' tab and create a 'domain|Domain' custom field.''' <br/> Do not forget to mark it as a '' 'Required Field' '' and  '' 'Show On Order Form'.'' Only then your clients will be able to successfully order and use this security tool for their relay domains.
 
|}
 
|}
 
{|
 
{|
Line 178: Line 205:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|That is all. Your product is now ready to use.
+
|style="padding: 0px 0px 30px 15px;"|That is all. Your product is now ready to use so move to the following sections to learn about all the possibilities it may give you and your clients.
 
|}
 
|}
  
 
=Management=
 
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''In this section we will show you the possibilities  <br/>
+
|style="padding: 10px 0px 30px 15px;"|'''In this section we will show and discuss every benefit that using  the Proxmox Mail Gateway solution may bring. <br/>
−
Go through the below descriptions to become familiarized with all the options the Proxmox Mail Gateway solution can offer you.
+
Go through the below descriptions to become familiarized with all the options of this security tool may offer you.
 
|}
 
|}
 
==Admin Area==
 
==Admin Area==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''Proxmox Mail Gateway For WHMCS allows you to monitor your service configuration details from the admin area of your WHMCS system.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''Proxmox Mail Gateway For WHMCS allows you to monitor and edit your service configuration details from the admin area of your WHMCS system.'''<br />
 
This includes supervision of such features like:
 
This includes supervision of such features like:
−
# Domain Name
+
* Domain Name
−
# Transport Host
+
* Transport Host
−
# Transport Port
+
* Transport Port
−
# Transport Protocol
+
* Transport Protocol
−
# MX Usage Status<br/>
+
* MX Usage Status <br/>
  
 
Basic module commands that can be executed on the service:  
 
Basic module commands that can be executed on the service:  
Line 203: Line 230:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PMG_19.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PMG_18.png]]
 
|}
 
|}
  
 
==Ordering==
 
==Ordering==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Ordering the service for rely domain, use the domain when placing the order.  
+
|style="padding: 10px 0px 15px 15px;"|That is how an exemplary page with the order may look like. Please be aware that a domain is obligatory when placing the order.<br.> The relay domain may also be provided in the form of a custom field to be filled in depending on the product configuration, just like on the screen below. 
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PMG_21.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PMG_20.png]]
 
|}
 
|}
−
{|
+
 
−
|style="padding: 0px 0px 20px 15px;"|The relay domain may also be provided in the form of a custom field to be filled in depending on the product configuration.  
+
==Client Area==
 +
{|  
 +
|style="padding: 10px 0px 15px 15px;"|Proxmox Mail Gateway For WHMCS assures protection to your clients' mail servers against threats. Your clients are allowed to view and edit the service details, including:
 +
* Domain name
 +
* Transport of Host, Port and Protocol
 +
* MX Usage Status
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PMG_22.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PMG_21.png]]
 
|}
 
|}
−
==Client Area==
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|This is how the service will be displayed in the client area. Proxmox Mail Gateway For WHMCS assures protection to your clients' mail servers against threats.
+
|style="padding: 0px 0px 20px 15px;"|Edit the service details, press the edit icon marked on the below screen. A new widow will appear.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PMG_22.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PMG_22.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Edit the service details (if allowed by the admin). Press the edit icon.
+
|style="padding: 0px 0px 15px 15px;"|You may now change your service for mail server details. Select options, change the configuration.<br/> Remember to confirm your changes in the end.
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:PMG_23.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:PMG_23.png]]
 
|}
 
|}
 +
 +
=Tips=
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Confirm the changes when ready.
+
|style="padding: 10px 0px 30px 15px;"|
 
|}
 
|}
 +
==How To Use Language Overrides==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PMG_24.png]]
+
|style="padding: 10px 0px 15px 15px;"|'''Incorporating language customizations - the module readily accommodates language overrides, allowing you to tailor the language files to your preferences.'''<br/> The language file english.php remains unencoded and can be modified to suit your needs. However, it's recommended to avoid altering the core file itself, and instead, leverage the capability of using overrides.<br/>
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Here's how to apply language overrides:
 +
* Navigate to the ''~/langs/'' directory located within the following ''yourWHMCS/modules/servers/moduleName/langs/'' path.
 +
* Within this directory, create a new file or duplicate the language file you intend to modify. For instance, if you wish to create an override for the English language, establish the following directory structure:
 +
  ''~/langs/overrides/english.php''.
 +
* Open the newly created override file to edit its contents.
 +
* At the beginning of the file, indicate the used code, for instance, you can use: '''<?php''' for PHP code.
 +
* Adapt the file content according to your requirements. You can either selectively modify specific variables or opt to revise the entire content of the language file.
  
−
=Tips=
+
For example:
 +
 
 +
'''Original ''yourWHMCS/modules/servers/moduleName/langs/english.php:'''''
 +
 
 +
  $_LANG['Search'] = 'Search';
 +
 
 +
'''Override ''yourWHMCS/modules/servers/moduleName/langs/overrides/english.php:''''' 
 +
 
 +
  $_LANG['Search'] = 'Look for';
 +
|}
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|1.  
+
|style="padding: 0px 0px 15px 15px;"|By following these steps, you can seamlessly implement language customizations without altering the core language file, ensuring your changes will not be lost after every module update.<br/>
 +
 
 +
Remember that some of the modules have more than one language file, located under ''/addons'' and ''/servers'' paths. You may create the override files for both of them.<br/> Note that you do not need to paste all the original content of the lang file into the override file. Enter there only the lines that you wish to change, every other line will be fetched from the original module lang file.<br/> Consequently, the override lang file might include only one or just a few lines.
 
|}
 
|}
  
 
=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/proxmox-mail-gateway#open-source-version Open Source version] of your Proxmox Mail Gateway 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.
 
|}
 
|}
  

Latest revision as of 16:08, 31 January 2025

Proxmox Mail Gateway For WHMCS has reached End of Support (EOS) and is no longer actively maintained. The module remains available for purchase, including the Open Source version and License Upgrade at a discounted price. Current license subscriptions continue and stay valid for future renewals.

Contents

[edit] About Proxmox Mail Gateway For WHMCS

Proxmox Mail Gateway For WHMCS is a modern security tool that assures protection to mail servers from any kind of threats.

The module allows to perform the core management actions on the Proxmox Mail Gateway services directly from your WHMCS, from both the admin and the client side.

ModulesGarden is official Proxmox Solution Partner. Our products and services are recommended by Proxmox Server Solutions GmbH.

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate Service
✔ View/Edit Service Configuration:
✔ Domain Name
✔ Transport Host/Port/Protocol
✔ MX Usage Status
✔ Configure Product Details
✔ Allow User To Change Domain Name
  • Client Area Features:
✔ Order Service For Mail Server Domain
✔ View/Edit Service Configuration:
✔ Domain Name
✔ Transport Host/Port/Protocol
✔ MX Usage Status
  • General Info:
✔ Deliver Proxmox Mail Gateway Security Solution To Protect Clients Mail Servers Against Threats
✔ Multi-Language Support
✔ Supports Proxmox Mail Gateway 7.X And Later
✔ Supports PHP 8.2 Back To PHP 8.1
✔ Supports WHMCS Themes "Six" And "Twenty-One"
✔ Supports WHMCS V8.12 Back To WHMCS V8.9
✔ Requires ionCube Loader V13 Or Later
✔ Easy Module Upgrade To Open Source Version

[edit] Installation and Configuration

Proxmox Mail Gateway For WHMCS has reached End of Support (EOS) and is no longer actively maintained. The module remains available for purchase, including the Open Source version and License Upgrade at a discounted price. Current license subscriptions continue and stay valid for future renewals.

This tutorial will show you how to successfully install and configure Proxmox Mail Gateway 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.
PMG 1.png
2. Upload and extract the extension into the main WHMCS directory.

Extracted files in your WHMCS directory should look like this:

PMG 2.png
3. When you install Proxmox Mail Gateway For WHMCS for the first time, you have to rename the 'license_RENAME.php' file.

The file is located in '/yourWHMCS/modules/servers/ProxmoxMailGateway/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

PMG 3.png
4. 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'.

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

This folder is available at '/yourWHMCS/modules/servers/ProxmoxMailGateway/'.

PMG 5.png

[edit] Server Configuration

6. Now, we will show you how to configure a new server.

To do so, log into your WHMCS and go to 'System Settings' → 'Servers'.
Once you are there, press 'Add New Server'.

PMG 6.png
7. Next, enter your server name, hostname and IP address, username and password. Choose 'ProxmoxMailGateway' from a dropdown menu.

If you want to provide data for a Linux user account in 'Authentication' select 'Linux PAM standard authentication' , and for ProxmoxMailGateway user select 'Proxmox Mail Gateway authentication server'.
Remember to save the changes when ready.

PMG 7.png
8. After you configure your server correctly, you will see the following screen.

At this point, you need to create a new group for your server. For that purpose, press 'Create New Group'.

PMG 8.png
9. Enter the name, click on your previously created server, press 'Add' and then 'Save Changes'.
PMG 9.png

[edit] Configuration of Product

10. In order to create and configure a product, go to 'System Settings' → 'Products/Services' → 'Products/Services'.

Click on 'Create a New Group'.

PMG 10.png
11. Enter your product group name and press 'Save Changes'.
PMG 11.png
12. Once you have a product group, you can create a new product.

To do so, first click on 'Create a New Product'.

PMG 12.png
13. Afterward, choose your product type, enter your product name, choose module and the product group from the dropdown menus. Press 'Continue'.
PMG 13.png
14. At this moment, in the product 'Details', you may also check the 'Require Domain' option as providing a domain must be a required step in the service ordering process.
Alternatively, you may add an adequate custom field to let the clients enter the domain name there (see step 17).
PMG 14.png
15. Now, go to the 'Module Settings' section, choose your previously created server group from the dropdown menu.

If you did not set the proper permissions, you will be asked to do it now.

PMG 15.png
16. Let's start configuring the product settings finally. Choose whether you wish to allow your clients to change the domain name or not.
Toggle the 'Change Domain Name' option and save the changes.
PMG 16.png
17. In case you did not mark the 'Require Domain' option in the product 'Details' (step '14th'), move to the 'Custom Fields' tab and create a 'domain|Domain' custom field.
Do not forget to mark it as a 'Required Field' and 'Show On Order Form'. Only then your clients will be able to successfully order and use this security tool for their relay domains.
PMG 17.png
That is all. Your product is now ready to use so move to the following sections to learn about all the possibilities it may give you and your clients.

[edit] Management

In this section we will show and discuss every benefit that using the Proxmox Mail Gateway solution may bring.

Go through the below descriptions to become familiarized with all the options of this security tool may offer you.

[edit] Admin Area

Proxmox Mail Gateway For WHMCS allows you to monitor and edit your service configuration details from the admin area of your WHMCS system.

This includes supervision of such features like:

  • Domain Name
  • Transport Host
  • Transport Port
  • Transport Protocol
  • MX Usage Status

Basic module commands that can be executed on the service:

  • Create
  • Suspend
  • Unsuspend
  • Terminate
PMG 18.png

[edit] Ordering

That is how an exemplary page with the order may look like. Please be aware that a domain is obligatory when placing the order.
The relay domain may also be provided in the form of a custom field to be filled in depending on the product configuration, just like on the screen below.
PMG 20.png

[edit] Client Area

Proxmox Mail Gateway For WHMCS assures protection to your clients' mail servers against threats. Your clients are allowed to view and edit the service details, including:
  • Domain name
  • Transport of Host, Port and Protocol
  • MX Usage Status
PMG 21.png
Edit the service details, press the edit icon marked on the below screen. A new widow will appear.
PMG 22.png
You may now change your service for mail server details. Select options, change the configuration.
Remember to confirm your changes in the end.
PMG 23.png

[edit] Tips

[edit] How To Use Language Overrides

Incorporating language customizations - the module readily accommodates language overrides, allowing you to tailor the language files to your preferences.
The language file english.php remains unencoded and can be modified to suit your needs. However, it's recommended to avoid altering the core file itself, and instead, leverage the capability of using overrides.
Here's how to apply language overrides:
  • Navigate to the ~/langs/ directory located within the following yourWHMCS/modules/servers/moduleName/langs/ path.
  • Within this directory, create a new file or duplicate the language file you intend to modify. For instance, if you wish to create an override for the English language, establish the following directory structure: 
 ~/langs/overrides/english.php.
  • Open the newly created override file to edit its contents.
  • At the beginning of the file, indicate the used code, for instance, you can use: <?php for PHP code.
  • Adapt the file content according to your requirements. You can either selectively modify specific variables or opt to revise the entire content of the language file.

For example:

Original yourWHMCS/modules/servers/moduleName/langs/english.php: 

 $_LANG['Search'] = 'Search';

Override yourWHMCS/modules/servers/moduleName/langs/overrides/english.php: 

 $_LANG['Search'] = 'Look for';
By following these steps, you can seamlessly implement language customizations without altering the core language file, ensuring your changes will not be lost after every module update.

Remember that some of the modules have more than one language file, located under /addons and /servers paths. You may create the override files for both of them.
Note that you do not need to paste all the original content of the lang file into the override file. Enter there only the lines that you wish to change, every other line will be fetched from the original module lang file.
Consequently, the override lang file might include only one or just a few lines.

[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 Proxmox Mail Gateway 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. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Proxmox_Mail_Gateway_For_WHMCS&oldid=74279"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
cPanel Modules
General
FAQ
Community
Proxmox Mail Gateway For WHMCS