Gmail policy
A Gmail policy contains the connection details that are used by a Gmail Input or Gmail Request node when connecting to a Gmail application.
You can use a Gmail Request node in a message flow to connect IBM® App Connect Enterprise to Gmail and issue requests to send, delete, or retrieve emails, or update email labels. You can use a Gmail Input node in a message flow to monitor Gmail for changes and accept input. The Gmail policy controls, at run time, access to the Gmail application.
The Gmail policy is created when you configure a connection between a Gmail Input or Gmail Request
node and Gmail by using the Connector Discovery wizard.
During the process of discovery, account credentials are stored in the vault and connection details
are stored in a Gmail policy. The policy is created with a type of Gmail
, and the
name of the policy is returned to the Gmail node and specified in the Connection tab, in the format
{policyProjectName}:policyName
.
You can also create, update, or delete a Gmail policy by using the Manage Discovery Connector Policies and Credentials wizard, which you can access by right-clicking the policy project in the IBM App Connect Enterprise Toolkit and then clicking .
You must deploy this policy before message flows that use the policy are started. If you redeploy a Gmail policy, all message flows that are using the policy will be stopped and restarted.
For more information about using Gmailpolicies, see Using Gmail with IBM App Connect Enterprise.
Property | Property name in .policyxml file | Description of properties |
---|---|---|
Credential Name | credentialName | This property specifies the name of the credential that will be used for the
connection to Gmail. The specified credential can be defined during connector discovery and stored in the vault. Alternatively, you can specify an existing credential that was configured by using the mqsicredentials command or the server.conf.yaml file, or loaded through an external credential provider. |
Gmail Authentication method | authenticationMethod | This property specifies the type of authentication that is used for the
connection between IBM App Connect Enterprise and Gmail. This property is reserved for future use and must be
set to the value BASIC_OAUTH . |
Gmail Application Type | applicationType | This property is reserved for future use and must be set to the value
online . |
Gmail Application Version | applicationVersion | This property is reserved for future use and must be set to the value
v1 . |