Class DMails

constructor

• new DMails(e621: E621<NoV2Options> | undefined, client: Client): DMails

  e621 may be omitted (pass undefined) when constructing a module standalone, without the main E621 client, to keep bundles tree-shakable. Convenience methods on models returned by this module that call back into other modules via this.e621 will throw in that case.

  Parameters

  • e621: E621<NoV2Options> | undefined
  • client: Client

  Returns DMails

Static ReadonlymoduleKey

delete

• delete(id: number): Promise<null>
  Requires Api Key Auth

  Deleting simply hides your copy of the dmail.

  Parameters

  • id: number

  Returns Promise<null>

  Operation Id

  dmails#destroy

  See

  Documentation for more details.

get

• get(id: number): Promise<DMail | null>
  Requires Api Key Auth

  Fetching a dmail will not mark it as read. Unless the dmail is owned:

  • The current user must be staff and the dmail must be to or from the automod
  • The current user must be Moderator+ and a ticket must exist for the dmail
  • The current user must be Admin+ and the dmail must be to or from Admin+
  • The current user must be Staff and have a share key for the dmail

  Parameters

  • id: number

  Returns Promise<DMail | null>

  Operation Id

  dmails#show

  See

  Documentation for more details.

markAllRead

• markAllRead(): Promise<null>
  Requires Api Key Auth

  Returns Promise<null>

  Operation Id

  dmails#mark_all_as_read

  See

  Documentation for more details.

markRead

• markRead(id: number): Promise<null>
  Requires Api Key Auth

  Parameters

  • id: number

  Returns Promise<null>

  Operation Id

  dmails#mark_as_read

  See

  Documentation for more details.

markUnread

• markUnread(id: number): Promise<null>
  Requires Api Key Auth

  Parameters

  • id: number

  Returns Promise<null>

  Operation Id

  dmails#mark_as_unread

  See

  Documentation for more details.

search

• search(options?: SearchDMailsOptions): Promise<DMail[]>
  Requires Api Key Auth

  Parameters

  • Optionaloptions: SearchDMailsOptions

  Returns Promise<DMail[]>

  Operation Id

  dmails#index

  See

  Documentation for more details.