← Mailgun

Send Email with Mailgun API

Pipedream makes it easy to connect APIs for Mailgun and 1000+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Send Email with the Mailgun API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜

Trusted by 500,000+ developers from startups to Fortune 500 companies

Adyen logo
Brex logo
Carta logo
Checkr logo
Chameleon logo
DevRev logo
LinkedIn logo
Netflix logo
New Relic logo
OnDeck logo
Replicated logo
Scale AI logo
Teamwork logo
Warner Bros. logo
Xendit logo

Developers Pipedream

Getting Started

Create a workflow to Send Email with the Mailgun API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Send Email action
    1. Connect your Mailgun account
    2. Select a Domain Name
    3. Configure From Name
    4. Configure From Email
    5. Optional- Configure Reply-To
    6. Configure To
    7. Configure Subject
    8. Optional- Configure Message Body (text)
    9. Optional- Configure Message Body (HTML)
    10. Optional- Configure Attachments
    11. Configure Send in test mode?
    12. Optional- Configure Use DKIM?
    13. Optional- Configure Use Tracking?
    14. Configure Halt on error?
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Mailgun Send Email with Mailgun API on New Requests from HTTP / Webhook API
HTTP / Webhook + Mailgun
 
Try it
Mailgun Send Email with Mailgun API on New Item in Feed from RSS API
RSS + Mailgun
 
Try it
Mailgun Send Email with Mailgun API on New Message from Discord API
Discord + Mailgun
 
Try it
Mailgun Send Email with Mailgun API on New Message In Channels from Slack API
Slack + Mailgun
 
Try it
Mailgun Send Email with Mailgun API on New Message in Channel from Discord Bot API
Discord Bot + Mailgun
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Send Email on Mailgun
Description:Send email with Mailgun. [See the docs here](https://documentation.mailgun.com/en/latest/api-sending.html#sending)
Version:0.1.0
Key:mailgun-send-email

Code

import mailgun from "../../mailgun.app.mjs";
import common from "../common.mjs";
import downloader from "@pipedream/helper_functions/actions/download-file-to-tmp/download-file-to-tmp.mjs";

export default {
  ...common,
  key: "mailgun-send-email",
  name: "Send Email",
  description: "Send email with Mailgun. [See the docs here](https://documentation.mailgun.com/en/latest/api-sending.html#sending)",
  version: "0.1.0",
  type: "action",
  props: {
    mailgun,
    domain: {
      propDefinition: [
        mailgun,
        "domain",
      ],
    },
    fromName: {
      propDefinition: [
        mailgun,
        "name",
      ],
      label: "From Name",
      description: "Sender name",
    },
    from: {
      propDefinition: [
        mailgun,
        "emailString",
      ],
      label: "From Email",
      description: "Sender email address",
    },
    /* eslint-disable pipedream/default-value-required-for-optional-props */
    replyTo: {
      propDefinition: [
        mailgun,
        "emailString",
      ],
      label: "Reply-To",
      description: "Sender reply email address",
      optional: true,
    },
    /* eslint-enable pipedream/default-value-required-for-optional-props */
    to: {
      propDefinition: [
        mailgun,
        "emails",
      ],
      label: "To",
      description: "Recipient email address(es)",
    },
    /* eslint-enable pipedream/default-value-required-for-optional-props */
    subject: {
      propDefinition: [
        mailgun,
        "subject",
      ],
      description: "Message subject",
    },
    text: {
      propDefinition: [
        mailgun,
        "bodyText",
      ],
      optional: true,
    },
    /* eslint-disable pipedream/default-value-required-for-optional-props */
    html: {
      propDefinition: [
        mailgun,
        "bodyHtml",
      ],
      optional: true,
    },
    attachments: {
      type: "object",
      label: "Attachments",
      description: "Add any attachments you'd like to include as objects. The `key` should be " +
       "the **filename** and the `value` should be the **url** download link for the attachment.",
      optional: true,
    },
    /* eslint-enable pipedream/default-value-required-for-optional-props */
    testMode: {
      type: "boolean",
      label: "Send in test mode?",
      default: true,
      description: "Enables sending in test mode. For more information, see the [Mailgun API " +
        "documentation](https://documentation.mailgun.com/en/latest/api-sending.html#sending)",
    },
    dkim: {
      type: "boolean",
      label: "Use DKIM?",
      default: true,
      description: "Enables or disables DKIM signatures. For more information, see the [Mailgun " +
        "API documentation](https://documentation.mailgun.com/en/latest/api-sending.html#sending)",
      optional: true,
    },
    tracking: {
      type: "boolean",
      label: "Use Tracking?",
      default: true,
      description: "Enables or disables tracking. For more information, see the [Mailgun API " +
        "documentation](https://documentation.mailgun.com/en/latest/api-sending.html#sending)",
      optional: true,
    },
    ...common.props,
  },
  methods: {
    ...common.methods,
    async download($, attachments) {
      const promises = Object.entries(attachments).map(async ([
        filename,
        url,
      ]) => downloader.run.bind({
        url,
        filename,
      })({
        $,
      }));

      return (await Promise.all(promises))
        .map((filedata) => this.createAttachment(filedata[3], filedata[0]));
    },
    createAttachment(data, filename) {
      return {
        data,
        filename,
      };
    },
  },
  async run({ $ }) {
    const msg = {
      "from": `${this.fromName} <${this.from}>`,
      "to": this.to,
      "subject": this.subject,
      "text": this.text,
      "html": this.html,
    };
    if (this.attachments) {
      msg["attachment"] = await this.download($, this.attachments);
    }
    if (this.testMode) {
      msg["o:testmode"] = "yes";
    }
    if (this.replyTo) {
      msg["h:Reply-To"] = this.replyTo;
    }
    if (this.dkim !== null) {
      msg["o:dkim"] = this.dkim
        ? "yes"
        : "no";
    }
    if (this.tracking) {
      msg["o:tracking"] = "yes";
    }
    const resp = await this.withErrorHandler(this.mailgun.sendMail, {
      domain: this.domain,
      msg,
    });
    $.export("filedata", null); // remove set filedata from downloader
    $.export("$summary", "Successfully sent email.");
    return resp;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
MailgunmailgunappThis component uses the Mailgun app.
Domain NamedomainstringSelect a value from the drop down menu.
From NamefromNamestring

Sender name

From Emailfromstring

Sender email address

Reply-ToreplyTostring

Sender reply email address

Totostring[]

Recipient email address(es)

Subjectsubjectstring

Message subject

Message Body (text)textstring
Message Body (HTML)htmlstring
Attachmentsattachmentsobject

Add any attachments you'd like to include as objects. The key should be the filename and the value should be the url download link for the attachment.

Send in test mode?testModeboolean

Enables sending in test mode. For more information, see the Mailgun API documentation

Use DKIM?dkimboolean

Enables or disables DKIM signatures. For more information, see the Mailgun API documentation

Use Tracking?trackingboolean

Enables or disables tracking. For more information, see the Mailgun API documentation

Halt on error?haltOnErrorboolean

Authentication

Mailgun uses API keys for authentication. When you connect your Mailgun account, Pipedream securely stores the keys so you can easily authenticate to Mailgun APIs in both code and no-code steps.

Get your API Key in the Control Panel, specifically in Settings > API Keys. More info in docs.

If your Mailgun account resides in the EU, choose the EU option in the Region field. Otherwise, choose the US (non-EU) region.

About Mailgun

Sending, receiving and tracking email effortlessly

More Ways to Use Mailgun

Triggers

New Bounce (Instant) from the Mailgun API

Emit new event when the email recipient could not be reached.

 
Try it
New Click (Instant) from the Mailgun API

Emit new event when the email recipient clicked on a link in the email. Open tracking must be enabled in the Mailgun control panel, and the CNAME record must be pointing to mailgun.org. See more at the Mailgun User's Manual Tracking Messages section

 
Try it
New Complaint (Instant) from the Mailgun API

Emit new event when the email recipient clicked on the spam complaint button within their email client. Feedback loops enable the notification to be received by Mailgun.

 
Try it
New Delivery (Instant) from the Mailgun API

Emit new event when an email is sent and accepted by the recipient email server.

 
Try it
New Delivery Failure (Instant) from the Mailgun API

Emit new event when an email can't be delivered to the recipient email server.

 
Try it

Actions

Create Mailing List Member with the Mailgun API

Add to an existing mailing list. See the docs here

 
Try it
Create Route with the Mailgun API

Create a new route. See the docs here

 
Try it
Delete Mailing List Member with the Mailgun API

Delete a mailing list member by address. See the docs here

 
Try it
Get Mailing List Member with the Mailgun API

Retrieve a mailing list member by address. See the docs here

 
Try it
Get Mailing List Members with the Mailgun API

List all mailing list members. See the docs here

 
Try it