docs

All functions Legacy functions About function names

vuMail Legacy Functions

Legacy vuMail function names are maintained for backward compatibility. Where a preferred modern function name exists, the legacy page points to it.

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 Legacy ANSI-to-UTF8 conversion helper retained for compatibility.
vuCloseWhenComplete Sets the legacy CloseWhenComplete runtime flag.
vuExtractMailAddr Legacy email-address parsing helper retained for compatibility.
vuFailureNotice Requests a delivery failure notice for the next sent email.
vuGetCodePage Legacy alias for vuGlobalsGetCodePage.
vuGetFromReplyTo Legacy alias for vuSmtpGetFromReplyTo.
vuGetMailLog Legacy alias for vuLogGetFile.
vuGetMailProxy Legacy alias for vuNetGetProxy.
vuGetMailSecurity Legacy alias for vuSmtpGetSecurity.
vuGetMailServer Legacy alias for vuSmtpGetServer.
vuGetSaveFolder Legacy alias for vuGlobalsGetEmailFolder.
vuHighPriority Marks the next sent email as high priority.
vuMailAppendCSV Appends one mail row to the currently selected legacy CSV file.
vuMailClient Legacy default-mail-client helper retained for compatibility.
vuMailCreateCSV Creates or truncates a CSV file and selects it for vuMailAppendCSV().
vuMailErrorDisplay Enables or disables automatic verbose error message display.
vuMailExport Exports the currently loaded legacy message to an .eml file.
vuMailGetGlobals Legacy alias for 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 Gets the current last-error text using the legacy vuMail compatibility pattern using the legacy pointer-to-CString compatibility pattern.
vuMailSaveGlobals Legacy alias for vuGlobalsSave.
vuMailSaveName Sets the .eml file name used when saving the next sent email.
vuMailSelectCSV Selects an existing CSV file for subsequent vuMailAppendCSV() calls.
vuMailStatus Returns send queue and background send status.
vuMailSuccessDisplay Enables or disables automatic success message display.
vuMailTo Opens the default mail client using a mailto: URI built from message fields.
vuMailToA Opens the default mail client using a mailto: URI and includes an attachment hint parameter.
vuNoPasswordInRegistry Legacy alias for vuGlobalsSetNoPasswordInRegistry.
vuPOP3AttachmentName Legacy POP3 text getter retained for compatibility.
vuPOP3Connect Opens a POP3 connection using host, user, and password values.
vuPOP3Count Returns the number of messages currently available in the POP3 mailbox.
vuPOP3Delete Marks a POP3 message for deletion by message number.
vuPOP3Disconnect Closes the active POP3 connection.
vuPOP3GetDate Legacy POP3 text getter retained for compatibility.
vuPOP3GetFolder Legacy POP3 text getter retained for compatibility.
vuPOP3GetFrom Legacy POP3 text getter retained for compatibility.
vuPOP3GetHTMLText Legacy POP3 text getter retained for compatibility.
vuPOP3GetMessageId Legacy POP3 text getter retained for compatibility.
vuPOP3GetPassword Legacy POP3 text getter retained for compatibility.
vuPOP3GetPlainText Legacy POP3 text getter retained for compatibility.
vuPOP3GetReturnPath Legacy POP3 text getter retained for compatibility.
vuPOP3GetServer Legacy POP3 text getter retained for compatibility.
vuPOP3GetSubject Legacy POP3 text getter retained for compatibility.
vuPOP3GetUser Legacy POP3 text getter retained for compatibility.
vuPOP3HaveAttachments Reports whether the currently loaded POP3 message contains attachments.
vuPOP3HaveHTMLText Reports whether the currently loaded POP3 message contains an HTML body.
vuPOP3HavePlainText Reports whether the currently loaded POP3 message contains a plain-text body.
vuPOP3LoadEmail Loads a full POP3 message by message number into the current in-process session.
vuPOP3LoadHeader Loads POP3 headers for a message by message number into the current in-process session.
vuPOP3SaveAttachment Saves a named attachment from the loaded POP3 message into the configured POP3 folder.
vuPOP3SaveAttachments Saves all attachments from the loaded POP3 message into the configured POP3 folder.
vuPOP3SetFolder Sets the POP3 save folder in memory.
vuPOP3SetPassword Sets the POP3 password in memory.
vuPOP3SetServer Sets the POP3 server name in memory.
vuPOP3SetUser Sets the POP3 user name in memory.
vuPOP3Size Returns the size, in bytes, of a POP3 message by message number.
vuReadUCodeFile Legacy UCode file-read helper retained for compatibility.
vuRequestReceipt Requests a return receipt for the next sent email.
vuSendMail Queues one email for background SMTP delivery.
vuSendMailFromFile Queues outbound emails from a CSV file.
vuSendMailWait Queues one email and waits for SMTP processing to finish.
vuSetCodePage Legacy alias for vuGlobalsSetCodePage.
vuSetFromReplyTo Legacy alias for vuSmtpSetFromReplyTo.
vuSetImageSize Legacy image-size hint setter retained for compatibility.
vuSetMailLog Legacy alias for vuLogSetFile.
vuSetMailProxy Legacy alias for vuNetSetProxy.
vuSetMailSecurity Legacy alias for vuSmtpSetSecurity.
vuSetMailServer Legacy alias for vuSmtpSetServer.
vuSetSaveFolder Legacy alias for vuGlobalsSetEmailFolder.
vuUTF8toANSI Legacy UTF8-to-ANSI conversion helper retained for compatibility.
vuValidateMailAddr Validates a practical real-world internet email address, rejects obvious malformed values, and flags certain typo-like domains as suspicious.
vuViewMail Opens an existing mail file using the Windows shell-associated application.
All functions Legacy functions About function names