docs

Home Browse by Category OAuth All functions

Preferred Functions

For new work, use the preferred vuMailKit names and the profile-based workflow where possible.

Legacy vuMail function names remain supported so old applications can continue to build, but new code should normally use the clearer vuMailKit names shown in the main function reference.

Normal setup and send workflow

Task Preferred page
Understand the normal wizard-plus-send application flow Recommended send flow with a stored profile
Initialize vuMailKit licensing at startup vuMailKitInitialize
Run setup/autodetect vuAutoDetectFillSettings
Send a setup test message vuAutoDetectSendTestMessage
Save the working profile vuSaveProfile
Load the saved profile vuLoadProfile
Send one message vuSendMail
Send one message and wait for completion vuSendMailWait

Preferred runtime setting names

Area Preferred pages Legacy compatibility notes
SMTP server vuSmtpSetServer, vuSmtpGetServer Legacy names include vuSetMailServer / vuGetMailServer.
SMTP security vuSmtpSetSecurity, vuSmtpGetSecurity Legacy names include vuSetMailSecurity / vuGetMailSecurity.
From / Reply-To vuSmtpSetFromReplyTo, vuSmtpGetFromReplyTo Legacy names include vuSetFromReplyTo / vuGetFromReplyTo.
SMTP auth mode vuSmtpSetAuthMode, vuSmtpGetAuthMode Used when switching between password and OAuth modes.
Save folder vuGlobalsSetEmailFolder, vuGlobalsGetEmailFolder Legacy names include vuSetSaveFolder / vuGetSaveFolder.
Legacy sent-mail CSV log vuLogSetFile, vuLogGetFile, vuClearMailLog Legacy names include vuSetMailLog / vuGetMailLog.
Diagnostics vuDiagnosticsSetFile, vuSetDiagnosticsLevel, vuDiagnosticsEnable, vuClearDiagnosticsLog Diagnostics are separate from the legacy sent-mail CSV log.

OAuth helpers

For normal OAuth setup, the preferred workflow is the vuMailKit Email Setup Wizard. Configure provider values in the global template, import the wizard with CTRL+U, compile, run the wizard, and save the profile. The lower-level OAuth functions below are mainly for custom setup screens and special flows.

Task Preferred page
Use the normal zero-OAuth-code setup path vuMailKit Email Setup Wizard
Detect provider from email address vuOAuthDetectProviderFromEmail
Start OAuth login manually vuOAuthBeginLogin
Launch verification manually vuOAuthLaunchUserVerification
Complete login manually vuOAuthCompleteLogin
Refresh stored tokens vuOAuthRefresh
Clear stored OAuth state vuOAuthClear

Template, mail merge, and Simple HTML helpers

Task Preferred page
Merge tokens in a string TokenMergeInString
Merge tokens from one file into another TokenMergeInFile
Insert generated file content into a template file TokenMergeFileIntoFile
Turn Simple HTML mode on or off vuSetSimpleHTML
Set Simple HTML header image vuSetSimpleHTMLHeaderImage
Set Simple HTML footer image vuSetSimpleHTMLFooterImage
Reset Simple HTML settings vuResetSimpleHTML

Migrating old vuMail code

Old function names remain listed here:

The legacy pages are intentional migration helpers. New vuMailKit-only features, such as Simple HTML and TokenMerge helpers, do not have old vuMail legacy pages.

Home Browse by Category OAuth All functions