Get Email Code
get_email_codeExtracts a one-time password (OTP) candidate from a message in an existing inbox, with optional message selection, to retrieve verification codes during automated sign-up flows.
Instructions
Extract an OTP candidate from a received message in your existing inbox. Optionally pass message_id to select a message; use list_email_messages to inspect messages first. Pass inbox_id, capability and access_token from create_email_inbox. No additional charge. Poll at least 2 seconds apart; back off on 429/503. Pending, no_code or ambiguous does not confirm a usable OTP; external code acceptance is not guaranteed.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"inbox_id": "<inbox_id>",
"capability": "<capability>"
},
"name": "get_email_code"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| inbox_id | Yes | inbox_id parameter for get_email_code | |
| capability | Yes | capability parameter for get_email_code | |
| message_id | No | message_id parameter for get_email_code | |
| access_token | No | Use the scoped access_token returned by create_email_inbox. Optional only for an existing provisioned private pilot connection. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||