Configuration

This section explains each of the properties in the configuration blade.
General
Property
Description
Collection
This associates the Agent to a specific Collection (default to that of the current Data Stream).
Polling Interval (seconds)
A timespan to specify how often should the Agent check for new data/changes or update its cache.
Refer to Collections and Stream Hosts to understand more about Collections.
Server
Property
Description
Protocol
The Email Protocol used to connect to the Host Server. The protocols supported are:
POP3: get unread emails that arrive after the Data Stream is published
IMAP: get unread emails, regardless of whether they arrived before or after the Data Stream is published
Use Variables?
Tick to use server variables for Host Address, Port, User, and Password; or enter them manually.
Host
The Url of the server to connect to.
Port
The port of the server to connect to (default to port 995).
Use SSL
Tick to always attempt to connect using a secure connection; otherwise, a secure connection is not guaranteed. It is recommended to tick this when possible.
Disable SSL Validation?
Tick to turn off the validation of SSL certificates when connecting to the email server. It is recommended to leave this unticked when possible.
Refresh Client Token Interval (hours)
A timespan between 1 (default) and 24 hours to specify how often should the Agent refresh the email client token (applies to OAuth Authentication Mode only).
Authentication 
Property
Description
User
The username with which to authenticate to the email server.
Password
The password of the user to use for authentication.
Authentication Mode
The authentication mode used to connect to the email server: Basic (default) or OAuth (token-based).
Tenant ID
Tenant Id used for authentication (applies to OAuth Authentication Mode only).
Client ID
Client Id used for authentication (applies to OAuth Authentication Mode only).
Client Secret
Client Secret used for authentication (applies to OAuth Authentication Mode only).
Refresh Client Token Interval (hours)
A timespan to specify how often should the Agent refresh the email client token, between 1 (default) and 24. (applies to OAuth Authentication Mode only).
Options
Property
Description
Get Email
The criteria to filter the unread Emails:  
All
With Attachment
Without Attachment
Applies to IMAP protocol only.
Delete on read?
Tick for emails to be deleted once they have been processed.
Attachment Streaming Type
The output options are Local Storage (output as file path) or Streaming (output as Base64 binary string)
Endpoints
Name
Description
Output
An event per email is made available to this endpoint.
Error
Errors encountered during the execution of this Agent will be published on this endpoint.

Property	Description
Collection	This associates the Agent to a specific Collection (default to that of the current Data Stream).
Polling Interval (seconds)	A timespan to specify how often should the Agent check for new data/changes or update its cache.

Property	Description
Protocol	The Email Protocol used to connect to the Host Server. The protocols supported are: POP3: get unread emails that arrive after the Data Stream is published IMAP: get unread emails, regardless of whether they arrived before or after the Data Stream is published
Use Variables?	Tick to use server variables for Host Address, Port, User, and Password; or enter them manually.
Host	The Url of the server to connect to.
Port	The port of the server to connect to (default to port 995).
Use SSL	Tick to always attempt to connect using a secure connection; otherwise, a secure connection is not guaranteed. It is recommended to tick this when possible.
Disable SSL Validation?	Tick to turn off the validation of SSL certificates when connecting to the email server. It is recommended to leave this unticked when possible.
Refresh Client Token Interval (hours)	A timespan between 1 (default) and 24 hours to specify how often should the Agent refresh the email client token (applies to OAuth Authentication Mode only).

Property	Description
User	The username with which to authenticate to the email server.
Password	The password of the user to use for authentication.
Authentication Mode	The authentication mode used to connect to the email server: Basic (default) or OAuth (token-based).
Tenant ID	Tenant Id used for authentication (applies to OAuth Authentication Mode only).
Client ID	Client Id used for authentication (applies to OAuth Authentication Mode only).
Client Secret	Client Secret used for authentication (applies to OAuth Authentication Mode only).
Refresh Client Token Interval (hours)	A timespan to specify how often should the Agent refresh the email client token, between 1 (default) and 24. (applies to OAuth Authentication Mode only).

Property	Description
Get Email	The criteria to filter the unread Emails: All With Attachment Without Attachment Applies to IMAP protocol only.
Delete on read?	Tick for emails to be deleted once they have been processed.
Attachment Streaming Type	The output options are Local Storage (output as file path) or Streaming (output as Base64 binary string)

Name	Description
Output	An event per email is made available to this endpoint.
Error	Errors encountered during the execution of this Agent will be published on this endpoint.

Last modified 9mo ago