🎉 Pipedream raises $20M Series A 🎉
Read the blog post and TC Techcrunch article.
← Mailgun

Suppress Email with Mailgun API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Suppress 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 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Create a workflow to Suppress 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 Suppress Email action
    1. Connect your Mailgun account
    2. Select a Domain Name
    3. Configure Email Address
    4. Select a Category
    5. Optional- Configure Bounce Error Code
    6. Optional- Configure Bounce Error Message
    7. Optional- Configure Tag to unsubscribe from
    8. 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

Details

This is a pre-built, open source 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.

Suppress Email on Mailgun
Description:Add email to the Mailgun suppression list.
Version:0.0.2
Key:mailgun-suppress-email

Code

const mailgun = require("../../mailgun.app.js");
const {
  props,
  methods,
} = require("../common");

module.exports = {
  key: "mailgun-suppress-email",
  name: "Suppress Email",
  description: "Add email to the Mailgun suppression list.",
  version: "0.0.2",
  type: "action",
  props: {
    mailgun,
    domain: {
      propDefinition: [
        mailgun,
        "domain",
      ],
    },
    email: {
      propDefinition: [
        mailgun,
        "email",
      ],
    },
    category: {
      type: "string",
      label: "Category",
      description: "Which suppression list to add the email to",
      options: [
        "bounces",
        "unsubscribes",
        "complaints",
      ],
    },
    bounceErrorCode: {
      type: "string",
      label: "Bounce Error Code",
      description: "Email bounce error code",
      default: "550",
      optional: true,
    },
    /* eslint-disable pipedream/default-value-required-for-optional-props */
    bounceErrorMessage: {
      type: "string",
      label: "Bounce Error Message",
      description: "Email bounce error message",
      optional: true,
    },
    /* eslint-enable pipedream/default-value-required-for-optional-props */
    unsubscribeFrom: {
      type: "string",
      label: "Tag to unsubscribe from",
      description: "Use * to unsubscribe an address from all domain’s correspondence",
      default: "*",
      optional: true,
    },
    ...props,
  },
  methods: {
    ...methods,
  },
  async run() {
    const urlSearchParams = new URLSearchParams();
    urlSearchParams.append("address", this.email);
    switch (this.category) {
    case "bounces":
      urlSearchParams.append("code", this.bounceErrorCode);
      urlSearchParams.append("error", this.bounceErrorMessage);
      break;
    case "unsubscribes":
      urlSearchParams.append("tag", this.unsubscribeFrom);
      break;
    }
    const params = urlSearchParams.toString();
    const url = `v3/${this.domain}/${this.category}?${params}`;
    const supressEmail = async function (mailgun, url) {
      return await mailgun.api("request").post(url);
    };
    return await this.withErrorHandler(supressEmail, url);
  },
};

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.
Email Addressemailstring
CategorycategorystringSelect a value from the drop down menu:bouncesunsubscribescomplaints
Bounce Error CodebounceErrorCodestring

Email bounce error code

Bounce Error MessagebounceErrorMessagestring

Email bounce error message

Tag to unsubscribe fromunsubscribeFromstring

Use * to unsubscribe an address from all domain’s correspondence

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