the-mail
Version:
Mail client for the-framework
121 lines (120 loc) • 3.63 kB
JSON
{
"functions": [
{
"name": "create",
"access": "",
"virtual": false,
"description": "Create a TheMail instance",
"parameters": [
{
"name": "args",
"type": "*",
"description": "",
"default": "",
"optional": "",
"nullable": ""
}
],
"examples": [],
"returns": {
"type": "TheMail",
"description": ""
}
},
{
"name": "toLowerKeys",
"access": "",
"virtual": false,
"description": "",
"parameters": [],
"examples": []
},
{
"name": "sendMock",
"access": "",
"virtual": false,
"description": "",
"parameters": [],
"examples": []
},
{
"name": "sendSendgrid",
"access": "",
"virtual": false,
"description": "",
"parameters": [],
"examples": []
},
{
"name": "sendSMTP",
"access": "",
"virtual": false,
"description": "",
"parameters": [],
"examples": []
}
],
"classes": [
{
"name": "TheMail",
"description": "",
"extends": [],
"access": "",
"virtual": false,
"fires": "",
"constructor": {
"name": "TheMail",
"description": "",
"parameters": [],
"examples": []
},
"functions": [
{
"name": "send",
"access": "",
"virtual": false,
"description": "Send mail",
"parameters": [
{
"name": "config.from",
"type": "string",
"description": "From address",
"default": "",
"optional": "",
"nullable": ""
},
{
"name": "config.to",
"type": "string",
"description": "To address",
"default": "",
"optional": "",
"nullable": ""
},
{
"name": "config.subject",
"type": "string",
"description": "Mail subject",
"default": "",
"optional": "",
"nullable": ""
},
{
"name": "config.content",
"type": "string",
"description": "Mail content",
"default": "",
"optional": "",
"nullable": ""
}
],
"examples": [],
"returns": {
"type": "Promise",
"description": ""
}
}
]
}
]
}