Exchange (EWS)

Microsoft Exchange Server is a mail server and calendaring server developed by Microsoft. This integration relies on EWS being enabled for the server.

Integration with LogicHub

Connecting with Exchange

To connect to Exchange following details are required:

  • Label: Connection name.
  • Reference Values: Define variables here to templatize integration connections and actions. For example, you can use https://www.{{hostname}}.com where, hostname is a variable defined in this input. For more information on how to add data, see 'Add Data' Input Type for Integrations.
  • Server Name/IP: Server Name or IP address for Exchange authentication.
  • Username: Username for Exchange authentication.
  • Password: Password for Exchange authentication.
  • Email Address to use: User to login into Exchange as.
  • Timeout (Optional): Seconds to wait before stopping the authentication request (Default is 30 seconds).

Actions with Exchange

Read Email

Pulls emails from a user's inbox.

Inputs to this Action

  • Connection: Choose a connection that you have created.
  • Mailbox Folder: Path and name of the folder from which to pull email messages (typically Inbox).
  • Mark Read (Optional): Automatically mark messages read when they are pulled by LogicHub (Default is True).
  • Unread Only (Optional): Pull only unread messages (Default is True).
  • Download Attachments(Optional): Automatically download attachments (Default is True, Doing so may significantly increase processing time.).
  • Filter by Subject (Optional): Jinja templated Subject to filter emails by. A case-insensitive 'contains' match is done.
  • Message Limit (Optional): Limit the number of messages to pull at once. (Default is 100 messages).
  • Maximum Message Age (Optional): Filter messages based on maximum age (in seconds) since message receipt time (Default is to retrieve all messages).

Output of Action
Correlated results when Filter By Subject is provided, otherwise uncorrelated results. The output table contains one row per email.

Get Attachments

Pulls the attachments of a set of emails.

Inputs to this Action

  • Connection: Choose a connection that you have created.
  • Column with email message IDs: Select column holding the emails message-IDs.

Output of Action
JSON containing the following items

  • has_error: True/False
  • error: message/null
  • msgid: message-id of email
  • attachments: json array of attachments

Delete Email

Deletes an email by ID.

Inputs to this Action

  • Connection: Choose a connection that you have created.
  • Column with email message ID: Select column containing the message IDs of emails, which need to be deleted.

Output of Action
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • msgid: message-id of email
  • msg: Successfully deleted email

Mark Email as Read

Marks an email as read by ID.

Inputs to this Action

  • Connection: Choose a connection that you have created.
  • Column with email message ID: Select column containing the message IDs of emails, which need to be marked as read.

Output of Action
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • msgid: message-id of email
  • msg: Successfully marked email as read.

Mark Email as Unread

Marks an email as unread by ID.

Inputs to this Action

  • Connection: Choose a connection that you have created.
  • Column with email message ID: Select column containing the message IDs of emails, which need to be marked as unread.

Output of Action
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • msgid: message-id of email
  • msg: Successfully marked email as unread.

Add Categories

Append categories to an email.

Inputs to this Action

  • Connection: Choose a connection that you have created.
  • Column with email message ID: Select column containing the ids of the messages to update.
  • Categories: A comma-separated list of categories.

Output of Action
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • msgid: message-id of email
  • msg: Successfully updated email categories.

Replace Categories

Replace an email's categories.

Inputs to this Action

  • Connection: Choose a connection that you have created.
  • Column with email message ID: Select column containing the IDs of the messages to update.
  • Categories: A comma-separated list of categories.

Output of Action
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • msgid: message-id of email
  • msg: Successfully updated email categories.

Remove Categories

Remove categories from an email.

Inputs to this Action

  • Connection: Choose a connection that you have created.
  • Column with email message ID: Select column containing the IDs of the messages to update.
  • Categories: A comma-separated list of categories.

Output of Action
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • msgid: message-id of email
  • msg: Successfully updated email categories.

Send Email

Sends an email to an email address.

Inputs to this Action

  • Connection: Choose a connection that you have created.
  • Column containing the email address for recipients: Select column containing the email addresses to send an email to.
  • Column containing the subject of an email: Select column containing the subject title for emails.
  • Column containing the body of an email: Select column containing the body for outbound emails.
  • Column containing the cc on outbound email (Optional): Select column containing an email address to attach as a cc on an outbound email.
  • File Attachment (Optional): Column containing one or more file IDs to attachment. (Can be a comma separated string of lhub_file_id values or a json dict in the format of {"<lhub_id>":"<file_name>"}).
  • Attachment File Extension (Optional): If no file name is provided, add this extension to the attached files.
  • Type (Optional): HTML/Plain-Text. Select the type of email body (default is Plain Text).

Output of Action
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • msgid: message-id of email
  • msg: Successfully sent email

Move Email

Moves an email from one folder to another.

Inputs to this Action

  • Connection: Choose a connection that you have created.
  • Column with email message IDs: Select column containing the message IDs of emails, which need to be moved.
  • Column with folder name: Select column containing the destination folder name.

Output of Action
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • msgid: message-id of email
  • msg: Successfully moved email to folder: .

Did this page help you?