| Home | All functions | Legacy functions | Categories |
This documentation has been written for modern development using the full vuMailKit library of functions and modern naming standards. These are the preferred function names for new development.
The Legacy names from the old vuMail functions remain supported and are listed on the Legacy functions page. If you look up a function with the old name, it will refer you to the preferred name page.
Within each category, function names are listed alphabetically so known functions are easier to find.
| Function | Description |
|---|---|
| AboutFunctionNames | Explains preferred function naming and how it maps to legacy vuMail names. |
| AboutGlobalMemory | Explains vuMailKit runtime global memory, legacy registry behavior, and managed profile behavior. |
| Function | Description |
|---|---|
| vuGlobalsGetCodePage | Gets the CodePage value used by vuMailKit. |
| vuGlobalsGetEmailFolder | Gets the folder where vuMailKit can save email files. |
| vuGlobalsLoad | Loads vuMailKit global settings into active runtime memory. |
| vuGlobalsSave | Saves active runtime settings using the current persistence model. |
| vuGlobalsSetCodePage | Sets the CodePage value used by vuMailKit. |
| vuGlobalsSetEmailFolder | Sets the folder where vuMailKit can save email files. |
| vuGlobalsSetNoPasswordInRegistry | Controls whether the SMTP password is saved in the registry. |
| Function | Description |
|---|---|
| vuCleanupLegacyRegistry | Deletes legacy registry settings after managed migration is verified. |
| vuClearDiagnosticsLog | Clears the diagnostics log file. |
| vuClearMailLog | Clears the legacy sent-mail CSV log file. |
| vuDiagnosticsClearLogs | Deletes the current diagnostics log file. |
| vuDiagnosticsDisable | Disables diagnostics logging. |
| vuDiagnosticsEnable | Enables diagnostics logging. |
| vuDiagnosticsGetFile | Gets the diagnostics log file path. |
| vuDiagnosticsSetFile | Sets the diagnostics log file path. |
| vuGetDiagnosticsLevel | Gets the diagnostics verbosity level. |
| vuHaveStoredProfile | Returns whether any managed vuMailKit profile has already been saved for the current Windows user. |
| vuLoadProfile | Loads the internal default managed profile into active runtime memory. |
| vuLoadProfileEx | Loads a named managed profile into active runtime memory. Pro and Back Office only. |
| vuLogGetFile | Gets the legacy sent-mail CSV log file path. |
| vuLogSetFile | Sets the legacy sent-mail CSV log file path. |
| vuResetStoredSettings | Clears stored vuMailKit settings, profiles, and OAuth state. |
| vuSaveProfile | Saves active runtime memory into the internal default managed profile. |
| vuSaveProfileEx | Saves active runtime memory into a named managed profile. Pro and Back Office only. |
| vuSetDiagnosticsLevel | Sets the diagnostics verbosity level. |
| Function | Description |
|---|---|
| vuCloseWhenComplete | Sets the legacy CloseWhenComplete runtime flag. |
| vuFailureNotice | Requests a failure notice (delivery failure notification) for the next sent email. |
| vuGetFromReplyTo | Gets the default From and Reply-To email addresses for outgoing mail. |
| vuGetMailLog | Gets the current legacy sent-mail CSV log file path. |
| vuGetMailProxy | Gets the proxy server name and port used by vuMailKit. |
| vuGetMailSecurity | Gets SMTP user, password, security type, and SSL flag. |
| vuGetMailServer | Gets the outbound SMTP server name and port. |
| vuGetSaveFolder | Gets the folder used for saving mail files. |
| vuHighPriority | Marks the next sent email as high priority. |
| vuMailAppendCSV | Appends one mail row to the currently selected legacy CSV file. |
| vuMailClient | Returns the default mail client name from the Windows registry. |
| vuMailCreateCSV | Creates or truncates a CSV file and selects it for vuMailAppendCSV(). |
| vuMailErrorDisplay | Automatically displays a verbose error message when a send fails. |
| vuMailExport | Exports the currently loaded legacy message to an .eml file. |
| vuMailImport | Imports an .eml message file into the legacy in-process session. |
| vuMailImportHeader | Imports only message headers from an .eml file into the legacy session. |
| vuMailLastError | Returns the last verbose error message text. |
| vuMailSaveName | Sets the filename used when saving the next sent email as an .eml file. |
| vuMailSelectCSV | Selects an existing CSV file for vuMailAppendCSV(). |
| vuMailStatus | Returns send queue and background send status. |
| vuMailSuccessDisplay | Displays a success message each time an email is sent successfully. |
| vuMailTo | Opens the default mail client with To/Cc/Bcc/Subject/Body fields. |
| vuMailToA | Opens the default mail client with To/Cc/Bcc/Subject/Body plus attachment hint. |
| vuRequestReceipt | Requests a return receipt for the next sent email. |
| vuResetSimpleHTML | Resets all Simple HTML runtime settings back to their defaults. |
| vuSendMail | Queues one outbound email for background SMTP delivery. |
| vuSendMailFromFile | Queues outbound emails from CSV rows. |
| vuSendMailWait | Queues one outbound email and waits for completion. |
| vuSetFromReplyTo | Sets default From and Reply-To email addresses for outgoing mail. |
| vuSetMailProxy | Sets the proxy server name and port used by vuMailKit. |
| vuSetMailSecurity | Sets SMTP user, password, security type, and SSL flag. |
| vuSetMailServer | Sets the outbound SMTP server name and port. |
| vuSetSimpleHTML | Turns Simple HTML mode on or off for later send calls. |
| vuSetSimpleHTMLFooterImage | Sets the optional footer image used by Simple HTML mode. |
| vuSetSimpleHTMLHeaderImage | Sets the optional header image used by Simple HTML mode. |
| vuSetSimpleHTMLNormalizeBody | Controls whether Simple HTML treats the body as ordinary text or as an HTML fragment. |
| vuValidateMailAddr | Validates a practical internet email address, rejects malformed values, and can flag suspicious typo-like domains. |
| vuViewMail | Opens a mail file using the default shell-associated application. |
| Function | Description |
|---|---|
| vuNetGetProxy | Gets the proxy server name and port used by vuMailKit. |
| vuNetSetProxy | Sets the proxy server name and port used by vuMailKit. |
| Function | Description |
|---|---|
| vuAutoDetectCancelDeepScan | Requests cancellation of an asynchronous deep autodetect job. |
| vuAutoDetectFillSettings | Runs the full deep-scan autodetect pipeline and fills provider settings. |
| vuAutoDetectFillSettingsDeep | Runs the explicit deep-scan autodetect pipeline when the user requests a broader search. |
| vuAutoDetectFillSettingsFast | Runs the fast first-pass autodetect pipeline for responsive setup screens. |
| vuAutoDetectGetDeepScanResult | Copies final results from a completed asynchronous deep autodetect job. |
| vuAutoDetectPollDeepScan | Polls the state, stage, and status text for an asynchronous deep autodetect job. |
| vuAutoDetectReleaseDeepScan | Releases the stored state for an asynchronous deep autodetect job. |
| vuAutoDetectSendTestMessage | Sends a temporary test message using the outgoing settings only. |
| vuAutoDetectSendTestMessageEx | Sends a temporary test message and includes outgoing plus incoming setup details in the message body. |
| vuAutoDetectStartDeepScan | Starts an asynchronous deep autodetect job and returns a scan handle. |
| vuAutoDetectTestSettings | Tests detected server settings without sending mail. |
For normal Microsoft or Google OAuth setup, use the vuMailKit Email Setup Wizard. These functions are advanced/manual helpers for custom setup screens and special flows.
| Function | Description |
|---|---|
| vuOAuthDetectProviderFromEmail | Detects OAuth provider/auth mode from an email address. |
| 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 OAuth support for a provider at runtime. |
| vuOAuthSetClientSecret | Stores a provider/account client secret for advanced manual flows. |
| vuOAuthSetLoopbackPort | Stores a loopback callback port for advanced manual flows. |
| vuOAuthBeginLogin | Starts an OAuth login flow and returns callback/device text. |
| vuOAuthLaunchUserVerification | Launches user verification UI/browser for an OAuth flow. |
| vuOAuthLaunchAuthorizeUrl | Launches the authorization URL captured from BeginLogin. |
| vuOAuthGetDeviceInfo | Returns device verification URL/code from the last BeginLogin. |
| vuOAuthCompleteLogin | Completes 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. |
| Function | Description |
|---|---|
| vuMailKitGetLicenseInfo | Returns a diagnostic text summary of the current license state, tier, and demo flag. |
| vuMailKitInitialize | Initializes vuMailKit licensing for the current process. Call once at EXE startup before send, autodetect, or profile operations. |
| Function | Description |
|---|---|
| vuPOP3AttachmentName | Returns the attachment filename by index. |
| vuPOP3Connect | Connects and authenticates to the POP3 server. |
| vuPOP3Count | Returns the number of available POP3 messages. |
| vuPOP3Delete | Marks a POP3 message number for deletion. |
| vuPOP3Disconnect | Closes the active POP3 connection. |
| vuPOP3EmbeddedCID | Returns the CID for an embedded content item by index. |
| vuPOP3EmbeddedName | Returns the name for an embedded content item by index. |
| vuPOP3GetAuthMode | Gets the configured POP3 authentication mode value. |
| vuPOP3GetDate | Returns the Date header value from the loaded POP3 message. |
| vuPOP3GetFolder | Gets the POP3 folder used for receiving email. |
| vuPOP3GetFrom | Returns the From header value from the loaded POP3 message. |
| vuPOP3GetHTMLText | Returns the HTML body from the loaded POP3 message. |
| vuPOP3GetMessageId | Returns the Message-ID header value from the loaded POP3 message. |
| vuPOP3GetPassword | Gets the POP3 password used for receiving email. |
| vuPOP3GetPlainText | Returns the plain-text body from the loaded POP3 message. |
| vuPOP3GetReturnPath | Returns the Return-Path header value from the loaded POP3 message. |
| vuPOP3GetServer | Gets the POP3 server used for receiving email. |
| vuPOP3GetSubject | Returns the Subject header value from the loaded POP3 message. |
| vuPOP3GetUser | Gets the POP3 user used for receiving email. |
| vuPOP3HaveAttachments | Reports whether the loaded POP3 message has attachments. |
| vuPOP3HaveEmbedded | Reports whether the loaded POP3 message has embedded parts. |
| vuPOP3HaveHTMLText | Reports whether the loaded POP3 message has an HTML body. |
| vuPOP3HavePlainText | Reports whether the loaded POP3 message has a plain-text body. |
| vuPOP3LoadEmail | Loads a full POP3 message into the current session. |
| vuPOP3LoadHeader | Loads headers for a POP3 message into the current session. |
| vuPOP3SaveAttachment | Saves one named attachment from the loaded POP3 message. |
| vuPOP3SaveAttachments | Saves all attachments from the loaded POP3 message. |
| vuPOP3SaveEmbedded | Saves one named embedded content item from the loaded POP3 message. |
| vuPOP3SaveEmbeddedOne | Saves one embedded content item by index from the loaded POP3 message. |
| vuPOP3SetAuthMode | Sets the POP3 authentication mode value used at connect time. |
| vuPOP3SetFolder | Sets the POP3 folder used for receiving email. |
| vuPOP3SetPassword | Sets the POP3 password used for receiving email. |
| vuPOP3SetServer | Sets the POP3 server used for receiving email. |
| vuPOP3SetUser | Sets the POP3 user used for receiving email. |
| vuPOP3Size | Returns the size in bytes for a POP3 message number. |
| Function | Description |
|---|---|
| vuSetMailServerOAuth | Sets OAuth-specific SMTP server name and port. |
| vuSmtpGetAuthMode | Gets current SMTP auth mode (0 password, 1 OAuth). |
| vuSmtpGetFromReplyTo | Gets default From and Reply-To email addresses for outgoing mail. |
| vuSmtpGetSecurity | Gets SMTP user, password, security type, and SSL flag. |
| vuSmtpGetServer | Gets the outbound SMTP server name and port. |
| vuSmtpSetAuthMode | Sets SMTP auth mode (0 password, non-zero OAuth). |
| vuSmtpSetFromReplyTo | Sets default From and Reply-To email addresses for outgoing mail. |
| vuSmtpSetSecurity | Sets SMTP user, password, security type, and SSL flag. |
| vuSmtpSetServer | Sets the outbound SMTP server name and port. |
| Function | Description |
|---|---|
| vuPasswordCleanup | Removes managed password-control behavior and destroys the generated eye button. |
| vuPasswordInit | Initializes a Clarion password entry control for managed cue text, eye-button creation, and show/hide behavior. |
| vuPasswordToggle | Toggles a managed password control between masked and visible mode. |
| Function | Description |
|---|---|
| TokenMergeFileIntoFile | Replaces token text in a source template file with the contents of another file and writes the merged result to a target file. |
| TokenMergeInFile | Replaces token text in a source file and writes the merged result to a target file. |
| TokenMergeInString | Replaces token text in a source string and writes the merged result to a caller-owned output buffer. |
| Function | Description |
|---|---|
| vuANSItoUTF8 | Converts ANSI text to a byte-preserving UTF-8 encoded legacy string. |
| vuExtractMailAddr | Extracts the first email address found in input text. |
| vuGetUCodeFile | Returns the default UCode.txt compatibility file path. |
| vuReadUCodeFile | Reads UTF-8 text from a specified UCode file path. |
| vuShellOpenUrl | Opens a URL with shell/browser and returns diagnostics. |
| vuUTF8toANSI | Converts byte-preserving UTF-8 input to decoded text. |
| Home | All functions | Legacy functions | Categories |