API Docs for: 0.8.0
Show:

EmailService Class

Defined in: include/email.js:25
Module: Services

Service for sending emails.

Methods

getDefaultSettings

() Object

Defined in include/email.js:174

Retrieves the default email settings from installation

Returns:

Object:

Email settings

getSettings

(
  • cb
)

Defined in include/email.js:160

Retrieves the email settings

Parameters:

  • cb Function

    Callback function

send

(
  • from
  • to
  • subject
  • body
  • cb
)

Defined in include/email.js:105

Sends an email

Parameters:

  • from String

    From name

  • to String

    To email address

  • subject String

    Email subject

  • body String

    Email content

  • cb Function

    Callback function

sendFromLayout

(
  • options
  • cb
)

Defined in include/email.js:87

Uses an HTML layout and sends it as an email

Parameters:

  • options Object

    Object containing the email settings and layout

  • cb Function

    Callback function

sendFromTemplate

(
  • options
  • cb
)

Defined in include/email.js:63

Retrieves a template and sends it as an email

Parameters:

  • options Object

    Object containing the email settings and template name

  • cb Function

    Callback function

Properties

DEFAULT_SETTINGS

Object private static

Defined in include/email.js:41