Class DMails

Hierarchy (View Summary)

Base
- DMails

Index

Constructors

Methods

delete get markAllRead markRead markUnread search

Constructors

constructor

new DMails(e621: E621, client: Client): DMails
Parameters
- e621: E621
- client: Client
Returns DMails
Inherited from Base.constructor
- Defined in lib/modules/Base.ts:19

Methods

delete

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

Deleting simply hides your copy of the dmail.
Parameters
- id: number
Returns Promise<null>
Operation Id
deleteDMail

See
Documentation for more details.
- Defined in lib/modules/DMails.ts:31

get

get(id: number): Promise<DMail | null>
Get DMail

Fetching a dmail will not mark it as read.
Parameters
- id: number
Returns Promise<DMail | null>
Operation Id
getDMail

See
Documentation for more details.
- Defined in lib/modules/DMails.ts:48

markAllRead

markAllRead(): Promise<null>
Requires Api Key Auth
Mark All DMails As Read

Returns Promise<null>
Operation Id
markAllDMailsAsRead

See
Documentation for more details.
- Defined in lib/modules/DMails.ts:65

markRead

markRead(id: number): Promise<null>
Requires Api Key Auth
Mark DMail As Read
Parameters
- id: number
Returns Promise<null>
Operation Id
markDMailAsRead

See
Documentation for more details.
- Defined in lib/modules/DMails.ts:81

markUnread

markUnread(id: number): Promise<null>
Requires Api Key Auth
Mark DMail As Unread
Parameters
- id: number
Returns Promise<null>
Operation Id
markDMailAsUnread

See
Documentation for more details.
- Defined in lib/modules/DMails.ts:98

search

search(options?: SearchDMailsOptions): Promise<DMail[]>
Search DMails
Parameters
- Optionaloptions: SearchDMailsOptions
Returns Promise<DMail[]>
Operation Id
searchDMails

See
Documentation for more details.
- Defined in lib/modules/DMails.ts:113