View as Markdown
Salesforce icon

Salesforce ACTION

Send Email

Send an email through Salesforce. Use List Email Templates to find a template ID first when sending templated mail. Sent mail is logged against the related record - use List Email Messages to read it back. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Salesforce account once, then configure and run Send 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: "salesforce_rest_api-send-email",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    salesforce_rest_api: { authProvisionId: "apn_xxxxxxx" },
    emailAddress: "Email Address",
    emailSubject: "Subject",
  },
})

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.

Send Email inputs
Property Type Description
emailAddress Email Address string
The email address to send the email to
Required
emailSubject Subject string
The subject of the email
Required
emailBody Body string
The body of the email
Required
sendRichBody Send Rich Body boolean
Whether to send Body of the email as rich text (HTML) rather than plain text. Defaults to false.
Optional
logEmailOnSend Log Email on Send boolean
Indicates whether to log the email on the specified records' activity time lines
Optional
relatedRecordId Related Record ID string
The ID of a record that is not a person (for example, a case record). If logEmailOnSend is included, this is the ID of a secondary record (except a lead) to log the email to.
Optional
addThreadingTokenToBody Add Threading Token to Body boolean
Whether to create a unique token for the related record and add it to the email body. When the related record is a case record, Email-to-Case uses the token to link future email responses to that case.
Optional
addThreadingTokenToSubject Add Threading Token to Subject boolean
The same as Add Threading Token to Body, but for the email subject.
Optional
senderType Sender Type string
Email address used as the email's From and Reply-To addresses. In scheduled flows, the only valid value is OrgWideEmailAddress.
Required
senderAddress Sender Address string
If Sender Type is OrgWideEmailAddress, this is the organization-wide email address to be used as the sender.
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
salesforce_rest_api-send-email
Version
0.2.0
App
Salesforce
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes