docs

All functions Legacy functions About function names

vuMail Legacy Functions

Legacy vuMail function names are maintained for backward compatibility. Each page links back to the preferred vuMailKit function.

Important legacy note: several original vuMail text helpers are documented as Clarion LONG returns, but in the original PowerBasic DLL that numeric value was actually the address of an internal C string buffer. That is why the legacy Clarion examples use these functions directly in assignments and MESSAGE() expressions. This behavior is preserved only for compatibility and is not the model for new APIs.

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.
vuANSItoUTF8 Converts ANSI text to a byte-preserving UTF-8 encoded legacy string.
vuCloseWhenComplete Sets the legacy CloseWhenComplete runtime flag.
vuExtractMailAddr Extracts the first email address found in input text.
vuFailureNotice Requests a failure notice (delivery failure notification) for the next sent email.
vuGetCodePage Legacy alias for vuGlobalsGetCodePage(). (Preferred: vuGlobalsGetCodePage)
vuGetFromReplyTo Legacy alias for vuSmtpGetFromReplyTo(). (Preferred: vuSmtpGetFromReplyTo)
vuGetMailLog Gets the mail log file path. (Preferred: vuLogGetFile)
vuGetMailProxy Legacy alias for vuNetGetProxy(). (Preferred: vuNetGetProxy)
vuGetMailSecurity Legacy alias for vuSmtpGetSecurity(). (Preferred: vuSmtpGetSecurity)
vuGetMailServer Gets the outbound SMTP server name and port. (Preferred: vuSmtpGetServer)
vuGetSaveFolder Legacy alias for vuGlobalsGetEmailFolder(). (Preferred: vuGlobalsGetEmailFolder)
vuGetUCodeFile Returns the default UCode.txt compatibility file path.
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.
vuMailGetGlobals Loads vuMailKit global settings into active runtime memory. (Preferred: vuGlobalsLoad)
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.
vuMailSaveGlobals Saves active runtime settings using the current persistence model. (Preferred: vuGlobalsSave)
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.
vuNoPasswordInRegistry Controls whether the SMTP password is saved in the registry. (Preferred: vuGlobalsSetNoPasswordInRegistry)
vuPOP3GetFolder Gets the POP3 folder used for receiving email.
vuPOP3GetPassword Gets the POP3 password used for receiving email.
vuPOP3GetServer Gets the POP3 server used for receiving email.
vuPOP3GetUser Gets the POP3 user used for receiving email.
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.
vuReadUCodeFile Reads UTF-8 text from a specified UCode file path.
vuRequestReceipt Requests a return receipt for the next sent email.
vuSetCodePage Legacy alias for vuGlobalsSetCodePage(). (Preferred: vuGlobalsSetCodePage)
vuSetFromReplyTo Legacy alias for vuSmtpSetFromReplyTo(). (Preferred: vuSmtpSetFromReplyTo)
vuSetMailLog Sets the mail log file path. (Preferred: vuLogSetFile)
vuSetMailProxy Legacy alias for vuNetSetProxy(). (Preferred: vuNetSetProxy)
vuSetMailSecurity Legacy alias for vuSmtpSetSecurity(). (Preferred: vuSmtpSetSecurity)
vuSetMailServer Sets the outbound SMTP server name and port. (Preferred: vuSmtpSetServer)
vuSetSaveFolder Legacy alias for vuGlobalsSetEmailFolder(). (Preferred: vuGlobalsSetEmailFolder)
vuUTF8toANSI Converts byte-preserving UTF-8 input to decoded text.
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.
All functions Legacy functions About function names