Poll Email from Microsoft Exchange EWS API

Overview

This plugin provides an alternative to sending emails to an Appian process model when inbound email integration is requested. Instead of the email being forwarded to Appian, this plugin reads the emails directly from the Exchange mailbox using the EWS web services API.

Deployment Instructions

  • Deploy the plugin through the admin console of your Appian Cloud site or by copying the plugin zip file to the plugins folder
  • Download the component from the App Market. The zip file "EWS Mail Poller applications.zip" contains sample applications for use with the plugin
  • Use the application, scripts, or XSDs that correspond to your database
  • Configure a Third Party Credentials entry in the admin console with the following parameters:
    • username: email identifier of the mailbox to poll. This is usually the part of the email address coming before the '@' character, but depending on the Exchange server may instead be the entire email address or domain\EmailAddress
    • password: password to access the mailbox
    • proxyUsername (or proxyusername) : username of the proxy account
    • proxyPassword (or proxypassword) : password of the proxy account

Key Features & Functionality

Smart service "EWS Mail Poller To DB":

  • Reads the mailbox using the EWS web service API
  • Convert the email to an EWM file stored as an Appian document
  • Store all email attachments as Appian documents
  • Store all email metadata (subject, author, recipients, etc...) into a set of tables in the database

To use this plug-in:

  • Create a process model to invoke the plugin on a schedule basis like every few minutes
  • Configure a Secure Credential Store with the following attributes
  • Configure the smart service plugin with the required inputs including the name of the Secured Credential Store created above

By default, the emails successfully processed are moved to the folder Deleted Items and the emails that cannot be processed are moved to the folder Junk E-mails.

Anonymous
Parents
  • v1.1.0 Release Notes
    • Adds support for inline images. Inline images can now be created as Appian documents. Additionally, the inline image metadata is added to the APP_MAIL_POLLER_DOC table and the updated HTML (with Appian docs ids substituted for the original content ids), is stored in a new column in the APP_MAIL_POLLER table. This allows for easy display of the email content with inline images in rich text component plugins.
    • The updated plugin expects the following new columns
    • BODY_SWAPPED_IMAGES in APP_MAIL_POLLER: data type should be the same as BODY_HTML column (longtext in MariaDB)
    • INLINE_ID in APP_MAIL_POLLER_DOC: data type should be able to hold 255 text characters (varchar 255 in MariaDB)
    • DISPOSITION in APP_MAIL_POLLER_DOC: data type should be able to hold 255 text characters (varchar 255 in MariaDB)
Comment
  • v1.1.0 Release Notes
    • Adds support for inline images. Inline images can now be created as Appian documents. Additionally, the inline image metadata is added to the APP_MAIL_POLLER_DOC table and the updated HTML (with Appian docs ids substituted for the original content ids), is stored in a new column in the APP_MAIL_POLLER table. This allows for easy display of the email content with inline images in rich text component plugins.
    • The updated plugin expects the following new columns
    • BODY_SWAPPED_IMAGES in APP_MAIL_POLLER: data type should be the same as BODY_HTML column (longtext in MariaDB)
    • INLINE_ID in APP_MAIL_POLLER_DOC: data type should be able to hold 255 text characters (varchar 255 in MariaDB)
    • DISPOSITION in APP_MAIL_POLLER_DOC: data type should be able to hold 255 text characters (varchar 255 in MariaDB)
Children
No Data