Skip to content
background-image background-image

Microsoft Exchange EWS Reader

[ | version 3.1]

Connector

The connector is permitted for use of the platform background agent.

Connector processing type: Row by row!

This connector allows to download email messages from Microsoft Exchange by Exchange Web Services (EWS). It is used when given mailbox is not supporting REST API i.e. on-premise installations.

Using placeholders

For string properties in configuration you can use single cell placeholder which can be wrapped by other text. Typically it can be used to read messages for different users. So each input row can contain username and password to be used in configuration.

Example

  • ${input.UserName}
  • ${input.Password}

Storage data

This connector saves last read email for each username or mailbox.

{
  "LastReadEmail": {
    "test.user@intelstudios.com": {
      "LastRead": {
        "IDs": [
          "ZAAAfWGVlAAA="
        ],
        "Received": "2020-03-17T07:50:07Z"
      },
      "FoldersMap": {}
    },
    "test.user2@intelstudios.com": {
      "LastRead": {
        "IDs": [
          "ZADJSpsadIIDAAA="
        ],
        "Received": "2020-04-17T03:50:07Z"
      },
      "FoldersMap": {}
    }
  }
}

Configuration

Exchange EWS Mail Download configuration

Filter From

Comma-separated set of filter expressions. ie *test,*prod would match anything ending with test or prod. Empty filter matches everything.

Filter To

Comma-separated set of filter expressions. ie *test,*prod would match anything ending with test or prod. Empty filter matches everything.

Filter Subject

Comma-separated set of filter expressions. ie *test,*prod would match anything ending with test or prod. Empty filter matches everything.

Folder

Select email folder from which emails will be read

  • Inbox (Default)
  • Sent items
  • Outbox
  • Drafts
  • Deleted items
  • Junk

Shared Mailbox address

Shared mailbox address. Fill only when downloading messages from shared mailbox.

Emails to check

  • All untreated emails - all emails which have not yet been processed
  • Only untreated emails with no attachments - all not yet processed emails which must NOT have attachment
  • Only untreated emails with attachments - all not yet processed emails which MUST have at least one attachment

Number of messages to process

Maximum number of messages which will be processed in one task run (0 = unlimited, n = exact number).

Mark processed messages as read

If set to true, processed messages will be marked as read.

Mark processed messages with category

If set to true, processed messages will be marked with category.

Mark with category

Category which the processed messages will be marked as.

Example

  • Green category
  • Red category
  • ...

Default is Green category.

Move processed messages into folder

If set to true, processed messages will be moved into selected mailbox folder.

Move to folder

Folder into which the processed messages will be moved.

Example

  • Processed
  • Inbox\Processed
  • Inbox\Completed
  • ...

Only when Shared mailbox is not filled

Transfer attachments

If set to false, output schema property Attachment will be always null.

Filter Attachment name

Comma-separated set of filter expressions. ie *pdf,*jpg would match anything ending with pdf or jpg. Empty filter matches everything.

Ignore attachments linked from body

If set to true and if attachment, ie. image, is linked from body content, then is ignored.

Exchange EWS Connection configuration

Exchange version

Select default exchange version used. Default is Exchange 2016.

Username

Define mailbox server bind login which is used for authentication of the connection. Placeholder can be used to refer data from input schema ${input.UserName}.

Password

Define mailbox server bind password which is used for authentication of the connection.

Domain

Define Domain where mailbox server is placed.

Timeout

Define timeout in seconds. Default is 100.

Autodiscover

If set to true, exchange server is discovering settings automatically by entered email.

Autodiscover email

Email address used for auto discovering exchange server settings.

Exchange url

Url address used for setting exchange server parameters.

Input & Output Schema

Input

Input schema is opional

Output

Result of EWS reader connector are email messages from given mailbox. Attachments are encoded to Base64 and saved to Attachment of output schema.

E-Mail (ver. 1.4.0)

Column Data type Allow null Description
ID string No ID of message
Email string No Actual email address from Username field in configuration
Subject string Yes Subject
From E-Mail Person 1.0.0 No Sender of email data
To E-Mail Person 1.0.0 No The recipient/s of the email data object
Cc E-Mail Person 1.0.0 Yes Recipients that are copied on the email data object
Bcc E-Mail Person 1.0.0 Yes Recipients that are blind-copied on the email data object
DateSent DateTime No Date when email was sent
DateReceived DateTime No Date when email was received
ReplyTo E-Mail Person 1.0.0 Yes Serialized content of HTTP response
BodyText String Yes Serialized content of HTTP response
Body String Yes Body
Importance String No Importance of email (low, normal, high)
Attachment E-Mail Attachment 1.0.0 Yes Email attachments

E-Mail Person (ver. 1.0.0)

Column Data type Allow null Description
Name string Yes Name of person
Address string No Email address

E-Mail Attachment (ver. 1.0.0)

Column Data type Allow null Description
Name string No File name with extension
Content Base64 No Encoded file content

Release notes

3.1.5

  • Plugin binaries update as a result of included connector change.

3.1.4

  • Fixed parsing configurations.

3.1.3

  • Fixed shared nuget package versions.

3.1.2

  • Fixed right processing of nullable properties.

Was this page helpful?

Privacy Policy

©Integray 2024

Privacy Policy