Interface IEmailControllerApiSync

Represents a collection of functions to interact with the API endpoints

Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IEmailControllerApiSync : IApiAccessor

Methods

View Source

ApplyImapFlagOperation(Guid, ImapFlagOperationOptions, int)

Set IMAP flags associated with a message. Only supports '\Seen' flag.

Declaration
EmailPreview ApplyImapFlagOperation(Guid emailId, ImapFlagOperationOptions imapFlagOperationOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
ImapFlagOperationOptions imapFlagOperationOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
EmailPreview

EmailPreview
Remarks

Applies RFC3501 IMAP flag operations on a message. Current implementation supports read/unread semantics via the \\\\Seen flag only.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ApplyImapFlagOperationWithHttpInfo(Guid, ImapFlagOperationOptions, int)

Set IMAP flags associated with a message. Only supports '\Seen' flag.

Declaration
ApiResponse<EmailPreview> ApplyImapFlagOperationWithHttpInfo(Guid emailId, ImapFlagOperationOptions imapFlagOperationOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
ImapFlagOperationOptions imapFlagOperationOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<EmailPreview>

ApiResponse of EmailPreview
Remarks

Applies RFC3501 IMAP flag operations on a message. Current implementation supports read/unread semantics via the \\\\Seen flag only.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CanSend(Guid, SendEmailOptions, int)

Check whether an email send would be accepted

Declaration
CanSendEmailResults CanSend(Guid inboxId, SendEmailOptions sendEmailOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid inboxId

ID of the inbox you want to send the email from
SendEmailOptions sendEmailOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
CanSendEmailResults

CanSendEmailResults
Remarks

Validates sender/inbox context and recipient eligibility before attempting a send. Useful for preflight checks in UI or test workflows.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CanSendWithHttpInfo(Guid, SendEmailOptions, int)

Check whether an email send would be accepted

Declaration
ApiResponse<CanSendEmailResults> CanSendWithHttpInfo(Guid inboxId, SendEmailOptions sendEmailOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid inboxId

ID of the inbox you want to send the email from
SendEmailOptions sendEmailOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<CanSendEmailResults>

ApiResponse of CanSendEmailResults
Remarks

Validates sender/inbox context and recipient eligibility before attempting a send. Useful for preflight checks in UI or test workflows.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CheckEmailBody(Guid, int)

Check email body for broken links, images, and spelling issues

Declaration
CheckEmailBodyResults CheckEmailBody(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
int operationIndex

Index associated with the operation.
Returns
Type Description
CheckEmailBodyResults

CheckEmailBodyResults
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CheckEmailBodyFeatureSupport(Guid, int)

Check client support for features used in a stored email body

Declaration
CheckEmailBodyFeatureSupportResults CheckEmailBodyFeatureSupport(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
int operationIndex

Index associated with the operation.
Returns
Type Description
CheckEmailBodyFeatureSupportResults

CheckEmailBodyFeatureSupportResults
Remarks

Detects HTML/CSS features in the target email body and reports compatibility across major email clients and devices.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CheckEmailBodyFeatureSupportWithHttpInfo(Guid, int)

Check client support for features used in a stored email body

Declaration
ApiResponse<CheckEmailBodyFeatureSupportResults> CheckEmailBodyFeatureSupportWithHttpInfo(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<CheckEmailBodyFeatureSupportResults>

ApiResponse of CheckEmailBodyFeatureSupportResults
Remarks

Detects HTML/CSS features in the target email body and reports compatibility across major email clients and devices.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CheckEmailBodyWithHttpInfo(Guid, int)

Check email body for broken links, images, and spelling issues

Declaration
ApiResponse<CheckEmailBodyResults> CheckEmailBodyWithHttpInfo(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<CheckEmailBodyResults>

ApiResponse of CheckEmailBodyResults
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CheckEmailClientSupport(CheckEmailClientSupportOptions, int)

Check email-client support for a provided HTML body

Declaration
CheckEmailClientSupportResults CheckEmailClientSupport(CheckEmailClientSupportOptions checkEmailClientSupportOptions, int operationIndex = 0)
Parameters
Type Name Description
CheckEmailClientSupportOptions checkEmailClientSupportOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
CheckEmailClientSupportResults

CheckEmailClientSupportResults
Remarks

Evaluates HTML/CSS features in the supplied body and reports support coverage across major email clients and platforms.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CheckEmailClientSupportWithHttpInfo(CheckEmailClientSupportOptions, int)

Check email-client support for a provided HTML body

Declaration
ApiResponse<CheckEmailClientSupportResults> CheckEmailClientSupportWithHttpInfo(CheckEmailClientSupportOptions checkEmailClientSupportOptions, int operationIndex = 0)
Parameters
Type Name Description
CheckEmailClientSupportOptions checkEmailClientSupportOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<CheckEmailClientSupportResults>

ApiResponse of CheckEmailClientSupportResults
Remarks

Evaluates HTML/CSS features in the supplied body and reports support coverage across major email clients and platforms.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteAllEmails(int)

Delete all emails in all inboxes.

Declaration
void DeleteAllEmails(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteAllEmailsWithHttpInfo(int)

Delete all emails in all inboxes.

Declaration
ApiResponse<object> DeleteAllEmailsWithHttpInfo(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<object>

ApiResponse of Object(void)
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteEmail(Guid, int)

Delete an email

Declaration
void DeleteEmail(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email to delete
int operationIndex

Index associated with the operation.
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteEmailWithHttpInfo(Guid, int)

Delete an email

Declaration
ApiResponse<object> DeleteEmailWithHttpInfo(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email to delete
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<object>

ApiResponse of Object(void)
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DownloadAttachment(Guid, string, string, int)

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.

Declaration
byte[] DownloadAttachment(Guid emailId, string attachmentId, string apiKey = null, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email
string attachmentId

ID of attachment
string apiKey

Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
byte[]

byte[]
Remarks

Returns attachment bytes by attachment ID. Use attachment IDs from email payloads or attachment listing endpoints.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DownloadAttachmentBase64(Guid, string, int)

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.

Declaration
DownloadAttachmentDto DownloadAttachmentBase64(Guid emailId, string attachmentId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email
string attachmentId

ID of attachment
int operationIndex

Index associated with the operation.
Returns
Type Description
DownloadAttachmentDto

DownloadAttachmentDto
Remarks

Returns attachment payload as base64 in JSON. Useful for clients that cannot reliably consume binary streaming responses.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DownloadAttachmentBase64WithHttpInfo(Guid, string, int)

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.

Declaration
ApiResponse<DownloadAttachmentDto> DownloadAttachmentBase64WithHttpInfo(Guid emailId, string attachmentId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email
string attachmentId

ID of attachment
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<DownloadAttachmentDto>

ApiResponse of DownloadAttachmentDto
Remarks

Returns attachment payload as base64 in JSON. Useful for clients that cannot reliably consume binary streaming responses.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DownloadAttachmentWithHttpInfo(Guid, string, string, int)

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.

Declaration
ApiResponse<byte[]> DownloadAttachmentWithHttpInfo(Guid emailId, string attachmentId, string apiKey = null, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email
string attachmentId

ID of attachment
string apiKey

Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<byte[]>

ApiResponse of byte[]
Remarks

Returns attachment bytes by attachment ID. Use attachment IDs from email payloads or attachment listing endpoints.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DownloadBody(Guid, int)

Get email body as string. Returned as plain/text with content type header.

Declaration
string DownloadBody(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email
int operationIndex

Index associated with the operation.
Returns
Type Description
string

string
Remarks

Returns hydrated email body text as a string with content type aligned to the underlying body format.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DownloadBodyBytes(Guid, int)

Get email body in bytes. Returned as octet-stream with content type header.

Declaration
byte[] DownloadBodyBytes(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email
int operationIndex

Index associated with the operation.
Returns
Type Description
byte[]

byte[]
Remarks

Streams hydrated email body bytes with content type derived from the message body format.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DownloadBodyBytesWithHttpInfo(Guid, int)

Get email body in bytes. Returned as octet-stream with content type header.

Declaration
ApiResponse<byte[]> DownloadBodyBytesWithHttpInfo(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<byte[]>

ApiResponse of byte[]
Remarks

Streams hydrated email body bytes with content type derived from the message body format.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DownloadBodyWithHttpInfo(Guid, int)

Get email body as string. Returned as plain/text with content type header.

Declaration
ApiResponse<string> DownloadBodyWithHttpInfo(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<string>

ApiResponse of string
Remarks

Returns hydrated email body text as a string with content type aligned to the underlying body format.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ForwardEmail(Guid, ForwardEmailOptions, int)

Forward email to recipients

Declaration
SentEmailDto ForwardEmail(Guid emailId, ForwardEmailOptions forwardEmailOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email
ForwardEmailOptions forwardEmailOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
SentEmailDto

SentEmailDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ForwardEmailWithHttpInfo(Guid, ForwardEmailOptions, int)

Forward email to recipients

Declaration
ApiResponse<SentEmailDto> ForwardEmailWithHttpInfo(Guid emailId, ForwardEmailOptions forwardEmailOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email
ForwardEmailOptions forwardEmailOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<SentEmailDto>

ApiResponse of SentEmailDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAttachmentMetaData(Guid, string, int)

Get email attachment metadata. This is the contentType and contentLength of an attachment. To get the individual attachments use the downloadAttachment methods.

Declaration
AttachmentMetaData GetAttachmentMetaData(Guid emailId, string attachmentId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email
string attachmentId

ID of attachment
int operationIndex

Index associated with the operation.
Returns
Type Description
AttachmentMetaData

AttachmentMetaData
Remarks

Returns metadata for a specific attachment ID (name, content type, and size fields).

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAttachmentMetaDataWithHttpInfo(Guid, string, int)

Get email attachment metadata. This is the contentType and contentLength of an attachment. To get the individual attachments use the downloadAttachment methods.

Declaration
ApiResponse<AttachmentMetaData> GetAttachmentMetaDataWithHttpInfo(Guid emailId, string attachmentId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email
string attachmentId

ID of attachment
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<AttachmentMetaData>

ApiResponse of AttachmentMetaData
Remarks

Returns metadata for a specific attachment ID (name, content type, and size fields).

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmail(Guid, int)

Get hydrated email (headers and body)

Declaration
Email GetEmail(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
int operationIndex

Index associated with the operation.
Returns
Type Description
Email

Email
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailAttachments(Guid, int)

List attachment metadata for an email

Declaration
List<AttachmentMetaData> GetEmailAttachments(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email
int operationIndex

Index associated with the operation.
Returns
Type Description
List<AttachmentMetaData>

List<AttachmentMetaData>
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailAttachmentsWithHttpInfo(Guid, int)

List attachment metadata for an email

Declaration
ApiResponse<List<AttachmentMetaData>> GetEmailAttachmentsWithHttpInfo(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<List<AttachmentMetaData>>

ApiResponse of List<AttachmentMetaData>
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailCodes(Guid, ExtractCodesOptions, int)

Extract verification codes from an email

Declaration
ExtractCodesResult GetEmailCodes(Guid emailId, ExtractCodesOptions extractCodesOptions = null, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email to extract codes from
ExtractCodesOptions extractCodesOptions

(optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ExtractCodesResult

ExtractCodesResult
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailCodesWithHttpInfo(Guid, ExtractCodesOptions, int)

Extract verification codes from an email

Declaration
ApiResponse<ExtractCodesResult> GetEmailCodesWithHttpInfo(Guid emailId, ExtractCodesOptions extractCodesOptions = null, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email to extract codes from
ExtractCodesOptions extractCodesOptions

(optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<ExtractCodesResult>

ApiResponse of ExtractCodesResult
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailContentMatch(Guid, ContentMatchOptions, int)

Run regex against hydrated email body and return matches

Declaration
EmailContentMatchResult GetEmailContentMatch(Guid emailId, ContentMatchOptions contentMatchOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email to match against
ContentMatchOptions contentMatchOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
EmailContentMatchResult

EmailContentMatchResult
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailContentMatchWithHttpInfo(Guid, ContentMatchOptions, int)

Run regex against hydrated email body and return matches

Declaration
ApiResponse<EmailContentMatchResult> GetEmailContentMatchWithHttpInfo(Guid emailId, ContentMatchOptions contentMatchOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email to match against
ContentMatchOptions contentMatchOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<EmailContentMatchResult>

ApiResponse of EmailContentMatchResult
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailContentPart(Guid, string, bool?, int?, int)

Get email content part by content type

Declaration
EmailContentPartResult GetEmailContentPart(Guid emailId, string contentType, bool? strict = null, int? index = null, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email to match against
string contentType

Content type
bool? strict

Strict content type match (optional)
int? index

Index of content type part if multiple (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
EmailContentPartResult

EmailContentPartResult
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailContentPartContent(Guid, string, bool?, int?, int)

Get multipart content part as raw response

Declaration
string GetEmailContentPartContent(Guid emailId, string contentType, bool? strict = null, int? index = null, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email to match against
string contentType

Content type
bool? strict

Strict content type match (optional)
int? index

Index of content type part if multiple. Starts from 0 and applies to the result list after selecting for your content type. Content type parts are sorted by order found in original MIME message. (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
string

string
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailContentPartContentWithHttpInfo(Guid, string, bool?, int?, int)

Get multipart content part as raw response

Declaration
ApiResponse<string> GetEmailContentPartContentWithHttpInfo(Guid emailId, string contentType, bool? strict = null, int? index = null, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email to match against
string contentType

Content type
bool? strict

Strict content type match (optional)
int? index

Index of content type part if multiple. Starts from 0 and applies to the result list after selecting for your content type. Content type parts are sorted by order found in original MIME message. (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<string>

ApiResponse of string
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailContentPartWithHttpInfo(Guid, string, bool?, int?, int)

Get email content part by content type

Declaration
ApiResponse<EmailContentPartResult> GetEmailContentPartWithHttpInfo(Guid emailId, string contentType, bool? strict = null, int? index = null, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email to match against
string contentType

Content type
bool? strict

Strict content type match (optional)
int? index

Index of content type part if multiple (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<EmailContentPartResult>

ApiResponse of EmailContentPartResult
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailCount(Guid?, int)

Get email count

Declaration
CountDto GetEmailCount(Guid? inboxId = null, int operationIndex = 0)
Parameters
Type Name Description
Guid? inboxId

(optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
CountDto

CountDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailCountWithHttpInfo(Guid?, int)

Get email count

Declaration
ApiResponse<CountDto> GetEmailCountWithHttpInfo(Guid? inboxId = null, int operationIndex = 0)
Parameters
Type Name Description
Guid? inboxId

(optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<CountDto>

ApiResponse of CountDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailHTML(Guid, bool?, int)

Get hydrated email HTML for browser rendering

Declaration
string GetEmailHTML(Guid emailId, bool? replaceCidImages = null, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
bool? replaceCidImages

(optional, default to false)
int operationIndex

Index associated with the operation.
Returns
Type Description
string

string
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailHTMLJson(Guid, bool?, int)

Get hydrated email HTML wrapped in JSON

Declaration
EmailHtmlDto GetEmailHTMLJson(Guid emailId, bool? replaceCidImages = null, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
bool? replaceCidImages

(optional, default to false)
int operationIndex

Index associated with the operation.
Returns
Type Description
EmailHtmlDto

EmailHtmlDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailHTMLJsonWithHttpInfo(Guid, bool?, int)

Get hydrated email HTML wrapped in JSON

Declaration
ApiResponse<EmailHtmlDto> GetEmailHTMLJsonWithHttpInfo(Guid emailId, bool? replaceCidImages = null, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
bool? replaceCidImages

(optional, default to false)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<EmailHtmlDto>

ApiResponse of EmailHtmlDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailHTMLQuery(Guid, string, int)

Query hydrated HTML body and return matching text lines

Declaration
EmailTextLinesResult GetEmailHTMLQuery(Guid emailId, string htmlSelector, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email to perform HTML query on
string htmlSelector

HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information.
int operationIndex

Index associated with the operation.
Returns
Type Description
EmailTextLinesResult

EmailTextLinesResult
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailHTMLQueryWithHttpInfo(Guid, string, int)

Query hydrated HTML body and return matching text lines

Declaration
ApiResponse<EmailTextLinesResult> GetEmailHTMLQueryWithHttpInfo(Guid emailId, string htmlSelector, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email to perform HTML query on
string htmlSelector

HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information.
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<EmailTextLinesResult>

ApiResponse of EmailTextLinesResult
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailHTMLWithHttpInfo(Guid, bool?, int)

Get hydrated email HTML for browser rendering

Declaration
ApiResponse<string> GetEmailHTMLWithHttpInfo(Guid emailId, bool? replaceCidImages = null, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
bool? replaceCidImages

(optional, default to false)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<string>

ApiResponse of string
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailLinks(Guid, string, int)

Extract links from an email HTML body

Declaration
EmailLinksResult GetEmailLinks(Guid emailId, string selector = null, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email to fetch text for
string selector

Optional HTML query selector for links (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
EmailLinksResult

EmailLinksResult
Remarks

Parses HTML content and extracts link URLs (href). For non-HTML emails this endpoint returns a validation error.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailLinksWithHttpInfo(Guid, string, int)

Extract links from an email HTML body

Declaration
ApiResponse<EmailLinksResult> GetEmailLinksWithHttpInfo(Guid emailId, string selector = null, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email to fetch text for
string selector

Optional HTML query selector for links (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<EmailLinksResult>

ApiResponse of EmailLinksResult
Remarks

Parses HTML content and extracts link URLs (href). For non-HTML emails this endpoint returns a validation error.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailPreviewURLs(Guid, int)

Get email URLs for viewing in browser or downloading

Declaration
EmailPreviewUrls GetEmailPreviewURLs(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
int operationIndex

Index associated with the operation.
Returns
Type Description
EmailPreviewUrls

EmailPreviewUrls
Remarks

Returns precomputed URLs for preview and raw message access for the specified email.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailPreviewURLsWithHttpInfo(Guid, int)

Get email URLs for viewing in browser or downloading

Declaration
ApiResponse<EmailPreviewUrls> GetEmailPreviewURLsWithHttpInfo(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<EmailPreviewUrls>

ApiResponse of EmailPreviewUrls
Remarks

Returns precomputed URLs for preview and raw message access for the specified email.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailScreenshotAsBase64(Guid, GetEmailScreenshotOptions, int)

Take a screenshot of an email in a browser and return base64 encoded string

Declaration
EmailScreenshotResult GetEmailScreenshotAsBase64(Guid emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
GetEmailScreenshotOptions getEmailScreenshotOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
EmailScreenshotResult

EmailScreenshotResult
Remarks

Renders the email in a browser engine and returns PNG data as base64. Useful for APIs and dashboards that cannot easily stream binary responses.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailScreenshotAsBase64WithHttpInfo(Guid, GetEmailScreenshotOptions, int)

Take a screenshot of an email in a browser and return base64 encoded string

Declaration
ApiResponse<EmailScreenshotResult> GetEmailScreenshotAsBase64WithHttpInfo(Guid emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
GetEmailScreenshotOptions getEmailScreenshotOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<EmailScreenshotResult>

ApiResponse of EmailScreenshotResult
Remarks

Renders the email in a browser engine and returns PNG data as base64. Useful for APIs and dashboards that cannot easily stream binary responses.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailScreenshotAsBinary(Guid, GetEmailScreenshotOptions, int)

Take a screenshot of an email in a browser

Declaration
void GetEmailScreenshotAsBinary(Guid emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
GetEmailScreenshotOptions getEmailScreenshotOptions
int operationIndex

Index associated with the operation.
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailScreenshotAsBinaryWithHttpInfo(Guid, GetEmailScreenshotOptions, int)

Take a screenshot of an email in a browser

Declaration
ApiResponse<object> GetEmailScreenshotAsBinaryWithHttpInfo(Guid emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
GetEmailScreenshotOptions getEmailScreenshotOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<object>

ApiResponse of Object(void)
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailSignature(Guid, int)

Extract signature from an inbound email

Declaration
EmailSignatureParseResult GetEmailSignature(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email to extract signature from
int operationIndex

Index associated with the operation.
Returns
Type Description
EmailSignatureParseResult

EmailSignatureParseResult
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailSignatureWithHttpInfo(Guid, int)

Extract signature from an inbound email

Declaration
ApiResponse<EmailSignatureParseResult> GetEmailSignatureWithHttpInfo(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email to extract signature from
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<EmailSignatureParseResult>

ApiResponse of EmailSignatureParseResult
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailSummary(Guid, bool?, int)

Get email summary (headers/metadata only)

Declaration
EmailPreview GetEmailSummary(Guid emailId, bool? decode = null, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
bool? decode

Deprecated and ignored. Retained for backwards compatibility. (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
EmailPreview

EmailPreview
Remarks

Returns lightweight metadata and headers for an email. Use getEmail for hydrated body content or getRawEmail for original SMTP content.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailSummaryWithHttpInfo(Guid, bool?, int)

Get email summary (headers/metadata only)

Declaration
ApiResponse<EmailPreview> GetEmailSummaryWithHttpInfo(Guid emailId, bool? decode = null, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
bool? decode

Deprecated and ignored. Retained for backwards compatibility. (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<EmailPreview>

ApiResponse of EmailPreview
Remarks

Returns lightweight metadata and headers for an email. Use getEmail for hydrated body content or getRawEmail for original SMTP content.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailTextLines(Guid, bool?, string, int)

Extract normalized text lines from email body

Declaration
EmailTextLinesResult GetEmailTextLines(Guid emailId, bool? decodeHtmlEntities = null, string lineSeparator = null, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email to fetch text for
bool? decodeHtmlEntities

Decode HTML entities (optional)
string lineSeparator

Line separator character (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
EmailTextLinesResult

EmailTextLinesResult
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailTextLinesWithHttpInfo(Guid, bool?, string, int)

Extract normalized text lines from email body

Declaration
ApiResponse<EmailTextLinesResult> GetEmailTextLinesWithHttpInfo(Guid emailId, bool? decodeHtmlEntities = null, string lineSeparator = null, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email to fetch text for
bool? decodeHtmlEntities

Decode HTML entities (optional)
string lineSeparator

Line separator character (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<EmailTextLinesResult>

ApiResponse of EmailTextLinesResult
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailThread(Guid, int)

Get email thread metadata by thread ID

Declaration
EmailThreadDto GetEmailThread(Guid threadId, int operationIndex = 0)
Parameters
Type Name Description
Guid threadId
int operationIndex

Index associated with the operation.
Returns
Type Description
EmailThreadDto

EmailThreadDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailThreadItems(Guid, string, int)

Get messages in a specific email thread

Declaration
EmailThreadItemsDto GetEmailThreadItems(Guid threadId, string sort = null, int operationIndex = 0)
Parameters
Type Name Description
Guid threadId
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
int operationIndex

Index associated with the operation.
Returns
Type Description
EmailThreadItemsDto

EmailThreadItemsDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailThreadItemsWithHttpInfo(Guid, string, int)

Get messages in a specific email thread

Declaration
ApiResponse<EmailThreadItemsDto> GetEmailThreadItemsWithHttpInfo(Guid threadId, string sort = null, int operationIndex = 0)
Parameters
Type Name Description
Guid threadId
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<EmailThreadItemsDto>

ApiResponse of EmailThreadItemsDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailThreadWithHttpInfo(Guid, int)

Get email thread metadata by thread ID

Declaration
ApiResponse<EmailThreadDto> GetEmailThreadWithHttpInfo(Guid threadId, int operationIndex = 0)
Parameters
Type Name Description
Guid threadId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<EmailThreadDto>

ApiResponse of EmailThreadDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailThreads(Guid?, int?, int?, string, string, DateTime?, DateTime?, int)

List email threads in paginated form

Declaration
PageEmailThreadProjection GetEmailThreads(Guid? htmlSelector = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
Guid? htmlSelector

Optional inbox filter. Query parameter name is htmlSelector for legacy compatibility. (optional)
int? page

Optional page index in email thread pagination (optional, default to 0)
int? size

Optional page size in email thread pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string searchFilter

Optional search filter search filter for email threads. (optional)
DateTime? since

Optional filter email threads created since time (optional)
DateTime? before

Optional filter emails threads created before given date time (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageEmailThreadProjection

PageEmailThreadProjection
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailThreadsWithHttpInfo(Guid?, int?, int?, string, string, DateTime?, DateTime?, int)

List email threads in paginated form

Declaration
ApiResponse<PageEmailThreadProjection> GetEmailThreadsWithHttpInfo(Guid? htmlSelector = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
Guid? htmlSelector

Optional inbox filter. Query parameter name is htmlSelector for legacy compatibility. (optional)
int? page

Optional page index in email thread pagination (optional, default to 0)
int? size

Optional page size in email thread pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string searchFilter

Optional search filter search filter for email threads. (optional)
DateTime? since

Optional filter email threads created since time (optional)
DateTime? before

Optional filter emails threads created before given date time (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageEmailThreadProjection>

ApiResponse of PageEmailThreadProjection
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailWithHttpInfo(Guid, int)

Get hydrated email (headers and body)

Declaration
ApiResponse<Email> GetEmailWithHttpInfo(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<Email>

ApiResponse of Email
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailsOffsetPaginated(List<Guid>, int?, int?, string, bool?, string, DateTime?, DateTime?, bool?, bool?, Guid?, List<Guid>, int)

Get all emails in all inboxes in paginated form. Email API list all.

Declaration
PageEmailProjection GetEmailsOffsetPaginated(List<Guid> inboxId = null, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? favourited = null, bool? syncConnectors = null, Guid? plusAddressId = null, List<Guid> include = null, int operationIndex = 0)
Parameters
Type Name Description
List<Guid> inboxId

Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
int? page

Optional page index in email list pagination (optional, default to 0)
int? size

Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool? unreadOnly

Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
string searchFilter

Optional search filter. Full email addresses match sender and receiving inbox email or receiving plus-address full address exactly. Address-like fragments containing @ (for example +alias@) also match sender, receiving inbox email, and receiving plus-address full address by contains. General text search matches sender, subject, and ID. (optional)
DateTime? since

Optional filter emails received after given date time (optional)
DateTime? before

Optional filter emails received before given date time (optional)
bool? favourited

Optional filter emails that are favourited (optional)
bool? syncConnectors

Sync connectors (optional)
Guid? plusAddressId

Optional plus address ID filter (optional)
List<Guid> include

Optional list of IDs to include in result (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageEmailProjection

PageEmailProjection
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailsOffsetPaginatedWithHttpInfo(List<Guid>, int?, int?, string, bool?, string, DateTime?, DateTime?, bool?, bool?, Guid?, List<Guid>, int)

Get all emails in all inboxes in paginated form. Email API list all.

Declaration
ApiResponse<PageEmailProjection> GetEmailsOffsetPaginatedWithHttpInfo(List<Guid> inboxId = null, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? favourited = null, bool? syncConnectors = null, Guid? plusAddressId = null, List<Guid> include = null, int operationIndex = 0)
Parameters
Type Name Description
List<Guid> inboxId

Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
int? page

Optional page index in email list pagination (optional, default to 0)
int? size

Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool? unreadOnly

Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
string searchFilter

Optional search filter. Full email addresses match sender and receiving inbox email or receiving plus-address full address exactly. Address-like fragments containing @ (for example +alias@) also match sender, receiving inbox email, and receiving plus-address full address by contains. General text search matches sender, subject, and ID. (optional)
DateTime? since

Optional filter emails received after given date time (optional)
DateTime? before

Optional filter emails received before given date time (optional)
bool? favourited

Optional filter emails that are favourited (optional)
bool? syncConnectors

Sync connectors (optional)
Guid? plusAddressId

Optional plus address ID filter (optional)
List<Guid> include

Optional list of IDs to include in result (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageEmailProjection>

ApiResponse of PageEmailProjection
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailsPaginated(List<Guid>, int?, int?, string, bool?, string, DateTime?, DateTime?, bool?, Guid?, bool?, int)

Get all emails in all inboxes in paginated form. Email API list all.

Declaration
PageEmailProjection GetEmailsPaginated(List<Guid> inboxId = null, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? syncConnectors = null, Guid? plusAddressId = null, bool? favourited = null, int operationIndex = 0)
Parameters
Type Name Description
List<Guid> inboxId

Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
int? page

Optional page index in email list pagination (optional, default to 0)
int? size

Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool? unreadOnly

Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
string searchFilter

Optional search filter. Full email addresses match sender and receiving inbox email or receiving plus-address full address exactly. Address-like fragments containing @ (for example +alias@) also match sender, receiving inbox email, and receiving plus-address full address by contains. General text search matches sender, subject, and ID. (optional)
DateTime? since

Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional)
DateTime? before

Optional filter emails received before given date time (optional)
bool? syncConnectors

Sync connectors (optional)
Guid? plusAddressId

Optional plus address ID filter (optional)
bool? favourited

Optional filter emails that are favourited (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageEmailProjection

PageEmailProjection
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmailsPaginatedWithHttpInfo(List<Guid>, int?, int?, string, bool?, string, DateTime?, DateTime?, bool?, Guid?, bool?, int)

Get all emails in all inboxes in paginated form. Email API list all.

Declaration
ApiResponse<PageEmailProjection> GetEmailsPaginatedWithHttpInfo(List<Guid> inboxId = null, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? syncConnectors = null, Guid? plusAddressId = null, bool? favourited = null, int operationIndex = 0)
Parameters
Type Name Description
List<Guid> inboxId

Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
int? page

Optional page index in email list pagination (optional, default to 0)
int? size

Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool? unreadOnly

Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
string searchFilter

Optional search filter. Full email addresses match sender and receiving inbox email or receiving plus-address full address exactly. Address-like fragments containing @ (for example +alias@) also match sender, receiving inbox email, and receiving plus-address full address by contains. General text search matches sender, subject, and ID. (optional)
DateTime? since

Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional)
DateTime? before

Optional filter emails received before given date time (optional)
bool? syncConnectors

Sync connectors (optional)
Guid? plusAddressId

Optional plus address ID filter (optional)
bool? favourited

Optional filter emails that are favourited (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageEmailProjection>

ApiResponse of PageEmailProjection
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetGravatarUrlForEmailAddress(string, string, int)

Get Gravatar URL for an email address

Declaration
GravatarUrl GetGravatarUrlForEmailAddress(string emailAddress, string size = null, int operationIndex = 0)
Parameters
Type Name Description
string emailAddress
string size

(optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
GravatarUrl

GravatarUrl
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetGravatarUrlForEmailAddressWithHttpInfo(string, string, int)

Get Gravatar URL for an email address

Declaration
ApiResponse<GravatarUrl> GetGravatarUrlForEmailAddressWithHttpInfo(string emailAddress, string size = null, int operationIndex = 0)
Parameters
Type Name Description
string emailAddress
string size

(optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<GravatarUrl>

ApiResponse of GravatarUrl
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetLatestEmail(List<Guid>, int)

Get latest email in all inboxes. Most recently received.

Declaration
Email GetLatestEmail(List<Guid> inboxIds = null, int operationIndex = 0)
Parameters
Type Name Description
List<Guid> inboxIds

Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
Email

Email
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetLatestEmailInInbox1(Guid, int)

Get latest email in an inbox. Use WaitForController to get emails that may not have arrived yet.

Declaration
Email GetLatestEmailInInbox1(Guid inboxId, int operationIndex = 0)
Parameters
Type Name Description
Guid inboxId

ID of the inbox you want to get the latest email from
int operationIndex

Index associated with the operation.
Returns
Type Description
Email

Email
Remarks

Returns the newest email for the specified inbox ID. For polling/wait semantics use wait endpoints.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetLatestEmailInInbox1WithHttpInfo(Guid, int)

Get latest email in an inbox. Use WaitForController to get emails that may not have arrived yet.

Declaration
ApiResponse<Email> GetLatestEmailInInbox1WithHttpInfo(Guid inboxId, int operationIndex = 0)
Parameters
Type Name Description
Guid inboxId

ID of the inbox you want to get the latest email from
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<Email>

ApiResponse of Email
Remarks

Returns the newest email for the specified inbox ID. For polling/wait semantics use wait endpoints.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetLatestEmailWithHttpInfo(List<Guid>, int)

Get latest email in all inboxes. Most recently received.

Declaration
ApiResponse<Email> GetLatestEmailWithHttpInfo(List<Guid> inboxIds = null, int operationIndex = 0)
Parameters
Type Name Description
List<Guid> inboxIds

Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<Email>

ApiResponse of Email
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetOrganizationEmailsPaginated(List<Guid>, int?, int?, string, bool?, string, DateTime?, DateTime?, bool?, bool?, Guid?, int)

List organization-visible emails

Declaration
PageEmailProjection GetOrganizationEmailsPaginated(List<Guid> inboxId = null, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? syncConnectors = null, bool? favourited = null, Guid? plusAddressId = null, int operationIndex = 0)
Parameters
Type Name Description
List<Guid> inboxId

Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
int? page

Optional page index in email list pagination (optional, default to 0)
int? size

Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool? unreadOnly

Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
string searchFilter

Optional search filter search filter for emails. (optional)
DateTime? since

Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional)
DateTime? before

Optional filter emails received before given date time (optional)
bool? syncConnectors

Sync connectors (optional)
bool? favourited

Search only favorited emails (optional)
Guid? plusAddressId

Optional plus address ID filter (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageEmailProjection

PageEmailProjection
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetOrganizationEmailsPaginatedWithHttpInfo(List<Guid>, int?, int?, string, bool?, string, DateTime?, DateTime?, bool?, bool?, Guid?, int)

List organization-visible emails

Declaration
ApiResponse<PageEmailProjection> GetOrganizationEmailsPaginatedWithHttpInfo(List<Guid> inboxId = null, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? syncConnectors = null, bool? favourited = null, Guid? plusAddressId = null, int operationIndex = 0)
Parameters
Type Name Description
List<Guid> inboxId

Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
int? page

Optional page index in email list pagination (optional, default to 0)
int? size

Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool? unreadOnly

Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
string searchFilter

Optional search filter search filter for emails. (optional)
DateTime? since

Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional)
DateTime? before

Optional filter emails received before given date time (optional)
bool? syncConnectors

Sync connectors (optional)
bool? favourited

Search only favorited emails (optional)
Guid? plusAddressId

Optional plus address ID filter (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageEmailProjection>

ApiResponse of PageEmailProjection
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetRawEmailContents(Guid, int)

Get raw email string. Returns unparsed raw SMTP message with headers and body.

Declaration
void GetRawEmailContents(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email
int operationIndex

Index associated with the operation.
Remarks

Returns the original unparsed SMTP/MIME message as text/plain. Use JSON variant if your client expects JSON transport.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetRawEmailContentsWithHttpInfo(Guid, int)

Get raw email string. Returns unparsed raw SMTP message with headers and body.

Declaration
ApiResponse<object> GetRawEmailContentsWithHttpInfo(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<object>

ApiResponse of Object(void)
Remarks

Returns the original unparsed SMTP/MIME message as text/plain. Use JSON variant if your client expects JSON transport.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetRawEmailJson(Guid, int)

Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.

Declaration
RawEmailJson GetRawEmailJson(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email
int operationIndex

Index associated with the operation.
Returns
Type Description
RawEmailJson

RawEmailJson
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetRawEmailJsonWithHttpInfo(Guid, int)

Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.

Declaration
ApiResponse<RawEmailJson> GetRawEmailJsonWithHttpInfo(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<RawEmailJson>

ApiResponse of RawEmailJson
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetUnreadEmailCount(Guid?, int)

Get unread email count

Declaration
UnreadCount GetUnreadEmailCount(Guid? inboxId = null, int operationIndex = 0)
Parameters
Type Name Description
Guid? inboxId

Inbox ID filter for unread count scope (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
UnreadCount

UnreadCount
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetUnreadEmailCountWithHttpInfo(Guid?, int)

Get unread email count

Declaration
ApiResponse<UnreadCount> GetUnreadEmailCountWithHttpInfo(Guid? inboxId = null, int operationIndex = 0)
Parameters
Type Name Description
Guid? inboxId

Inbox ID filter for unread count scope (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<UnreadCount>

ApiResponse of UnreadCount
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

MarkAllAsRead(bool?, Guid?, int)

Mark all emails as read or unread

Declaration
void MarkAllAsRead(bool? read = null, Guid? inboxId = null, int operationIndex = 0)
Parameters
Type Name Description
bool? read

What value to assign to email read property. Default true. (optional, default to true)
Guid? inboxId

Optional inbox ID filter (optional)
int operationIndex

Index associated with the operation.
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

MarkAllAsReadWithHttpInfo(bool?, Guid?, int)

Mark all emails as read or unread

Declaration
ApiResponse<object> MarkAllAsReadWithHttpInfo(bool? read = null, Guid? inboxId = null, int operationIndex = 0)
Parameters
Type Name Description
bool? read

What value to assign to email read property. Default true. (optional, default to true)
Guid? inboxId

Optional inbox ID filter (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<object>

ApiResponse of Object(void)
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

MarkAsRead(Guid, bool?, int)

Mark an email as read or unread

Declaration
EmailPreview MarkAsRead(Guid emailId, bool? read = null, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
bool? read

What value to assign to email read property. Default true. (optional, default to true)
int operationIndex

Index associated with the operation.
Returns
Type Description
EmailPreview

EmailPreview
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

MarkAsReadWithHttpInfo(Guid, bool?, int)

Mark an email as read or unread

Declaration
ApiResponse<EmailPreview> MarkAsReadWithHttpInfo(Guid emailId, bool? read = null, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId
bool? read

What value to assign to email read property. Default true. (optional, default to true)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<EmailPreview>

ApiResponse of EmailPreview
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ReplyToEmail(Guid, ReplyToEmailOptions, int)

Reply to an email

Declaration
SentEmailDto ReplyToEmail(Guid emailId, ReplyToEmailOptions replyToEmailOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of the email that should be replied to
ReplyToEmailOptions replyToEmailOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
SentEmailDto

SentEmailDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ReplyToEmailWithHttpInfo(Guid, ReplyToEmailOptions, int)

Reply to an email

Declaration
ApiResponse<SentEmailDto> ReplyToEmailWithHttpInfo(Guid emailId, ReplyToEmailOptions replyToEmailOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of the email that should be replied to
ReplyToEmailOptions replyToEmailOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<SentEmailDto>

ApiResponse of SentEmailDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SearchEmails(SearchEmailsOptions, bool?, bool?, Guid?, int)

Get all emails by search criteria. Return in paginated form.

Declaration
PageEmailProjection SearchEmails(SearchEmailsOptions searchEmailsOptions, bool? syncConnectors = null, bool? favourited = null, Guid? plusAddressId = null, int operationIndex = 0)
Parameters
Type Name Description
SearchEmailsOptions searchEmailsOptions
bool? syncConnectors

Sync connectors (optional)
bool? favourited

Search only favourited emails (optional)
Guid? plusAddressId

Optional plus address ID filter (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageEmailProjection

PageEmailProjection
Remarks

Searches emails by sender/recipient/address/subject/id fields and returns paginated matches. Does not perform full-text body search.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SearchEmailsWithHttpInfo(SearchEmailsOptions, bool?, bool?, Guid?, int)

Get all emails by search criteria. Return in paginated form.

Declaration
ApiResponse<PageEmailProjection> SearchEmailsWithHttpInfo(SearchEmailsOptions searchEmailsOptions, bool? syncConnectors = null, bool? favourited = null, Guid? plusAddressId = null, int operationIndex = 0)
Parameters
Type Name Description
SearchEmailsOptions searchEmailsOptions
bool? syncConnectors

Sync connectors (optional)
bool? favourited

Search only favourited emails (optional)
Guid? plusAddressId

Optional plus address ID filter (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageEmailProjection>

ApiResponse of PageEmailProjection
Remarks

Searches emails by sender/recipient/address/subject/id fields and returns paginated matches. Does not perform full-text body search.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SendEmailSourceOptional(SendEmailOptions, Guid?, bool?, bool?, int)

Send email

Declaration
void SendEmailSourceOptional(SendEmailOptions sendEmailOptions, Guid? inboxId = null, bool? useDomainPool = null, bool? virtualSend = null, int operationIndex = 0)
Parameters
Type Name Description
SendEmailOptions sendEmailOptions
Guid? inboxId

ID of the inbox you want to send the email from (optional)
bool? useDomainPool

Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional)
bool? virtualSend

Optionally create inbox to send from that is a virtual inbox and won't send to external addresses (optional)
int operationIndex

Index associated with the operation.
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SendEmailSourceOptionalWithHttpInfo(SendEmailOptions, Guid?, bool?, bool?, int)

Send email

Declaration
ApiResponse<object> SendEmailSourceOptionalWithHttpInfo(SendEmailOptions sendEmailOptions, Guid? inboxId = null, bool? useDomainPool = null, bool? virtualSend = null, int operationIndex = 0)
Parameters
Type Name Description
SendEmailOptions sendEmailOptions
Guid? inboxId

ID of the inbox you want to send the email from (optional)
bool? useDomainPool

Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional)
bool? virtualSend

Optionally create inbox to send from that is a virtual inbox and won't send to external addresses (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<object>

ApiResponse of Object(void)
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SetEmailFavourited(Guid, bool, int)

Set email favourited state

Declaration
void SetEmailFavourited(Guid emailId, bool favourited, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email to set favourite state
bool favourited
int operationIndex

Index associated with the operation.
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SetEmailFavouritedWithHttpInfo(Guid, bool, int)

Set email favourited state

Declaration
ApiResponse<object> SetEmailFavouritedWithHttpInfo(Guid emailId, bool favourited, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email to set favourite state
bool favourited
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<object>

ApiResponse of Object(void)
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ValidateEmail(Guid, int)

Validate email HTML contents

Declaration
ValidationDto ValidateEmail(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email
int operationIndex

Index associated with the operation.
Returns
Type Description
ValidationDto

ValidationDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ValidateEmailWithHttpInfo(Guid, int)

Validate email HTML contents

Declaration
ApiResponse<ValidationDto> ValidateEmailWithHttpInfo(Guid emailId, int operationIndex = 0)
Parameters
Type Name Description
Guid emailId

ID of email
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<ValidationDto>

ApiResponse of ValidationDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call