Skip to main content
Version: 2025.1

AliasSubMailrepIMAP

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

Overview​

PropertySummary
accessTokenEndpointUrl—
authenticationType—
authorizeTokenEndpointUrl—
clientId—
clientSecret—
connectionSecuritySpecifies whether to secure the connection using SSL, TLS, or not at all.
folderName of the IMAP folder
hostThe host under which the database server, calendar backend, or other alias definitions are reachable.
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.
passwordThe password of the user to be used for login, e.g. to log on to the ADITO server, Exchange Server, etc.
portThe port under which the database server, calendar backend, or other alias definitions are reachable.
requestTokenEndpointUrl—
scope—
tenantId—
throwSearchErrorIf set to true, the server will thrown an exception instead of doing a fallback if the requested search term configuration ( YoungerTerm, OlderTerm or…
tokenApiType—
userThe user to be used to log on, for example, to log on to the Exchange or database server.

accessTokenEndpointUrl​

Type: String
Requires: tokenApiType property group


authenticationType​

Type: EImapAliasAuthType


authorizeTokenEndpointUrl​

Type: String
Requires: tokenApiType property group


clientId​

Type: String
Requires: authenticationType property group


clientSecret​

Type: String
Requires: authenticationType property group


connectionSecurity​

Type: EAliasTransportSecurity

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


folder​

Type: String

Name of the IMAP folder


host​

Type: String

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


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.


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.


port​

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

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


requestTokenEndpointUrl​

Type: String
Requires: tokenApiType property group


scope​

Type: String
Requires: authenticationType property group


tenantId​

Type: String
Requires: authenticationType property group


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


tokenApiType​

Type: EImapTokenApiType
Requires: authenticationType property group


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.