/** * MailSlurp API * MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. It\'s designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository * * The version of the OpenAPI document: 6.5.2 * Contact: contact@mailslurp.dev * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { AttachmentMetaData, CanSendEmailResults, CheckEmailBodyFeatureSupportResults, CheckEmailBodyResults, CheckEmailClientSupportOptions, CheckEmailClientSupportResults, ContentMatchOptions, CountDto, DownloadAttachmentDto, Email, EmailAuditAnalysisResult, EmailAuditDto, EmailContentMatchResult, EmailContentPartResult, EmailHtmlDto, EmailLinksResult, EmailPreview, EmailPreviewUrls, EmailScreenshotResult, EmailSignatureParseResult, EmailTextLinesResult, EmailThreadDto, EmailThreadItemsDto, ExtractCodesOptions, ExtractCodesResult, ForwardEmailOptions, GetEmailScreenshotOptions, GravatarUrl, ImapFlagOperationOptions, PageEmailProjection, PageEmailThreadProjection, RawEmailJson, ReplyToEmailOptions, SearchEmailsOptions, SendEmailOptions, SentEmailDto, UnreadCount, ValidationDto } from '../models'; export interface ApplyImapFlagOperationRequest { emailId: string; imapFlagOperationOptions: ImapFlagOperationOptions; } export interface CanSendRequest { inboxId: string; sendEmailOptions: SendEmailOptions; } export interface CheckEmailAudit1Request { emailId: string; } export interface CheckEmailBodyRequest { emailId: string; } export interface CheckEmailBodyFeatureSupportRequest { emailId: string; } export interface CheckEmailClientSupportRequest { checkEmailClientSupportOptions: CheckEmailClientSupportOptions; } export interface CreateEmailAuditForEmailRequest { emailId: string; } export interface DeleteEmailRequest { emailId: string; } export interface DownloadAttachmentRequest { emailId: string; attachmentId: string; apiKey?: string; } export interface DownloadAttachmentBase64Request { emailId: string; attachmentId: string; } export interface DownloadBodyRequest { emailId: string; } export interface DownloadBodyBytesRequest { emailId: string; } export interface ForwardEmailRequest { emailId: string; forwardEmailOptions: ForwardEmailOptions; } export interface GetAttachmentMetaDataRequest { emailId: string; attachmentId: string; } export interface GetEmailRequest { emailId: string; } export interface GetEmailAttachmentsRequest { emailId: string; } export interface GetEmailCodesRequest { emailId: string; extractCodesOptions?: ExtractCodesOptions; } export interface GetEmailContentMatchRequest { emailId: string; contentMatchOptions: ContentMatchOptions; } export interface GetEmailContentPartRequest { emailId: string; contentType: string; strict?: boolean; index?: number; } export interface GetEmailContentPartContentRequest { emailId: string; contentType: string; strict?: boolean; index?: number; } export interface GetEmailCountRequest { inboxId?: string; } export interface GetEmailHTMLRequest { emailId: string; replaceCidImages?: boolean; } export interface GetEmailHTMLJsonRequest { emailId: string; replaceCidImages?: boolean; } export interface GetEmailHTMLQueryRequest { emailId: string; htmlSelector: string; } export interface GetEmailLinksRequest { emailId: string; selector?: string; } export interface GetEmailPreviewURLsRequest { emailId: string; } export interface GetEmailScreenshotAsBase64Request { emailId: string; getEmailScreenshotOptions: GetEmailScreenshotOptions; } export interface GetEmailScreenshotAsBinaryRequest { emailId: string; getEmailScreenshotOptions: GetEmailScreenshotOptions; } export interface GetEmailSignatureRequest { emailId: string; } export interface GetEmailSummaryRequest { emailId: string; decode?: boolean; } export interface GetEmailTextLinesRequest { emailId: string; decodeHtmlEntities?: boolean; lineSeparator?: string; } export interface GetEmailThreadRequest { threadId: string; } export interface GetEmailThreadItemsRequest { threadId: string; sort?: GetEmailThreadItemsSortEnum; } export interface GetEmailThreadsRequest { htmlSelector?: string; page?: number; size?: number; sort?: GetEmailThreadsSortEnum; searchFilter?: string; since?: Date; before?: Date; } export interface GetEmailsOffsetPaginatedRequest { inboxId?: Array; page?: number; size?: number; sort?: GetEmailsOffsetPaginatedSortEnum; unreadOnly?: boolean; searchFilter?: string; since?: Date; before?: Date; favourited?: boolean; syncConnectors?: boolean; plusAddressId?: string; include?: Array; } export interface GetEmailsPaginatedRequest { inboxId?: Array; page?: number; size?: number; sort?: GetEmailsPaginatedSortEnum; unreadOnly?: boolean; searchFilter?: string; since?: Date; before?: Date; syncConnectors?: boolean; plusAddressId?: string; favourited?: boolean; } export interface GetGravatarUrlForEmailAddressRequest { emailAddress: string; size?: string; } export interface GetLatestEmailRequest { inboxIds?: Array; } export interface GetLatestEmailInInbox1Request { inboxId: string; } export interface GetOrganizationEmailsPaginatedRequest { inboxId?: Array; page?: number; size?: number; sort?: GetOrganizationEmailsPaginatedSortEnum; unreadOnly?: boolean; searchFilter?: string; since?: Date; before?: Date; syncConnectors?: boolean; favourited?: boolean; plusAddressId?: string; } export interface GetRawEmailContentsRequest { emailId: string; } export interface GetRawEmailJsonRequest { emailId: string; } export interface GetUnreadEmailCountRequest { inboxId?: string; } export interface MarkAllAsReadRequest { read?: boolean; inboxId?: string; } export interface MarkAsReadRequest { emailId: string; read?: boolean; } export interface ReplyToEmailRequest { emailId: string; replyToEmailOptions: ReplyToEmailOptions; } export interface SearchEmailsRequest { searchEmailsOptions: SearchEmailsOptions; syncConnectors?: boolean; favourited?: boolean; plusAddressId?: string; } export interface SendEmailSourceOptionalRequest { sendEmailOptions: SendEmailOptions; inboxId?: string; useDomainPool?: boolean; virtualSend?: boolean; } export interface SetEmailFavouritedRequest { emailId: string; favourited: boolean; } export interface ValidateEmailRequest { emailId: string; } /** * */ export declare class EmailControllerApi extends runtime.BaseAPI { /** * 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. */ applyImapFlagOperationRaw(requestParameters: ApplyImapFlagOperationRequest, initOverrides?: RequestInit): Promise>; /** * 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. */ applyImapFlagOperation(requestParameters: ApplyImapFlagOperationRequest, initOverrides?: RequestInit): Promise; /** * 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 */ canSendRaw(requestParameters: CanSendRequest, initOverrides?: RequestInit): Promise>; /** * 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 */ canSend(requestParameters: CanSendRequest, initOverrides?: RequestInit): Promise; /** * Runs the same message-level audit bundle used by the email audit dashboard in one request. Combines content checks, HTML validation, compatibility analysis, and reputation verdict rollup when available. * Run aggregate email audit for a stored email */ checkEmailAudit1Raw(requestParameters: CheckEmailAudit1Request, initOverrides?: RequestInit): Promise>; /** * Runs the same message-level audit bundle used by the email audit dashboard in one request. Combines content checks, HTML validation, compatibility analysis, and reputation verdict rollup when available. * Run aggregate email audit for a stored email */ checkEmailAudit1(requestParameters: CheckEmailAudit1Request, initOverrides?: RequestInit): Promise; /** * 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 */ checkEmailBodyRaw(requestParameters: CheckEmailBodyRequest, initOverrides?: RequestInit): Promise>; /** * 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 */ checkEmailBody(requestParameters: CheckEmailBodyRequest, initOverrides?: RequestInit): Promise; /** * 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 */ checkEmailBodyFeatureSupportRaw(requestParameters: CheckEmailBodyFeatureSupportRequest, initOverrides?: RequestInit): Promise>; /** * 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 */ checkEmailBodyFeatureSupport(requestParameters: CheckEmailBodyFeatureSupportRequest, initOverrides?: RequestInit): Promise; /** * 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 */ checkEmailClientSupportRaw(requestParameters: CheckEmailClientSupportRequest, initOverrides?: RequestInit): Promise>; /** * 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 */ checkEmailClientSupport(requestParameters: CheckEmailClientSupportRequest, initOverrides?: RequestInit): Promise; /** * Runs the aggregate audit bundle for the target email and stores the resulting audit record for later review and history tracking. * Persist aggregate email audit for a stored email */ createEmailAuditForEmailRaw(requestParameters: CreateEmailAuditForEmailRequest, initOverrides?: RequestInit): Promise>; /** * Runs the aggregate audit bundle for the target email and stores the resulting audit record for later review and history tracking. * Persist aggregate email audit for a stored email */ createEmailAuditForEmail(requestParameters: CreateEmailAuditForEmailRequest, initOverrides?: RequestInit): Promise; /** * Deletes all emails for the authenticated account context. This operation is destructive and cannot be undone. * Delete all emails in all inboxes. */ deleteAllEmailsRaw(initOverrides?: RequestInit): Promise>; /** * Deletes all emails for the authenticated account context. This operation is destructive and cannot be undone. * Delete all emails in all inboxes. */ deleteAllEmails(initOverrides?: RequestInit): Promise; /** * Deletes a single email from account scope. Operation is destructive and not reversible. * Delete an email */ deleteEmailRaw(requestParameters: DeleteEmailRequest, initOverrides?: RequestInit): Promise>; /** * Deletes a single email from account scope. Operation is destructive and not reversible. * Delete an email */ deleteEmail(requestParameters: DeleteEmailRequest, initOverrides?: RequestInit): Promise; /** * 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. */ downloadAttachmentRaw(requestParameters: DownloadAttachmentRequest, initOverrides?: RequestInit): Promise>; /** * 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. */ downloadAttachment(requestParameters: DownloadAttachmentRequest, initOverrides?: RequestInit): Promise; /** * 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`. */ downloadAttachmentBase64Raw(requestParameters: DownloadAttachmentBase64Request, initOverrides?: RequestInit): Promise>; /** * 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`. */ downloadAttachmentBase64(requestParameters: DownloadAttachmentBase64Request, initOverrides?: RequestInit): Promise; /** * 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. */ downloadBodyRaw(requestParameters: DownloadBodyRequest, initOverrides?: RequestInit): Promise>; /** * 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. */ downloadBody(requestParameters: DownloadBodyRequest, initOverrides?: RequestInit): Promise; /** * 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. */ downloadBodyBytesRaw(requestParameters: DownloadBodyBytesRequest, initOverrides?: RequestInit): Promise>; /** * 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. */ downloadBodyBytes(requestParameters: DownloadBodyBytesRequest, initOverrides?: RequestInit): Promise; /** * Forwards an existing email to new recipients. Uses the owning inbox context unless overridden by allowed sender options. * Forward email to recipients */ forwardEmailRaw(requestParameters: ForwardEmailRequest, initOverrides?: RequestInit): Promise>; /** * Forwards an existing email to new recipients. Uses the owning inbox context unless overridden by allowed sender options. * Forward email to recipients */ forwardEmail(requestParameters: ForwardEmailRequest, initOverrides?: RequestInit): Promise; /** * 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. */ getAttachmentMetaDataRaw(requestParameters: GetAttachmentMetaDataRequest, initOverrides?: RequestInit): Promise>; /** * 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. */ getAttachmentMetaData(requestParameters: GetAttachmentMetaDataRequest, initOverrides?: RequestInit): Promise; /** * 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) */ getEmailRaw(requestParameters: GetEmailRequest, initOverrides?: RequestInit): Promise>; /** * 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) */ getEmail(requestParameters: GetEmailRequest, initOverrides?: RequestInit): Promise; /** * Returns metadata for all attachment IDs associated with the email (name, content type, size, and IDs). * List attachment metadata for an email */ getEmailAttachmentsRaw(requestParameters: GetEmailAttachmentsRequest, initOverrides?: RequestInit): Promise>>; /** * Returns metadata for all attachment IDs associated with the email (name, content type, size, and IDs). * List attachment metadata for an email */ getEmailAttachments(requestParameters: GetEmailAttachmentsRequest, initOverrides?: RequestInit): Promise>; /** * Extracts one-time passcodes and similar tokens from email content using the selected extraction method and fallback options. * Extract verification codes from an email */ getEmailCodesRaw(requestParameters: GetEmailCodesRequest, initOverrides?: RequestInit): Promise>; /** * Extracts one-time passcodes and similar tokens from email content using the selected extraction method and fallback options. * Extract verification codes from an email */ getEmailCodes(requestParameters: GetEmailCodesRequest, initOverrides?: RequestInit): Promise; /** * 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 */ getEmailContentMatchRaw(requestParameters: GetEmailContentMatchRequest, initOverrides?: RequestInit): Promise>; /** * 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 */ getEmailContentMatch(requestParameters: GetEmailContentMatchRequest, initOverrides?: RequestInit): Promise; /** * Extracts one MIME body part by `contentType` and optional `index`, returned in a structured DTO with metadata. * Get email content part by content type */ getEmailContentPartRaw(requestParameters: GetEmailContentPartRequest, initOverrides?: RequestInit): Promise>; /** * Extracts one MIME body part by `contentType` and optional `index`, returned in a structured DTO with metadata. * Get email content part by content type */ getEmailContentPart(requestParameters: GetEmailContentPartRequest, initOverrides?: RequestInit): Promise; /** * 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 */ getEmailContentPartContentRaw(requestParameters: GetEmailContentPartContentRequest, initOverrides?: RequestInit): Promise>; /** * 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 */ getEmailContentPartContent(requestParameters: GetEmailContentPartContentRequest, initOverrides?: RequestInit): Promise; /** * Returns total email count for the authenticated user, or count scoped to a specific inbox when `inboxId` is provided. * Get email count */ getEmailCountRaw(requestParameters: GetEmailCountRequest, initOverrides?: RequestInit): Promise>; /** * Returns total email count for the authenticated user, or count scoped to a specific inbox when `inboxId` is provided. * Get email count */ getEmailCount(requestParameters: GetEmailCountRequest, initOverrides?: RequestInit): Promise; /** * 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 */ getEmailHTMLRaw(requestParameters: GetEmailHTMLRequest, initOverrides?: RequestInit): Promise>; /** * 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 */ getEmailHTML(requestParameters: GetEmailHTMLRequest, initOverrides?: RequestInit): Promise; /** * 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 */ getEmailHTMLJsonRaw(requestParameters: GetEmailHTMLJsonRequest, initOverrides?: RequestInit): Promise>; /** * 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 */ getEmailHTMLJson(requestParameters: GetEmailHTMLJsonRequest, initOverrides?: RequestInit): Promise; /** * Applies a JSoup/CSS selector to hydrated HTML email body and returns matching text lines. * Query hydrated HTML body and return matching text lines */ getEmailHTMLQueryRaw(requestParameters: GetEmailHTMLQueryRequest, initOverrides?: RequestInit): Promise>; /** * Applies a JSoup/CSS selector to hydrated HTML email body and returns matching text lines. * Query hydrated HTML body and return matching text lines */ getEmailHTMLQuery(requestParameters: GetEmailHTMLQueryRequest, initOverrides?: RequestInit): Promise; /** * 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 */ getEmailLinksRaw(requestParameters: GetEmailLinksRequest, initOverrides?: RequestInit): Promise>; /** * 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 */ getEmailLinks(requestParameters: GetEmailLinksRequest, initOverrides?: RequestInit): Promise; /** * Returns precomputed URLs for preview and raw message access for the specified email. * Get email URLs for viewing in browser or downloading */ getEmailPreviewURLsRaw(requestParameters: GetEmailPreviewURLsRequest, initOverrides?: RequestInit): Promise>; /** * Returns precomputed URLs for preview and raw message access for the specified email. * Get email URLs for viewing in browser or downloading */ getEmailPreviewURLs(requestParameters: GetEmailPreviewURLsRequest, initOverrides?: RequestInit): Promise; /** * 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 */ getEmailScreenshotAsBase64Raw(requestParameters: GetEmailScreenshotAsBase64Request, initOverrides?: RequestInit): Promise>; /** * 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 */ getEmailScreenshotAsBase64(requestParameters: GetEmailScreenshotAsBase64Request, initOverrides?: RequestInit): Promise; /** * 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 */ getEmailScreenshotAsBinaryRaw(requestParameters: GetEmailScreenshotAsBinaryRequest, initOverrides?: RequestInit): Promise>; /** * 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 */ getEmailScreenshotAsBinary(requestParameters: GetEmailScreenshotAsBinaryRequest, initOverrides?: RequestInit): Promise; /** * 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 */ getEmailSignatureRaw(requestParameters: GetEmailSignatureRequest, initOverrides?: RequestInit): Promise>; /** * 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 */ getEmailSignature(requestParameters: GetEmailSignatureRequest, initOverrides?: RequestInit): Promise; /** * 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) */ getEmailSummaryRaw(requestParameters: GetEmailSummaryRequest, initOverrides?: RequestInit): Promise>; /** * 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) */ getEmailSummary(requestParameters: GetEmailSummaryRequest, initOverrides?: RequestInit): Promise; /** * 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 */ getEmailTextLinesRaw(requestParameters: GetEmailTextLinesRequest, initOverrides?: RequestInit): Promise>; /** * 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 */ getEmailTextLines(requestParameters: GetEmailTextLinesRequest, initOverrides?: RequestInit): Promise; /** * 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 */ getEmailThreadRaw(requestParameters: GetEmailThreadRequest, initOverrides?: RequestInit): Promise>; /** * 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 */ getEmailThread(requestParameters: GetEmailThreadRequest, initOverrides?: RequestInit): Promise; /** * Returns all messages in a thread ordered by `createdAt` using the requested sort direction. * Get messages in a specific email thread */ getEmailThreadItemsRaw(requestParameters: GetEmailThreadItemsRequest, initOverrides?: RequestInit): Promise>; /** * Returns all messages in a thread ordered by `createdAt` using the requested sort direction. * Get messages in a specific email thread */ getEmailThreadItems(requestParameters: GetEmailThreadItemsRequest, initOverrides?: RequestInit): Promise; /** * 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 */ getEmailThreadsRaw(requestParameters: GetEmailThreadsRequest, initOverrides?: RequestInit): Promise>; /** * 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 */ getEmailThreads(requestParameters: GetEmailThreadsRequest, initOverrides?: RequestInit): Promise; /** * 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. */ getEmailsOffsetPaginatedRaw(requestParameters: GetEmailsOffsetPaginatedRequest, initOverrides?: RequestInit): Promise>; /** * 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. */ getEmailsOffsetPaginated(requestParameters: GetEmailsOffsetPaginatedRequest, initOverrides?: RequestInit): Promise; /** * 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. */ getEmailsPaginatedRaw(requestParameters: GetEmailsPaginatedRequest, initOverrides?: RequestInit): Promise>; /** * 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. */ getEmailsPaginated(requestParameters: GetEmailsPaginatedRequest, initOverrides?: RequestInit): Promise; /** * 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 */ getGravatarUrlForEmailAddressRaw(requestParameters: GetGravatarUrlForEmailAddressRequest, initOverrides?: RequestInit): Promise>; /** * 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 */ getGravatarUrlForEmailAddress(requestParameters: GetGravatarUrlForEmailAddressRequest, initOverrides?: RequestInit): Promise; /** * 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. */ getLatestEmailRaw(requestParameters: GetLatestEmailRequest, initOverrides?: RequestInit): Promise>; /** * 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. */ getLatestEmail(requestParameters: GetLatestEmailRequest, initOverrides?: RequestInit): Promise; /** * 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. */ getLatestEmailInInbox1Raw(requestParameters: GetLatestEmailInInbox1Request, initOverrides?: RequestInit): Promise>; /** * 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. */ getLatestEmailInInbox1(requestParameters: GetLatestEmailInInbox1Request, initOverrides?: RequestInit): Promise; /** * 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 */ getOrganizationEmailsPaginatedRaw(requestParameters: GetOrganizationEmailsPaginatedRequest, initOverrides?: RequestInit): Promise>; /** * 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 */ getOrganizationEmailsPaginated(requestParameters: GetOrganizationEmailsPaginatedRequest, initOverrides?: RequestInit): Promise; /** * 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. */ getRawEmailContentsRaw(requestParameters: GetRawEmailContentsRequest, initOverrides?: RequestInit): Promise>; /** * 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. */ getRawEmailContents(requestParameters: GetRawEmailContentsRequest, initOverrides?: RequestInit): Promise; /** * 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. */ getRawEmailJsonRaw(requestParameters: GetRawEmailJsonRequest, initOverrides?: RequestInit): Promise>; /** * 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. */ getRawEmailJson(requestParameters: GetRawEmailJsonRequest, initOverrides?: RequestInit): Promise; /** * Returns unread email count. An email is considered read after dashboard/API retrieval depending on your read workflow. * Get unread email count */ getUnreadEmailCountRaw(requestParameters: GetUnreadEmailCountRequest, initOverrides?: RequestInit): Promise>; /** * Returns unread email count. An email is considered read after dashboard/API retrieval depending on your read workflow. * Get unread email count */ getUnreadEmailCount(requestParameters: GetUnreadEmailCountRequest, initOverrides?: RequestInit): Promise; /** * 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 */ markAllAsReadRaw(requestParameters: MarkAllAsReadRequest, initOverrides?: RequestInit): Promise>; /** * 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 */ markAllAsRead(requestParameters: MarkAllAsReadRequest, initOverrides?: RequestInit): Promise; /** * 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 */ markAsReadRaw(requestParameters: MarkAsReadRequest, initOverrides?: RequestInit): Promise>; /** * 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 */ markAsRead(requestParameters: MarkAsReadRequest, initOverrides?: RequestInit): Promise; /** * Sends a reply using the original conversation context (subject/thread headers). Reply target resolution honors sender/reply-to semantics. * Reply to an email */ replyToEmailRaw(requestParameters: ReplyToEmailRequest, initOverrides?: RequestInit): Promise>; /** * Sends a reply using the original conversation context (subject/thread headers). Reply target resolution honors sender/reply-to semantics. * Reply to an email */ replyToEmail(requestParameters: ReplyToEmailRequest, initOverrides?: RequestInit): Promise; /** * 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. */ searchEmailsRaw(requestParameters: SearchEmailsRequest, initOverrides?: RequestInit): Promise>; /** * 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. */ searchEmails(requestParameters: SearchEmailsRequest, initOverrides?: RequestInit): Promise; /** * 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 */ sendEmailSourceOptionalRaw(requestParameters: SendEmailSourceOptionalRequest, initOverrides?: RequestInit): Promise>; /** * 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 */ sendEmailSourceOptional(requestParameters: SendEmailSourceOptionalRequest, initOverrides?: RequestInit): Promise; /** * Sets favourite state for an email for dashboard/search workflows. * Set email favourited state */ setEmailFavouritedRaw(requestParameters: SetEmailFavouritedRequest, initOverrides?: RequestInit): Promise>; /** * Sets favourite state for an email for dashboard/search workflows. * Set email favourited state */ setEmailFavourited(requestParameters: SetEmailFavouritedRequest, initOverrides?: RequestInit): Promise; /** * 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 */ validateEmailRaw(requestParameters: ValidateEmailRequest, initOverrides?: RequestInit): Promise>; /** * 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 */ validateEmail(requestParameters: ValidateEmailRequest, initOverrides?: RequestInit): Promise; } /** * @export * @enum {string} */ export declare enum GetEmailThreadItemsSortEnum { ASC = "ASC", DESC = "DESC" } /** * @export * @enum {string} */ export declare enum GetEmailThreadsSortEnum { ASC = "ASC", DESC = "DESC" } /** * @export * @enum {string} */ export declare enum GetEmailsOffsetPaginatedSortEnum { ASC = "ASC", DESC = "DESC" } /** * @export * @enum {string} */ export declare enum GetEmailsPaginatedSortEnum { ASC = "ASC", DESC = "DESC" } /** * @export * @enum {string} */ export declare enum GetOrganizationEmailsPaginatedSortEnum { ASC = "ASC", DESC = "DESC" }