Lists allow you to filter emails by allowing or blocking specific email addresses or domains. There are six list types based on two dimensions:
send, receive, or replyallow or blockEach entry can be either a full email address (e.g., partner@example.com) or an entire domain (e.g., example.com).
Lists can be scoped at three levels. A narrower scope overrides a broader one:
client.lists.client.pods.lists.client.inboxes.lists.When evaluating whether to allow or block a message, AgentMail checks the most specific scope first. If an inbox-level list has a match, pod and org lists are not checked.
The reply direction handles inbound emails that are replies to previous outbound messages. When an inbound email arrives, AgentMail checks the In-Reply-To header to determine whether it is a reply:
The two branches are completely separate. By default, when reply lists are empty, all replies are allowed. You can restrict replies by populating reply allow or reply block lists.
Retrieve entries from a list with optional pagination.
Add an email address or domain to a list. The reason parameter is optional and available on block lists.
Retrieve a specific entry from a list by its email address or domain.
Remove an entry from a list.
Manage lists for a specific inbox. The same operations are available at the inbox level.
Control which addresses can send replies to an inbox’s outbound messages.
Copy one of the blocks below into Cursor or Claude for complete Lists API knowledge in one shot.