Adapter Layer: Email Adapter

Email Adapter requires configuration of both transport and adapter layers of the adapter. To create adapter layer of Email Adapter:

What needed for Email Adapter

Adapter Name
Adapter name will be displayed in the Transport Name drop-down list of Email Adapter. See more about Adapter Name Concept: Logical and Physical Reference

Email template
Before configuring with Email adapter, you should prepare your email template and that template has some conditions :

  1. The template has to be saved in zip. file
  2. In that zip. the file will have 2 folders named html and text only.
  3. Inside the html folder will include an html file which is named only email.html, content.html, and index.html.
  4. Inside the text folder will include a text file which is named only email.txt, content.txt, and message.txt.
  5. Combine these two folders into zip. file

Attached file (If any)
If your email needs to attach a file, you have to configure that file in FTP IN to import it. And in this email adapter, you can attach files more than one. See FTP IN configuration in Transport Layer: FTP IN Adapter

Create Email Adapter

  1. Go to SSQUARE Adapter through http://YOURDOMAIN:8380/adapter e.g. (Google Chrome is recommended)
  2. Select Email on sidebar 
  3. Click + to create a new Email adapter
  4. Define adapter name in Adapter Name field
  5. Select Transport Type (SMTP in this case) and select Transport Name from a drop-down list in Transport Configuration section
  6. In Basic Configuration section, define the details:
  • Sender Email: a sender email address that will use on this adapter
  • Receiver Email: a receiver email address that will use on this adapter (This is just a default email but if you will send email in list please see the details at Email Adapter Node)
  • Subject: the email subject
  1. Select your email template in the Content Configuration section.
  • Import Template: Browse your email template that saved in zip.file and then click Upload
  • Content Parameter Pattern: Parameter format that you defined in email content. Example: {$param} or *IparamI*
  1. Click + and FTP IN popup will appear and select your FTP Adapter that already created then add Input File Parameter (If any) and then click Confirm
  2. In Input Parameter section, click at Load Parameter to review the parameters, and at the Field Properties, you can choose that will promote a parameter or not and then click Apply
  3. Click Create

Now your Email adapter is all set, ready to use as a reference on Email Node. To use your adapter, you’ll find and select your adapter in Adapter Name field on Properties setting of Email Node.