Difference between revisions of "Email Campaigns"
(Created page with "<div class="docs-alert-info"> <span class="title">Mass Mail</span><br /> In WHMCS 7.x and earlier, this was the '''Mass Mail Tool''' at '''Clients > Mass Mail'''. </div>...") |
|||
| 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 | + | In WHMCS 8.0, this replaced the less fully-featured '''Mass Mail Tool''' at '''Clients > [[Mass Mail]]'''. |
| − | + | ||
| − | |||
==Create a New Campaign== | ==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. | + | 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: | 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. | #** '''Product/Service''', to filter by product-related criteria. | ||
| Line 18: | Line 17: | ||
#*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'''. | + | #Click '''Compose Message'''. [[File:Email_campaigns_compose_message.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. | #Enter any '''CC''' or '''BCC''' recipients as a comma-separated list. | ||
| − | #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. | ||
| Line 30: | Line 29: | ||
#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, or click '''Send Campaign''' to send the message immediately or, if you set one, at the scheduled time. | #Click '''Save Draft''' to save the message, or click '''Send Campaign''' to send the message immediately or, if you set one, at the scheduled time. | ||
| − | + | ||
<div class="docs-alert-info"> | <div class="docs-alert-info"> | ||
<span class="title">Note</span><br /> | <span class="title">Note</span><br /> | ||
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. | 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> | </div> | ||
| − | + | ||
===Filtering by Country=== | ===Filtering by Country=== | ||
You can send mass mailings to only clients in specific countries. To do this, select the countries as in the example below. | You can send mass mailings to only clients in specific countries. To do this, select the countries as in the example below. | ||
| − | + | ||
| − | [[File: | + | [[File:Email_campaigns_by_country.png|250px|thumb|right|Filtering by Country]] |
| − | + | ||
===Contacts=== | ===Contacts=== | ||
You can use contacts to send a copy of a message to a different email address. When sending one-time or mass mails, clients and users with the '''General''' email notification option enabled will receive a copy of any '''General''' mass mails that you send to the master account holder. | You can use contacts to send a copy of a message to a different email address. When sending one-time or mass mails, clients and users with the '''General''' email notification option enabled will receive a copy of any '''General''' mass mails that you send to the master account holder. | ||
| − | + | ||
If the contact has '''Product''' email notifications enabled, they will receive copies of mass mails with the '''Product/Service''' email type. If they have '''Domain''' email notifications enabled, they will receive copies of mass mails with the '''Domain''' email type. | If the contact has '''Product''' email notifications enabled, they will receive copies of mass mails with the '''Product/Service''' email type. If they have '''Domain''' email notifications enabled, they will receive copies of mass mails with the '''Domain''' email type. | ||
| − | + | ||
The recipients list doesn't include contacts when composing the message. However, if the master account appears in the list and the contact has the appropriate email permissions, they will receive a copy. | The recipients list doesn't include contacts when composing the message. However, if the master account appears in the list and the contact has the appropriate email permissions, they will receive a copy. | ||
| − | + | ||
===Mailing Lists=== | ===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: | + | [[File:Email_campaigns_custom_field.png|250px|thumb|right|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. | This will display as a client filter option. You can only send this to clients who have chosen to receive these mailings. | ||
| − | + | ||
| − | [[File: | + | [[File:Email_campaigns_mailing_list.png|250px|thumb|right|Sending to Mailing List]] |
| − | + | ||
==Working with Email Campaigns== | ==Working with Email Campaigns== | ||
| + | |||
| + | [[File:Email_campaigns_list.png|500px|thumb|Email Campaigns]] | ||
| + | |||
| + | After you create a campaign, it will appear in the list, with information about its status, sending progress, and other details. You can also perform some actions. | ||
| + | |||
| + | ===Internal Queue vs. External Send Requests=== | ||
| + | |||
| + | You may see campaigns that display 100% completion for '''Sending Progress''' but that have '''Sending''' as their '''Status'''. This is due to differences between the internal email campaign process queue and external send requests. | ||
| + | |||
| + | 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. | ||
| + | * 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. | ||
| + | |||
| + | [[File:Email_campaigns_sending_report.png|250px|thumb|right|Email Campaigns Sending Report]] | ||
| + | |||
| + | This report includes the time at which the campaign started sending and the completion date if there is one. Below this, you can view a sending progress bar and a list of failed recipients. | ||
| + | |||
| + | The progress bar increments as messages are accepted by the mail provider. If a message isn't accepted by the mail provider or there are failures to contact the mail server, WHMCS will automatically retry sending the message three times. After three retries, that message is added to the list of failures. | ||
| + | |||
| + | ===Managing Campaigns=== | ||
| + | |||
| + | To manage your campaigns, click '''Manage Campaign''' under '''Actions'''. Then, choose one of the options below: | ||
| + | |||
| + | ====Editing and Pausing Campaigns==== | ||
| + | |||
If you created an '''Email Campaign''' and saved it as a draft, or if you scheduled it for the future but it hasn't started sending yet, you can edit it. To do this, click '''Edit''' in the list of campaigns. | If you created an '''Email Campaign''' and saved it as a draft, or if you scheduled it for the future but it hasn't started sending yet, you can edit it. To do this, click '''Edit''' in the list of campaigns. | ||
| − | + | ||
| − | == | + | <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. | |
| − | + | </div> | |
| − | + | ||
| − | If the '''Email Campaign''' has started sending, you can't edit | + | 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==== |
| − | Click ''' | + | |
| − | + | Click '''Message Preview''' to view a preview of the campaign message. To update this message for queued campaigns, click '''Edit'''. | |
| + | |||
| + | ====Delete==== | ||
| + | |||
| + | Click '''Delete''' to delete the campaign. This will prevent future campaign emails from sending and will remove the campaign from the list. | ||
| + | |||
==Common Problems== | ==Common Problems== | ||
| − | + | ||
===No Recipients=== | ===No Recipients=== | ||
| − | If the criteria for an email includes no recipients, the system can't send it. Go back and select a different set of criteria. | + | If the criteria for an email includes no recipients, the system can't send it. Go back and select a different set of criteria. |
| − | + | ||
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. | ||
Revision as of 15:56, 28 August 2020
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.
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.
- Enter an email campaign name.
- 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:
- 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.
- By default, the email type is General, which only lets you filter on the client status or country criteria. You can also choose:
- 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.
- 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.
- 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.
- Click Message Preview to preview your message.
- Click Enable/Disable Rich-Text Editor to use the rich-text editor.
- Add any Attachments.
- 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.
- Use Start Date/Time to schedule when the email will send.
- Click Save Draft to save the message, or click Send Campaign to send the message immediately or, if you set one, at the scheduled time.
Note
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.
Filtering by Country
You can send mass mailings to only clients in specific countries. To do this, select the countries as in the example below.
Contacts
You can use contacts to send a copy of a message to a different email address. When sending one-time or mass mails, clients and users with the General email notification option enabled will receive a copy of any General mass mails that you send to the master account holder.
If the contact has Product email notifications enabled, they will receive copies of mass mails with the Product/Service email type. If they have Domain email notifications enabled, they will receive copies of mass mails with the Domain email type.
The recipients list doesn't include contacts when composing the message. However, if the master account appears in the list and the contact has the appropriate email permissions, they will receive a copy.
Mailing Lists
You can create a mailing list using custom client fields. To do this, navigate to Configuration () > System Settings > Custom Fields. You can use the Dropdown or TickBox field types. If you choose Dropdown, make sure to enter the necessary options.
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
After you create a campaign, it will appear in the list, with information about its status, sending progress, and other details. You can also perform some actions.
Internal Queue vs. External Send Requests
You may see campaigns that display 100% completion for Sending Progress but that have Sending as their Status. This is due to differences between the internal email campaign process queue and external send requests.
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.
- The Sending Report contains the status of the external send requests, including a list of failures. See 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.
This report includes the time at which the campaign started sending and the completion date if there is one. Below this, you can view a sending progress bar and a list of failed recipients.
The progress bar increments as messages are accepted by the mail provider. If a message isn't accepted by the mail provider or there are failures to contact the mail server, WHMCS will automatically retry sending the message three times. After three retries, that message is added to the list of failures.
Managing Campaigns
To manage your campaigns, click Manage Campaign under Actions. Then, choose one of the options below:
Editing and Pausing Campaigns
If you created an Email Campaign and saved it as a draft, or if you scheduled it for the future but it hasn't started sending yet, you can edit it. To do this, click Edit in the list of campaigns.
Important
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.
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
Click Message Preview to view a preview of the campaign message. To update this message for queued campaigns, click Edit.
Delete
Click Delete to delete the campaign. This will prevent future campaign emails from sending and will remove the campaign from the list.
Common Problems
No Recipients
If the criteria for an email includes no recipients, the system can't send it. Go back and select a different set of criteria.
Most commonly, this is because you selected a client group or language to which you have assigned no clients.