View as Markdown
AcyMailing icon

AcyMailing ACTION

Email User

Sends an email to a single AcyMailing user. The user must exist in the AcyMailing database. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's AcyMailing account once, then configure and run Email User 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: "acymailing-email-user",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    acymailing: { authProvisionId: "apn_xxxxxxx" },
    email: "Email",
    autoAddUser: true,
  },
})

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.

Email User inputs
Property Type Description
email Email string
The email address of the receiver.
Required
autoAddUser Auto Add User boolean
Defaults to false. If the email address doesn't match an existing AcyMailing user, one will be automatically created if this option is set to true.
Optional
emailId Email Id integer
The mail ID to send. This is not a campaign ID but the mail ID of the table xxx_acym_mail in the database, or the mail_id of a campaign.
Required
trackEmail Track Email boolean
Defaults to true. If true, the open/click statistics will be collected for this email.
Optional
params Params object
An object of shortcodes and values to replace in the body of the sent email. Example: { "shortcode1": "value 1" }. If the body of the sent email contains the text "{shortcode1}", it will be replaced by "value 1" in the sent version.
Optional

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
acymailing-email-user
Version
0.0.3
App
AcyMailing
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes