General Properties
Property | Description |
|---|---|
.ProxyServer | Proxy server for connection to the mail server (optional) Syntax: see Proxy Server Connection |
Property | Description |
|---|---|
.Url(*) | Address of the Exchange Server in the form of a URL This property only applies to the EWS interface. A correct URL typically ends with Default value: |
.UserMailForAutoUrl | Email address of the user for automatic determination of the This property only applies to the EWS interface. |
.Version | Identifier of the API version of the Exchange server This property only applies to the EWS interface. Default value: |
.OAuthClientAppId(*) .OAuthTenantId(*) .OAuthClientSecret(§) | Application ID and tenant ID for token-based OAuth authentication against an Azure Active Directory This property only applies to the EWS and Graph interfaces. By default, "delegated authentication" is performed for the user defined (see the |
Access to Gmail requires token-based OAuth authentication. The Gmail interface does not support private accounts, only Google Workspace accounts that belong to a domain.
These user accounts are accessed via a service account. In order to access user data, domain-wide authorizations must be delegated to this service account. For xSuite Interface, a project must first be created in the workspace administration to which the service account is assigned. The "Gmail API" must be activated for the project. To access the users' mailboxes, only the users' email addresses (.User) must be specified, but not their passwords (.Password).
Property | Description |
|---|---|
InputSystem.ServiceAccountEmail* | Email address of the service account |
InputSystem.ServiceAccountKeyFile* InputSystem.ServiceAccountKeyFilePassword* | A key in P12 format must be generated for the service account in the workspace administration, which is downloaded as a file. This key file is required at runtime to retrieve an authentication token. The path of the file must be specified under The file is assigned the default password |
InputSystem.Scope[] | Specification of the Google API areas to which xSuite Interface has access (optional) Default value: The full list of value specifications is stored in the configurator application. Alternatively, the URLs behind these values (e.g., |
Property | Description |
|---|---|
.Host | Name or IP address of the mail server |
.Port | Numerical specification of the IP port to be used Default values without/with TLS usage:
|
.UseTls | Boolean value determining whether the connection to the mail server is secured via SSL/TLS Default value: |
.StartTls | Boolean value determining whether the communication with the mail server is initiated according to the STARTTLS procedure Default value: |
.CloseConnection | Boolean value determining whether the connection is explicitly closed again after each command to the mail server This property only applies to the SMTP protocol. Default value: |
.ReconnectInterval | Numeric value for a time interval in which the connection to the mail server is automatically disconnected and re-established (in seconds) This property only applies to the IMAP protocol. Default value: |
.ForceEndSession | Boolean value determining whether the connection to the mail server is explicitly terminated after each request and re-established with the next one This property only applies to the POP3 protocol. Default value: |
The mail API used for the POP3, IMAP and SMTP protocols provides an extended logging option for analyzing communication problems with the mail server. If the extended logging option is enabled, the original data streams of these protocols will also be logged. No separate configuration property is available for this. It is implicitly linked to setting the option Logging.Level: "Trace" option.