Difference between revisions of "Messages/Emails"

From WHMCS Documentation

(→‎Mass Mail)
Line 1: Line 1:
−
==Mass Mail==
+
==Sending Emails to a Client==
  
−
To send an email to a group of clients, go to Clients > Mass Mail.  You can then choose the criteria you want to filter on in order to select who the email will be sent to.  If you want to filter on product related criteria you must ensure you set the Email Type to be Product/Service related.  Likewise if you want to filter on domain related criteria you must set the Email Type to be Domain related.  By default the email type is General and so you can only filter on the client status criteria.
+
===One Off Mail===
  
−
When composing the email you will see the full list of filtered clients in the To field. However each email is sent individually, so your clients will not see everyone else's addresses.
+
*Begin by locating the client that you want to send the email to either by searching or locating their name in the clients list and then follow the link through to the client summary page
 +
*Next, in the '''Send Email''' panel, select the '''New Message''' option and click Send
 +
*This will take you to the email composition window where you can enter your message before clicking '''Send Message'''
  
−
==Email Templates==
+
====Save as a Template====
 +
 
 +
*When composing your message, if you think you may want to use it again in the future, you can save it.
 +
*To do this, tick the '''Save Message''' checkbox under the Subject field and enter a name to add it to the Email Templates.
 +
 
 +
===Predefined Templates===
 +
 
 +
*Predefined templates can be sent '''on demand''' for clients, products & domains. Other email types are only sent when specific events occur.
 +
 
 +
====Client Related====
 +
 
 +
*The steps are the same as the with the One Off Mail above but instead of choosing New Message in the dropdown, you need to choose the template name to send.
 +
 
 +
====Product & Domain Related====
 +
 
 +
*From the Client Summary page, click the edit icon next to the service or domain you want to send the email related to
 +
*Now scroll to the bottom of the product or domain details page that gets displayed
 +
*There you'll see a '''Send Message''' dropdown where you can choose the template name and click '''Send'''
 +
 
 +
====Customise the Template before Sending====
  
−
The Emails that WHMCS sends out to your customers can be fully customised in the email templates section of the WHMCS Configuration area.
+
*There might be some occassions where you want to send a predefined template but make some modifications first.
 +
*To do this, follow the steps as above but instead of choosing the template name choose '''New Message'''.
 +
*Then on the message composition screen which you are taken to for the new message, scroll to the bottom where you'll see a '''Load Message''' dropdown box.
 +
*From there you can choose the predefined template and load it into the message box ready for you to customise before sending.
  
−
The merge fields that are available in the email you are currently composing are displayed on the right of the page.  The fields you can use will depend on the type of email that you are creating and what it relates to - for example you cannot use a product specific merge field in a general email template as WHMCS wouldn't know which product is being referred to.
+
==Merge Fields==
  
−
To display client custom fields in the email templates, you can either reference it by it's numerical reference such as '''{$client_custom_fields.0}''' for the first field, '''{$client_custom_fields.1}''' for the second, etc...  Or you reference it by name using the format '''{$client_custom_field_fieldnamehere}'''.  For fieldnamehere, you need to take your custom field name, convert the name to lowercase and remove anything other than a-z 0-9 chars. For example "VAT Number" would become "vatnumber" and so would be '''{$client_custom_field_vatnumber}''' in the email template.
+
*In email messages you can enter '''merge field''' variables wihch are then replaced at the time of sending automatically with the users data.
−
The same applies to Product custom fields, however they are referenced by '''{$service_custom_fields.0}''' or '''{$service_custom_field_fieldnamehere}'''.
+
*The merge fields available in your message '''depend on what type''' of email you are sending.
 +
*For example if it's an email related to a client you can include client fields only, but if it's a product related email you could include product details aswell as client fields.
 +
*The exact list of fields you have available in any email message you are composing are listed directly below the message box with the field description and merge field code.
 +
*Clicking on the description will insert the merge field at the point of your cursor in the message.
  
−
==Sending Preset Emails to a Client==
+
===Custom Fields===
  
−
With WHMCS, it is possible to resend any of the automated emails in the general, product & domain categories manually should you need to. In this article, we will look at how this is done.
+
*To display client custom fields in the email templates, you can either reference it by it's numerical reference such as '''{$client_custom_fields.0}''' for the first field, '''{$client_custom_fields.1}''' for the second, etc...
 +
*Or you reference it by name using the format '''{$client_custom_field_fieldnamehere}'''.
 +
*For fieldnamehere, you need to take your custom field name, convert the name to lowercase and remove anything other than a-z 0-9 chars.
 +
*For example "VAT Number" would become "vatnumber" and so would be '''{$client_custom_field_vatnumber}''' in the email template.
 +
*The same applies to Product custom fields, however they are referenced by '''{$service_custom_fields.0}''' or '''{$service_custom_field_fieldnamehere}'''.
  
−
* General Emails - To resend an email from the general category to a client such as the Welcome Email or Client Area Details Reminder, simply locate the client either through the search or clients list and click their name to proceed to the client summary for that client.  You will see an area labelled Send Email where you have a dropdown to pick any of the general emails and once selected, just click the Send button to send it. 
+
===Conditional Displays===
  
−
* Product Emails - To resend a product related email, you need to tell WHMCS what product it's related to.  To do this, you need to locate the client, then click on to their Products/Services tab, select the product/service you want to send it for in the services dropdown menu and then scroll to the bottom of the page where you'll find a Send Message section.  From the dropdown menu you can select any of the product related emails in your system to resend to a client. 
+
*There may be cases where you want to display text in an email only if certain conditions are met.  For example you might want to include specific information in a sales support ticket submission so could use the below conditional statement in the Support Ticket Opened email template:
  
−
* Domain Emails - To resend a domain related email, you need to tell WHMCS what domain you want to send it for. To do this, like with product emails, you need to locate the client, but then click on to their Domains tab, select the domain you want to send it for and then scroll to the bottom of the page where you'll find a Send Message section. From the dropdown menu you can select any of the domain related emails in your system to resend to a client.
+
{if $ticket_department eq "Sales"}The sales department is open 9-5pm Monday-Friday so you
 +
  will only receive a response between these times. We thank you for your patience.{/if}
  
 
==Resending Emails to Clients==
 
==Resending Emails to Clients==
  
−
WHMCS allows you to resend a previously sent email from the users email log inside WHMCS. To do this, locate the email you wish to resend in the email log and click the Resend icon to the right of the row.  The email will then be loaded into the message editor where you can edit the content and add additional recipients, then click Send to resend.
+
*Begin by locating the email you want to resend. You can do this from the '''Email''' tab inside a clients profile or the master email log accessed in '''Utilities > Email Log'''.
 +
*Next, click the Resend icon on the message's row that you want to resend
 +
*The email will now be loaded into the message editor where you can edit the content and add any additional recipients
 +
*Once you are ready, click the '''Send Message''' button to resend.
 +
 
 +
==Mass Mailing==
 +
 
 +
*Mass Mail allows you to send an email to a group of clients.
 +
 
 +
*Begin by going to '''Clients > Mass Mail'''
 +
*You can then choose the criteria you want to filter on in order to select who the email will be sent to
 +
*By default the email type is General and so you can only filter on the client status criteria
 +
*If you want to filter on '''product related criteria''' you must ensure you set the Email Type to be Product/Service related
 +
*Likewise if you want to filter on '''domain related criteria''' you must set the Email Type to be Domain related
 +
 
 +
'''Please Note:''' When composing the email you will see the full list of clients matching your selected criteria in the To field. This is so you can review who will be receiving it but each email is sent '''individually''' and so the receiver will not see any other client's addresses in the To field of the copy they receive.
 +
 
 +
==Email Templates==
 +
 
 +
*All of the emails that WHMCS sends out to clients can be customised in '''Setup > Email Templates'''
  
−
==Sending a Custom Email to Clients==
+
===Creating Custom Templates===
  
−
To send a custom one off email to a client use the same process as above for the preset emails but instead of choosing an email template name, select the "New Message" option in the dropdown menu.
+
*You can create your own email templates to serve as custom welcome emails for products or messages you send manually but frequently
 +
*To do that go to '''Setup > Email Templates''' and scroll to the bottom of the page where you will see a '''Create New Email Template''' area
 +
*You can only create email templates for the types you can manually send: General, Product & Domain
 +
*You should use a '''unique name''' for the template so you can identify it in the send message dropdowns. Only admin users will see the name you give it.
  
−
==Disabling Emails==
+
===Disabling Templates===
  
−
There may be circumstances where you want to disable certain emails from sending.  For example you might not want emails to go out when invoices get created, or when a product is suspended.  You can do that by following these steps:
+
*There may be circumstances where you want to disable certain emails from sending.   
 +
*For example you might not want emails to go out when invoices get created, or when a product is suspended.   
 +
*You can do that by following these steps:
  
 
#Go to Config > Email Templates
 
#Go to Config > Email Templates
Line 41: Line 97:
 
#Save your changes to the email
 
#Save your changes to the email
  
−
That email will now not send until re-enabled.
+
*That email will now not send until re-enabled.

Revision as of 17:12, 18 July 2009

Sending Emails to a Client

One Off Mail

  • Begin by locating the client that you want to send the email to either by searching or locating their name in the clients list and then follow the link through to the client summary page
  • Next, in the Send Email panel, select the New Message option and click Send
  • This will take you to the email composition window where you can enter your message before clicking Send Message

Save as a Template

  • When composing your message, if you think you may want to use it again in the future, you can save it.
  • To do this, tick the Save Message checkbox under the Subject field and enter a name to add it to the Email Templates.

Predefined Templates

  • Predefined templates can be sent on demand for clients, products & domains. Other email types are only sent when specific events occur.

Client Related

  • The steps are the same as the with the One Off Mail above but instead of choosing New Message in the dropdown, you need to choose the template name to send.

Product & Domain Related

  • From the Client Summary page, click the edit icon next to the service or domain you want to send the email related to
  • Now scroll to the bottom of the product or domain details page that gets displayed
  • There you'll see a Send Message dropdown where you can choose the template name and click Send

Customise the Template before Sending

  • There might be some occassions where you want to send a predefined template but make some modifications first.
  • To do this, follow the steps as above but instead of choosing the template name choose New Message.
  • Then on the message composition screen which you are taken to for the new message, scroll to the bottom where you'll see a Load Message dropdown box.
  • From there you can choose the predefined template and load it into the message box ready for you to customise before sending.

Merge Fields

  • In email messages you can enter merge field variables wihch are then replaced at the time of sending automatically with the users data.
  • The merge fields available in your message depend on what type of email you are sending.
  • For example if it's an email related to a client you can include client fields only, but if it's a product related email you could include product details aswell as client fields.
  • The exact list of fields you have available in any email message you are composing are listed directly below the message box with the field description and merge field code.
  • Clicking on the description will insert the merge field at the point of your cursor in the message.

Custom Fields

  • To display client custom fields in the email templates, you can either reference it by it's numerical reference such as {$client_custom_fields.0} for the first field, {$client_custom_fields.1} for the second, etc...
  • Or you reference it by name using the format {$client_custom_field_fieldnamehere}.
  • For fieldnamehere, you need to take your custom field name, convert the name to lowercase and remove anything other than a-z 0-9 chars.
  • For example "VAT Number" would become "vatnumber" and so would be {$client_custom_field_vatnumber} in the email template.
  • The same applies to Product custom fields, however they are referenced by {$service_custom_fields.0} or {$service_custom_field_fieldnamehere}.

Conditional Displays

  • There may be cases where you want to display text in an email only if certain conditions are met. For example you might want to include specific information in a sales support ticket submission so could use the below conditional statement in the Support Ticket Opened email template:
{if $ticket_department eq "Sales"}The sales department is open 9-5pm Monday-Friday so you
will only receive a response between these times. We thank you for your patience.{/if}

Resending Emails to Clients

  • Begin by locating the email you want to resend. You can do this from the Email tab inside a clients profile or the master email log accessed in Utilities > Email Log.
  • Next, click the Resend icon on the message's row that you want to resend
  • The email will now be loaded into the message editor where you can edit the content and add any additional recipients
  • Once you are ready, click the Send Message button to resend.

Mass Mailing

  • Mass Mail allows you to send an email to a group of clients.
  • Begin by going to Clients > Mass Mail
  • You can then choose the criteria you want to filter on in order to select who the email will be sent to
  • By default the email type is General and so you can only filter on the client status criteria
  • If you want to filter on product related criteria you must ensure you set the Email Type to be Product/Service related
  • Likewise if you want to filter on domain related criteria you must set the Email Type to be Domain related

Please Note: When composing the email you will see the full list of clients matching your selected criteria in the To field. This is so you can review who will be receiving it but each email is sent individually and so the receiver will not see any other client's addresses in the To field of the copy they receive.

Email Templates

  • All of the emails that WHMCS sends out to clients can be customised in Setup > Email Templates

Creating Custom Templates

  • You can create your own email templates to serve as custom welcome emails for products or messages you send manually but frequently
  • To do that go to Setup > Email Templates and scroll to the bottom of the page where you will see a Create New Email Template area
  • You can only create email templates for the types you can manually send: General, Product & Domain
  • You should use a unique name for the template so you can identify it in the send message dropdowns. Only admin users will see the name you give it.

Disabling Templates

  • There may be circumstances where you want to disable certain emails from sending.
  • For example you might not want emails to go out when invoices get created, or when a product is suspended.
  • You can do that by following these steps:
  1. Go to Config > Email Templates
  2. Edit the email template you wish to disable
  3. Check the Disable tickbox in the fields at the top of the page
  4. Save your changes to the email
  • That email will now not send until re-enabled.
Retrieved from "http://3.17.75.209/index.php?title=Messages/Emails&oldid=1631"