Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MailThreadsRoute

Hierarchy

  • MailThreadsRoute

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

disabled

disabled: string[] = ['get']

endpoint

endpoint: string = "/mail/threads"

Methods

get

  • get(req: { data: { auth: AuthData }; query: { categoryName?: undefined | string; childrenOnly?: undefined | false | true; full?: undefined | false | true; grouping?: undefined | false | true; threadId?: undefined | string } }): Thread[] | GroupingThread | GroupingThread[]
  • Get threads (list by category/single - parent + children/single - children only)

    Parameters

    • req: { data: { auth: AuthData }; query: { categoryName?: undefined | string; childrenOnly?: undefined | false | true; full?: undefined | false | true; grouping?: undefined | false | true; threadId?: undefined | string } }
      • data: { auth: AuthData }
      • query: { categoryName?: undefined | string; childrenOnly?: undefined | false | true; full?: undefined | false | true; grouping?: undefined | false | true; threadId?: undefined | string }
        • Optional categoryName?: undefined | string
        • Optional childrenOnly?: undefined | false | true
        • Optional full?: undefined | false | true
        • Optional grouping?: undefined | false | true
        • Optional threadId?: undefined | string

    Returns Thread[] | GroupingThread | GroupingThread[]

Generated using TypeDoc