Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Input System "ImapMail"

The properties that apply to this input system are generally those listed in General Properties.

Only those properties that are specifically required for Gmail are added below. Gmail also requires token-based OAuth authentication when using the IMAP protocol. In principle, only Google Workspace accounts that belong to a shared domain are supported. These user accounts are accessed via a service account. To enable access to user data, delegate cross-domain authorizations to this service account.

First, create a project for xSuite Interface, in the workspace administration to which the service account is assigned. Activate the "Gmail API" for the project.

Property

Description

InputSystem.GmailOAuth.ServiceAccountEmail*

InputSystem.GmailOAuth.ServiceAccountKeyFile*

InputSystem.GmailOAuth.ServiceAccountKeyFilePassword*

The content of these properties corresponds to the InputSystem.ServiceAccount*** properties of the general mail server connection.

InputSystem.GMailOAuth.Scope

Optional specification of the Google API areas (as URLs) to which xSuite Interface has access

This property corresponds to the property InputSystem.Scope[]. However, only the specification of URLs is supported here.

Default value: https://mail.google.com/