Use Mailgun to send text or HTML emails, retrieve messages and delivery events, manage mailing lists, and inspect sending domains. Tags help associate sent messages with a workflow or campaign.
Send text or HTML emails, manage mailing lists and members, inspect domains, and track email events with tags.
Send an email using Mailgun API
Inputs and outputsParameter Type Required Description apiKeystring Yes Mailgun API key regionstring No Mailgun account region: "us" (default) or "eu" domainstring Yes Mailgun sending domain (e.g., mg.example.com) fromstring Yes Sender email address (e.g., sender@example.com or "Name <sender@example.com >") tostring Yes Recipient email address (e.g., user@example.com ). Use comma-separated values for multiple recipients subjectstring Yes Email subject line textstring No Plain text body of the email htmlstring No HTML body of the email (e.g., "<h1>Hello</h1><p>Message content</p>") ccstring No CC recipient email address (e.g., cc@example.com ). Use comma-separated values for multiple recipients bccstring No BCC recipient email address (e.g., bcc@example.com ). Use comma-separated values for multiple recipients tagsstring No Tags for the email (comma-separated)
Parameter Type Description successboolean Whether the message was sent successfully idstring Message ID messagestring Response message from Mailgun
Retrieve a stored message by its key
Inputs and outputsParameter Type Required Description apiKeystring Yes Mailgun API key regionstring No Mailgun account region: "us" (default) or "eu" domainstring Yes Mailgun domain for retrieving messages (e.g., mg.example.com) messageKeystring Yes Message storage key
Parameter Type Description successboolean Whether the request was successful recipientsstring Message recipients fromstring Sender email subjectstring Message subject bodyPlainstring Plain text body strippedTextstring Stripped text strippedSignaturestring Stripped signature bodyHtmlstring HTML body strippedHtmlstring Stripped HTML attachmentCountnumber Number of attachments timestampnumber Message timestamp messageHeadersjson Message headers contentIdMapjson Content ID map
List events (logs) for messages sent through Mailgun
Inputs and outputsParameter Type Required Description apiKeystring Yes Mailgun API key regionstring No Mailgun account region: "us" (default) or "eu" domainstring Yes Mailgun domain for listing events (e.g., mg.example.com) eventstring No Filter by event type (accepted, delivered, failed, opened, clicked, etc.) limitnumber No Maximum number of events to return (default: 100)
Parameter Type Description successboolean Whether the request was successful itemsjson Array of event items pagingjson Paging information
Create a new mailing list
Inputs and outputsParameter Type Required Description apiKeystring Yes Mailgun API key regionstring No Mailgun account region: "us" (default) or "eu" addressstring Yes Mailing list address (e.g., newsletter@mg.example.com ) namestring No Mailing list name descriptionstring No Mailing list description accessLevelstring No Access level: readonly, members, or everyone
Parameter Type Description successboolean Whether the list was created successfully messagestring Response message listjson Created mailing list details
Get details of a mailing list
Inputs and outputsParameter Type Required Description apiKeystring Yes Mailgun API key regionstring No Mailgun account region: "us" (default) or "eu" addressstring Yes Mailing list address to retrieve (e.g., newsletter@mg.example.com )
Parameter Type Description successboolean Whether the request was successful listjson Mailing list details
Add a member to a mailing list
Inputs and outputsParameter Type Required Description apiKeystring Yes Mailgun API key regionstring No Mailgun account region: "us" (default) or "eu" listAddressstring Yes Mailing list address (e.g., list@mg.example.com ) addressstring Yes Member email address to add (e.g., user@example.com ) namestring No Member name varsstring No JSON string of custom variables subscribedboolean No Whether the member is subscribed
Parameter Type Description successboolean Whether the member was added successfully messagestring Response message memberjson Added member details
List all domains for your Mailgun account
Inputs and outputsParameter Type Required Description apiKeystring Yes Mailgun API key regionstring No Mailgun account region: "us" (default) or "eu"
Parameter Type Description successboolean Whether the request was successful totalCountnumber Total number of domains itemsjson Array of domain objects
Get details of a specific domain
Inputs and outputsParameter Type Required Description apiKeystring Yes Mailgun API key regionstring No Mailgun account region: "us" (default) or "eu" domainstring Yes Domain name to retrieve details for (e.g., mg.example.com)
Parameter Type Description successboolean Whether the request was successful domainjson Domain details