| Home | Getting Started | Browse by Category | All functions |
vuMailKit includes a large function library, but most real-world applications only need a small part of it at first.
The lower-level and legacy-compatible functions remain available for continuity, diagnostics, setup, and advanced control. You do not need to learn all of them before sending mail.
For a normal Clarion application, start with this sequence:
In a multi-DLL application, put the vuMailKit template on the EXE app. The EXE initializes licensing once, and the runtime DLL can be used from code reached anywhere in the program.
Hand-coded integrations must call vuMailKitInitialize once at EXE startup before setup, autodetect, profile, or send functions are used.
| Guide | Purpose |
|---|---|
| What most developers actually use | Understand which parts of vuMailKit matter most in everyday use. |
| First-time setup | Add the template, import the vuMailKit Email Setup Wizard with CTRL+U, compile the EXE, run the vuMailKit Email Setup Wizard, test the connection, and save a working profile. |
| vuMailKit Email Setup Wizard | Let the vuMailKit Email Setup Wizard validate the address, detect server/OAuth settings, send a test email, and save the profile. |
| Deployment and profiles | Understand how profiles behave on individual machines, shared installs, and networks. |
| Send your first email | The simplest path to sending mail once licensing is initialized and a profile is 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. |
For most applications, choose one of these paths instead of hand-building a full HTML message inside Clarion source.
| Need | Recommended path |
|---|---|
| Ordinary text from a TEXT control, TPS memo, customer note, or generated report | Use Simple HTML mode, keep NormalizeBody on, and pass the text as-is. |
| Ordinary text plus images inside the body | Use Send an embedded image with Simple HTML and the embed-attachments marker. Put the marker where the images should appear and pass local image files or remote http/https image URLs in Attach. |
| Designed HTML with layout, images, and merge tokens | Use an external UTF-8 HTML file and TokenMerge, then send the merged output file. |
This keeps the common case easy. Developers can send clean HTML from normal Clarion fields, and they only need external HTML when they want full design control.
| Guide | Purpose |
|---|---|
| Send an HTML email | Start with Simple HTML, then move to external HTML files if you need more control. |
| Send a Simple HTML Email with a Company Logo | Let vuMailKit Basic wrap body content in a modest HTML container with an optional header image and footer image. |
| Send an email from an external file | Keep the message body outside your code and send it from a file. |
| Use TokenMerge with email templates | Replace placeholder tokens in memory, files, or generated file content before sending. |
| Send attachments | Attach files to outgoing email. |
| Send an embedded image | Put body-positioned images into ordinary text with Simple HTML plus the embed-attachments marker, or use local paths, remote URLs, and external HTML files. |
| Send a branded HTML email from a template | Reuse a logo, letterhead, and footer while merging changing message content into a separate output file. |
| Send a form-letter invoice email with an optional personal message | Combine fixed letter text, token values, and generated invoice content in a branded HTML email. |
| Send a batch of emails from CSV | Send multiple messages from a CSV data source. |
Many Clarion developers can write their own search-and-replace code, but vuMailKit already includes TokenMerge helpers.
You can replace tokens in a string, replace tokens while copying one file to another, or insert the contents of one file into a token location in another file. That last option is useful when a Clarion report writes invoice or statement detail to a text file and you want to insert that output into an email body.
Once the vuMailKit Email Setup Wizard runs successfully, sends a test email, and saves the profile, the profile is ready to use.
In most cases, you do not need to manually fill in server settings after that. For a fuller button-handler pattern that checks for the saved profile, offers the wizard when needed, validates the recipient, sends, and shows useful diagnostics, see Recommended send flow with a stored profile.
| Home | Getting Started | Browse by Category | All functions |