Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MailRoute

Hierarchy

  • MailRoute

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Properties

disabled

disabled: string[] = ['put', 'patch']

endpoint

endpoint: string = "/mail"

Methods

get

  • get(): { remainingDailyQuota: number }

patch

  • patch(req: { body: { input: MailingInput<unknown>; messageId?: undefined | string; replyAll?: undefined | false | true; threadId?: undefined | string }; data: { auth: AuthData } }): GmailMessage | GmailThread
  • Reply to a thread/message

    Parameters

    • req: { body: { input: MailingInput<unknown>; messageId?: undefined | string; replyAll?: undefined | false | true; threadId?: undefined | string }; data: { auth: AuthData } }
      • body: { input: MailingInput<unknown>; messageId?: undefined | string; replyAll?: undefined | false | true; threadId?: undefined | string }
        • input: MailingInput<unknown>
        • Optional messageId?: undefined | string
        • Optional replyAll?: undefined | false | true
        • Optional threadId?: undefined | string
      • data: { auth: AuthData }

    Returns GmailMessage | GmailThread

put

  • put(req: { body: { categoryName?: undefined | string; input: MailingInput<unknown>; recipient: string; subject: string } }): { threadId: string }
  • Send an email

    Parameters

    • req: { body: { categoryName?: undefined | string; input: MailingInput<unknown>; recipient: string; subject: string } }
      • body: { categoryName?: undefined | string; input: MailingInput<unknown>; recipient: string; subject: string }
        • Optional categoryName?: undefined | string
        • input: MailingInput<unknown>
        • recipient: string
        • subject: string

    Returns { threadId: string }

    • threadId: string

Object literals

errors

errors: object

mail/invalid-input

mail/invalid-input: string = "Invalid input."

mail/missing-recipient

mail/missing-recipient: string = "Missing required recipient for the action"

mail/no-access

mail/no-access: string = "Current auth user has no access permission for the resource."

Generated using TypeDoc