How to integrate via FTP: Step by step

In this article you will find a guide on how to integrate Doppler Relay via FTP to be able to send transactional emails via batch, with custom fields and attachments.

Step by step guide

Let’s see one by one the necessary actions to be able to carry out the integration:

1. Creation of Templates

• A. You must first enter your Doppler Relay account to generate the necessary forms. For that you must go to the Templates section, you can access from here.
• B. These templates can have dynamic fields, which should be enclosed in double keys, eg {{name}} For this we use the Mustache nomenclature, you can see examples here.

2. Now it’s time to create the CSV file, based on the table you can see below.

• A. File structure (mandatory fields):
  

  Order	Field	Description
  1	email	recipient’s email
  2	name	Sender’s name
  3	templateid	Template ID to be used, generated in step 1.
  4	attach1	Name of the file to be attached in the email.

• The attach field can be omitted by configuration or add more than one
• B. Example structure of a file with more than 1 attachment and dynamic fields used in the template.
  

  Order	Field	Description
  1	email	Email del destinatario del correo.
  2	name	Sender’s name
  3	templateid	Template ID to be used, generated in step 1.
  4	attach1	Name of the file to be attached in the email.
  5	attach2	Second attachment
  6	name	Recipient’s name
  7	lastname	Recipient’s last name

• You can place as many dynamic fields as you wish, always respecting the obligatory ones.

3. When steps 1 and 2 are complete, it is recommended to use a test CSV file along with the images, to be able to make some test sends and see if the configuration is done correctly.

• A. When generating the CSV files, it is important to keep in mind that Doppler Relay validates that the names are not repeated, if the same file name is entered twice, the second one will not be sent. This restriction prevents potential problem of duplicate shipments by mistake when uploading the wrong file.
• B. The number of fields of each shipment must be the same as the number of headers in the file, if one does not exist, it must be the empty space (only the separator, see example)

4. The CSV files are placed in the FTP folder provided, with the corresponding credentials.

5. The attachments must be placed inside the folder / Attachments of the FTP and each shipment within the csv file, in the column that corresponds to the attach must reference it by name. There are 2 options to deposit the attachments.

• A. All separate files.
• B. A compressed file (.ZIP) with all the attachments and this file must have the same name as the .CSV in order to associate it with the corresponding file.

6. At the end of the file creation process, a file is deposited in the FTP in the / Results folder, with the same name of the processed file (filename_processed.csv), which includes the results of each submission.

7. Local copies of the processed files are kept for 30 days, and once the process is finished it is removed from the FTP. After the 30 days, there are only records of the shipments in the Doppler Relay platform.

Useful resources

Here you will find useful tools that will make the process of integration and sending by FTP much easier.

• FTP Client: Filezilla
• Nomenclature for dynamic fields: Mustache
• Sample file in CSV format: download it here.