the-mail/doc/api/api.md

Mail client for the-framework

<!-- // Code generated by coz. DO NOT EDIT. -->
# the-mail@3.1.3

Mail client for the-framework

+ Functions
  + [create(args)](#the-mail-function-create)
+ [`TheMail`](#the-mail-classes) Class
  + [new TheMail()](#the-mail-classes-the-mail-constructor)
  + [mail.send()](#the-mail-classes-the-mail-send)

## Functions

<a class='md-heading-link' name="the-mail-function-create" ></a>

### create(args) -> `TheMail`

Create a TheMail instance

| Param | Type | Description |
| ----- | --- | -------- |
| args | * |  |



<a class='md-heading-link' name="the-mail-classes"></a>

## `TheMail` Class






<a class='md-heading-link' name="the-mail-classes-the-mail-constructor" ></a>

### new TheMail()

Constructor of TheMail class



<a class='md-heading-link' name="the-mail-classes-the-mail-send" ></a>

### mail.send() -> `Promise`

Send mail

| Param | Type | Description |
| ----- | --- | -------- |
| config.from | string | From address |
| config.to | string | To address |
| config.subject | string | Mail subject |
| config.content | string | Mail content |