vuMailKit

Basic edition documentation

Current Version: vuMailKit 1.1.0 build 157

Release Date: 2026-07-01

Last Updated: 2026-07-01

This documentation covers the current vuMailKit 1.1.0 build 157 Basic edition function set and the supporting setup, deployment, and usage notes needed by Clarion developers.

Use the links below to browse the documentation.

vuMailKit is your fastest path to sending an email

vuMailKit is designed so you do not have to learn the whole function library before you can send mail.

For a normal Clarion application, the short path is:

Add the vuMailKit global template to the EXE application.
Enter the developer license string in the template, inside single quotes.
Use the Clarion Utility Template command, CTRL+U, to import the vuMailKit Email Setup Wizard.
Compile the application.
Run the compiled EXE and use the vuMailKit Email Setup Wizard to test the account.
Save the working profile.
Call a send function such as vuSendMail or vuSendMailWait. For normal Microsoft or Google OAuth accounts, the wizard handles authorization and profile saving, so your application does not need hand-coded OAuth flow code.

In a Clarion multi-DLL application, add the vuMailKit template to the EXE app, not to the supporting DLL apps. The EXE startup code initializes vuMailKit licensing for the process, and the runtime DLL can then be used from anywhere in the running program.

Hand-coded integrations must call vuMailKitInitialize once at EXE startup before calling send, setup, autodetect, or profile functions. If initialization is skipped, those calls return -9001 and vuMailLastError reports a vuMailKit licensing/setup problem.

Easier HTML email

If you want a cleaner-looking message, start with Simple HTML mode. You can turn it on, keep body normalization on, pass ordinary body text from a TEXT control or memo, and let vuMailKit create the HTML wrapper and plain-text alternative for you.

For body-positioned images in ordinary text, use Send an embedded image. The easiest pattern is Simple HTML plus the embed-attachments marker: put the marker where the images should appear in the body text, and pass local image files or remote http/https image URLs in the Attach parameter.

For designed HTML, use TokenMerge with external files so your application can personalize templates, insert generated invoice or statement text, and send the final result without hand-building HTML strings in Clarion source.

Start here

Page	Purpose
Getting Started	Task-based guides for the quickest path to success.
What most developers actually use	Explains the small set of calls most developers need day to day.
First-time setup	Add the template, import the vuMailKit Email Setup Wizard with CTRL+U, compile the EXE, test settings, and save a reusable profile.
vuMailKit Email Setup Wizard	The vuMailKit Email Setup Wizard validates the address, detects server/OAuth settings, sends a test email, and saves the profile.
Send your first email	Send mail after vuMailKit has been initialized and a working profile has been saved.
Recommended send flow with a stored profile	A copyable Clarion button-handler pattern for checking setup, offering the wizard, validating the recipient, sending, and showing useful diagnostics.

OAuth setup

If you plan to use Microsoft 365, Outlook.com, Google, or Gmail accounts with OAuth sign-in, the normal path is still the vuMailKit Email Setup Wizard. Configure the provider values in the global template, import the wizard with CTRL+U, and let the wizard handle provider detection, authorization, testing, and profile save. Start here:

Function reference browsing

You can browse the function reference in several ways:

Common task guides

Recommended send flow with a stored profile
Send an HTML email
Send a Simple HTML email with a company logo
Send an email from an external file
Use TokenMerge with email templates
Send a branded HTML email from a template
Send a form-letter invoice email with an optional personal message
Send attachments
Send an embedded image — includes the easy Simple HTML plus embed-attachments marker path
Send a batch of emails from CSV

For the most up-to-date documentation:

Online docs: https://clarionproseries.github.io/docs/vuMailKit/
Source on GitHub: https://github.com/ClarionProSeries/docs/tree/main/vuMailKit

If the link above does not open in your help viewer, copy and paste this URL into your browser:

https://clarionproseries.github.io/docs/vuMailKit/