Class DMail

Schema

See

Documentation for more details.

Hierarchy (View Summary)

DMail
Base<DMailData>
- DMail

Index

Constructors

Methods

[custom] delete markRead markUnread toJSON updateFilter

Constructors

constructor

new DMail(e621: E621<NoV2Options>, data: DMail): DMail
Parameters
- e621: E621<NoV2Options>
- data: DMail
Returns DMail
Inherited from Base.constructor
- Defined in lib/models/Base.ts:11

Methods

[custom]

"[custom]"(_depth: never, opts: InspectOptions): string
Parameters
- _depth: never
- opts: InspectOptions
Returns string
Inherited from Base.[custom]
- Defined in lib/models/Base.ts:19

delete

delete(): Promise<null>
Requires Api Key Auth
Deleting simply hides your copy of the dmail.

Returns Promise<null>

Operation Id
dmails#destroy

See
Documentation for more details.
- Defined in lib/models/DMail.ts:28

markRead

markRead(): Promise<null>
Requires Api Key Auth
Returns Promise<null>

Operation Id
dmails#mark_as_read

See
Documentation for more details.
- Defined in lib/models/DMail.ts:41

markUnread

markUnread(): Promise<null>
Requires Api Key Auth
Returns Promise<null>

Operation Id
dmails#mark_as_unread

See
Documentation for more details.
- Defined in lib/models/DMail.ts:54

toJSON

toJSON(): DMail
Returns DMail
Inherited from Base.toJSON
- Defined in lib/models/Base.ts:41

updateFilter

updateFilter(words: string): Promise<null>
Requires Api Key Auth
Parameters
- words: string
Returns Promise<null>

Operation Id
maintenance/user/dmail_filters#update

See
Documentation for more details.
- Defined in lib/models/DMail.ts:67