Adding attachments to an email notification

Prerequisites

To understand this tutorial, it is necessary to understand the concept of email notifications. You are using the email notification created in a previous tutorial: Creating an Email Notification

Steps

Attaching a file to an Email Notification is a one-step process:

• Step 1: Include the 'attachments' JSON file in the Email Notification

Step 1: Include the 'attachments' JSON file in the Email Notification

Add the JSON to the Email Notification created in a previous tutorial:

app/emails/welcome_user.liquid

---
to: "{{ form.email }}"
from: "Platform <[email protected]>"
reply_to: [email protected]
subject: "Welcome to our platform, {{ form.first_name }} !"
layout: mailer
attachments: >
  {
    "logo.jpg": {
      "url": "https://insites.io/images/logo.svg"
    }
  }
---
<h2>Hi {{ form.first_name }}!</h2>

<p>Welcome to our platform!</p>

Now, the attachment will be included when you send an email.

You can use in the field, as long as it evaluates to valid JSON. The expected JSON is in the following format:

{
 "<file_name_user_will_see1>": {
   "url": "<url to the attachment>"
 },
 "<file_name_user_will_see2>": {
   "url": "<another url to the attachment>"
 }
}

You can also mark any attachment's as .
Inline attachment means that some types of files will be displayed inside the email content by some email clients.
By default, attachments have set to , which means they are only available for download to email clients.

{
  "my_file": {
    "url": "https://example.com/file.pdf",
    "inline": "true"
  }
}

Next Steps

Congratulations! You have sent an Email Notification with an attachment. Now you can learn about creating an SMS Notification: Creating an SMS Notification