AddressListEntry
The AddressListEntry type of the TypeScript SDK, which accountAddressLists.addEntry and 3 more methods take or answer.
type AddressListEntry = {
createdAt: number
expiresAt: number | null
hitCount: number
lastHitAt: number | null
note: string | null
pattern: string
}Fields
| Field | Type | Description |
|---|---|---|
createdAt | number | Timestamp when pattern was added in epoch seconds |
expiresAt | number | null | Epoch seconds after which the entry stops applying and disappears from the list, or null for never |
hitCount | number | Evaluations this entry decided (at least: hits within ten seconds of the previous recorded one are folded into it) |
lastHitAt | number | null | Epoch seconds of the last recorded hit, or null if never matched |
note | string | null | Optional operator note, or null |
pattern | string | Address pattern (e.g. user@example.com, *@example.com, or *@.example.com) |
Used by
| Method | What it does |
|---|---|
accountAddressLists.addEntry | Add a pattern to an address list |
accountAddressLists.listEntries | List patterns in an address list |
mailboxAddressLists.addEntry | Add a pattern to an address list |
mailboxAddressLists.listEntries | List patterns in an address list |
Used in
AddressListBatchResult
The AddressListBatchResult type of the TypeScript SDK, which accountAddressLists.addEntries and 3 more methods take or answer.
AddressListEntryPage
The AddressListEntryPage type of the TypeScript SDK, which accountAddressLists.listEntries and mailboxAddressLists.listEntries take or answer.