Send email using Gmail in Sheetbase backend app.

• Installation
• Options
• Lib
  • Lib properties
  • Lib methods
    • registerRoutes(routeEnabling?, middlewares?)
• Routing
  • Errors
  • Routes
    • Routes overview
    • Routes detail
      • GET /mail
      • PATCH /mail
      • PUT /mail
      • GET /mail/thread
      • GET /mail/threads
• Detail API reference

Installation

• Install: npm install --save @sheetbase/mail

• Usage:

// 1. import module
import { MailModule } from "@sheetbase/mail";

// 2. create an instance
export class App {
  // the object
  mailModule: MailModule;

  // initiate the instance
  constructor() {
    this.mailModule = new MailModule(/* options */);
  }
}

Options

Lib

The Lib class.

Lib properties

Lib methods

registerRoutes(routeEnabling?, middlewares?)

Expose the module routes

Parameters

Returns

RouterService<>

Routing

MailModule provides REST API endpoints allowing clients to access server resources. Theses enpoints are not exposed by default, to expose the endpoints:

MailModule.registerRoutes(routeEnabling?);

Errors

MailModule returns these routing errors, you may use the error code to customize the message:

• mail/invalid-input: Invalid input.
• mail/missing-recipient: Missing required recipient for the action
• mail/no-access: Current auth user has no access permission for the resource.

Routes

Routes overview

Routes detail

GET /mail

Get mail information

Response

object

PATCH /mail

DISABLED Reply to a thread/message

Request body

Middleware data

Response

GmailMessage | GmailThread

PUT /mail

DISABLED Send an email

Request body

Response

object

GET /mail/thread

DISABLED Get a single message/thread

Request query

Middleware data

Response

null | Thread

GET /mail/threads

DISABLED Get threads (list by category/single - parent + children/single - children only)

Request query

Middleware data

Response

Thread[] | GroupingThread | GroupingThread[]

@sheetbase/mail is released under the MIT license.