---
title: "Emails hooks"
description: "Hand-written shim. Implementation is generated; see ./emails.gen."
section: "Libraries"
group: "React hooks"
order: 416
---

## Hooks

### `useDeleteEmail` `mutation`

Soft-delete an email.

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

**Types:** [SuccessResponse](/types/success-response)

### `useListEmails` `query`

List received emails.

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

**Types:** [ListEmailsParams](/types/list-emails-params) · [EmailFilter](/types/email-filter) · [EmailOrderBy](/types/email-order-by) · [EmailShorthands](/types/email-shorthands) · [Page](/types/page) · [Email](/types/email)

### `usePurgeEmail` `composite`

Permanently delete a soft-deleted email.

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

**Types:** [SuccessResponse](/types/success-response) · [PurgeEmailParams](/types/purge-email-params)

### `useRestoreEmail` `composite`

Restore a soft-deleted email.

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

**Types:** [Email](/types/email)

### `useRetrieveEmail` `query`

Get a single email by ID.

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

**Types:** [Email](/types/email)