# AddressList

The AddressList type of the TypeScript SDK, which accountAddressLists.create and 7 more methods take or answer.

```ts
type AddressList = {
  catchAll?: boolean
  contactsExempt: boolean
  createdAt: number
  direction: ('inbound' | 'outbound')
  entryCount?: number
  id: string
  name: string
  scopeId: string
  scopeKind: ('account' | 'domain' | 'mailbox')
  updatedAt: number
  verdict: ('allow' | 'block')
}
```

## Fields

| Field | Type | Description |
| --- | --- | --- |
| `catchAll` | `boolean` | Optional. Whether this list holds a live catch-all (`*@*`) entry: the "block all" switch, for this list only. Read-only, present on list reads. |
| `contactsExempt` | `boolean` | Inbound block lists only: when this list's catch-all (`*@*`) decides, a vouched sender found in the receiving mailbox's own address book is let through. Applies only where a concrete receiving mailbox is known: a group, webhook or remote route behind the same block-all still needs a named allow. Every catch-all list at the most specific scope holding one must opt in. Never lifts a named block. |
| `createdAt` | `number` | Creation timestamp in epoch seconds |
| `direction` | `('inbound' \| 'outbound')` | Traffic direction ('inbound' for senders, 'outbound' for recipients) |
| `entryCount` | `number` | Optional. Count of pattern entries in this list (on single list read) |
| `id` | `string` | Address list ULID identifier |
| `name` | `string` | Descriptive name for this address list |
| `scopeId` | `string` | Associated account ID, domain name, or mailbox ID depending on scopeKind |
| `scopeKind` | `('account' \| 'domain' \| 'mailbox')` | Policy scope level ('account', 'domain', or 'mailbox') |
| `updatedAt` | `number` | Last updated timestamp in epoch seconds |
| `verdict` | `('allow' \| 'block')` | Policy action ('allow' or 'block') |

## Used by

| Method | What it does |
| --- | --- |
| [`accountAddressLists.create`](/docs/sdks/typescript/account-address-lists/create) | Create an address list |
| [`accountAddressLists.list`](/docs/sdks/typescript/account-address-lists/list) | List address lists |
| [`accountAddressLists.get`](/docs/sdks/typescript/account-address-lists/get) | Get an address list |
| [`accountAddressLists.update`](/docs/sdks/typescript/account-address-lists/update) | Update an address list |
| [`mailboxAddressLists.create`](/docs/sdks/typescript/mailbox-address-lists/create) | Create an address list |
| [`mailboxAddressLists.list`](/docs/sdks/typescript/mailbox-address-lists/list) | List address lists |
| [`mailboxAddressLists.get`](/docs/sdks/typescript/mailbox-address-lists/get) | Get an address list |
| [`mailboxAddressLists.update`](/docs/sdks/typescript/mailbox-address-lists/update) | Update an address list |

## Used in

[`AddressListPage`](/docs/sdks/typescript/types/address-list-page).
