Enginemailer

Learn how to use Enginemailer with Composio

Overview

SLUG: ENGINEMAILER

Description

Enginemailer is an email marketing platform that enables businesses to manage contacts, design campaigns, and send personalized emails.

Authentication Details

generic_api_key
stringRequired

Connecting to Enginemailer

Create an auth config

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

1

Select App

Navigate to the Enginemailer toolkit page and click “Setup Integration”.

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 Integration”. 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
4enginemailer_auth_config_id = "ac_YOUR_ENGINEMAILER_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": user_api_key}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Enginemailer 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, enginemailer_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 Enginemailer 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=["ENGINEMAILER"])
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: Check Export Status V2

Description

Tool to check status of a previously requested csv report export. use after initiating an export to poll for completion.

Action Parameters

ID
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Campaign

Description

Tool to create a new email campaign. use when you need to configure and schedule a campaign before sending.

Action Parameters

attachments
array
campaignContent
stringRequired
campaignName
stringRequired
campaignSubject
stringRequired
campaignText
string
fromEmail
Required
fromName
stringRequired
replyTo
sendDate
Required
toListID
integerRequired
trackClicks
boolean
trackOpens
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Export CSV Report V2

Description

Tool to export a transactional email report as csv. use when you need to initiate an export within a specific date range (max past 60 days).

Action Parameters

DomainFilter
string
EmailToFilter
string
Period
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Subcategories

Description

Tool to retrieve subcategories for a given category. use when you need to list or choose subcategories after selecting a category.

Action Parameters

CategoryID
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Insert Subscriber

Description

Tool to add a new subscriber with optional custom fields. use when registering a user to a specific mailing list after verifying their email.

Action Parameters

customfields
object
email
stringRequired
listid
integerRequired
name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Campaign

Description

Tool to retrieve a list of undelivered campaigns. use when you need to fetch campaigns awaiting delivery.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Pause Campaign

Description

Tool to pause a scheduled email campaign. use when you need to halt a campaign before sending to apply updates or adjust schedule.

Action Parameters

CampaignID
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Send Campaign

Description

Tool to send an email campaign immediately. use when the campaign exists, has at least one recipient, and is not scheduled or already delivered. e.g., 'send campaign 123 now'.

Action Parameters

CampaignID
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired