Skip to main content

AliasSubMailrepIMAP

This page provides generated reference documentation for the AliasSubMailrepIMAP data model.

Overview

PropertySummary
hostThe host under which the database server, calendar backend, or other alias definitions are reachable.
portThe port under which the database server, calendar backend, or other alias definitions are reachable.
userThe user to be used to log on, for example, to log on to the Exchange or database server.
passwordThe password of the user to be used for login, e.g. to log on to the ADITO server, Exchange Server, etc.
clientId
clientSecret
tenantId
scope
tokenApiType
requestTokenEndpointUrl
accessTokenEndpointUrl
authorizeTokenEndpointUrl
folderName of the IMAP folder
connectionSecuritySpecifies whether to secure the connection using SSL, TLS, or not at all.
ignoreBodyStructureSizeThe IMAP BODYSTRUCTURE response includes the exact size of each body part. Normally, this size is used to determine how much data to fetch for each body part.
partialFetchControls whether the IMAP partial-fetch capability should be used.
throwSearchErrorIf set to true, the server will thrown an exception instead of doing a fallback if the requested search term configuration ( YoungerTerm, OlderTerm or…
authenticationType

host

Type: String

The host under which the database server, calendar backend, or other alias definitions are reachable.


port

Type: Integer
Constraints: Minimum: 0, Maximum: 65536

The port under which the database server, calendar backend, or other alias definitions are reachable.


user

Type: String
Requires: authenticationType property group

The user to be used to log on, for example, to log on to the Exchange or database server.


password

Type: String
Requires: authenticationType property group

The password of the user to be used for login, e.g. to log on to the ADITO server, Exchange Server, etc.


clientId

Type: String
Requires: authenticationType property group


clientSecret

Type: String
Requires: authenticationType property group


tenantId

Type: String
Requires: authenticationType property group


scope

Type: String
Requires: authenticationType property group


tokenApiType

Type: EImapTokenApiType
Requires: authenticationType property group


requestTokenEndpointUrl

Type: String
Requires: tokenApiType property group


accessTokenEndpointUrl

Type: String
Requires: tokenApiType property group


authorizeTokenEndpointUrl

Type: String
Requires: tokenApiType property group


folder

Type: String

Name of the IMAP folder


connectionSecurity

Type: EAliasTransportSecurity

Specifies whether to secure the connection using SSL, TLS, or not at all.


ignoreBodyStructureSize

Type: Boolean

The IMAP BODYSTRUCTURE response includes the exact size of each body part. Normally, this size is used to determine how much data to fetch for each body part.


partialFetch

Type: Boolean

Controls whether the IMAP partial-fetch capability should be used.


throwSearchError

Type: Boolean

If set to true, the server will thrown an exception instead of doing a fallback if the requested search term configuration ( YoungerTerm, OlderTerm or ModifiedSinceTerm ) is not supported


authenticationType

Type: EImapAliasAuthType