Email Piping - Revision history

SarahK at 21:32, 1 March 2023

2023-03-01T21:32:03Z

SarahK at 21:16, 8 February 2023

2023-02-08T21:16:06Z

SarahK at 21:13, 8 February 2023

2023-02-08T21:13:29Z

SarahK at 20:13, 21 April 2022

2022-04-21T20:13:01Z

SarahK at 22:41, 11 March 2022

2022-03-11T22:41:35Z

SarahK at 19:20, 18 January 2022

2022-01-18T19:20:20Z

Lawrence: /* The system prevented an autoresponder from opening a ticket. */

2021-11-02T20:29:28Z

‎The system prevented an autoresponder from opening a ticket.

SarahK: /* Common Problems */

2021-10-13T20:15:26Z

‎Common Problems

SarahK: /* Testing the Email Piping */

2021-10-13T20:15:11Z

‎Testing the Email Piping

SarahK: /* Common Problems */

2021-09-28T16:42:14Z

‎Common Problems

@@ Line 2: / Line 2: @@
 <div class="docs-alert-info">
-For steps to configure email piping and Google Apps, see [[Email Piping: Google Apps]].
+* For a tutorial on setting up email piping for cPanel, see [https://help.whmcs.com/m/setup/l/1112149-configuring-email-piping Configuring Email Piping].
 </div>
-Begin by first configuring your support ticket departments. You do this by going to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Support Departments]]''' or, prior to WHMCS 8.0, '''Setup > Support Departments'''.  Add each of your departments and the email address that you assigned to them.
+==Department Setup==
-<div class="docs-alert-info">
+Before you can set up email piping, you must configure your support departments at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Support Departments]]''' or, prior to WHMCS 8.0, '''Setup > Support Departments'''.  Add each of your departments and the email address that you assigned to them.
 ==Email Piping Methods==
@@ Line 20: / Line 18: @@
 * The '''Forwarder Method''' uses email forwarders to pipe messages to WHMCS. Use this method if you use cPanel or DirectAdmin and are piping in emails from the domain that WHMCS is installed on.
 * The '''Mail Importing Method''' pipes messages to WHMCS from individual email accounts. Use this method if you don't use cPanel or DirectAdmin or if you want to pipe email from multiple domains.
-−
 <div class="docs-alert-info">
-<strong>RFC 3834</strong><br />
+If you have customized the location of the crons directory, adjust the file path examples below accordingly.
 </div>
@@ Line 63: / Line 58: @@
 ==Spam Control==
-Email piping can include the problem of Spam sent via email. To help with this, WHMCS includes spam control filters.  See the [[Spam Control]] article for more information.
+When you use email piping, spam can become a problem. To help with this, WHMCS includes spam control filters. For more information, see [[Spam Control]].
 ==Common Problems==
@@ Line 84: / Line 79: @@
 ===The system prevented an autoresponder from opening a ticket.===
 This error message indicates that an email contained the <tt>Auto-Submitted</tt> attribute in its headers. The system will not import these messages into the WHMCS support ticket system. This avoids sending an auto-reply in accordance with the [https://datatracker.ietf.org/doc/html/rfc3834 RFC 3834] email specification.

@@ Line 92: / Line 92: @@
 ====Unable to communicate with the WHMCS installation====
-This error occurs when the cron.php file is unable to communicate with the WHMCS installation. It typically occurs when you have [[Custom_Crons_Directory|customized the location of the /crons directory]]. The <tt>cron.php</tt> file will look for the WHMCS directory in the location in the <tt>/crons/config.php</tt> file. To resolve this error:
+This error occurs when the cron.php file is unable to communicate with the WHMCS installation. It typically occurs when you have customized the location of the /crons directory. The <tt>cron.php</tt> file will look for the WHMCS directory in the location in the <tt>/crons/config.php</tt> file. To resolve this error:
 # Open the <tt>/crons/config.php</tt> file.

@@ Line 9: / Line 9: @@
 <div class="docs-alert-info">
 <span class="title">Note:</span><br />
-If you have customized the location of [[Custom_Crons_Directory|the crons directory]], adjust the file path examples below accordingly.
+If you have customized the location of the crons directory, adjust the file path examples below accordingly.
 </div>

@@ Line 2: / Line 2: @@
 <div class="docs-alert-info">
 For steps to configure email piping and Google Apps, see [[Email Piping: Google Apps]].
 </div>
-Begin by first configuring your support ticket departments. You do this by going to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Support > Support Departments'''.  Add each of your departments and the email address that you assigned to them.
+Begin by first configuring your support ticket departments. You do this by going to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Support Departments]]''' or, prior to WHMCS 8.0, '''Setup > Support Departments'''.  Add each of your departments and the email address that you assigned to them.
 <div class="docs-alert-info">
@@ Line 25: / Line 24: @@
 <strong>RFC 3834</strong><br />
 In WHMCS 8.1 and later, the system sends support emails with RFC 3834-compliant headers by default.
-* You can disable this at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' in the '''Mail''' tab.
+* You can disable this at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' in the '''[[Mail Tab|Mail]]''' tab.
 * Regardless of your settings, WHMCS will not accept email that email that contains the <tt>Auto-Submitted</tt> header via email piping or email importing.
 </div>
@@ Line 40: / Line 39: @@
 </nowiki></div>
-You can find a copy-and-paste-ready command with the specific path for your setup. Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Support Departments''' within your WHMCS installation and copy the command from the forwarder command field.
+You can find a copy-and-paste-ready command with the specific path for your setup. Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Support Departments]]''' or, prior to WHMCS 8.0, '''Setup > Support Departments''' within your WHMCS installation and copy the command from the forwarder command field.
 <div class="docs-alert-info">
 The <tt>pipe.php</tt> file requires <tt>755</tt> permissions to function properly.
 <br />
@@ Line 57: / Line 55: @@
 After you set up email piping, try sending a test email. If the piping is correctly configured, the system will open a new ticket. (It can take up to five minutes if you use the cron job method.) For testing purposes, do not use your admin email address to send the message. The system expects emails from admin email addresses to be replies to tickets only, and so it won't open new tickets.
-If the system doesn't create a ticket when sending an email, check in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs > Ticket Mail Import Log''' (in WHMCS 7.x and earlier, '''Utilities > Ticket Mail Import Log'''). If WHMCS received the message, it will appear in this list with the reason why it failed to create a ticket. If the message you sent doesn't appear here, the forwarder you set up previously is not working correctly and WHMCS didn't receive the message.
+If the system doesn't create a ticket when sending an email, check the '''Ticket Mail Import Log''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' (in WHMCS 7.x and earlier, '''Utilities > Logs'''). If WHMCS received the message, it will appear in this list with the reason why it failed to create a ticket. If the message you sent doesn't appear here, the forwarder you set up previously is not working correctly and WHMCS didn't receive the message.
 If you get the error message ''The system could not find the ticket ID.'' (''Ticket ID Not Found'' prior to WHMCS 8.3), you are trying to open a support ticket from your admin email address. Admins can only reply to tickets, not open new ones. Submit a ticket from any other email address and the system should accept it.
@@ Line 68: / Line 66: @@
 ==Common Problems==
-If the system didn't pipe an email into the ticket system, first see '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs > Ticket Mail Import Log''' (in WHMCS 7.x and earlier, this is at '''Utilities > Logs > Ticket Mail Import Log'''). This shows all the emails that WHMCS's email piping feature has processed and any errors that may have occurred. Below are the most common errors:
+If the system didn't pipe an email into the ticket system, check the '''Ticket Mail Import Log''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' (in WHMCS 7.x and earlier, '''Utilities > Logs'''). This shows all the emails that WHMCS's email piping feature has processed and any errors that may have occurred. Below are the most common errors:
 ===The system could not find the ticket ID.===
@@ Line 81: / Line 79: @@
 ===The sender's email address is not registered.===
-This error message indicates that you have chosen to only allow registered clients to open tickets in this department. You must uncheck '''Clients Only''' when you edit a support department at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Support Departments''' to public ticket creation.
+This error message indicates that you have chosen to only allow registered clients to open tickets in this department. You must uncheck '''Clients Only''' for the support department at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Support Departments]]''' or, prior to WHMCS 8.0, '''Setup > Support > Support Departments'''.
 Prior to WHMCS 8.3, this was ''Unregistered Email Address''.
@@ Line 153: / Line 151: @@
 To troubleshoot this:
-* Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Support > Support Departments'''.
+# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Support Departments]]''' or, prior to WHMCS 8.0, '''Setup > Support > Support Departments'''.
-* Edit the department that the notification email referenced.
+# Edit the department that the notification email referenced.
-* Verify that the POP3 settings use correct values (username (<tt>user@example.com</tt>), password, and port),
+# Verify that the POP3 settings use correct values (username (<tt>user@example.com</tt>), password, and port),
-* Verify that the hostname is a FQDN and resolves. Alternately, check with your system administrator or hosting provider for the correct connection details to use for POP3.
+# Verify that the hostname is a FQDN and resolves. Alternately, check with your system administrator or hosting provider for the correct connection details to use for POP3.
-* Click '''Save Changes'''.
+# Click '''Save Changes'''.
 ====Sender Verify Failed====
 This error indicates that the SMTP server requires a valid account on the server to send from.
-Check that the '''From Address''' under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Mail''' is not blank and you have entered a valid address that is authorized to send mail through the SMTP server. You may need to check with your hosting provider or mail server administrator.
+Check that the '''From Address''' in the '''[[Mail Tab|Mail]]''' 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''' is not blank and you have entered a valid address that is authorized to send mail through the SMTP server. You may need to check with your hosting provider or mail server administrator.
 ====Too Many Login Failures====
-This error indicates that the mail server is blocking WHMCS because the login details under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Support > Support Departments > Edit''' (email piping) are incorrect.
+This error indicates that the mail server is blocking WHMCS because the email piping login details under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Support Departments]]''' or, prior to WHMCS 8.0, '''Setup > Support > Support Departments''' are incorrect.
 Check whether the details you entered are correct. After correcting them, you will need to wait out the block time. If you use a cPanel server, you can whitelist the WHMCS IP address in cPHulkd or remove the WHMCS IP address from the blacklist. For more information, see [https://docs.cpanel.net/whm/security-center/cphulk-brute-force-protection/|cPanel's documentation].

← Older revision		Revision as of 22:41, 11 March 2022
Line 1:		Line 1:
	Email piping automatically imports emails for an email address into the support ticket system. As a result, clients can open and reply to tickets via email without the need to log in to the client area first.		Email piping automatically imports emails for an email address into the support ticket system. As a result, clients can open and reply to tickets via email without the need to log in to the client area first.
		+
		+	<div class="docs-alert-info">
		+	<span class="title">Google Apps</span><br />
		+	For steps to configure email piping and Google Apps, see [[Email Piping: Google Apps]].
		+	</div>

	Begin by first configuring your support ticket departments. You do this by going to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Support > Support Departments'''. Add each of your departments and the email address that you assigned to them.		Begin by first configuring your support ticket departments. You do this by going to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Support > Support Departments'''. Add each of your departments and the email address that you assigned to them.

@@ Line 102: / Line 102: @@
   pipe to |/home/username/public_html/whmcs/crons/pipe.php
-  generated by support@yourdomain.com
+  generated by support@example.com
   local delivery failed
@@ Line 141: / Line 141: @@
 </nowiki></div>
-Next, visit the <tt>pop.php</tt> file directly in your browser (for example, <tt>http://www.yourdomain.com/crons/pop.php</tt>). You may encounter the common errors below:
+Next, visit the <tt>pop.php</tt> file directly in your browser (for example, <tt>http://www.example.com/crons/pop.php</tt>). You may encounter the common errors below:
 ====Could Not Authenticate====

@@ Line 81: / Line 81: @@
 ===The system prevented an autoresponder from opening a ticket.===
-This error message indicates that an email contained the <tt>Auto-Submitted</tt> attribute in its headers. The system will not import these messages into the WHMCS support ticket system. This avoids sending an auto-reply in accordance with the [http://tools.ietf.org/html/rfc3834 RFC 3834] email specification.
+This error message indicates that an email contained the <tt>Auto-Submitted</tt> attribute in its headers. The system will not import these messages into the WHMCS support ticket system. This avoids sending an auto-reply in accordance with the [https://datatracker.ietf.org/doc/html/rfc3834 RFC 3834] email specification.
 Prior to WHMCS 8.3, this was ''Prevented an Auto Responder from Opening a Ticket''.

@@ Line 64: / Line 64: @@
 ==Common Problems==
 If the system didn't pipe an email into the ticket system, first see '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs > Ticket Mail Import Log''' (in WHMCS 7.x and earlier, this is at '''Utilities > Logs > Ticket Mail Import Log'''). This shows all the emails that WHMCS's email piping feature has processed and any errors that may have occurred. Below are the most common errors:
-===Ticket ID Not Found===
+Prior to WHMCS 8.3, this was ''Ticket ID Not Found''.
-This error message indicates that you are using an email address that you assigned to an administrator to send your email. Administrators can only reply to tickets, not open new ones. To test this, you must send an email from an email address that doesn't belong to an admin in your WHMCS system.
+===The system blocked a potential email loop.===
 This error message indicates that WHMCS received a large number of emails from the same email address, indicating an auto-responder loop. To break the cycle, WHMCS did not import the email. By default, the system will block any new tickets from the offending address if it receives 10 emails from the same address within a 15 minute period. You can customize this in the [[Support_Tab#Ticket_Reply_Email_Limit|General Settings]].
-===Unregistered Email Address===
+Prior to WHMCS 8.3, this was ''Blocked Potential Email Loop''.
-This error message indicates that you have chosen to only allow registered clients to open tickets in this department. You must uncheck the Clients Only checkbox in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Support Departments > Edit''' to allow the public to create tickets.
+===The sender's email address is not registered.===
-===Only Replies Allowed by Email===
+This error message indicates that you have chosen to only allow registered clients to open tickets in this department. You must uncheck '''Clients Only''' when you edit a support department at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Support Departments''' to public ticket creation.
-===Prevented an Auto Responder from Opening a Ticket===
+Prior to WHMCS 8.3, this was ''Unregistered Email Address''.
-This log message occurs when an email contains the ''Auto-Submitted'' attribute in its headers. Such messages will not be imported into the WHMCS support ticket system. This is to avoid sending an auto-reply in accordance with the [http://tools.ietf.org/html/rfc3834 RFC 3834] email specification.
-===One or more POP3 connections failed===
+Prior to WHMCS 8.3, this was ''Prevented an Auto Responder from Opening a Ticket''.
 ==Troubleshooting==

@@ Line 48: / Line 48: @@
 Email importing is an alternative to email piping. For more information, see [[Email Importing]].
-==Testing the Email Piping==
+==Testing Email Piping==
-−
-After you set up the piping, try sending a test email to it.  If the piping is correctly configured, the system will open a new ticket (it can take up to 5 minutes if using the cron job method).  For testing purposes, you should not use your admin email address to send the message. The system expects emails from admin email addresses to be replies to tickets only, and so it won't open new tickets.
+After you set up email piping, try sending a test email. If the piping is correctly configured, the system will open a new ticket. (It can take up to five minutes if you use the cron job method.) For testing purposes, do not use your admin email address to send the message. The system expects emails from admin email addresses to be replies to tickets only, and so it won't open new tickets.
-−
-If the system doesn't create a ticket when sending in an email, check in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs > Ticket Mail Import Log''' (in WHMCS 7.x and earlier, this is at '''Utilities > Ticket Mail Import Log''').  If WHMCS received the message, it will appear in this list with the reason why it failed to create a ticket.  If the message you sent doesn't appear here, then the forwarder you set up previously is not working correctly and WHMCS didn't receive the message.
+If the system doesn't create a ticket when sending an email, check in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs > Ticket Mail Import Log''' (in WHMCS 7.x and earlier, '''Utilities > Ticket Mail Import Log'''). If WHMCS received the message, it will appear in this list with the reason why it failed to create a ticket. If the message you sent doesn't appear here, the forwarder you set up previously is not working correctly and WHMCS didn't receive the message.
-−
-If you get the error message "Ticket ID Not Found", you are trying to open a support ticket from your admin email address. Admins can only reply to tickets, not open new ones. Submit a ticket from any other email address and the system should accept it.
+If you get the error message ''The system could not find the ticket ID.'' (''Ticket ID Not Found'' prior to WHMCS 8.3), you are trying to open a support ticket from your admin email address. Admins can only reply to tickets, not open new ones. Submit a ticket from any other email address and the system should accept it.
-−
 For other errors, see the following [[#Common Problems|Common Problems]] and [[#Troubleshooting|Troubleshooting]] sections.