Email Campaigns - Revision history

SarahK at 19:54, 21 April 2022

2022-04-21T19:54:01Z

SarahK at 22:30, 14 April 2022

2022-04-14T22:30:11Z

SarahK at 21:56, 1 March 2022

2022-03-01T21:56:32Z

SarahK: /* Create a New Campaign */

2021-12-17T16:14:06Z

‎Create a New Campaign

PeterM: /* Internal Queue vs. External Send Requests */

2021-06-28T08:27:35Z

‎Internal Queue vs. External Send Requests

John: /* Editing and Pausing Campaigns */

2021-03-17T15:16:08Z

‎Editing and Pausing Campaigns

John: /* Editing and Pausing Campaigns */

2021-03-17T13:54:55Z

‎Editing and Pausing Campaigns

SarahK: /* Common Problems */

2021-02-10T18:14:20Z

‎Common Problems

SarahK: /* Create a New Campaign */

2021-01-06T14:11:14Z

‎Create a New Campaign

SarahK: /* Mailing Lists */

2020-08-28T16:01:21Z

‎Mailing Lists

@@ Line 22: / Line 22: @@
 # Click '''Compose Message'''. [[File:Email_campaigns_compose_message84.png|200px|thumb|right|Composing an Email Campaign Message]]
 # Check the '''From''' information and list of recipients to ensure that they're correct.
-# In WHMCS 8.3 and earlier, enter any '''CC''' or '''BCC''' recipients as a comma-separated list. <div class="docs-alert-info"><span class="title">WHMCS 8.4 and later</span><br />We removed support for CC and BCC recipients in WHMCS 8.4.</div>
+# In WHMCS 8.3 and earlier, enter any '''CC''' or '''BCC''' recipients as a comma-separated list. <div class="docs-alert-info">We removed support for CC and BCC recipients in WHMCS 8.4.</div>
 # Enter a subject and body message for the email.
 #* The bottom of the interface lists values that you can display in the message, like displaying the client's name or an '''Unsubscribe''' link.
@@ Line 34: / Line 34: @@
 <div class="docs-alert-info">
 When you compose the email, you will see the first 50 clients matching your selected criteria in the '''To''' field, so that you can review the recipients. However, the system will send each email individually. The receiver will not see any other client addresses in the '''To''' field of the copy they receive.
 </div>
@@ Line 52: / Line 51: @@
 ===Mailing Lists===
-You can create a mailing list using custom client fields. To do this, navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Custom Fields'''. You can use the '''Dropdown''' or '''TickBox''' field types. If you choose '''Dropdown''', make sure to enter the necessary options.
+You can create a mailing list using custom client fields. To do this, navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Custom Fields]]'''. You can use the '''Dropdown''' or '''TickBox''' field types. If you choose '''Dropdown''', make sure to enter the necessary options.
 [[File:Email_campaigns_custom_field.png|400px|thumb|center|Custom Mailing List Field]]
@@ Line 71: / Line 70: @@
 When WHMCS starts sending a campaign, it will batch messages to the recipients (determined by your criteria) in increments of 50. A batch of these messages goes into a process queue every five minutes, at maximum, or with the frequency at which your cron runs if it runs less frequently. For example, if your cron runs every three minutes, the batches would go to the process queue every five minutes. If your cron runs every ten minutes, the batches would go to the process queue every ten minutes.
 * '''Sending Progress''' reports the status of this process. WHMCS sends the items in the process queue as API requests or emails to your mail provider. This occurs at a rate of 25 recipients per minute, depending on the frequency of your cron command. This is the total sending rate of all email campaigns. A new campaign will not begin sending until the previous campaign has completed.
 * The '''Sending Report''' contains the status of the external send requests, including a list of failures. See [[#Sending Report|Sending Report]] below.

@@ Line 1: / Line 1: @@
 Using '''Email Campaigns''' lets you send form field email messages to clients based on specific criteria. With a queueing process and email delivery provider integration, '''Email Campaigns''' lets you transparently process many campaigns at once. It also has retry capabilities to protect against network availability issues.
-You can work with email campaigns at '''Utilities > Email Campaigns'''.
+You can access this feature at '''Utilities > Email Campaigns'''.
-In WHMCS 8.0, this replaced the less fully-featured '''Mass Mail Tool''' at '''Clients > [[Mass Mail]]'''.
+In WHMCS 8.0, this replaced the '''Mass Mail Tool''' at '''Clients > [[Mass Mail]]'''.
 ==Create a New Campaign==

@@ Line 1: / Line 1: @@
 Using '''Email Campaigns''' lets you send form field email messages to clients based on specific criteria. With a queueing process and email delivery provider integration, '''Email Campaigns''' lets you transparently process many campaigns at once. It also has retry capabilities to protect against network availability issues.
 In WHMCS 8.0, this replaced the less fully-featured '''Mass Mail Tool''' at '''Clients > [[Mass Mail]]'''.
@@ Line 9: / Line 11: @@
 To create a new email campaign:
-# Go to '''Utilities > Email Campaigns''' and click '''Create New Campaign'''.
+# Click '''Create New Campaign'''.
 # Enter an email campaign name.
 # Choose the type of email to send, which sets the criteria to use to select the email's recipients.

@@ Line 4: / Line 4: @@
 ==Create a New Campaign==
 Use '''Email Campaigns''' to send an email message to a group of clients. You can choose to send the message to all of your clients or limit it to clients that meet specific criteria.
 To create a new email campaign:
-#Go to '''Utilities > Email Campaigns''' and click '''Create New Campaign'''.
+# Go to '''Utilities > Email Campaigns''' and click '''Create New Campaign'''.
-#Enter an email campaign name.
+# Enter an email campaign name.
-#Choose the type of email to send, which sets the criteria to use to select the email's recipients.
+# Choose the type of email to send, which sets the criteria to use to select the email's recipients.
-#*By default, the email type is '''General''', which only lets you filter on the client status or country criteria. You can also choose:
+#* By default, the email type is '''General''', which only lets you filter on the client status or country criteria. You can also choose:
 #** '''Product/Service''', to filter by product-related criteria.
 #** '''Addon''', to filter by addon-related criteria.
 #** '''Domain''', to filter by domain-related criteria.
-#*If you do not want to filter clients by a specific criteria, leave that filter unchanged and it will be ignored.
+#* If you do not want to filter clients by a specific criteria, leave that filter unchanged and it will be ignored.
-#Update '''Client Criteria''' to filter by the correct '''Client Group''', '''Country''', '''Language''', and '''Client Status'''. To do this, select one or more items from the lists. For example, if you select ''United States'' for '''Country''' to only send the email campaign to clients in the US.
+# Update '''Client Criteria''' to filter by the correct '''Client Group''', '''Country''', '''Language''', and '''Client Status'''. To do this, select one or more items from the lists. For example, if you select ''United States'' for '''Country''' to only send the email campaign to clients in the US.
-#Click '''Compose Message'''. [[File:Email_campaigns_compose_message.png|200px|thumb|right|Composing an Email Campaign Message]]
+# Click '''Compose Message'''. [[File:Email_campaigns_compose_message84.png|200px|thumb|right|Composing an Email Campaign Message]]
-#Check the '''From''' information and list of recipients to ensure that they're correct.
+# Check the '''From''' information and list of recipients to ensure that they're correct.
-#Enter any '''CC''' or '''BCC''' recipients as a comma-separated list.
+# In WHMCS 8.3 and earlier, enter any '''CC''' or '''BCC''' recipients as a comma-separated list. <div class="docs-alert-info"><span class="title">WHMCS 8.4 and later</span><br />We removed support for CC and BCC recipients in WHMCS 8.4.</div>
-#Enter a subject and body message for the email.
+# Enter a subject and body message for the email.
-#*The bottom of the interface lists values that you can display in the message, like displaying the client's name or an '''Unsubscribe''' link.
+#* The bottom of the interface lists values that you can display in the message, like displaying the client's name or an '''Unsubscribe''' link.
-#*Click '''Message Preview''' to preview your message.
+#* Click '''Message Preview''' to preview your message.
-#*Click '''Enable/Disable Rich-Text Editor''' to use the rich-text editor.
+#* Click '''Enable/Disable Rich-Text Editor''' to use the rich-text editor.
-#Add any '''Attachments'''.
+# Add any '''Attachments'''.
-#Check '''Marketing Email?''' to prevent sending this message to anyone who has opted out of marketing emails.
+# Check '''Marketing Email?''' to prevent sending this message to anyone who has opted out of marketing emails.
-#Check '''Save Message''' and enter a name to save the message for future use.
+# Check '''Save Message''' and enter a name to save the message for future use.
-#Use '''Start Date/Time''' to schedule when the email will send.
+# Use '''Start Date/Time''' to schedule when the email will send.
-#Click '''Save Draft''' to save the message. Click '''Send Campaign''' to send the message immediately or, if you set one, at the scheduled time.
+# Click '''Save Draft''' to save the message. Click '''Send Campaign''' to send the message immediately or, if you set one, at the scheduled time.
 <div class="docs-alert-info">

@@ Line 68: / Line 68: @@
 When WHMCS starts sending a campaign, it will batch messages to the recipients (determined by your criteria) in increments of 50. A batch of these messages goes into a process queue every five minutes, at maximum, or with the frequency at which your cron runs if it runs less frequently. For example, if your cron runs every three minutes, the batches would go to the process queue every five minutes. If your cron runs every ten minutes, the batches would go to the process queue every ten minutes.
-* '''Sending Progress''' reports the status of this process. WHMCS sends the items in the process queue as API requests or emails to your mail provider. This occurs at a rate of 25 recipients per minute, depending on the frequency of your cron command.
+* '''Sending Progress''' reports the status of this process. WHMCS sends the items in the process queue as API requests or emails to your mail provider. This occurs at a rate of 25 recipients per minute, depending on the frequency of your cron command. This is the total sending rate of all email campaigns. A new campaign will not begin sending until the previous campaign has completed.
 * The '''Sending Report''' contains the status of the external send requests, including a list of failures. See [[#Sending Report|Sending Report]] below.
-−
 ===Sending Report===
 Click '''View Sending Report''' under '''Sending Progress''' to view a report on the external send request status for the campaign.

@@ Line 93: / Line 93: @@
 </div>
-Click '''Pause''' to pause further sending of a campaign or to keep a queued campaign from sending. You can then click '''Resume''' here to resume sending.
+Click '''Pause''' to pause further queuing-up of messages for sending under this campaign. You can then click '''Resume''' here to resume queueing. Queued emails will continue to send after the campaign is paused.
 ====Message Preview====

@@ Line 90: / Line 90: @@
 <div class="docs-alert-warning">
 <span class="title">Important</span><br />
-If the '''Email Campaign''' has started sending, you can't edit it. You can, however, click '''Pause''' to stop it from continuing to send messages.
+If the '''Email Campaign''' has started sending, you can't edit it. You can, however, click '''Pause''' to stop it from continuing to queue more messages. Queued emails will continue to send after the campaign is paused.
 </div>
 Click '''Pause''' to pause further sending of a campaign or to keep a queued campaign from sending. You can then click '''Resume''' here to resume sending.
-−
 ====Message Preview====

← Older revision		Revision as of 18:14, 10 February 2021
Line 109:		Line 109:

	Most commonly, this is because you selected a client group or language to which you have assigned no clients.		Most commonly, this is because you selected a client group or language to which you have assigned no clients.
		+
		+	===Invalid Email Addresses===
		+	For any recipients with invalid email addresses, the system will abort sending the message. The system will not retry sending to these addresses.
		+
		+	===External Problems===
		+	If the system experiences external problems during sending, such as invalid SMTP details or problems with the SMTP server, it will retry sending indefinitely, with a new attempt every five minutes. If this occurs, pause the campaign, fix the external issue, and then click '''Resume'''.

@@ Line 48: / Line 48: @@
 ===Mailing Lists===
 You can create a mailing list using custom client fields. To do this, navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Custom Fields'''. You can use the '''Dropdown''' or '''TickBox''' field types. If you choose '''Dropdown''', make sure to enter the necessary options.
-−
-[[File:Email_campaigns_mailing_list.png|250px|thumb|right|Sending to Mailing List]]
+[[File:Email_campaigns_custom_field.png|400px|thumb|center|Custom Mailing List Field]]
 This will display as a client filter option. You can only send this to clients who have chosen to receive these mailings.
 ==Working with Email Campaigns==