Skip to main content

AliasSubMailserverIMAP

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

Overview

PropertySummary
clientId
clientSecret
tenantId
scope
authenticationTimeoutTimeout for the OAuth2 authentication request in milliseconds. The default value is 0, which means an infinite timeout (no timeout).
tokenApiType
requestTokenEndpointUrl
accessTokenEndpointUrl
authorizeTokenEndpointUrl
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.
connectionSecuritySpecifies whether to secure the connection using SSL, TLS, or not at all.
authenticationType
isPublicMailboxHint for public mailboxes. This provides better integration with Office 365. Please enable if necessary
inboxSpecifies the name of the Inbox/Inbox folder, such as “inbox”.
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…
smtpHostThe host name/IP of the SMTP server. This setting is required if you want to automate sending emails from ADITO.
smtpPortThe port of the SMTP server. This setting is required if you want to automate sending emails from ADITO. By default, the port is set to 25.
smtpSecuritySpecifies whether a secure connection is desired when connecting to SMTP. The connection can be encrypted over SSL, TLS, or not at all.
smtpAuthSpecifies whether NONE, BASIC or XOAUTH2 authentication is used when logging on to the SMTP server. XOAUTH2_DELEGATED uses the username and…
smtpOAuthAlias
smtpOAuthScope
outboxSpecifies the name of the outbox/source folder, such as "outbox”.

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


authenticationTimeout

Type: Integer
Requires: authenticationType property group

Timeout for the OAuth2 authentication request in milliseconds. The default value is 0, which means an infinite timeout (no timeout).


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


host

Type: String

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


port

Type: Integer
Default: 143

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


connectionSecurity

Type: EAliasTransportSecurity

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


authenticationType

Type: EImapAliasAuthType


isPublicMailbox

Type: Boolean
Default: false

Hint for public mailboxes. This provides better integration with Office 365. Please enable if necessary


inbox

Type: String

Specifies the name of the Inbox/Inbox folder, such as “inbox”.


ignoreBodyStructureSize

Type: Boolean
Default: false

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
Default: false

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


throwSearchError

Type: Boolean
Default: true

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


smtpHost

Type: String

The host name/IP of the SMTP server. This setting is required if you want to automate sending emails from ADITO.


smtpPort

Type: Integer
Default: 587

The port of the SMTP server. This setting is required if you want to automate sending emails from ADITO. By default, the port is set to 25.


smtpSecurity

Type: EAliasTransportSecurity

Specifies whether a secure connection is desired when connecting to SMTP. The connection can be encrypted over SSL, TLS, or not at all.


smtpAuth

Type: ESmtpAuthType

Specifies whether NONE, BASIC or XOAUTH2 authentication is used when logging on to the SMTP server. XOAUTH2_DELEGATED uses the username and password to obtain a token for the specified user. XOAUTH2_APPLICATION needs application permissions for all users, but does not need a username or a password.


smtpOAuthAlias

Type: String


smtpOAuthScope

Type: String


outbox

Type: String

Specifies the name of the outbox/source folder, such as "outbox”.