Skip to main content

Mail

Formidable provides a clean, simple email API powered by the popular Nodemailer library. Nodemailer provide drivers for sending email via SMTP, Amazon SES, and sendmail, allowing you to quickly get started sending mail through a local or cloud based service of your choice.

Configuration

Formidable's email services may be configured via your application's config/mail.imba configuration file. Each mailer configured within this file may have its own unique configuration and even its own unique "transport", allowing your application to use different email services to send certain email messages.

Within your mail configuration file, you will find a mailers configuration object. This object contains a sample configuration entry for each of the major mail drivers / transports supported by Formidable, while the default configuration value determines which mailer will be used by default when your application needs to send an email message.

Generating Mailables

When building Formidable applications, each type of email sent by your application is represented as a "mailable" class. These classes are stored in the app/Mail directory. Don't worry if you don't see this directory in your application, since it will be generated for you when you create your first mailable class using the make:mail Craftsman command:

node craftsman make:mail SubscribedToEventNotifications

Sending Raw Emails

Here's an example of how to send an email:

import { Mail } from '@formidablejs/mailer'

Mail.to('email@example').raw('This is a test email')

Sending Attachments

Here's an example of how to send an email with an attachment:

import { Mail } from '@formidablejs/mailer'
import path from 'path'

const file\String = path.join(process.cwd!, 'storage', 'framework', 'logos', 'imba.png')

Mail.to('email@example').attach({ path: file }).raw('This is a test email')

You can also send multiple attachments:

import { Mail } from '@formidablejs/mailer'
import path from 'path'

const formidableLogo\String = path.join(process.cwd!, 'storage', 'framework', 'logos', 'formidable.png')
const imbaLogo\String = path.join(process.cwd!, 'storage', 'framework', 'logos', 'imba.png')

Mail.to('email@example')
.attach({ path: formidableLogo })
.attach({ path: imbaLogo })
.raw('This is a test email')

You may also pass an array of attachments instead of a single attachment each time you call attach:

import { Mail } from '@formidablejs/mailer'
import path from 'path'

const formidableLogo\String = path.join(process.cwd!, 'storage', 'framework', 'logos', 'formidable.png')
const imbaLogo\String = path.join(process.cwd!, 'storage', 'framework', 'logos', 'imba.png')

Mail.to('email@example')
.attach([
{ path: formidableLogo }
{ path: imbaLogo }
])
.raw('This is a test email')

Attachment object consists of the following properties:

  • filename - filename to be reported as the name of the attached file. Use of unicode is allowed.
  • content - String, Buffer or a Stream contents for the attachment
  • path - path to the file if you want to stream the file instead of including it (better for larger attachments)
  • href – an URL to the file (data uris are allowed as well)
  • httpHeaders - optional HTTP headers to pass on with the href request, eg. {authorization: "bearer ..."}
  • contentType - optional content type for the attachment, if not set will be derived from the filename property
  • contentDisposition - optional content disposition type for the attachment, defaults to ‘attachment’
  • cid - optional content id for using inline images in HTML message source
  • encoding - If set and content is string, then encodes the content to a Buffer using the specified encoding. Example values: ‘base64’, ‘hex’, ‘binary’ etc. Useful if you want to use binary attachments in a JSON formatted email object.
  • headers - custom headers for the attachment node. Same usage as with message headers
  • raw - is an optional special value that overrides entire contents of current mime node including mime headers. Useful if you want to prepare node contents yourself

Embedding Images

Attachments can be used as embedded images in the HTML body. To use this feature, you need to set additional property of the attachment - cid (unique identifier of the file) which is a reference to the attachment file. The same cid value must be used as the image URL in HTML (using cid: as the URL protocol, see example below):

import { Mail } from '@formidablejs/mailer'
import path from 'path'

const file\String = path.join(process.cwd!, 'storage', 'framework', 'logos', 'imba.png')

Mail.to('email@example')
.attach({
filename: 'imba.png',
path: file,
cid: 'imba',
})
.raw('Embedded image: <img src="cid:imba"/>')

Note, the cid must be unique for each attachment.

Sending HTML Emails

Before you can start sending html emails, you will need to create a new Mailable. All Mailables must extend the Mailable class:

import { Mailable } from '@formidablejs/mailer'

export default WelcomeEmail < Mailable

prop subject\String
prop name\String

def constructor name\String
super()

self.subject = 'Welcome to Formidable'
self.name = name

def render
<p> "Welcome to Formidable, {self.name}"

Now that you've created a Mailable, you can use the send method of the Mail class to send it:

Mail.to('email@example').send(new WelcomeEmail)

Attachments

You can attach files to the email by passing an array of attachment objects or a single object to the attach method:

import { Mailable } from '@formidablejs/mailer'
import path from 'path'

export default WelcomeEmail < Mailable

prop subject\String
prop name\String

def constructor name\String
super()

self.subject = 'Welcome to Formidable'
self.name = name

const file\String = path.join(process.cwd!, 'storage', 'framework', 'logos', 'imba.png')

self.attach({ path: file })

def render
<p> "Welcome to Formidable, {self.name}"

Mail API

Here is a list of all the methods available on the Mail class.

MethodParamsDescription
torecipient: String[] or StringRecipients of the email.
ccrecipient: String[] or StringCarbon copy recipients of the email.
bccrecipient: String[] or StringBlind carbon copy recipients of the email.
fromname: String, email: StringSender of the email.
replyToemail: StringReply to address of the email.
attachObject[] or ObjectAdd attachments to the email.
rawcontent: String; text: String or nullRaw email content.
subjectsubject: StringSubject of the email.
sendmailable: MailableSend the email with a Mailable class.

This section is incomplete. Join our discord if you have questions.