| Home | OAuth | Microsoft OAuth |
This guide explains how to create Google OAuth credentials for use with vuMailKit.
Google OAuth is commonly needed for Gmail.com accounts and Google Workspace hosted mailboxes when modern authentication is required.
Make sure you have:
For vuMailKit Basic, you will need these Google values:
You will also choose the name you want vuMailKit to display on the Google OAuth success page after the user completes authorization successfully.
Copy the Google values carefully. You will later place them into the vuMailKit template in quoted form.
In your Clarion application, open the:
Then:
Enter each value in this format:
'client-string'
Example:
'123456789012-abcdefghijklmnopqrstuvwxyz.apps.googleusercontent.com'
'GOCSPX-abcdefghijklmnopqrstuvwxyz123456'
'My Application Name'
Do not remove the single quotes.
The OAuth Success Name value is used on the Google success page that the user sees after authorization completes successfully.
This lets you display your product name, company name, or application name on that page instead of a more generic label.
This setting is only for the success page display. It does not replace or change your Google Client ID or Google Secret.
Some Google-hosted mailboxes use a custom company domain instead of an address that obviously looks like Gmail.
For example, a mailbox such as user@yourcompany.com may still be hosted by Google Workspace even though the email address itself does not end in gmail.com.
In those cases, vuMailKit may not detect from the domain alone that the mailbox should use Google OAuth.
If autodetect does not identify the account as OAuth, but you know the mailbox is hosted by Google Workspace, use Manual Configuration in the wizard and select the Google OAuth sign-in method.
Typical Google Workspace settings are:
| Setting | Typical value |
|---|---|
| Outgoing server | smtp.gmail.com |
| Outgoing port | 587 |
| Outgoing security | STARTTLS |
| Incoming server | imap.gmail.com or pop.gmail.com |
| Incoming port | 993 for IMAP or 995 for POP3 |
| Incoming security | SSL/TLS |
| Sign-in method | Google Sign-In |
Use the mailbox owner’s actual email address as the account name unless the hosted environment requires something different.
If the site uses non-standard settings, confirm them with the mailbox administrator.
Go directly to Google Cloud Console:
https://console.cloud.google.com/
Sign in with the Google account that will own the OAuth client.
Then create or select the Google Cloud project you want to use for vuMailKit.
Google may require you to set up the OAuth consent and branding information before the client can be fully used.
In Google Cloud Console, look for:
Google Auth platform > Branding
If the Google Auth platform is not configured yet, complete the required setup there.
If you plan to publish a production application that uses Google OAuth for external users, Google may require more than just the OAuth client itself. Depending on the scopes used and how your application is published, you may also need items such as:
These website and policy requirements are set by Google and are the responsibility of the application publisher, not vuMailKit itself.
If you want to provide direct access to those pages from inside your application, vuMailKit already includes a helper function for opening a URL in the user’s default browser:
This can be called from a button, menu option, or similar UI element in your application.
To create the actual OAuth client, go to:
APIs & Services > Credentials
You can also go directly to the credentials page here:
https://console.cloud.google.com/apis/credentials
Click Create Credentials > OAuth client ID
Then choose the application type that matches the authentication flow your vuMailKit-based application will use.
Set the options required for the Google OAuth flow used by your application.
The exact labels in the Google portal may vary over time, but the main goal remains the same: create a valid OAuth client and obtain the correct Client ID and Client Secret values.
Once the OAuth client has been created, copy:
These are the two values you place into the vuMailKit template.
Common setup problems include:
After entering the Google Client ID, Google Secret, and OAuth Success Name into the vuMailKit template:
For related runtime functions, see:
| Home | OAuth | Microsoft OAuth |