Convert SOAP XML Object to JSON with Salesforce API on New Email from IMAP API

Pipedream makes it easy to connect APIs for Salesforce, IMAP and 2,400+ other apps remarkably fast.

Trigger workflow on

New Email from the IMAP API

Next, do this

Convert SOAP XML Object to JSON with the Salesforce API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a IMAP trigger and Salesforce action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Email trigger
1. Connect your IMAP account
2. Configure Polling interval
3. Select a Mailbox
Configure the Convert SOAP XML Object to JSON action
1. Connect your Salesforce account
2. Configure infoBox
3. Configure XML Soap Object
4. Optional- Configure Extract Notifications Only
5. Optional- Configure Fail 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 Email on IMAP

Description:Emit new event for each new email in a mailbox

Version:0.0.4

Key:imap-new-email

View on GitHub

IMAP Overview#

Using Pipedream's IMAP API, developers can automate interactions with their email inbox, enabling serverless workflows that perform actions based on incoming emails. This could include parsing email contents, triggering events upon receiving emails from specific senders, attaching labels, and much more. By leveraging IMAP, Pipedream can act as a bridge between your email and other services, streamlining processes that would otherwise require manual intervention.

Trigger Code#

import imap from "../../imap.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

/**
 * Creates an IMAP server connection and emits emails added to a mailbox after the last emitted
 * email.
 */
export default {
  key: "imap-new-email",
  name: "New Email",
  description: "Emit new event for each new email in a mailbox",
  version: "0.0.4",
  type: "source",
  dedupe: "unique",
  props: {
    imap,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description:
        "Pipedream will poll the IMAP server for new emails at this interval",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    mailbox: {
      propDefinition: [
        imap,
        "mailbox",
      ],
    },
  },
  methods: {
    _getLastUid(mailbox) {
      return this.db.get(`lastUid-${mailbox}`);
    },
    _setLastUid(mailbox, lastUid) {
      this.db.set(`lastUid-${mailbox}`, lastUid);
    },
    _getUidValidity(mailbox) {
      return this.db.get(`uidValidity-${mailbox}`);
    },
    _setUidValidity(mailbox, uidValidity) {
      this.db.set(`uidValidity-${mailbox}`, uidValidity);
    },
    _handleUidValidityChange(mailbox, uidValidity) {
      this._setUidValidity(mailbox, uidValidity);
      this._setLastUid(mailbox, null);
    },
    hasNewMessages(box) {
      const lastUid = this._getLastUid(box.name);
      return !lastUid || box.uidnext > lastUid + 1;
    },
    generateMeta(message) {
      const date = message.attributes?.date ?? new Date();
      const ts = Date.parse(date);
      return {
        id: `${message.attributes?.uid}-${ts}`,
        ts,
        summary: message.mail?.subject,
      };
    },
    processMessage(message) {
      const lastUid = message.attributes?.uid ?? lastUid;
      this._setLastUid(this.mailbox, lastUid);
      this.$emit(message.mail, this.generateMeta(message));
    },
    async processMessageStream(stream) {
      for await (const message of stream) {
        this.processMessage(message);
      }
    },
    async getHistoricalEvents() {
      const { mailbox } = this;
      const connection = await this.imap.getConnection();
      try {
        const box = await this.imap.openMailbox(connection, mailbox);
        const startSeqno = box.messages.total > 25
          ? box.messages.total - 24
          : 1;
        const messageStream = this.imap.fetchMessages(connection, {
          startSeqno,
        });
        await this.processMessageStream(messageStream);
      } finally {
        await this.imap.closeConnection(connection);
      }
    },
  },
  hooks: {
    async deploy() {
      await this.getHistoricalEvents();
    },
  },
  async run() {
    const { mailbox } = this;
    const connection = await this.imap.getConnection();

    try {
      const box = await this.imap.openMailbox(connection, mailbox);

      const uidValidity = this._getUidValidity(box.name);
      if (uidValidity !== box.uidvalidity) {
        this._handleUidValidityChange(box.name, box.uidvalidity);
      }

      if (!this.hasNewMessages(box)) {
        console.log("No new messages since last run");
        return;
      }

      const lastUid = this._getLastUid(box.name);

      // Fetch messages after lastUid if it exists, or most recent message otherwise
      const messageStream = this.imap.fetchMessages(connection, {
        startUid: lastUid && lastUid + 1,
        startSeqno: box.messages.total,
      });
      await this.processMessageStream(messageStream);
    } finally {
      await this.imap.closeConnection(connection);
    }
  },
};

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
IMAP	`imap`	`app`	This component uses the IMAP app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the IMAP server for new emails at this interval
Mailbox	`mailbox`	`string`	Select a value from the drop down menu.

Trigger Authentication#

IMAP uses API keys for authentication. When you connect your IMAP account, Pipedream securely stores the keys so you can easily authenticate to IMAP APIs in both code and no-code steps.

Below are the required fields to connect your IMAP account to Pipedream:

host: Enter the host Pipedream should connect to. Refer to your email provider's IMAP instructions if you aren't sure what to enter.
email: Enter the email address you use to sign in to the account you'd like to connect.
password: This is the password you use to sign in to your email account. Note: in order to connect a Gmail account, you must use an App Password.
port: Specify the port number, either 143 (default) or 993. Refer to your email provider's IMAP instructions if you aren't sure which to use.

For Gmail accounts, refer to these instructions.

About IMAP#

Connect Pipedream to any IMAP email provider to trigger custom workflows.

Action#

Convert SOAP XML Object to JSON on Salesforce

Description:Converts a SOAP XML Object received from Salesforce to JSON

Version:0.0.6

Key:salesforce_rest_api-convert-soap-xml-to-json

View on GitHub

Salesforce Overview#

The Salesforce (REST API) provides a powerful platform for creating and managing customer relationships with a wide array of features like data manipulation, querying, and complex automation. With Pipedream's serverless execution, you can create workflows that automate your sales processes, sync data with other platforms, enhance customer engagement, and trigger actions based on specific events. Dive into Salesforce data, streamline lead management, track customer interactions, and push or pull data to or from Salesforce seamlessly.

Action Code#

import salesforce_rest_api from "../../salesforce_rest_api.app.mjs";
import converter from "../../../helper_functions/actions/xml-to-json/xml-to-json.mjs";

export default {
  key: "salesforce_rest_api-convert-soap-xml-to-json",
  name: "Convert SOAP XML Object to JSON",
  description: "Converts a SOAP XML Object received from Salesforce to JSON",
  version: "0.0.6",
  type: "action",
  props: {
    salesforce_rest_api,
    infoBox: {
      type: "alert",
      alertType: "info",
      content: `This action is useful in conjunction with Salesforce Flow Builder, and is primarily used if Instant triggers are not working for your use case.
\\
[See the documentation](https://pipedream.com/apps/salesforce-rest-api#troubleshooting) for more details.`,
    },
    xml: {
      type: "string",
      label: "XML Soap Object",
      description: "The object received from Salesforce that will be converted.",
    },
    extractNotificationOnly: {
      type: "boolean",
      label: "Extract Notifications Only",
      description: "Whether to extract only the notification parts from the XML. Default: `true`.",
      optional: true,
      default: true,
    },
    failOnError: {
      type: "boolean",
      label: "Fail on Error",
      description: "Whether the action should fail if an error occurs when extracting notifications. Default: `false`.",
      optional: true,
      default: false,
    },
  },
  async run({ $ }) {
    const json = await converter.run.bind({
      input: this.xml,
      compact: false,
    })({
      $,
    });

    if (!this.extractNotificationOnly) {
      return json;
    }

    try {
      const notifications = json.elements[0].elements[0].elements[0].elements
        .filter(({ name }) => name === "Notification");
      $.export("$summary", "Successfully converted to JSON and extracted notifications");
      return {
        notifications,
      };
    } catch (e) {
      const errorMessage = "Successfully converted to JSON, but was unable to extract notifications";
      if (this.failOnError) {
        $.export("$summary", errorMessage); // overrides exported $summary in converter
        throw new Error(errorMessage);
      }

      $.export("$summary", `${errorMessage}. Will return the whole JSON.`);
      return json;
    }
  },
};

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
Salesforce	`salesforce_rest_api`	`app`	This component uses the Salesforce app.
XML Soap Object	`xml`	`string`	The object received from Salesforce that will be converted.
Extract Notifications Only	`extractNotificationOnly`	`boolean`	Whether to extract only the notification parts from the XML. Default: `true`.
Fail on Error	`failOnError`	`boolean`	Whether the action should fail if an error occurs when extracting notifications. Default: `false`.

Action Authentication#

Salesforce uses OAuth authentication. When you connect your Salesforce account, Pipedream will open a popup window where you can sign into Salesforce and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Salesforce API.

Pipedream requests the following authorization scopes when you connect your account:

Convert SOAP XML Object to JSON with Salesforce API on New Email from IMAP API

Pipedream makes it easy to connect APIs for Salesforce, IMAP and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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