Class EmailControllerApi

Applies RFC3501 IMAP flag operations on a message. Current implementation supports read/unread semantics via the \\\\Seen flag only. Set IMAP flags associated with a message. Only supports '\Seen' flag.

Applies RFC3501 IMAP flag operations on a message. Current implementation supports read/unread semantics via the \\\\Seen flag only. Set IMAP flags associated with a message. Only supports '\Seen' flag.

Validates sender/inbox context and recipient eligibility before attempting a send. Useful for preflight checks in UI or test workflows. Check whether an email send would be accepted

Validates sender/inbox context and recipient eligibility before attempting a send. Useful for preflight checks in UI or test workflows. Check whether an email send would be accepted

Runs content quality checks against hydrated email body content. This endpoint performs outbound HTTP checks for linked resources, so avoid use with sensitive or stateful URLs. Check email body for broken links, images, and spelling issues

Detects HTML/CSS features in the target email body and reports compatibility across major email clients and devices. Check client support for features used in a stored email body

Detects HTML/CSS features in the target email body and reports compatibility across major email clients and devices. Check client support for features used in a stored email body

Runs content quality checks against hydrated email body content. This endpoint performs outbound HTTP checks for linked resources, so avoid use with sensitive or stateful URLs. Check email body for broken links, images, and spelling issues

Evaluates HTML/CSS features in the supplied body and reports support coverage across major email clients and platforms. Check email-client support for a provided HTML body

Evaluates HTML/CSS features in the supplied body and reports support coverage across major email clients and platforms. Check email-client support for a provided HTML body

Deletes all emails for the authenticated account context. This operation is destructive and cannot be undone. Delete all emails in all inboxes.

Deletes all emails for the authenticated account context. This operation is destructive and cannot be undone. Delete all emails in all inboxes.

Deletes a single email from account scope. Operation is destructive and not reversible. Delete an email

Deletes a single email from account scope. Operation is destructive and not reversible. Delete an email

Returns attachment bytes by attachment ID. Use attachment IDs from email payloads or attachment listing endpoints. Get email attachment bytes. Returned as octet-stream with content type header. If you have trouble with byte responses try the downloadAttachmentBase64 response endpoints and convert the base 64 encoded content to a file or string.

Returns attachment payload as base64 in JSON. Useful for clients that cannot reliably consume binary streaming responses. Get email attachment as base64 encoded string as an alternative to binary responses. Decode the base64FileContents as a utf-8 encoded string or array of bytes depending on the contentType.

Returns attachment payload as base64 in JSON. Useful for clients that cannot reliably consume binary streaming responses. Get email attachment as base64 encoded string as an alternative to binary responses. Decode the base64FileContents as a utf-8 encoded string or array of bytes depending on the contentType.

Returns attachment bytes by attachment ID. Use attachment IDs from email payloads or attachment listing endpoints. Get email attachment bytes. Returned as octet-stream with content type header. If you have trouble with byte responses try the downloadAttachmentBase64 response endpoints and convert the base 64 encoded content to a file or string.

Returns hydrated email body text as a string with content type aligned to the underlying body format. Get email body as string. Returned as plain/text with content type header.

Streams hydrated email body bytes with content type derived from the message body format. Get email body in bytes. Returned as octet-stream with content type header.

Streams hydrated email body bytes with content type derived from the message body format. Get email body in bytes. Returned as octet-stream with content type header.

Returns hydrated email body text as a string with content type aligned to the underlying body format. Get email body as string. Returned as plain/text with content type header.

Forwards an existing email to new recipients. Uses the owning inbox context unless overridden by allowed sender options. Forward email to recipients

Forwards an existing email to new recipients. Uses the owning inbox context unless overridden by allowed sender options. Forward email to recipients

Returns metadata for a specific attachment ID (name, content type, and size fields). Get email attachment metadata. This is the contentType and contentLength of an attachment. To get the individual attachments use the downloadAttachment methods.

Returns metadata for a specific attachment ID (name, content type, and size fields). Get email attachment metadata. This is the contentType and contentLength of an attachment. To get the individual attachments use the downloadAttachment methods.

Returns parsed email content including headers and body fields. Accessing hydrated content may mark the email as read depending on read-state rules. Get hydrated email (headers and body)

Returns metadata for all attachment IDs associated with the email (name, content type, size, and IDs). List attachment metadata for an email

Returns metadata for all attachment IDs associated with the email (name, content type, size, and IDs). List attachment metadata for an email

Extracts one-time passcodes and similar tokens from email content. Supports deterministic extraction now with method/fallback flags (AUTO, PATTERN, LLM, OCR, OCR_THEN_LLM) for QA and future advanced pipelines. Extract verification codes from an email

Extracts one-time passcodes and similar tokens from email content. Supports deterministic extraction now with method/fallback flags (AUTO, PATTERN, LLM, OCR, OCR_THEN_LLM) for QA and future advanced pipelines. Extract verification codes from an email

Executes a Java regex pattern over hydrated email body text and returns the full match plus capture groups. Pattern syntax follows Java Pattern rules. Run regex against hydrated email body and return matches

Executes a Java regex pattern over hydrated email body text and returns the full match plus capture groups. Pattern syntax follows Java Pattern rules. Run regex against hydrated email body and return matches

Extracts one MIME body part by contentType and optional index, returned in a structured DTO with metadata. Get email content part by content type

Extracts one MIME body part by contentType and optional index, and returns raw content with matching response content type when valid. Get multipart content part as raw response

Extracts one MIME body part by contentType and optional index, and returns raw content with matching response content type when valid. Get multipart content part as raw response

Extracts one MIME body part by contentType and optional index, returned in a structured DTO with metadata. Get email content part by content type

Returns total email count for the authenticated user, or count scoped to a specific inbox when inboxId is provided. Get email count

Returns total email count for the authenticated user, or count scoped to a specific inbox when inboxId is provided. Get email count

Returns hydrated HTML body directly with text/html content type. Supports temporary access/browser usage and optional CID replacement for inline asset rendering. Get hydrated email HTML for browser rendering

Returns hydrated HTML body and subject in a JSON DTO. Useful for API clients that need structured response payloads instead of raw HTML responses. Get hydrated email HTML wrapped in JSON

Returns hydrated HTML body and subject in a JSON DTO. Useful for API clients that need structured response payloads instead of raw HTML responses. Get hydrated email HTML wrapped in JSON

Applies a JSoup/CSS selector to hydrated HTML email body and returns matching text lines. Query hydrated HTML body and return matching text lines

Applies a JSoup/CSS selector to hydrated HTML email body and returns matching text lines. Query hydrated HTML body and return matching text lines

Returns hydrated HTML body directly with text/html content type. Supports temporary access/browser usage and optional CID replacement for inline asset rendering. Get hydrated email HTML for browser rendering

Parses HTML content and extracts link URLs (href). For non-HTML emails this endpoint returns a validation error. Extract links from an email HTML body

Parses HTML content and extracts link URLs (href). For non-HTML emails this endpoint returns a validation error. Extract links from an email HTML body

Returns precomputed URLs for preview and raw message access for the specified email. Get email URLs for viewing in browser or downloading

Returns precomputed URLs for preview and raw message access for the specified email. Get email URLs for viewing in browser or downloading

Returns parsed email content including headers and body fields. Accessing hydrated content may mark the email as read depending on read-state rules. Get hydrated email (headers and body)

Renders the email in a browser engine and returns PNG data as base64. Useful for APIs and dashboards that cannot easily stream binary responses. Take a screenshot of an email in a browser and return base64 encoded string

Renders the email in a browser engine and returns PNG data as base64. Useful for APIs and dashboards that cannot easily stream binary responses. Take a screenshot of an email in a browser and return base64 encoded string

Renders the email in a browser engine and returns PNG bytes. Intended for visual QA and rendering regression checks. Take a screenshot of an email in a browser

Renders the email in a browser engine and returns PNG bytes. Intended for visual QA and rendering regression checks. Take a screenshot of an email in a browser

Attempts to parse a sender signature block from an email body. Uses raw MIME content parts when possible and falls back to hydrated body parsing. This is heuristic and may not be accurate for all email clients or formats. Extract signature from an inbound email

Attempts to parse a sender signature block from an email body. Uses raw MIME content parts when possible and falls back to hydrated body parsing. This is heuristic and may not be accurate for all email clients or formats. Extract signature from an inbound email

Returns lightweight metadata and headers for an email. Use getEmail for hydrated body content or getRawEmail for original SMTP content. Get email summary (headers/metadata only)

Returns lightweight metadata and headers for an email. Use getEmail for hydrated body content or getRawEmail for original SMTP content. Get email summary (headers/metadata only)

Converts email body content to line-based plain text with optional HTML entity decoding and custom line separator. Extract normalized text lines from email body

Converts email body content to line-based plain text with optional HTML entity decoding and custom line separator. Extract normalized text lines from email body

Returns thread metadata built from RFC 5322 Message-ID, In-Reply-To, and References headers. Use getEmailThreadItems to fetch the thread messages. Get email thread metadata by thread ID

Returns all messages in a thread ordered by createdAt using the requested sort direction. Get messages in a specific email thread

Returns all messages in a thread ordered by createdAt using the requested sort direction. Get messages in a specific email thread

Returns thread metadata built from RFC 5322 Message-ID, In-Reply-To, and References headers. Use getEmailThreadItems to fetch the thread messages. Get email thread metadata by thread ID

Lists conversation threads inferred from Message-ID, In-Reply-To, and References. Supports filtering by inbox, search text, and time range. List email threads in paginated form

Lists conversation threads inferred from Message-ID, In-Reply-To, and References. Supports filtering by inbox, search text, and time range. List email threads in paginated form

Offset-style pagination endpoint for listing emails across inboxes. Supports inbox filters, unread-only, search, date boundaries, favourites, connector sync, plus-address filtering, and explicit include IDs. Get all emails in all inboxes in paginated form. Email API list all.

Offset-style pagination endpoint for listing emails across inboxes. Supports inbox filters, unread-only, search, date boundaries, favourites, connector sync, plus-address filtering, and explicit include IDs. Get all emails in all inboxes in paginated form. Email API list all.

Primary paginated email listing endpoint. Returns emails across inboxes with support for inbox filters, unread-only, search, date boundaries, favourites, connector sync, and plus-address filtering. Get all emails in all inboxes in paginated form. Email API list all.

Primary paginated email listing endpoint. Returns emails across inboxes with support for inbox filters, unread-only, search, date boundaries, favourites, connector sync, and plus-address filtering. Get all emails in all inboxes in paginated form. Email API list all.

Builds a Gravatar image URL from the provided email address and optional size. This endpoint does not fetch image bytes; it only returns the computed URL. Get Gravatar URL for an email address

Builds a Gravatar image URL from the provided email address and optional size. This endpoint does not fetch image bytes; it only returns the computed URL. Get Gravatar URL for an email address

Returns the most recently received email across all inboxes or an optional subset of inbox IDs. Get latest email in all inboxes. Most recently received.

Returns the newest email for the specified inbox ID. For polling/wait semantics use wait endpoints. Get latest email in an inbox. Use WaitForController to get emails that may not have arrived yet.

Returns the newest email for the specified inbox ID. For polling/wait semantics use wait endpoints. Get latest email in an inbox. Use WaitForController to get emails that may not have arrived yet.

Returns the most recently received email across all inboxes or an optional subset of inbox IDs. Get latest email in all inboxes. Most recently received.

Returns paginated emails visible through organization/team access. Supports inbox filtering, unread-only filtering, search, favourites, plus-address filtering, and optional connector sync. List organization-visible emails

Returns paginated emails visible through organization/team access. Supports inbox filtering, unread-only filtering, search, favourites, plus-address filtering, and optional connector sync. List organization-visible emails

Returns the original unparsed SMTP/MIME message as text/plain. Use JSON variant if your client expects JSON transport. Get raw email string. Returns unparsed raw SMTP message with headers and body.

Returns the original unparsed SMTP/MIME message as text/plain. Use JSON variant if your client expects JSON transport. Get raw email string. Returns unparsed raw SMTP message with headers and body.

Returns the original unparsed SMTP/MIME message wrapped in a JSON DTO for API clients that avoid plain-text stream responses. Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.

Returns the original unparsed SMTP/MIME message wrapped in a JSON DTO for API clients that avoid plain-text stream responses. Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.

Returns unread email count. An email is considered read after dashboard/API retrieval depending on your read workflow. Get unread email count

Returns unread email count. An email is considered read after dashboard/API retrieval depending on your read workflow. Get unread email count

Sets read state for all emails, optionally scoped to one inbox. Use read=false to reset unread state in bulk. Mark all emails as read or unread

Sets read state for all emails, optionally scoped to one inbox. Use read=false to reset unread state in bulk. Mark all emails as read or unread

Sets read state for one email. Useful when implementing custom mailbox workflows that treat viewed messages as unread. Mark an email as read or unread

Sets read state for one email. Useful when implementing custom mailbox workflows that treat viewed messages as unread. Mark an email as read or unread

Sends a reply using the original conversation context (subject/thread headers). Reply target resolution honors sender/reply-to semantics. Reply to an email

Sends a reply using the original conversation context (subject/thread headers). Reply target resolution honors sender/reply-to semantics. Reply to an email

Searches emails by sender/recipient/address/subject/id fields and returns paginated matches. Does not perform full-text body search. Get all emails by search criteria. Return in paginated form.

Searches emails by sender/recipient/address/subject/id fields and returns paginated matches. Does not perform full-text body search. Get all emails by search criteria. Return in paginated form.

Sends an email from an existing inbox, or creates a temporary inbox when inboxId is not provided. Supports useDomainPool and virtualSend inbox creation behavior for convenience sends. Send email

Sends an email from an existing inbox, or creates a temporary inbox when inboxId is not provided. Supports useDomainPool and virtualSend inbox creation behavior for convenience sends. Send email

Sets favourite state for an email for dashboard/search workflows. Set email favourited state

Sets favourite state for an email for dashboard/search workflows. Set email favourited state

Runs HTML validation on the email body when HTML is present. Non-HTML emails are treated as valid for this check. Validate email HTML contents

Runs HTML validation on the email body when HTML is present. Non-HTML emails are treated as valid for this check. Validate email HTML contents