Difference between revisions of "Mail Tab"

From WHMCS Documentation

(Configuring a Mail Type in WHMCS 7.x and earlier)
 
(7 intermediate revisions by 2 users not shown)
Line 5: Line 5:
 
You can access this tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[General Settings]]''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
 
You can access this tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[General Settings]]''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
 
   
 
   
===Mail Type or Provider===
+
===Mail Type or Mail Provider===
 
 
Use the '''Mail Type''' or '''Mail Provider''' settings, depending on your WHMCS version, to choose how your installation sends mail. Mail Providers determine how your installation sends mail. The mail provider you choose can affect your mail deliverability.
 
 
   
 
   
 +
Use the '''Mail Type''' or '''Mail Provider''' settings, depending on your WHMCS version, to choose how your installation sends mail. The mail provider you choose can affect your mail deliverability and offers different levels of security through different providers.
 +
 
 
====Configuring a Mail Provider in WHMCS 8.0 and later====
 
====Configuring a Mail Provider in WHMCS 8.0 and later====
 
+
For WHMCS 8.0 and later, '''Mail Provider''' displays your selected Mail Provider. To change and configure it, perform these steps:
+
For WHMCS 8.0 and later, '''Mail Provider''' displays your selected mail provider. To change and configure it:
 
+
 
# Click '''Configure Mail Provider'''.
 
# Click '''Configure Mail Provider'''.
 
# Choose a '''Mail Provider''' from the menu.
 
# Choose a '''Mail Provider''' from the menu.
# Fill out the information for your chosen provider. This information is different for each '''Mail Provider''':
+
# Enter the information for your chosen provider:
#* '''PHP Mail (default)''' — Choose an encoding type from '''Mail Encoding'''.
+
#* '''PHP Mail (default)''' Choose an encoding type from '''Mail Encoding'''. We recommend the ''8bit'' encoding type unless you are experiencing character display issues with your [[Localisation_Tab#System_Charset | system character set]].  
#* '''SMTP''' — Enter the indicated information, which differs depending on your chosen type of '''SMTP Authentication'''.  
+
#* '''SMTP''' Enter the indicated information:
#** Check '''SMTP Debug''' if you want to log debugging output for SMTP email. Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs > [[Activity_Logs|Activity Log]]''' to view this log.
+
#** Select a '''Mail Encoding''' type.
#** In '''SMTP Port''', specify the port on which your SMTP server operates.  
+
#** Select a service provider. If you choose ''Google'', see [https://help.whmcs.com/m/system/l/1277316-setting-up-google-as-your-mail-service-provider Setting Up Google As Your Mail Service Provider].
#*** This will usually vary depending on the SSL type and your particular mail server configuration.  
+
#** Enter an SMTP host. If you chose ''Google'' as your service provider, make certain to use <tt>smtp.google.com</tt>.
#*** Check with your mail server administrator for the appropriate port to use. These are the most commonly-used ports by SSL type:
+
#** Enter the port on which your SMTP server operates. The port varies depending on the SSL type and your mail server configuration. Check with your mail server administrator for the appropriate port to use. These are the most commonly-used ports by SSL type:
#****None: 25 or 26
+
#***None: 25 or 26
#****SSL: 465 or 587
+
#***SSL: 465 or 587
#****TLS: 587
+
#***TLS: 587
#** Use the '''SMTP SSL Type''' setting to specify whether a secure connection is used when communicating with your mail server. Changes to this option will usually also require changing the '''SMTP Port'''.
+
#** Select an authentication type. ''Oauth2'' is only available if you selected ''Google'' for '''Service Provider'''.
#** WHMCS currently only supports [[OAuth2 for SMTP|OAuth]] via Google. For help setting up ''Google'' as your '''Service Provider''', see [https://help.whmcs.com/m/system/l/1277316-setting-up-google-as-your-mail-service-provider Setting Up Google As Your Mail Service Provider].
+
#** Enter your authentication information. This depends on your chosen service provider and authentication type.
#* '''MailGun''' — Select a region, and then enter your sending domain and MailGun API key.
+
#** Specify whether to use a secure connection when communicating with your mail server using the '''SMTP SSL Type''' menu. Changes to this option will usually also require changing the '''SMTP Port''' value.
#* '''SendGrid''' — Enter your API key.
+
#** Check '''Debugging''' if you want to log debugging output at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]'''.
#* '''SparkPost''' — Select a SparkPost account and enter a SparkPost API key. Check '''Use Sink Testing''' to allow you to check email sending without actually sending emails.
+
#* '''MailGun''' — Select a region, and then enter your sending domain and MailGun API key.
# Click '''Test Configuration'''. The system will send an email to test your configuration. If the test doesn't succeed, you will see an error.
+
#* '''Microsoft''' — Enter your authentication information.
# Click '''Save'''. The system will send an email to test your configuration, and it won't save your changes unless the test is successful. 
+
#** In order to use Microsoft® email services, you '''must''' set '''Friendly URLs''' to ''Friendly index.php'' or ''Full Friendly Rewrite'' in the '''[[General Tab|General]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings'''.
 +
#** For complete setup steps, see [https://help.whmcs.com/m/system/l/1600738-setting-up-microsoft-as-your-mail-service-provider Setting Up Microsoft As Your Mail Service Provider].
 +
#** Check '''Debugging''' if you want to log debugging output at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]'''.
 +
#** This mail provider is only available in WHMCS 8.6 and later.
 +
#* '''SendGrid''' Enter your API key.
 +
#* '''SparkPost''' Select a SparkPost account and enter a SparkPost API key. Check '''Use Sink Testing''' to allow you to check email sending without actually sending emails.
 +
# Click '''Test Configuration'''. The system will send an email to test your configuration. If the test doesn't succeed, you will see an error.
 +
# Click '''Save'''. The system will send an email to test your configuration, and it won't save your changes unless the test is successful.
  
====Configuring a Mail Type in WHMCS 7.x and earlier====
+
====Configuring a Mail Type in WHMCS 7.10 and earlier====
 
+
For version 7.x and earlier, use '''Mail Type''' to choose one of these options:
+
For WHMCS 7.10 and earlier, use '''Mail Type''' to choose one of these options:
 
+
* Use '''PHP Mail''' to send emails from inside WHMCS. This requires no further configuration, but some email providers may treat email sent this way with increased suspicion.
+
* Use '''PHP Mail''' to send emails from inside WHMCS. This requires no further configuration, but some email providers may treat this email with increased suspicion.
* Use your SMTP server to send emails. The related '''SMTP''' fields are required.
+
* Use your SMTP server to send emails. The related '''SMTP''' fields are required:
** In '''SMTP Port''', specify the port on which your SMTP server operates.  
+
** For '''SMTP Port''', specify the port on which your SMTP server operates. This will usually vary depending on the SSL type and your particular mail server configuration.  
*** This will usually vary depending on the SSL type and your particular mail server configuration.  
+
***Check with your mail server administrator for the appropriate port to use.  
*** Check with your mail server administrator for the appropriate port to use. These are the most commonly-used ports by SSL type:
+
***These are the most commonly-used ports by SSL type:
 
****None: 25 or 26
 
****None: 25 or 26
 
****SSL: 465 or 587
 
****SSL: 465 or 587
 
****TLS: 587
 
****TLS: 587
** Use the '''SMTP SSL Type''' setting to specify whether a secure connection is used when communicating with your mail server. Changes to this option will usually also require changing the '''SMTP Port'''.
+
** For '''SMTP SSL Type''', specify whether a secure connection is used when communicating with your mail server. Changes to this option will usually also require changing '''SMTP Port'''.
 +
 
 +
For step-by-step instructions, see [https://help.whmcs.com/m/system/l/784309-configuring-whmcs-to-use-smtp-in-whmcs-7 Configuring WHMCS to Use SMTP in WHMCS 7].
  
 
==== Mail Providers and Mail Types ====
 
==== Mail Providers and Mail Types ====
 
+
 
WHMCS supports the following mail providers:
 
WHMCS supports the following mail providers:
 
+
 
* PHP Mail
 
* PHP Mail
* SMTP (with OAuth authentication via Google in WHMCS 8.0 and later)
+
* SMTP (with OAuth2 authentication via Google in WHMCS 8.0 and later)
 
* MailGun (WHMCS 8.0 and later)
 
* MailGun (WHMCS 8.0 and later)
 +
* Microsoft (WHMCS 8.6 and later)
 
* SendGrid (WHMCS 8.0 and later)
 
* SendGrid (WHMCS 8.0 and later)
 
* SparkPost (WHMCS 8.0 and later)
 
* SparkPost (WHMCS 8.0 and later)
 
+
 
===== PHP Mail =====
 
===== PHP Mail =====
 
+
When you choose PHP Mail, you won't need to configure any additional settings. PHP Mail is more likely to be considered spam by spam filtering applications.
+
When you choose ''PHP Mail'', you won't need to configure any additional settings. PHP Mail is more likely to be considered spam by spam filtering applications.
 
+
 
===== SMTP =====
 
===== SMTP =====
 
SMTP uses an SMTP server to send email. You will need to retrieve the SMTP configuration information from your control panel or hosting provider or from Google. The requirements depend on the authentication type you choose.
 
 
   
 
   
====== SMTP with OAuth ======
+
''SMTP'' uses an SMTP server to send email. You will need to retrieve the SMTP configuration information from your control panel or hosting provider or from Google. The requirements depend on the authentication type you choose.
WHMCS includes OAuth support for Google email in version 8.0 and later. OAuth is a technology that authorizes apps or services like WHMCS to access another service, such as a Google email account. It's more secure than traditional username-and-password authentication.
+
 
+
WHMCS 8.0 and later includes support for Google email. This includes OAuth2 to authorize app or service access and is more secure than traditional username-and-password authentication.
Some mail providers require OAuth or have announced a requirement for it in the future.
+
 +
<div class="docs-alert-info">
 +
For steps to set up Google and the required Google app, see [https://help.whmcs.com/m/system/l/1277316-setting-up-google-as-your-mail-service-provider Setting Up Google As Your Mail Service Provider].
 +
</div>
 +
 +
===== Microsoft =====
 +
 +
WHMCS 8.6 and later includes support for all Microsoft Azure® apps, like Hotmail®, Microsoft Outlook®, Microsoft 365®, Skype®, and several others. This includes OAuth2 to authorize app or service access and is more secure than traditional username-and-password authentication.
 +
 
 +
For steps to set up Microsoft and the required Microsoft Azure app, see [https://help.whmcs.com/m/system/l/1600738-setting-up-microsoft-as-your-mail-service-provider Setting Up Microsoft As Your Mail Service Provider].
 
   
 
   
For instructions to set up OAuth for Google email and the required Google app, see [https://help.whmcs.com/m/system/l/1277316-setting-up-google-as-your-mail-service-provider Setting Up Google As Your Mail Service Provider].
 
 
 
===== MailGun, SendGrid, and SparkPost =====
 
===== MailGun, SendGrid, and SparkPost =====
 
+
 
[https://www.mailgun.com MailGun], [https://www.sendgrid.com SendGrid], and [https://www.sparkpost.com SparkPost] are email service providers that allow you access to tools for improved mail deliverability and email validation.
 
[https://www.mailgun.com MailGun], [https://www.sendgrid.com SendGrid], and [https://www.sparkpost.com SparkPost] are email service providers that allow you access to tools for improved mail deliverability and email validation.
 +
 
 +
To set this up, enter your information from your email service provider, including the API key.
 
   
 
   
To set this up, you will need some information from your email service provider, including an API key.
 
 
 
===== Custom Modules =====
 
===== Custom Modules =====
 
+
 
You can extend the selection of mail providers with custom modules. For more information, consult our [https://developers.whmcs.com/mail-providers/ Mail Providers developer documentation].
 
You can extend the selection of mail providers with custom modules. For more information, consult our [https://developers.whmcs.com/mail-providers/ Mail Providers developer documentation].
  
Line 85: Line 100:
  
 
<div class="docs-alert-warning">
 
<div class="docs-alert-warning">
<span class="title">WHMCS 8.1 and later</span><br />
 
 
We added this setting in WHMCS 8.1.
 
We added this setting in WHMCS 8.1.
 
</div>
 
</div>
Line 91: Line 105:
 
Set the toggle to '''ON''' to stop WHMCS from sending any outgoing email. For more information, see [[Disabling Outgoing Mail]].
 
Set the toggle to '''ON''' to stop WHMCS from sending any outgoing email. For more information, see [[Disabling Outgoing Mail]].
  
We recommend that you only enable this setting when you are testing updates or customizations on a development installation or while troubleshooting. The system creates a log entry at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs''' whenever you enable or disable this setting.
+
We recommend that you only enable this setting when you are testing updates or customizations on a development installation or while troubleshooting. The system creates a log entry at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''Utilities > Logs''' whenever you enable or disable this setting.
  
 
===Disable RFC3834 Headers===
 
===Disable RFC3834 Headers===
Line 98: Line 112:
  
 
<div class="docs-alert-warning">
 
<div class="docs-alert-warning">
<span class="title">WHMCS 8.1 and later</span><br />
 
 
We added this setting in WHMCS 8.1. In WHMCS 8.1 and later, WHMCS sends support emails with RFC 3834-compliant headers by default.
 
We added this setting in WHMCS 8.1. In WHMCS 8.1 and later, WHMCS sends support emails with RFC 3834-compliant headers by default.
 
</div>
 
</div>

Latest revision as of 19:31, 28 November 2022


The Mail tab allows you to configure how emails and messages function in WHMCS.

You can access this tab at Configuration () > System Settings > General Settings or, prior to WHMCS 8.0, Setup > General Settings.

Mail Type or Mail Provider

Use the Mail Type or Mail Provider settings, depending on your WHMCS version, to choose how your installation sends mail. The mail provider you choose can affect your mail deliverability and offers different levels of security through different providers.

Configuring a Mail Provider in WHMCS 8.0 and later

For WHMCS 8.0 and later, Mail Provider displays your selected mail provider. To change and configure it:

  1. Click Configure Mail Provider.
  2. Choose a Mail Provider from the menu.
  3. Enter the information for your chosen provider:
    • PHP Mail (default) — Choose an encoding type from Mail Encoding. We recommend the 8bit encoding type unless you are experiencing character display issues with your system character set.
    • SMTP — Enter the indicated information:
      • Select a Mail Encoding type.
      • Select a service provider. If you choose Google, see Setting Up Google As Your Mail Service Provider.
      • Enter an SMTP host. If you chose Google as your service provider, make certain to use smtp.google.com.
      • Enter the port on which your SMTP server operates. The port varies depending on the SSL type and your mail server configuration. Check with your mail server administrator for the appropriate port to use. These are the most commonly-used ports by SSL type:
        • None: 25 or 26
        • SSL: 465 or 587
        • TLS: 587
      • Select an authentication type. Oauth2 is only available if you selected Google for Service Provider.
      • Enter your authentication information. This depends on your chosen service provider and authentication type.
      • Specify whether to use a secure connection when communicating with your mail server using the SMTP SSL Type menu. Changes to this option will usually also require changing the SMTP Port value.
      • Check Debugging if you want to log debugging output at Configuration () > System Logs.
    • MailGun — Select a region, and then enter your sending domain and MailGun API key.
    • Microsoft — Enter your authentication information.
      • In order to use Microsoft® email services, you must set Friendly URLs to Friendly index.php or Full Friendly Rewrite in the General tab at Configuration () > System Settings > General Settings.
      • For complete setup steps, see Setting Up Microsoft As Your Mail Service Provider.
      • Check Debugging if you want to log debugging output at Configuration () > System Logs.
      • This mail provider is only available in WHMCS 8.6 and later.
    • SendGrid — Enter your API key.
    • SparkPost — Select a SparkPost account and enter a SparkPost API key. Check Use Sink Testing to allow you to check email sending without actually sending emails.
  4. Click Test Configuration. The system will send an email to test your configuration. If the test doesn't succeed, you will see an error.
  5. Click Save. The system will send an email to test your configuration, and it won't save your changes unless the test is successful.

Configuring a Mail Type in WHMCS 7.10 and earlier

For WHMCS 7.10 and earlier, use Mail Type to choose one of these options:

  • Use PHP Mail to send emails from inside WHMCS. This requires no further configuration, but some email providers may treat this email with increased suspicion.
  • Use your SMTP server to send emails. The related SMTP fields are required:
    • For SMTP Port, specify the port on which your SMTP server operates. This will usually vary depending on the SSL type and your particular mail server configuration.
      • Check with your mail server administrator for the appropriate port to use.
      • These are the most commonly-used ports by SSL type:
        • None: 25 or 26
        • SSL: 465 or 587
        • TLS: 587
    • For SMTP SSL Type, specify whether a secure connection is used when communicating with your mail server. Changes to this option will usually also require changing SMTP Port.

For step-by-step instructions, see Configuring WHMCS to Use SMTP in WHMCS 7.

Mail Providers and Mail Types

WHMCS supports the following mail providers:

  • PHP Mail
  • SMTP (with OAuth2 authentication via Google in WHMCS 8.0 and later)
  • MailGun (WHMCS 8.0 and later)
  • Microsoft (WHMCS 8.6 and later)
  • SendGrid (WHMCS 8.0 and later)
  • SparkPost (WHMCS 8.0 and later)
PHP Mail

When you choose PHP Mail, you won't need to configure any additional settings. PHP Mail is more likely to be considered spam by spam filtering applications.

SMTP

SMTP uses an SMTP server to send email. You will need to retrieve the SMTP configuration information from your control panel or hosting provider or from Google. The requirements depend on the authentication type you choose.

WHMCS 8.0 and later includes support for Google email. This includes OAuth2 to authorize app or service access and is more secure than traditional username-and-password authentication.

For steps to set up Google and the required Google app, see Setting Up Google As Your Mail Service Provider.

Microsoft

WHMCS 8.6 and later includes support for all Microsoft Azure® apps, like Hotmail®, Microsoft Outlook®, Microsoft 365®, Skype®, and several others. This includes OAuth2 to authorize app or service access and is more secure than traditional username-and-password authentication.

For steps to set up Microsoft and the required Microsoft Azure app, see Setting Up Microsoft As Your Mail Service Provider.

MailGun, SendGrid, and SparkPost

MailGun, SendGrid, and SparkPost are email service providers that allow you access to tools for improved mail deliverability and email validation.

To set this up, enter your information from your email service provider, including the API key.

Custom Modules

You can extend the selection of mail providers with custom modules. For more information, consult our Mail Providers developer documentation.

Disable Email Sending

We added this setting in WHMCS 8.1.

Set the toggle to ON to stop WHMCS from sending any outgoing email. For more information, see Disabling Outgoing Mail.

We recommend that you only enable this setting when you are testing updates or customizations on a development installation or while troubleshooting. The system creates a log entry at Configuration () > System Logs or, prior to WHMCS 8.0, Utilities > Logs whenever you enable or disable this setting.

Disable RFC3834 Headers

Set the toggle to ON to stop WHMCS from including RFC 3834 headers in outgoing support emails. These headers prevent circular responses when both the sender and destination are using autoresponders.

We added this setting in WHMCS 8.1. In WHMCS 8.1 and later, WHMCS sends support emails with RFC 3834-compliant headers by default.

Regardless of the option that you choose for this setting, email piping and email importing won't import email that contains the Auto-Submitted header.

Global Email Signature

Enter the text to be appended to all emails sent to customers by WHMCS containing the {$signature} merge field. HTML can be used here.

Global Email CSS Styling

Enter the CSS code to be used to format every email template sent to clients by WHMCS.

For more information and the default content, see Email Styling.

Global Email Header Content

Content entered in this field will be displayed at the top of every email template sent to clients. HTML can be used here.

For more information and the default content, see Email Styling.

Global Email Footer Content

Content entered in this field will be displayed at the bottom of every email template sent to clients. HTML can be used here.

For more information and the default content, see Email Styling.

System Emails From Name

The sender name that will appear on all emails sent to staff by WHMCS.

For example, these emails include Cron Job Activity, New Order Notification, and Automation Success/Failure Notifications.

System Emails From Email

The email address that will appear on all emails sent to staff by WHMCS. This address does not necessarily have to exist (for example, noreply@yourcompany.com).

BCC Messages

An email address entered here will receive a blind carbon copy of all emails sent to customers by WHMCS.

Presales Form Destination OR Presales Contact Form Email

The department or email address that will receive messages sent via the pre-sales contact form.