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
  • Hi Team,

    We are using the "Poll Email from Microsoft Exchange EWS API 2.0.1" plugin for Email polling functionality.

    While hitting the curl command from  the application server we get authentication successful with the user name and password configured in the application, however when we run the functionality through APN, we get 401(unauthorized) error on server console.

    Caused by: microsoft.exchange.webservices.data.core.exception.http.HttpErrorException: The remote server returned an error: (401)Unauthorized at microsoft.exchange.webservices.data.core.request.ServiceRequestBase.getEwsHttpWebResponse(ServiceRequestBase.java:723) at microsoft.exchange.webservices.data.core.request.ServiceRequestBase.validateAndEmitRequest(ServiceRequestBase.java:639) This works in the UAT environment but not in preprod.

    Usually we need HTTP enabled in UAT but not in Preprod, hence blocked why the request is not succeeding in preprod.

    Any advise in this regard will be a great help.

    Regards

    Sumit Kumar

  • Hi Team, we used this plugin but we got this error. Can you please check

    The request failed. The request failed. PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target

    Regards,

    Bhanu Prakash

  • Is it possible to download a previous version compatible with Appian 21.3?

  • We have an urgent issue that I am hoping we can get some direction on...

    The plugin does not process any emails that have an "email" as an attachment (e.g. an email that has been forwarded) . this is clearly a pattern as we have been ingesting hundreds of mails over the past few weeks and all of the ones that have email attachments are kicked out as exceptions by the plugin.

    The error we see is quite misleading as the attachments definitely do not have any special characters in the file names. 

    Problem:  NTFS ADS separator (':') in file name is forbidden.

    Details:  An error occurred while trying to fetch the details from nzxopalingest@cigna.com. Please find the reason for this error message: NTFS ADS separator (':') in file name is forbidden.

    Priority of this problem: High Priority "

  • v2.0.1 Release Notes
    • Upgrade to Jakarta mail

  • Hi Team,

    It is working fine with normal username & password. but when i try to connect with service account user & password will connect 401 authorization issues. Please let us know need to change any configuration.

    Regards,

    Bhanu

  • v1.1.3 Release Notes
    • Fix issues with case sensitivity for Proxy settings
  • Hello, I have similar issue in this plugin. Do you have any update? Thanks

  • Thank you for bringing this up to our attention.

    I have added this item to our backlog. I expect a new version of the plugin to be available next week. I will update this thread when it is released.

  • v1.1.2 Release Notes
    • Security updates