<!--- Code generated by @the-/script-doc. DO NOT EDIT. -->

## Modules

<dl>
<dt><a href="#module_@the-/mail">@the-/mail</a></dt>
<dd><p>Mail client for the-framework</p>
</dd>
</dl>

## Functions

<dl>
<dt><a href="#default">default()</a></dt>
<dd><p>Alias of <a href="#module_@the-/mail.create">create</a></p>
</dd>
<dt><a href="#toLowerKeys">toLowerKeys()</a></dt>
<dd></dd>
</dl>

<a name="module_@the-/mail"></a>

## @the-/mail
Mail client for the-framework

**Version**: 15.4.1  
**License**: MIT  

* [@the-/mail](#module_@the-/mail)
    * [.TheMail](#module_@the-/mail.TheMail)
        * [.send()](#module_@the-/mail.TheMail+send) ⇒ <code>Promise</code>
    * [.helpers](#module_@the-/mail.helpers) : <code>object</code>
    * [.sending](#module_@the-/mail.sending) : <code>object</code>
        * [.sendMock()](#module_@the-/mail.sending.sendMock)
        * [.sendSendgrid()](#module_@the-/mail.sending.sendSendgrid)
        * [.sendSMTP()](#module_@the-/mail.sending.sendSMTP)
    * [.create(...args)](#module_@the-/mail.create) ⇒ <code>TheMail</code>

<a name="module_@the-/mail.TheMail"></a>

### mail.TheMail
**Kind**: static class of [<code>@the-/mail</code>](#module_@the-/mail)  
<a name="module_@the-/mail.TheMail+send"></a>

#### theMail.send() ⇒ <code>Promise</code>
Send mail

**Kind**: instance method of [<code>TheMail</code>](#module_@the-/mail.TheMail)  

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

<a name="module_@the-/mail.helpers"></a>

### mail.helpers : <code>object</code>
Helper functions

**Kind**: static namespace of [<code>@the-/mail</code>](#module_@the-/mail)  
**Access**: protected  
<a name="module_@the-/mail.sending"></a>

### mail.sending : <code>object</code>
Sending functions

**Kind**: static namespace of [<code>@the-/mail</code>](#module_@the-/mail)  
**Access**: protected  

* [.sending](#module_@the-/mail.sending) : <code>object</code>
    * [.sendMock()](#module_@the-/mail.sending.sendMock)
    * [.sendSendgrid()](#module_@the-/mail.sending.sendSendgrid)
    * [.sendSMTP()](#module_@the-/mail.sending.sendSMTP)

<a name="module_@the-/mail.sending.sendMock"></a>

#### sending.sendMock()
**Kind**: static method of [<code>sending</code>](#module_@the-/mail.sending)  
<a name="module_@the-/mail.sending.sendSendgrid"></a>

#### sending.sendSendgrid()
**Kind**: static method of [<code>sending</code>](#module_@the-/mail.sending)  
<a name="module_@the-/mail.sending.sendSMTP"></a>

#### sending.sendSMTP()
**Kind**: static method of [<code>sending</code>](#module_@the-/mail.sending)  
<a name="module_@the-/mail.create"></a>

### mail.create(...args) ⇒ <code>TheMail</code>
Create a TheMail instance

**Kind**: static method of [<code>@the-/mail</code>](#module_@the-/mail)  

| Param | Type |
| --- | --- |
| ...args | <code>\*</code> | 

<a name="default"></a>

## default()
Alias of [create](#module_@the-/mail.create)

**Kind**: global function  
<a name="toLowerKeys"></a>

## toLowerKeys()
**Kind**: global function  
