Email CSQ Data Structure

Attribute Name

Base Type

Restrictions

Description

emailAuthType

string

minOccurs = 0

maxOccurs = 1

nillable = false

Enumerations = PLAIN and OAUTH

The type of authentication used to access the configured email account.

PLAIN is used to access any one of the following configured email accounts:

MS Exchange
Office 365
Gmail

OAUTH is supported to access only the Gmail account.

Note	If you do not enter emailAuthType in the payload, PLAIN is considered as default.

emailOAuthDetails

string

minOccurs = 0

maxOccurs = 1

This contains Base64 encoded string of the downloaded JSON from the configured Gmail email server.

This is mandatory when emailAuthType is OAUTH, and it should not be present if emailAuthType is PLAIN.

accountUserId

string

minLength = 5

maxLength = 75

minOccurs = 0

maxOccurs = 1

nillable = false

Name contains alphanumeric characters, special characters, spaces, dots (.), underscores (_), and hyphens (-) without leading or trailing white spaces.

The account user ID cannot have consecutive dots.

The domain can have up to four characters.

Email account userid from which emails are retrieved for this CSQ.

One email address is associated with only one Email CSQ.

This field is mandatory for the Email CSQ.

accountPassword

string

minLength = 1

maxLength = 128

minOccurs = 0

maxOccurs = 1

nillable = false

Password for the account user ID.

This field is mandatory for Email CSQ when the emailOAuthType is PLAIN or OAUTH_MS.

channelProvider

nameUriPair

minOccurs = 0

maxOccurs = 1

nillable = false

Stores information about the source of the contacts.

In case of email, it is the mail server.

This field is mandatory for the Email CSQ.

pollingInterval

int

minOccurs = 0

maxOccurs = 1

nillable = false

minInclusive = 10

maxInclusive = 86400

default = 600

Frequency to fetch emails from the server in seconds.

This field is mandatory for the Email CSQ.

The pollingInterval is specified in seconds.

folderName

string

minLength = 1

maxLength = 255

minOccurs = 0

maxOccurs = 1

nillable = false

default = "Inbox"

The folder that holds the email messages in the email account.

This field is mandatory for the Email CSQ.

snapshotAge

int

minOccurs = 0

maxOccurs = 1

nillable = false

minInclusive = 10

maxInclusive = 43200

default = 120

Specify the time in minutes from when the emails are to be fetched.

This field is mandatory for the Email CSQ.

The snapshotAge is specified in minutes.

emailAuthType

string

PLAIN

OAUTH

OAUTH_MS minOccurs = 0

nillable = false

One of the 3 values.

PLAIN is applicable for Basic authentication.

OAUTH is applicable for Gmail OAuth 2.0 authentication.

OAUTH_MS is applicable for Microsoft Office 365 IMAP OAuth 2.0 authentication.

emailOAuthDetails

string

minOccurs="0" maxOccurs="1"

Upload the JSON file that you have received during the Gmail service account creation.

Note	This is applicable only when the emailAuthType value is OAUTH.

emailoAuthMSTenantID

string

minOccurs="0" maxOccurs="1"

Azure cloud Tenant ID.

Note	This is applicable only when the emailAuthType value is OAUTH_MS.

emailoAuthMSClientID

string

minOccurs="0" maxOccurs="1"

Azure OAuth Client application ID.

Note	This is applicable only when the emailAuthType value is OAUTH_MS

emailoAuthMSClientSecret

string

minOccurs="0" maxOccurs="1"

Azure OAuth Client application Client secret.

Note	This is applicable only when the emailAuthType value is OAUTH_MS.