Skip to content

Add plus addressing section to Inboxes concept page #179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fern-api wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add plus addressing section to Inboxes concept page #179

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions fern/pages/core-concepts/inboxes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,30 @@ agentmail inboxes list
domains](/managing-domains).
</Tip>

## Plus addressing

AgentMail supports plus addressing, also known as sub-addressing, for inbound email. If you create an inbox like `agent@example.com`, email sent to `agent+support@example.com`, `agent+billing@example.com`, or any other `agent+tag@example.com` address is delivered to the same `agent@example.com` inbox.

Create the base inbox address:

<CodeBlocks>

```python title="Python"
inbox = client.inboxes.create(
username="agent",
domain="example.com",
)
```

```typescript title="TypeScript"
const inbox = await client.inboxes.create({
username: "agent",
domain: "example.com",
});
```

</CodeBlocks>

## Metadata

Attach your own key-value data to any `Inbox` with the `metadata` field. Use it to link an inbox to records in your own system: a user ID, an agent name, or feature flags. Metadata is returned on every inbox response.
Expand Down
Loading