eleith/emailjs
1
0
Fork 0
mirror of https://github.com/eleith/emailjs.git synced 2024-07-03 11:38:50 +00:00
Code Issues Projects Releases Wiki Activity

update client/SMTPOptions definition

Browse Source
This commit is contained in:
Zack Schuster 2018-07-12 10:02:42 -07:00
parent cf3833b48d
commit a356229406
1 changed files with 17 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
smtp/client.js
View File

@ -4,17 +4,6 @@ const addressparser = require('addressparser');
class Client {
/**
* @typedef {Object} SMTPOptions
* @property {number} [timeout]
* @property {string} [user]
* @property {string} [password]
* @property {string} [domain]
* @property {string} [host]
* @property {number} [port]
* @property {boolean} [ssl]
* @property {boolean} [tls]
* @property {string[]} [authentication]
*
* @typedef {Object} MessageStack
* @property {function(Error, Message): void} [callback]
* @property {Message} [message]
@ -27,6 +16,23 @@ class Client {
* @property {string} [text]
* @property {*} [attachment]
*
* @typedef {Object} SMTPSocketOptions
* @property {string} key
* @property {string} ca
* @property {string} cert
*
* @typedef {Object} SMTPOptions
* @property {number} [timeout]
* @property {string} [user]
* @property {string} [password]
* @property {string} [domain]
* @property {string} [host]
* @property {number} [port]
* @property {boolean|SMTPSocketOptions} [ssl]
* @property {boolean|SMTPSocketOptions} [tls]
* @property {string[]} [authentication]
* @property {function(...any): void} [logger]
*
* @constructor
* @param {SMTPOptions} server smtp options
*/