SDK method
tools.createInbox
Create an inbox. Convenience alias for create_inbox, forwarding to tinbox.api.inboxes.create.mutate.
Signature
ts
createInbox(input: Parameters<TinboxTools["createInbox"]>[0]): ReturnType<TinboxTools["createInbox"]>Parameters
| Name | Type | Required | Description |
|---|---|---|---|
localPart | string | yes | The mailbox local-part — the bit before @ (e.g. 'support'). |
domain | string | no | Domain to use; defaults to the deployment's sending domain. |
name | string | no | Display label; defaults to the capitalized local-part. |
type | "personal" | "shared" | no | 'personal' (one human) or 'shared' (team inbox others can be granted onto). Default personal. |
Returns
ReturnType<TinboxTools["createInbox"]>
Example
ts
await tinbox.tools.createInbox({
"localPart": "<localPart>"
});