Get Issue with Jira API on New Email from IMAP API

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

Trigger workflow on

New Email from the IMAP API

Next, do this

Get Issue with the Jira 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 Jira 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 Get Issue action
1. Connect your Jira account
2. Select a Cloud ID
3. Select a Issue id or key
4. Optional- Configure Fields
5. Optional- Configure Fields by keys
6. Optional- Configure Properties
7. Optional- Configure Update history
8. Optional- Configure Expand
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.5

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.5",
  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#

Get Issue on Jira

Description:Gets the details for an issue. [See the docs](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-get)

Version:0.1.11

Key:jira-get-issue

View on GitHub

Jira Overview#

The Jira API opens up a world of possibilities for automating project management tasks, syncing with other tools, and enhancing data visibility. With Pipedream's integration, you can streamline issue tracking by automatically creating, updating, and searching for issues in Jira, as well as managing projects, sprints, users, and more. This integration not only saves time but also ensures real-time data flow across various platforms, keeping teams in sync and projects on track.

Action Code#

import jira from "../../jira.app.mjs";

export default {
  key: "jira-get-issue",
  name: "Get Issue",
  description: "Gets the details for an issue. [See the docs](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-get)",
  version: "0.1.11",
  type: "action",
  props: {
    jira,
    cloudId: {
      propDefinition: [
        jira,
        "cloudId",
      ],
    },
    issueIdOrKey: {
      propDefinition: [
        jira,
        "issueIdOrKey",
        (c) => ({
          cloudId: c.cloudId,
        }),
      ],
    },
    fields: {
      type: "string",
      label: "Fields",
      description: "A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields.  All fields are returned by default. Allowed values:\n`*all` Returns all fields.\n`*navigable` Returns navigable fields.\nAny issue field, prefixed with a minus to exclude, as in `-description `.",
      optional: true,
    },
    fieldsByKeys: {
      type: "boolean",
      label: "Fields by keys",
      description: "Whether `fields` in fields are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field's key may differ from its ID.",
      optional: true,
    },
    properties: {
      propDefinition: [
        jira,
        "properties",
      ],
      description: "A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values:\n`*all` Returns all issue properties.\nAny issue property key, prefixed with a minus to exclude.",
    },
    updateHistory: {
      type: "boolean",
      label: "Update history",
      description: "Whether the project in which the issue is created is added to the user's Recently viewed project list, as shown under Projects in Jira.",
      optional: true,
    },
    expand: {
      propDefinition: [
        jira,
        "expand",
      ],
      description: "Use expand to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include:\n`renderedFields` Returns field values rendered in HTML format.\n`names` Returns the display name of each field.\n`schema` Returns the schema describing a field type.\n`transitions` Returns all possible transitions for the issue.\n`editmeta` Returns information about how each field can be edited.\n`changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent.\n`versionedRepresentations` Returns a JSON array for each version of a field's value, with the highest number representing the most recent version. Note: When included in the request, the fields parameter is ignored.",
    },
  },
  async run({ $ }) {
    let properties;
    try {
      properties = JSON.parse(this.properties);
    } catch (err) {
      //pass
    }
    const response = await this.jira.getIssue({
      $,
      cloudId: this.cloudId,
      issueIdOrKey: this.issueIdOrKey,
      params: {
        fields: this.fields,
        fieldsByKeys: this.fieldsByKeys,
        properties,
        updateHistory: this.updateHistory,
        expand: this.expand,
      },
    });
    $.export("$summary", `Successfully retrieved issue with ID(or key): ${this.issueIdOrKey}`);
    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
Jira	`jira`	`app`	This component uses the Jira app.
Cloud ID	`cloudId`	`string`	Select a value from the drop down menu.
Issue id or key	`issueIdOrKey`	`string`	Select a value from the drop down menu.
Fields	`fields`	`string`	A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields. All fields are returned by default. Allowed values: `all` Returns all fields. `navigable` Returns navigable fields. Any issue field, prefixed with a minus to exclude, as in `-description` .
Fields by keys	`fieldsByKeys`	`boolean`	Whether `fields` in fields are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field's key may differ from its ID.
Properties	`properties`	`string`	A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values: `*all` Returns all issue properties. Any issue property key, prefixed with a minus to exclude.
Update history	`updateHistory`	`boolean`	Whether the project in which the issue is created is added to the user's Recently viewed project list, as shown under Projects in Jira.
Expand	`expand`	`string`	Use expand to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include: `renderedFields` Returns field values rendered in HTML format. `names` Returns the display name of each field. `schema` Returns the schema describing a field type. `transitions` Returns all possible transitions for the issue. `editmeta` Returns information about how each field can be edited. `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent. `versionedRepresentations` Returns a JSON array for each version of a field's value, with the highest number representing the most recent version. Note: When included in the request, the fields parameter is ignored.

Action Authentication#

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

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

read:jira-workmanage:jira-projectread:jira-userwrite:jira-workmanage:jira-data-providerread:meoffline_accessread:issue-details:jiraread:board-scope:jira-softwareread:webhook:jirawrite:webhook:jiraread:field:jiraread:project:jiradelete:webhook:jirawrite:board-scope:jira-softwareread:board-scope.admin:jira-softwareread:sprint:jira-softwarewrite:sprint:jira-softwareread:field.option:jirawrite:field.option:jiraread:custom-field-contextual-configuration:jira write:custom-field-contextual-configuration:jiramanage:jira-configurationread:jql:jira

About Jira#

Jira is the #1 agile project management tool used by teams to plan, track, release, and support great software with confidence

More Ways to Connect Jira + IMAP#

Other Popular Integrations#

JIRA - Create Issue with Jira API on New Email from IMAP API

IMAP + Jira

Get Issue with Jira API on New Email from IMAP API

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

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

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