Highoutput Email Service Client

Class:Client

Constructor:new Client(host, secret)

Creates an email service client for the specific host and it's secret.

sendEmail(param) <Promise>

• param <Object>
  • from <String> required Email of the sender
  • to <String>|<Array<String>> required Email(s) of the recipient(s)
  • text <String> Text content
  • html <String> Html content
  • bcc <String>|<Array<String>>
  • cc <String>|<Array<String>>
  • template <String> Name of the template
  • templateData <Object> Object data to be bound to the template
  • checkValidity <Boolean> Determine whether to check first all the email if those email(s) exists of the domain SMTP server

Though text, html, or template property is not required, but one of them must be present.

  sendEmail({
    from: "Highoutput Ventures <[email protected]>",
    to: ["[email protected]"],
    subject: "hello world",
    html: "<b>Hello world</b><a href='#'>Test</a>",
    text: "good eve",
    cc: ["[email protected]"],
    bcc: ["[email protected]"]
  });

sendEmailVerification(param, secret) <Promise>

Acts same like a send email but also includes a key data that is being included in templateData. It also adds a new optional property which is a payloadData other information you wanted to include upon verifying.

  client.verify({
    to: '[email protected]',
    from: 'High Output Ventures <[email protected]>',
    template: 'verify',
    templateData: { name: 'djansyle' },
    payloadData: { id: 'f64f2940-fae4-11e7-8c5f-ef356f279131'},
    subject: 'One more step',
  }, 'supersecretkey').then(() => console.log('sent'));

verify(param, secret)

Verifies the parameter it can be a string of the plain link or koa ctx.

  client.verify('http://localhost:8080?key=averylongvalidkey','supersecretkey');
  // Outputs:
  // { email: '[email protected]', id: 'f64f2940-fae4-11e7-8c5f-ef356f279131' iat: 1524793969 }