View as Markdown
Mailgun icon

Mailgun ACTION

Suppress Email

Add email to the Mailgun suppression list. See the docs here
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Mailgun account once, then configure and run Suppress Email from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "mailgun-suppress-email",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mailgun: { authProvisionId: "apn_xxxxxxx" },
    domain: "Domain Name",
    email: "Email Address",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Suppress Email inputs
Property Type Description
domain Domain Name string
Required Dynamic
email Email Address string
Required
category Category string
Which suppression list to add the email to
Required
bounceErrorCode Bounce Error Code string
Email bounce error code
Optional
bounceErrorMessage Bounce Error Message string
Email bounce error message
Optional
unsubscribeFrom Tag to unsubscribe from string
Use * to unsubscribe an address from all domain’s correspondence
Optional
haltOnError Halt on error? boolean
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
mailgun-suppress-email
Version
0.0.4
App
Mailgun
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes