AliasSubMailserverIMAP
This page provides generated reference documentation for the AliasSubMailserverIMAP data model.
Overview
| Property | Summary |
|---|---|
| accessTokenEndpointUrl | — |
| authenticationTimeout | Timeout for the OAuth2 authentication request in milliseconds. The default value is 0, which means an infinite timeout (no timeout). |
| authenticationType | — |
| authorizeTokenEndpointUrl | — |
| clientId | — |
| clientSecret | — |
| connectionSecurity | Specifies whether to secure the connection using SSL, TLS, or not at all. |
| host | The host under which the database server, calendar backend, or other alias definitions are reachable. |
| ignoreBodyStructureSize | 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. |
| inbox | Specifies the name of the Inbox/Inbox folder, such as “inbox”. |
| isPublicMailbox | Hint for public mailboxes. This provides better integration with Office 365. Please enable if necessary |
| outbox | Specifies the name of the outbox/source folder, such as "outbox”. |
| partialFetch | Controls whether the IMAP partial-fetch capability should be used. |
| port | The port under which the database server, calendar backend, or other alias definitions are reachable. |
| requestTokenEndpointUrl | — |
| scope | — |
| smtpAuth | Specifies whether NONE, BASIC or XOAUTH2 authentication is used when logging on to the SMTP server. XOAUTH2_DELEGATED uses the username and… |
| smtpHost | The host name/IP of the SMTP server. This setting is required if you want to automate sending emails from ADITO. |
| smtpOAuthAlias | — |
| smtpOAuthScope | — |
| smtpPort | 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 | Specifies whether a secure connection is desired when connecting to SMTP. The connection can be encrypted over SSL, TLS, or not at all. |
| tenantId | — |
| throwSearchError | If set to true, the server will thrown an exception instead of doing a fallback if the requested search term configuration ( YoungerTerm, OlderTerm or… |
| tokenApiType | — |
accessTokenEndpointUrl
Type: String
Requires: tokenApiType 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).
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.
host
Type: String
The host under which the database server, calendar backend, or other alias definitions are reachable.
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.
inbox
Type: String
Specifies the name of the Inbox/Inbox folder, such as “inbox”.
isPublicMailbox
Type: Boolean
Default: false
Hint for public mailboxes. This provides better integration with Office 365. Please enable if necessary
outbox
Type: String
Specifies the name of the outbox/source folder, such as "outbox”.
partialFetch
Type: Boolean
Default: false
Controls whether the IMAP partial-fetch capability should be used.
port
Type: Integer
Default: 143
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
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.
smtpHost
Type: String
The host name/IP of the SMTP server. This setting is required if you want to automate sending emails from ADITO.
smtpOAuthAlias
Type: String
smtpOAuthScope
Type: String
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.
tenantId
Type: String
Requires: authenticationType property group
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
tokenApiType
Type: EImapTokenApiType
Requires: authenticationType property group