Upload File with Zoho Projects API on New Email from IMAP API

Pipedream makes it easy to connect APIs for Zoho Projects, IMAP and 2,900+ other apps remarkably fast.

Trigger workflow on

New Email from the IMAP API

Next, do this

Upload File with the Zoho Projects 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 Zoho Projects 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 Upload File action
1. Connect your Zoho Projects account
2. Select a Portal ID
3. Select a Project ID
4. Select a Third Party Folder ID
5. Configure Folder Name
6. Configure Folder Include Files
7. Configure File Document
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.6

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.6",
  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 box.messages.total && (!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);
        if (box.messages.total) {
          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#

Upload File on Zoho Projects

Description:Add a document. [See the docs here](https://www.zoho.com/projects/help/rest-api/documents-api.html#alink3)

Version:0.0.3

Key:zoho_projects-upload-file

View on GitHub

Zoho Projects Overview#

The Zoho Projects API lets you harness the full potential of project management by enabling seamless integration with other tools and automating routine tasks. With it, you can create projects, manage tasks, track time, and customize your workflow. On Pipedream, you can leverage this API to build robust automations that connect Zoho Projects with a plethora of other apps, streamlining project tracking and collaboration workflows, all without writing a single line of code.

Action Code#

import zohoProjects from "../../zoho_projects.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "zoho_projects-upload-file",
  name: "Upload File",
  description: "Add a document. [See the docs here](https://www.zoho.com/projects/help/rest-api/documents-api.html#alink3)",
  type: "action",
  version: "0.0.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    zohoProjects,
    portalId: {
      propDefinition: [
        zohoProjects,
        "portalId",
      ],
    },
    projectId: {
      propDefinition: [
        zohoProjects,
        "projectId",
        ({ portalId }) => ({
          portalId,
        }),
      ],
    },
    folderId: {
      propDefinition: [
        zohoProjects,
        "folderId",
        ({
          portalId, projectId,
        }) => ({
          portalId,
          projectId,
        }),
      ],
    },
    folderName: {
      type: "string",
      label: "Folder Name",
      description: "Name of the folder to create.",
    },
    folderIncludeFiles: {
      type: "boolean",
      label: "Folder Include Files",
      description: "If `true`, the new folder will become the parent folder for the files instead of the one in the URL by default",
      default: true,
    },
    uploadFile: {
      type: "string",
      label: "File Document",
      description: "File path of a file previously downloaded in Pipedream E.g. (`/tmp/my-file.txt`). [Download a file to the `/tmp` directory](https://pipedream.com/docs/code/nodejs/http-requests/#download-a-file-to-the-tmp-directory)",
    },
  },
  async run({ $ }) {
    const {
      portalId,
      folderId,
      folderName,
      folderIncludeFiles,
      uploadFile,
    } = this;

    const response =
      await this.zohoProjects.uploadFiles({
        $,
        headers: constants.MULTIPART_FORM_DATA_HEADERS,
        portalId,
        folderId,
        data: {
          service: "workdrive",
          folder_name: folderName,
          folder_include_files: folderIncludeFiles,
          upload_file: uploadFile,
        },
      });

    $.export("$summary", "Successfully uploaded a file to the project");

    return response;
  },
};

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
Zoho Projects	`zohoProjects`	`app`	This component uses the Zoho Projects app.
Portal ID	`portalId`	`string`	Select a value from the drop down menu.
Project ID	`projectId`	`string`	Select a value from the drop down menu.
Third Party Folder ID	`folderId`	`string`	Select a value from the drop down menu.
Folder Name	`folderName`	`string`	Name of the folder to create.
Folder Include Files	`folderIncludeFiles`	`boolean`	If `true`, the new folder will become the parent folder for the files instead of the one in the URL by default
File Document	`uploadFile`	`string`	File path of a file previously downloaded in Pipedream E.g. (`/tmp/my-file.txt`). Download a file to the `/tmp` directory

Action Authentication#

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

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

ZohoProjects.portals.allZohoProjects.projects.allZohoProjects.activities.createZohoProjects.status.readZohoProjects.milestones.allZohoProjects.tasklists.allZohoProjects.tasks.allZohoProjects.timesheets.allZohoProjects.bugs.allZohoProjects.tags.allZohoProjects.events.allZohoProjects.forums.allZohoProjects.users.allZohoProjects.documents.CREATEZohoPC.files.CREATEZohoProjects.search.readZohoProjects.documents.READWorkDrive.team.ALLWorkDrive.workspace.ALLWorkDrive.files.ALL

Upload File with Zoho Projects API on New Email from IMAP API

Pipedream makes it easy to connect APIs for Zoho Projects, IMAP and 2,900+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

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