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).

Refer to Collections and Stream Hosts to understand more about Collections.

Server

Property
Description

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 993).

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.

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 between 1 (default) and 24 hours to specify how often should the Agent refresh the email client token (applies to OAuth Authentication Mode only).

Settings

Property
Description

Message Id

The column or attribute from the Input payload that contains the Message Id.

Endpoints

Name
Description

Input

This endpoint is used to receive data from the parent Agent.

Output

Events received from the parent Agent are made available to this endpoint, with two columns appended:

  • Email File Name - a hardcoded string value of message.eml

  • Email File Content - the email file as a base64 binary string

Error

Errors encountered during the execution of this Agent will be published on this endpoint.

Last updated