Skip to content

The Basics

nlsMailer's main object is the Application object, which all other objects stem off of. The object's main purpose is to manage user accounts as well as generate other objects.

To initialize the object, run the following code:

vba
Dim MailerApp As nlsMailer.Application
Set MailerApp = New nlsMailer.Application

Creating an Account

After initializing the Application object, the first step in any program should be creating an account, which allows the user to create items, send mail, etc.

Each account is based off of an existing email service API, so ensure you have the neccessary details at hand (e.g. API Key, API Url, etc.).

To create an account, you should use the Accounts.Add() function, with an example below:

vba
MailerApp.Accounts.Add SMTPAddress:="test@example.com", _
                        ApiKey:="api-key-0123456789", _
                        ApiUrl:="https://apiUrl.com", _
                        AccountType:=olMailgun

In short, this function call creates an account with the following details:

  • Email Address: test@example.com
  • API Key: api-key-0123456789
  • API Url: https://www.apiUrl.com
  • Account Type: olMailgun

Although the rest are rather self-explanatory, Account Type determines what type of account we are creating (e.g. Mailgun, Microsoft Graph API, etc.).

Creating a MailItem

After our account is created, the next step is creating a MailItem, which you can think of as an empty email message. To do so, we will use the CreateItem() method:

vba
Dim MailItem As nlsMailer.MailItem
Set MailItem = MailerApp.CreateItem(olMailItem)

Sending an Email

With our MailItem now created, it is time to send our very first email. To do so, we will edit the MailItem's properties, and then send the email:

vba
MailItem.Subject = "Test"
MailItem.Body = "Welcome to nlsMailer"
MailItem.Recipients.Add "recipient@example.com"
MailItem.Send

After this code is execute the newly created mail item will be sent to all recipients.