get_email_body
Read a bounded portion of one email body. Use nextOffset to continue.
Read a bounded portion of one email body. Use nextOffset to continue.
Permissions
Required capabilities: mail.read.
Inputs
| Name | Required | Type | Details |
|---|---|---|---|
accountId | No | string or null | Account to operate on. Optional when exactly one account is connected. Minimum length: 1. Maximum length: 512. |
messageId | Yes | string | Minimum length: 1. Maximum length: 512. |
bodyFormat | Yes | text or html | The body part to read |
offset | No | integer or null | Minimum: 0. |
maxChars | No | integer or null | Minimum: 1. Maximum: 50000. |
{
"type": "object",
"properties": {
"accountId": {
"description": "Account to operate on. Optional when exactly one account is connected.",
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 512
},
{
"type": "null"
}
]
},
"messageId": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"bodyFormat": {
"type": "string",
"enum": [
"text",
"html"
],
"description": "The body part to read"
},
"offset": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
}
]
},
"maxChars": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 50000
},
{
"type": "null"
}
]
}
},
"required": [
"messageId",
"bodyFormat"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}Last updated
get_email
Read one email with its recipients, body and attachment metadata. The body returns at most 50,000 characters, and bodyTruncation reports where each part continues. Use get_email_body to read the rest.
get_status
Account connection and scheduled-send status, including accounts that need re-authentication, and the time zone for the date above the quoted message in replies. Administrators also see plan details.