Suppress Email with Mailgun API on New Message Received from X Developer App (formerly Twitter) API

Pipedream makes it easy to connect APIs for Mailgun, X Developer App (formerly Twitter) and 2,000+ other apps remarkably fast.

Trigger workflow on

New Message Received from the X Developer App (formerly Twitter) API

Next, do this

Suppress Email with the Mailgun API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a X Developer App (formerly Twitter) trigger and Mailgun action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Message Received trigger
1. Connect your X Developer App (formerly Twitter) account
2. Configure timer
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?
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Message Received on X Developer App (formerly Twitter)

Description:Emit new event when a new Direct Message (DM) is received [See the documentation](https://developer.twitter.com/en/docs/twitter-api/direct-messages/lookup/api-reference/get-dm_events)

Version:1.1.0

Key:twitter-new-message

View on GitHub

Trigger Code#

import { defineSource } from "@pipedream/types";
import common from "../common/base.mjs";
import { getTweetSummary as getItemSummary } from "../common/getItemSummary.mjs";
import { getMessageFields } from "../../common/methods.mjs";
import { getDirectMessageIncludeIds, getObjIncludes, } from "../../common/addObjIncludes.mjs";
const DOCS_LINK = "https://developer.twitter.com/en/docs/twitter-api/direct-messages/lookup/api-reference/get-dm_events";
const MAX_RESULTS_PER_PAGE = 100;
export default defineSource({
    ...common,
    key: "twitter-new-message",
    name: "New Message Received",
    description: `Emit new event when a new Direct Message (DM) is received [See the documentation](${DOCS_LINK})`,
    version: "1.1.0",
    type: "source",
    methods: {
        ...common.methods,
        getMessageFields,
        getEntityName() {
            return "DM Received";
        },
        getItemSummary,
        async getResources(maxResults) {
            const params = {
                $: this,
                maxPerPage: MAX_RESULTS_PER_PAGE,
                maxResults: maxResults ?? MAX_RESULTS_PER_PAGE,
                params: {
                    ...this.getMessageFields(),
                    event_types: "MessageCreate",
                },
            };
            const { data, includes, } = await this.app.getDirectMessages(params);
            data.forEach((msg) => msg.includes = getObjIncludes(msg, includes, getDirectMessageIncludeIds));
            return data;
        },
    },
});

Trigger 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.

Label	Prop	Type	Description
X Developer App (formerly Twitter)	`app`	`app`	This component uses the X Developer App (formerly Twitter) app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

X Developer App (formerly Twitter) uses API keys for authentication. When you connect your X Developer App (formerly Twitter) account, Pipedream securely stores the keys so you can easily authenticate to X Developer App (formerly Twitter) APIs in both code and no-code steps.

Video Tutorial on how to create and connect a Twitter Developer App to Pipedream

First, you'll need to sign up for a Twitter developer account and create a new application in the Twitter app dashboard.

Register a new app on https://developers.twitter.com
Apply for a new Twitter app, be detailed about your use
After approval, create a new Standalone App
Copy the api_key and api_secret_key into a Twitter Developer App Account on Pipedream
Generate a new set of keys for your specific Twitter account
Paste the access_token and access_token_secret in the Twitter Developer App Account on Pipedream

Once you've created an app, visit the Keys and tokens section of the app's settings, and add the API key, API secret key, Access token, and Access token secret below.

About X Developer App (formerly Twitter)#

Use a Twitter developer app you've created to send API requests

Action#

Suppress Email on Mailgun

Description:Add email to the Mailgun suppression list. [See the docs here](https://documentation.mailgun.com/en/latest/api-suppressions.html#suppressions)

Version:0.0.3

Key:mailgun-suppress-email

View on GitHub

Mailgun Overview#

The Mailgun API on Pipedream is a potent tool for automating email operations without the overhead of managing a full-fledged email server. It offers capabilities to send, receive, track, and store emails with ease. With Pipedream's serverless platform, you can trigger workflows using Mailgun events, such as inbound emails or delivery status changes, and connect them to hundreds of other services to streamline communication, marketing, and notification systems within your ecosystem.

Action Code#

import mailgun from "../../mailgun.app.mjs";
import common from "../common.mjs";

export default {
  ...common,
  key: "mailgun-suppress-email",
  name: "Suppress Email",
  description: "Add email to the Mailgun suppression list. [See the docs here](https://documentation.mailgun.com/en/latest/api-suppressions.html#suppressions)",
  version: "0.0.3",
  type: "action",
  props: {
    mailgun,
    domain: {
      propDefinition: [
        mailgun,
        "domain",
      ],
    },
    email: {
      propDefinition: [
        mailgun,
        "emailString",
      ],
    },
    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,
    },
    ...common.props,
  },
  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 resp = await this.withErrorHandler(this.mailgun.mailgunPostRequest, url);
    $.export("$summary", "Successfully suppressed email");
    return resp;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Mailgun	`mailgun`	`app`	This component uses the Mailgun app.
Domain Name	`domain`	`string`	Select a value from the drop down menu.
Email Address	`email`	`string`
Category	`category`	`string`	Select a value from the drop down menu:`bouncesunsubscribescomplaints`
Bounce Error Code	`bounceErrorCode`	`string`	Email bounce error code
Bounce Error Message	`bounceErrorMessage`	`string`	Email bounce error message
Tag to unsubscribe from	`unsubscribeFrom`	`string`	Use * to unsubscribe an address from all domain’s correspondence
Halt on error?	`haltOnError`	`boolean`

Action 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.

About Mailgun#

Mailgun is an email automation service built for developers. Powerful transactional email APIs enable you to send, receive, and track emails.

More Ways to Connect Mailgun + X Developer App (formerly Twitter)#

Other Popular Integrations#

Send Direct Message (DM) with Twitter Developer App API on New Bounce from Mailgun API

Mailgun + X Developer App (formerly Twitter)

Suppress Email with Mailgun API on New Message Received from X Developer App (formerly Twitter) API

Pipedream makes it easy to connect APIs for Mailgun, X Developer App (formerly Twitter) and 2,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,000+apps by most popular

1
-
24
of
2,000+
apps by most popular