Files
kami-parse-server/src/Adapters/Email/MailAdapter.js
Florent Vilmart 942b9b5b1a Adds documentations for adapters and main constructors (#4951)
* wip

* Adds documentations for adapters, and constructors

* nits

* nit
2018-08-15 10:47:21 -04:00

28 lines
657 B
JavaScript

/*eslint no-unused-vars: "off"*/
/**
* @module Adapters
*/
/**
* @interface MailAdapter
* Mail Adapter prototype
* A MailAdapter should implement at least sendMail()
*/
export class MailAdapter {
/**
* A method for sending mail
* @param options would have the parameters
* - to: the recipient
* - text: the raw text of the message
* - subject: the subject of the email
*/
sendMail(options) {}
/* You can implement those methods if you want
* to provide HTML templates etc...
*/
// sendVerificationEmail({ link, appName, user }) {}
// sendPasswordResetEmail({ link, appName, user }) {}
}
export default MailAdapter;