Submit an email for rendering across email clients — full HTML, or a complete raw .eml (base64). Provide exactly one of html/eml. Returns a job ID to poll for results.
Показать схему аргументов
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"eml": {
"type": "string",
"description": "A complete raw RFC 822 message (.eml), base64-encoded — inserted verbatim (real headers, multipart, attachments). Max 10MB decoded. Provide exactly one of html or eml."
},
"html": {
"type": "string",
"description": "The full email HTML to preview. Provide exactly one of html or eml."
},
"renders": {
"type": "array",
"items": {
"type": "object",
"required": [
"client"
],
"properties": {
"client": {
"enum": [
"gmail",
"outlook",
"yahoo"
],
"type": "string",
"description": "Client ID"
},
"color_scheme": {
"enum": [
"light",
"dark"
],
"type": "string",
"description": "Render in the client's light or dark mode (default light). Dark must be supported by the client — check color_schemes in list_clients."
},
"viewport_width": {
"type": "number",
"description": "Viewport width in pixels (200-2560). Defaults to the client default (1280)."
},
"images_disabled": {
"type": "boolean",
"description": "Render with remote images blocked (default false)"
}
}
},
"description": "Exactly the renders you want, one entry each (e.g. outlook light + outlook dark are two entries). Omit for the server default: every live client at its default width, light."
},
"subject": {
"type": "string",
"description": "Email subject line"
},
"include_previews": {
"type": "boolean",
"description": "Also capture the inbox-list row (how the message looks unread in the list) and the subject heading, returned as inbox_preview / subject_preview on each render. Default false: they cost more than the body render itself, so ask only when you need them."
},
"include_full_page": {
"type": "boolean",
"description": "Also screenshot the whole client window around the opened email (the mailbox UI as well as the message), returned as full_page on each render next to the usual email-only screenshot. Default false. Best-effort: the render mailbox identity and any other mail are masked, and the capture is omitted when that cannot be verified."
}
}
}