• Documentation >
• Apps >
• Marketing >
• MailerSend

MailerSend

The MailerSend modules allow you to send emails in your MailerSend account.

Getting Started with MailerSend

Prerequisites

• A MailerSend account

In order to use MailerSend with Ibexa Connect, it is necessary to have a MailerSend account. If you do not have one, you can create a MailerSend account at mailersend.com/signup.

Note

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connecting MailerSend to Ibexa Connect

To connect your MailerSend account to Ibexa Connect you need to obtain the API Token from your MailerSend account and insert it in the Create a connection dialog in the Ibexa Connect module.

1. Log in to your MailerSend account and open your Dashboard.

2. Click Domains > Manage. Verify the domain to generate the API token. Click Generate new token.

   

3. Enter a name for the token, choose the permissions, and click Create Token.

   

4. Copy the token to your clipboard.

   

5. Go to Ibexa Connect and open the MailerSend module's Create a connection dialog.

   

6. In the Connection name field, enter a name for the connection.

7. In the API Key field, enter the key copied in step 4 and click Continue.

The connection has been established.

Actions

Make an API Call

Performs an arbitrary authorized API call.

URL

Enter a path relative to https://api.mailersend.com/. For example: /v1/domains

For the list of available endpoints, refer to the MailerSend API Documentation.

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - Get Domains

The following API call returns all the domains from your MailerSend account:

URL:

/v1/domains

Method:

GET

Matches of the search can be found in the module's Output under Bundle > Body > data.

In our example, 1 domain is returned:

Send an Email

Sends an email.

Send an Email Based on a Template	Select whether you want to send the email using a template.
Template ID	Select the Template ID to use for the email.
Text	Enter the email body message in plain text format. You can enter either plain text or HTML format but the HTML content type is given higher priority.
HTML	Enter the email body message in HTML format. You can enter either plain text or HTML format but the HTML content type is given higher priority.
Email	Enter the sender's email address. The email must be verified in your account.
Name	Enter the sender's name.
To	Add the recipients to whom you want to send the email. Email Enter the recipient's email address. Name Enter the recipient's name. The name must not contain ; or ,.
Subject	Enter the subject line of the email.
Attachment	Add the attachments: Content Enter the content type of the attachment. File Name Enter the file name of the attachment. For example, sample.png. ID Enter the attachment ID which can be used in content as an <img/> tag.
Tags	Add the tags for the email.
Variables	Add the additional variables: Email Enter the email address to add as a substitute. Substitutions Add the substitutions: Var Enter the variable name. For example, company Value Enter the variable value. For example, company name.
Email	Enter the email address to which the recipient can reply to.
Name	Enter the name of the member whose email address is provided above.