Adapter - Email Receiver

This page describes version 2.0.8 of the adapter.

Overview

You can use the Email Receiver adapter to receive and process emails in the Workflow Engine.

This adapter supports email using IMAP. Only secure connections to the IMAP server are supported.

IMAP should be enabled and "Allow less secure apps" has to be turned ON in the account settings for gmail.

Name	Display	Is Required	Comments	Type	Default Value	Maximum Value	Minimum Value	Maximum Length
imapserver	IMAP Server Address	True	The address of the IMAP server, e.g. imap.gmail.com	string				1024
imapport	IMAP Server Port	True	The port number to connect to the IMAP server, typically 993 for secure connections	integer	993	65535	1
username	Username	True	Username required for authentication with IMAP server	string				1024
password	Password	True	Password required for authentication with IMAP server	password				100
maxattachmentsize	Maximum attachment size (MB)	False	The maximum size of file in megabytes which can be sent as an attachment. If the size is greater than that, adapter will throw an error	integer	2	5	1
maxretentiondays	Maximum retention days	False	The maximum number of days the email is kept in the inbox, after which the emails will be deleted	integer	10	100	1

An event that occurs when an email is received to the inbox

Name	Display	Description	Type
messageId	Message ID	The message identifier	string
subject	Subject	The subject of the email	string
from	From	The 'From' address of the email	string
to	To	The 'To' address of the email	string
cc	CC	The 'CC' address of the email	string
bcc	BCC	The 'BCC' address of the email	string
textbody	Text Body	The email body, for plain text messages	string
htmlbody	HTML Body	The email body, for HTML messages	string
date	Date	The date of the email	string
importance	Importance	The email priority, one of: low, normal or high	string
attachment	Attachments	Attachments received in the email	array
attachment.count	Attachment Count	The number of attachments in the email	string
attachment[0].name	Attachment Name	The name of the attachment file, including the extension	string
attachment[0].data	Attachment Data	The attachment file data, encoded in base64 format	string
attachment[0].datatype	Attachment Data Type	The type of the attachment data; always set to base64	string
attachment[0].contenttype	Attachment Content Type	The media type of the attachment, e.g. image/png, text/plain, text/csv, application/pdf	string
attachment[0].isinlineattachment	Is Inline Attachment	Whether the attachment is shown in the HTML email body	boolean

Version	Type	Description	Tracking #	Date
2.0.1	Initial	First release in the Adapter Type store.
2.0.6	Maintenance	Updated third-party components and improved maintainability.	NAP-11518
2.0.7	Maintenance	Updated third-party components and improved maintainability.	NAP-23945	2022-11-29
2.0.8	Maintenance	Updated third-party components and improved maintainability.	NAP-27635	2024-07-31