Skip to main content
Smtp2go logo
  • Category: transactional email
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 32
  • Triggers: 0
  • Slug: SMTP2GO
  • Version: 20261101_00

Tools

Slug: SMTP2GO_ACTIVITY_SEARCHTool to search activity events like sends, opens, clicks, and bounces. Use when you need to filter account email activity by date, event, recipient, or message ID.

Input Parameters

integer
Number of results to return, defaults to 100, maximum 1000
integer
Number of records to skip for pagination
Filter criteria for searching email activity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_ALLOWED_SENDERS_ADDTool to add a new allowed sender email address. Use when you need to whitelist a sender before sending email. Example: Add “user@example.com” to allowed senders list.

Input Parameters

string
required
Email address to add as an allowed sender.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_ALLOWED_SENDERS_REMOVETool to remove a sender email address from the allowed senders list. Use when you need to revoke send permissions for a validated address.

Input Parameters

string
required
The email address to remove from the allowed senders list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_ALLOWED_SENDERS_UPDATEReplace the account’s allowed senders list with the supplied email addresses and domain names, and set its mode to whitelist, blacklist, or disabled. The update can also target a subaccount.

Input Parameters

string ("whitelist" | "blacklist" | "disabled")
required
A string indicating how the list of email addresses and domain names is interpreted. ‘whitelist’ allows only listed senders, ‘blacklist’ blocks listed senders, ‘disabled’ turns off the feature.
string
If you wish to make this API call on behalf of a subaccount then include its unique ID here.
array
required
Array of email addresses and/or domain names that will be allowed to send emails through your account. This replaces the existing list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_ALLOWED_SENDERS_VIEWTool to view the list of allowed senders configured in your account. Use after setting up SMTP2GO authentication to retrieve your allowed-senders list. Example: ‘Show me all verified allowed senders.‘

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_DOMAIN_ADDTool to add a new sender domain for SPF/DKIM verification. Use when you need to register a domain and optionally set tracking/return-path subdomains.

Input Parameters

string
required
The domain to add as a sending domain (top-level or subdomain).
boolean
If true, SMTP2GO will attempt to verify SPF/DKIM records automatically.
string
Unique ID of the subaccount (if you manage multiple subaccounts).
string
Subdomain for click/open tracking and unsubscribe links; defaults to ‘link’ if omitted.
string
Subdomain to use as the return-path (bounce) domain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_EMAIL_SEARCHTool to search sent emails. Use when filtering your SMTP2GO account’s email activity by criteria like date, sender, or recipient. Call after authentication.

Input Parameters

string
Filter only events matching this type (e.g., ‘bounce’, ‘spam’, etc.).
integer
Number of results to return (default 100, max 500).
integer
Pagination offset (default 0).
string
Return only results for this specific sender email.
string
Return only results with this status (e.g., ‘sent’, ‘dropped’).
string
Sort returned items by this field.
string
Return only results with this exact subject line.
string
End date (YYYY-MM-DD) for filtering results.
string
Return only results for this specific email ID.
string
Return only results for this specific recipient email.
string
Start date (YYYY-MM-DD) for filtering results.
string ("asc" | "desc")
Order of returned results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_IP_ALLOW_LIST_ADDTool to add a public IP address to your account’s IP allow list. Use when you need to whitelist specific sending sources by IP after confirming accuracy. Note: Only plain IP addresses are supported (no CIDR notation). Private/reserved IP ranges are rejected.

Input Parameters

string
required
Public IP address to add to the allow list (e.g., ‘8.8.8.8’). Note: CIDR notation is NOT supported; use plain IP addresses only. Private/reserved IP ranges are not allowed.
string
Optional note for your reference (max 255 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_IP_ALLOW_LIST_REMOVETool to remove an IP address from your account’s IP allow list. Use after identifying the IP you wish to revoke.

Input Parameters

string
required
The IPv4 address to remove from the allow list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_IP_ALLOW_LIST_VIEWTool to view the list of IP addresses in your IP allow list. Use after confirming your SMTP2GO API key is set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_SMS_VIEW_RECEIVEDTool to retrieve received SMS replies for your SMTP2GO account. Use when you need to fetch incoming SMS messages for analysis or display. Pagination supported via limit and offset.

Input Parameters

integer
Number of received SMS messages to return (default 100, max 500)
integer
Number of messages to skip for pagination (default 0)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_STATS_EMAIL_BOUNCESTool to retrieve email bounces statistics. Use after sending emails to analyze bounce metrics over a time period.

Input Parameters

string
Filter results by a specific email address
integer
Number of records to return, defaults to API default
integer
Record offset for pagination, defaults to API default
string
End date (inclusive) in YYYY-MM-DD format to filter bounces
string
Start date (inclusive) in YYYY-MM-DD format to filter bounces
string
Field by which to sort results, e.g., date_bounced
string ("ASC" | "DESC")
Sort direction for results, either ASC or DESC

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_STATS_EMAIL_CYCLETool to retrieve current email cycle/quota statistics. Use when you need to check the account’s monthly email allowance, usage, and remaining quota for the current billing cycle.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_STATS_EMAIL_HISTORYTool to retrieve email history statistics. Use when you need detailed delivery metrics within a date range.

Input Parameters

string
Filter results by message tag.
string
Filter results by recipient email address.
integer
Maximum number of records to return (1–1000).
integer
Number of records to skip for pagination.
string
Filter results by sender email address.
string
End date for filtering (YYYY-MM-DD).
string
Start date for filtering (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_STATS_EMAIL_SPAMTool to retrieve email spam report statistics. Use when analyzing spam trends for sent emails.

Input Parameters

integer
Number of records to return (default 100, max 1000).
integer
Pagination offset (default 0).
string
Filter results by sender email address.
string
required
End date (YYYY-MM-DD) for filtering spam statistics.
string
Filter results by recipient email address.
string
required
Start date (YYYY-MM-DD) for filtering spam statistics.
string
Filter results by transaction ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_STATS_EMAIL_UNSUBSTool to retrieve email unsubscribe statistics. Use when you need unsubscribe data for your account over a date range.

Input Parameters

string
Ending date (YYYY-MM-DD) for the unsubscribe report.
string
Starting date (YYYY-MM-DD) for the unsubscribe report.
integer
Maximum number of records to return (1-1000).
string
Restrict results to this email address.
integer
Number of records to skip for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_SUBACCOUNTS_SEARCHTool to search subaccounts. Use after authenticating to filter and paginate your subaccounts by name, email, or status.

Input Parameters

string
Filter results to subaccounts with this name.
string
Filter results to subaccounts with this email address.
integer
Number of records to return (default 100, max 1000).
boolean
Filter results by active status (true or false).
integer
Number of records to skip for pagination (default 0).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_SUBACCOUNTS_USAGETool to retrieve usage statistics for subaccounts. Use when you need to monitor per-subaccount email usage.

Input Parameters

string
ID of the subaccount for which to retrieve usage statistics. If omitted, statistics for all subaccounts are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_SUPPRESSION_ADDTool to add email addresses or domains to the suppression list. Use when you need to block sending emails to specific recipients or entire domains after unsubscribes or bounces.

Input Parameters

string ("EMAIL" | "DOMAIN" | "ALL")
Type of suppression: EMAIL to suppress addresses, DOMAIN to suppress domains, ALL for both.
string
Optional note about the suppression reason.
string
required
A valid RFC-5322 formatted email address to add to the suppression list. Email addresses added to the suppression list will be blocked from receiving future emails.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_SUPPRESSION_REMOVETool to remove an email address or domain from the suppression list. Use when you want to resume sending to the address or domain.

Input Parameters

string
Email address to remove from suppression list.
string
Domain to remove from suppression list.
string
Subaccount ID from which to remove suppression entry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_SUPPRESSION_VIEWTool to view the suppression list. Use when you need to inspect suppressed email addresses in your account.

Input Parameters

integer
Maximum number of results to return (default 100)
integer
Number of results to skip for pagination
string
Only list suppressions added on or before this date (YYYY-MM-DD)
string
Only list suppressions added on or after this date (YYYY-MM-DD)
string
Filter by specific email address
string ("bounces" | "unsubscribes" | "spam complaints")
Type of suppression to filter

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_TEMPLATE_EDITTool to edit details of an existing email template. Use when you need to update template properties after confirming its ID.

Input Parameters

string
New name for the template
string
New subject line for the template
string
New HTML content for the template
string
New plain text content for the template
string
New code view content for drag-and-drop editor templates
boolean
Whether to archive (true) or unarchive (false) the template
string
required
ID of the template to edit

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_TEMPLATE_SEARCHTool to search your collection of email templates by ID or name. Use when you need to find templates matching specific criteria after authentication.

Input Parameters

string
Filter by the template name.
integer
Number of results per page (1-1000).
integer
Number of results to skip for pagination.
string
Filter by the unique template identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_TEMPLATE_VIEWTool to view details of a specific email template. Use after you have the template ID to inspect.

Input Parameters

string
required
ID of the email template to view

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_USERS_SMTP_ADDTool to add a new SMTP user. Use when you need to provision a fresh SMTP credential after collecting username and password.

Input Parameters

object
required
The SMTP user details to add

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_USERS_SMTP_EDITTool to edit details of an existing SMTP user. Use when you need to update username, password, sender restrictions, or enable/disable a user after confirming the target username.

Input Parameters

boolean
If true, disables this SMTP user entirely.
string
New password for the SMTP user (minimum 8 characters).
string
required
The existing SMTP username to edit.
array
List of IP addresses permitted for this SMTP user. Omit or pass an empty list to allow any IP.
boolean
If true, resets all usage statistics for this SMTP user.
string
New SMTP username if you wish to change it.
array
List of specific email addresses this SMTP user is allowed to send from. Omit or pass an empty list to allow any sender.
string
Restrict sending to this domain only (e.g., ‘example.com’).
boolean
If true, disables all senders for this SMTP user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_USERS_SMTP_REMOVETool to remove an SMTP user from your account. Use when you need to revoke SMTP access for a user.

Input Parameters

string
required
SMTP username to remove, typically an email address or SMTP user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_USERS_SMTP_VIEWTool to list all SMTP users configured on your account. Use when you need to retrieve SMTP user configurations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_WEBHOOK_ADDCreate a webhook for email event notifications at a specified destination URL.

Input Parameters

string
Optional human-readable name for the webhook.
array
required
List of event types to trigger this webhook.
string
required
The destination URL where SMTP2GO will send event notifications.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_WEBHOOK_EDITTool to edit an existing webhook’s settings. Use when you need to update a webhook’s configuration after creation.

Input Parameters

string
required
Destination URL where SMTP2GO will POST webhook events (required for every edit)
array
List of SMTP2GO user IDs for which this webhook should fire
array
List of SMS events that will trigger this webhook
string
required
Unique identifier of the webhook to be edited (integer ID as string)
string ("json" | "form")
Format of the webhook payload
array
required
List of email events that will trigger this webhook. Valid events: bounce, unsubscribe, spam, transactional, click, open, delivered. At least one event is required.
array
Custom email headers to include in the webhook payload
string
Custom authorization header to include with each webhook request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_WEBHOOK_REMOVETool to remove a webhook. Use when you want to delete a webhook by its ID from your SMTP2GO account.

Input Parameters

string
required
Unique identifier of the webhook to remove

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMTP2GO_WEBHOOK_VIEWTool to view all webhooks configured in your account. Use when you need to inspect existing webhook configurations after setup.

Input Parameters

string
ID of the subaccount to retrieve webhooks for. If omitted, retrieves webhooks for the main account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not