How do I get started with the Mail Designer integration?
It’s simple: You only need two key files.
The MailDesignerIntegrationExample file in FileMaker walks you through the required scripts step by step (.fmp12 FileMaker file):
MailDesignerIntegrationExampleV3.fmp12
And in the Mail Designer 365 template, you’ll find placeholders that show how your FileMaker fields come to life directly in the design (Mail Designer file):
Open Demo Design Idea
Open this Mail Designer file and then go directly to File > Save to save it in your project.
Don’t have the Mail Designer app yet?
Download
How does the integration work with FileMaker?
Create a FileMaker string with all your existing database variables so they correspond with the placeholders in your Mail Designer 365 template. Then, relay these to the FileMaker send script (cURL-based) to enable one-click emails directly from your records. It's that easy!
Which FileMaker versions can I use the Mail Designer 365 FileMaker API with?
The API integration is also compatible with from FileMaker 12 onwards, as well as with the FileMaker Go iOS app. When using attachments, at least FileMaker 18 is required.
How do I define a FROM address that I can use in my FileMaker / Mail Designer 365 integration?
Why do I need placeholders in my contacts?
With placeholders, you can easily create target groups or personalize your emails. In third-party apps like FileMaker, you can create fields to use as placeholders in your designs. This allows you to send automated, personalized emails directly from FileMaker.
A placeholder (e.g., “Country”) can have multiple values (e.g., “Germany”, “USA”).
Add placeholders to your contacts to create target groups based on them (e.g., “Send newsletter only to users in the USA”).
Or use the Mail Designer 365 app to insert these placeholders into your emails for personalization (e.g., “All of ‘Germany’ is Celebrating the Super Sale!”).
Learn more in the handbook
How can I map FileMaker field names to Mail Designer 365 placeholders?
Step 1: Create the $AttributeFields Variable
Start by creating a variable named $AttributeFields. This variable will contain the text string that defines the placeholder content used in your Mail Designer 365 email template. All values must be separated by commas.
Scenario A: FileMaker Field Names Match the Email Placeholders
Method:
Use FileMaker field names that directly match the placeholders in your email design. Build the $AttributeFields variable by listing these field names, separated by commas.
In Mail Designer, you simply use the field name as the placeholder.
Format:
$AttributeFields = "Table::Field1,Table::Field2,Table::Field3"
Example Definition of $AttributeFields in FileMaker:
$AttributeFields="CityHotel::GUEST_FIRST_NAME,CityHotel::GUEST_LAST_NAME,CityHotel::GUEST_EMAIL,CityHotel::BOOKING_METHOD"
In Mail Designer 365, you can reference the values later using these placeholders:
GUEST_FIRST_NAME
GUEST_LAST_NAME
GUEST_EMAIL
BOOKING_METHOD
⸻
Scenario B: FileMaker Field Names Do Not Match the Email Placeholders in Mail Designer
Method:
Build the $AttributeFields variable by manually mapping each placeholder name to the corresponding field or variable using the format:
$AttributeFields = "PLACEHOLDER_NAME: " & FieldName_or_Variable & "," …
Example Definition of $AttributeFields in FileMaker:
"BOOKING_DATE:" & RESERVATION_DATE & "," &
"BOOKING_TIME:" & RESERVATION_TIME & "," & …
⸻
Scenario C: Using FileMaker Variables as Placeholders
Method:
If your FileMaker variable has the same name as the placeholder in Mail Designer 365, you can directly assign it like this:
$AttributeFields = "$city,$country"
This tells Mail Designer to use the value of $city for the placeholder named “city”.
Example:
The FileMaker variable $city contains “Munich”. If your Mail Designer template includes a placeholder named “city”, then define:
$AttributeFields = "$city"
The script will reveal the content “Munich” and pass it to Mail Designer to populate the “city” placeholder.
⸻
The Best Scenario D: Mixing All Methods
You can combine the approaches above into a single $AttributeFields string.
Method:
Mix matching field names, manually mapped fields, and variables in the $AttributeFields variable.
Example:
$AttributeFields = "BOOKING_DATE:" & RESERVATION_DATE & "," &
"CityHotel::BREAKFAST_TYPE," & "$city"
In Mail Designer 365 you can then reference them with the name BOOKING_DATE, BREAKFAST_TYPE and city
How do I set the Mail Designer 365 Template ID?
To specify an email design to use with your FileMaker integration, go to:
https://my.maildesigner365.com/team/designs
On the template you want to use, click the three dots icon and select “Mail Designer 365 API: Copy Template ID.”
You will then use this ID to define the variable $EMailTemplateID.
How is the integration technically implemented? Is it a FileMaker plug-in?
The integration of Mail Designer does not require any additional installation of FileMaker plug-ins or similar components. Technically, the integration is handled via a CURL request to the API endpoint of our Mail Designer delivery service. This is executed using the appropriate FileMaker script step.
By providing a FileMaker demo file, all relevant steps can be easily followed, see FAQ "How do I get started with the Mail Designer integration?"
Can I add attachments (like PDFs) to my Mail Designer templates using the FileMaker API?
Yes, it’s possible. You need FileMaker 18 or later to add attachments using our API.
Can I use image placeholders in Mail Designer 365?
Currently, the API only supports text placeholders. Image placeholders are on our roadmap for a future release.y
Does the Mail Designer 365 FileMaker Integration API work on iPhone and iPad?
I have questions about the Mail Designer 365 API integration. Who can I contact?
We’re happy to assist with any questions or feedback via our
support form.
