Email

Mailersend

Learn how to use Mailersend with Composio

Overview

SLUG: MAILERSEND

Description

MailerSend is a transactional email service designed for developers to integrate email sending capabilities into their applications.

Authentication Details

generic_api_key
stringRequired

Connecting to Mailersend

Create an auth config

Use the dashboard to create an auth config for the Mailersend toolkit. This allows you to connect multiple Mailersend accounts to Composio for agents to use.

1

Select App

Navigate to Mailersend.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Mailersend Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4mailersend_auth_config_id = "ac_YOUR_MAILERSEND_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10    # Replace this with a method to retrieve an API key from the user.
11    # Or supply your own.
12    user_api_key = input("[!] Enter API key")
13
14    connection_request = composio.connected_accounts.initiate(
15        user_id=user_id,
16        auth_config_id=auth_config_id,
17        config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Mailersend for user {user_id}")
22    print(f"Connection status: {connection_request.status}")
23    
24    return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, mailersend_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Mailersend toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["MAILERSEND"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Create Sending Domain

Description

Tool to add a new sending domain to mailersend. use when you need to register and configure a domain before sending emails.

Action Parameters

add_dns_records
boolean
domain_type
string
name
stringRequired
return_path_domain_id
string
skip_verification
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create SMTP User

Description

Tool to create a new smtp user. use after domain setup to obtain smtp credentials.

Action Parameters

domain_id
stringRequired
name
stringRequired
password
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create API Token

Description

Tool to create a new api token. use when you need to generate a token with specific permissions in mailersend.

Action Parameters

name
stringRequired
scopes
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Webhook

Description

Tool to create a new webhook for a mailersend domain. use after you have a domain id and need to receive event notifications like sent, delivered, opened, etc.

Action Parameters

domain_id
stringRequired
enabled
booleanDefaults to True
events
arrayRequired
name
stringRequired
url
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Webhook

Description

Tool to delete an existing webhook. use when the webhook is no longer needed. returns empty response on successful deletion (http 204).

Action Parameters

webhook_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get API Quota

Description

Tool to retrieve current api usage quota. use when monitoring api rate limits to avoid exceeding allowed calls.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Domain

Description

Tool to fetch information for a specific sending domain. use when you need to verify domain status and dns configuration after setup or changes.

Action Parameters

domain_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Domain Recipients

Description

Tool to list recipients for a domain. use after obtaining the domain id to view recipients with optional pagination.

Action Parameters

domain_id
stringRequired
limit
integer
page
integer

Action Response

data
arrayRequired
error
string
links
objectRequired
meta
objectRequired
successful
booleanRequired

Tool Name: Get sending domains

Description

Tool to retrieve a list of sending domains. use after configuring the mailersend api key.

Action Parameters

limit
integer
page
integer

Action Response

data
arrayRequired
error
string
links
objectRequired
meta
objectRequired
successful
booleanRequired

Tool Name: Get general API resources

Description

Tool to retrieve general api resources and information. use when you need an overview of all mailersend endpoints before constructing specific calls.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: List Sender Identities

Description

Tool to list sender identities. use when you need to retrieve all configured email or domain sender identities after authenticating with your mailersend api token.

Action Parameters

limit
integer
page
integer

Action Response

data
arrayRequired
error
string
meta
objectRequired
successful
booleanRequired

Tool Name: Get sent messages

Description

Tool to retrieve a paginated list of sent messages. use after sending emails to view message logs.

Action Parameters

date_from
string
date_to
string
limit
integerDefaults to 25
page
integerDefaults to 1

Action Response

data
arrayRequired
error
string
links
objectRequired
meta
objectRequired
successful
booleanRequired

Tool Name: Get email recipients

Description

Tool to retrieve a list of email recipients. use when you need to list and filter recipients by list id or search term.

Action Parameters

limit
integer
list_id
string
page
integer
search
string

Action Response

data
arrayRequired
error
string
links
objectRequired
meta
objectRequired
successful
booleanRequired

Tool Name: Get SMS Activity

Description

Tool to retrieve sms activity logs. use when you need to fetch delivery status and logs of sent sms messages.

Action Parameters

date_from
string
date_to
string
limit
integer
message_id
string
page
integer
sms_number_id
string

Action Response

data
arrayRequired
error
string
links
objectRequired
meta
objectRequired
successful
booleanRequired

Tool Name: Get SMS Inbounds

Description

Tool to retrieve inbound sms messages. use when you need to fetch sms messages received on your mailersend numbers.

Action Parameters

limit
integer
page
integer

Action Response

data
arrayRequired
error
string
links
objectRequired
meta
objectRequired
successful
booleanRequired

Tool Name: List SMS Messages

Description

Tool to list sent sms messages with optional filters. use after sending sms to review message logs.

Action Parameters

date_from
string
date_to
string
limit
integerDefaults to 25
page
integerDefaults to 1
recipient
string
status
string

Action Response

data
arrayRequired
error
string
links
objectRequired
meta
objectRequired
successful
booleanRequired

Tool Name: Get SMS Numbers

Description

Tool to retrieve a paginated list of sms phone numbers. use after purchasing numbers to fetch available sms numbers.

Action Parameters

limit
integer
page
integer

Action Response

data
arrayRequired
error
string
links
objectRequired
meta
objectRequired
successful
booleanRequired

Tool Name: Get SMS recipients

Description

Tool to retrieve a list of sms recipients. use when you need to list and paginate sms recipients, optionally filtering by sms number id.

Action Parameters

limit
integer
page
integer
sms_number_id
string

Action Response

data
arrayRequired
error
string
links
objectRequired
meta
objectRequired
successful
booleanRequired

Tool Name: Get SMTP users

Description

Tool to retrieve a list of smtp users. use when you need to list and paginate smtp users.

Action Parameters

domain_id
string
limit
integer
page
integer

Action Response

data
arrayRequired
error
string
links
objectRequired
meta
objectRequired
successful
booleanRequired

Tool Name: Get email templates

Description

Tool to retrieve a list of email templates. use when you need to list and paginate email templates.

Action Parameters

limit
integer
page
integer

Action Response

data
arrayRequired
error
string
links
objectRequired
meta
objectRequired
successful
booleanRequired

Tool Name: Get API Tokens

Description

Tool to retrieve a list of api tokens. use when you need to list and paginate api tokens after authentication.

Action Parameters

limit
integer
page
integer

Action Response

data
arrayRequired
error
string
links
objectRequired
meta
objectRequired
successful
booleanRequired

Tool Name: Get users

Description

Tool to retrieve a list of users associated with your account. use after authenticating with a valid api token.

Action Parameters

limit
integer
page
integer

Action Response

data
arrayRequired
error
string
meta
objectRequired
successful
booleanRequired

Tool Name: List webhooks

Description

Tool to retrieve a list of webhooks. use when you need to list and paginate all configured webhooks, optionally filtering by domain.

Action Parameters

domain_id
string
limit
integer
page
integer

Action Response

data
arrayRequired
error
string
links
objectRequired
meta
objectRequired
successful
booleanRequired