AeontelAeontel Docs

Emails hooks

Hand-written shim. Implementation is generated; see ./emails.gen.

Hooks

useDeleteEmail mutation

Soft-delete an email.

TypeScript
useDeleteEmail(options?: MutationOpts<SuccessResponse, string>)

Types: SuccessResponse

useListEmails query

List received emails.

TypeScript
useListEmails(params?: Omit<ListEmailsParams, | > & { filter?: EmailFilter; orderBy?: EmailOrderBy[]; } & EmailShorthands, options?: QueryOpts<Page<Email>>)

Types: ListEmailsParams · EmailFilter · EmailOrderBy · EmailShorthands · Page · Email

usePurgeEmail composite

Permanently delete a soft-deleted email.

TypeScript
usePurgeEmail(options?: MutationOpts<SuccessResponse, PurgeEmailParams>)

Types: SuccessResponse · PurgeEmailParams

useRestoreEmail composite

Restore a soft-deleted email.

TypeScript
useRestoreEmail(options?: MutationOpts<Email, string>)

Types: Email

useRetrieveEmail query

Get a single email by ID.

TypeScript
useRetrieveEmail(id: string, options?: QueryOpts<Email>)

Types: Email