docs

Home Browse by Category OAuth All functions

OAuth Functions

vuMailKit includes OAuth helper functions for modern provider sign-in flows.

For most applications, these are advanced/manual helpers. The normal path is to configure OAuth provider values in the vuMailKit global template, import the vuMailKit Email Setup Wizard with Clarion CTRL+U, compile the EXE, and let the wizard handle provider detection, OAuth authorization, test send, and profile save.

After the wizard saves the working profile, normal send functions can use the saved profile without hand-coded OAuth flow code.

For provider credential setup, start with:

Common OAuth functions

Function Purpose
vuOAuthDetectProviderFromEmail Detects whether an email address maps to a known OAuth provider and reports the recommended auth mode/reason text.
vuOAuthSetProvider Sets the default OAuth provider name used by helper flows.
vuOAuthGetProvider Gets the default OAuth provider name from global settings.
vuOAuthSetProviderEnabled Enables or disables provider support at runtime.
vuOAuthSetClientSecret Stores a provider/account client secret for advanced manual OAuth flows.
vuOAuthSetLoopbackPort Stores a loopback callback port for advanced manual OAuth flows.
vuOAuthBeginLogin Starts an OAuth login flow.
vuOAuthLaunchUserVerification Opens the verification URL from a device-code style login and can copy the user code.
vuOAuthLaunchAuthorizeUrl Opens the authorization URL captured from a BeginLogin flow.
vuOAuthGetDeviceInfo Returns verification URL and user code captured from the last matching BeginLogin call.
vuOAuthCompleteLogin Completes or polls OAuth login using callback or verification data.
vuOAuthStatus Returns OAuth status text for a provider/account pair.
vuOAuthRefresh Refreshes OAuth tokens for a provider/account pair.
vuOAuthClear Clears stored OAuth state/tokens for a provider/account pair.

Provider-detection return codes

The vuOAuthDetectProviderFromEmail page contains the authoritative return-code details for provider detection. Review that page before relying on numeric provider codes in application logic.

Home Browse by Category OAuth All functions