Introduction

Last updated 21/12/2023

What is Mail Merge?

Mail merges are one of the quickest ways to customize emails. Mail merges enable you to create customized documents based on the receiver. You will save time and work by not having to manually personalize each document for many recipients.

How Mail Merge Works in Five

A mail merge takes values from a data source and inserts them into the editor. This lets you create a master template from which you can generate many similar documents, each customized with the data being merged.

There are two methods you can use to create a mail merge in Five.

• You can create a mail merge based on a selected data source; or
• Create a mail merge with code and use Five's function
  executeAction()
  .

Navigate to Mail Merges

1. Select Tasks in the menu.

2. Select Mail Merges in the sub-menu.

Figure 1 - Mail Merges menu item

Who Can Add, Edit, and Delete Mail Merges?

• When working in the Cloud, only Developer and Control users can add and manage mail merge records.
• When working in Local, the Standalone user can add and manage mail merge records.

Mail Merge Form

The Mail Merge form consists of Five pages. The table below gives a description for each of the pages.

Page	Description
General	The General page is for you to configure your mail merge settings and create your email template.
Events	The Events page is for you to attach code for extra functionality.
Action Buttons	The Action Buttons page enables you to add customized buttons that will be available in the app bar.
Screen Fields	The Screen Fields page will create fields that data can be entered and are available in the email template.
References	The References page will list where the mail merge is being referenced.

The General Page

The table below gives a description for the fields on the Mail Merge form.

Field	Description
Title	Give your mail merge a title and it will be visible in the Mail Merge app bar if not automated.
Action ID	The unique identifer for your mail merge.
Data Source	Select a data source for your mail merge to use for the personalized information.
Name Field ID	Select the field from the data source that holds the recipient names.
Email Field ID	Select the field from the data source that holds the recipient emails.
SMTP From Name	The name of the sender.
SMTP From Email	The email of the sender.
Subject Text	Add a subject line for your mail merge.
Merge Text	Opens the editor for you to create your email template.
Help Text	Add help content.
Help URL	Add a URL link to external help.
Notes	Add notes for your mail merge for your own reference.