Interface IEmailControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IEmailControllerApiAsync : IApiAccessor

Methods

View Source

ApplyImapFlagOperationAsync(Guid, ImapFlagOperationOptions, int, CancellationToken)

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

Declaration

Task<EmailPreview> ApplyImapFlagOperationAsync(Guid emailId, ImapFlagOperationOptions imapFlagOperationOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
ImapFlagOperationOptions	imapFlagOperationOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<EmailPreview>	Task 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

ApplyImapFlagOperationWithHttpInfoAsync(Guid, ImapFlagOperationOptions, int, CancellationToken)

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

Declaration

Task<ApiResponse<EmailPreview>> ApplyImapFlagOperationWithHttpInfoAsync(Guid emailId, ImapFlagOperationOptions imapFlagOperationOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
ImapFlagOperationOptions	imapFlagOperationOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<EmailPreview>>	Task of ApiResponse (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

CanSendAsync(Guid, SendEmailOptions, int, CancellationToken)

Check whether an email send would be accepted

Declaration

Task<CanSendEmailResults> CanSendAsync(Guid inboxId, SendEmailOptions sendEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<CanSendEmailResults>	Task 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

CanSendWithHttpInfoAsync(Guid, SendEmailOptions, int, CancellationToken)

Check whether an email send would be accepted

Declaration

Task<ApiResponse<CanSendEmailResults>> CanSendWithHttpInfoAsync(Guid inboxId, SendEmailOptions sendEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<CanSendEmailResults>>	Task of ApiResponse (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

CheckEmailBodyAsync(Guid, int, CancellationToken)

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

Declaration

Task<CheckEmailBodyResults> CheckEmailBodyAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<CheckEmailBodyResults>	Task 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

CheckEmailBodyFeatureSupportAsync(Guid, int, CancellationToken)

Check client support for features used in a stored email body

Declaration

Task<CheckEmailBodyFeatureSupportResults> CheckEmailBodyFeatureSupportAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<CheckEmailBodyFeatureSupportResults>	Task 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

CheckEmailBodyFeatureSupportWithHttpInfoAsync(Guid, int, CancellationToken)

Check client support for features used in a stored email body

Declaration

Task<ApiResponse<CheckEmailBodyFeatureSupportResults>> CheckEmailBodyFeatureSupportWithHttpInfoAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<CheckEmailBodyFeatureSupportResults>>	Task of ApiResponse (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

CheckEmailBodyWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

Task<ApiResponse<CheckEmailBodyResults>> CheckEmailBodyWithHttpInfoAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<CheckEmailBodyResults>>	Task of ApiResponse (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

CheckEmailClientSupportAsync(CheckEmailClientSupportOptions, int, CancellationToken)

Check email-client support for a provided HTML body

Declaration

Task<CheckEmailClientSupportResults> CheckEmailClientSupportAsync(CheckEmailClientSupportOptions checkEmailClientSupportOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CheckEmailClientSupportOptions	checkEmailClientSupportOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<CheckEmailClientSupportResults>	Task 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

CheckEmailClientSupportWithHttpInfoAsync(CheckEmailClientSupportOptions, int, CancellationToken)

Check email-client support for a provided HTML body

Declaration

Task<ApiResponse<CheckEmailClientSupportResults>> CheckEmailClientSupportWithHttpInfoAsync(CheckEmailClientSupportOptions checkEmailClientSupportOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CheckEmailClientSupportOptions	checkEmailClientSupportOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<CheckEmailClientSupportResults>>	Task of ApiResponse (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

DeleteAllEmailsAsync(int, CancellationToken)

Delete all emails in all inboxes.

Declaration

Task DeleteAllEmailsAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of 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

DeleteAllEmailsWithHttpInfoAsync(int, CancellationToken)

Delete all emails in all inboxes.

Declaration

Task<ApiResponse<object>> DeleteAllEmailsWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

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

DeleteEmailAsync(Guid, int, CancellationToken)

Delete an email

Declaration

Task DeleteEmailAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email to delete
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of 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

DeleteEmailWithHttpInfoAsync(Guid, int, CancellationToken)

Delete an email

Declaration

Task<ApiResponse<object>> DeleteEmailWithHttpInfoAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email to delete
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

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

DownloadAttachmentAsync(Guid, string, string, int, CancellationToken)

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

Task<byte[]> DownloadAttachmentAsync(Guid emailId, string attachmentId, string apiKey = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<byte[]>	Task 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

DownloadAttachmentBase64Async(Guid, string, int, CancellationToken)

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

Task<DownloadAttachmentDto> DownloadAttachmentBase64Async(Guid emailId, string attachmentId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<DownloadAttachmentDto>	Task 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

DownloadAttachmentBase64WithHttpInfoAsync(Guid, string, int, CancellationToken)

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

Task<ApiResponse<DownloadAttachmentDto>> DownloadAttachmentBase64WithHttpInfoAsync(Guid emailId, string attachmentId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<DownloadAttachmentDto>>	Task of ApiResponse (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

DownloadAttachmentWithHttpInfoAsync(Guid, string, string, int, CancellationToken)

Declaration

Task<ApiResponse<byte[]>> DownloadAttachmentWithHttpInfoAsync(Guid emailId, string attachmentId, string apiKey = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<byte[]>>	Task of ApiResponse (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

DownloadBodyAsync(Guid, int, CancellationToken)

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

Declaration

Task<string> DownloadBodyAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<string>	Task 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

DownloadBodyBytesAsync(Guid, int, CancellationToken)

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

Declaration

Task<byte[]> DownloadBodyBytesAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<byte[]>	Task 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

DownloadBodyBytesWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

Task<ApiResponse<byte[]>> DownloadBodyBytesWithHttpInfoAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<byte[]>>	Task of ApiResponse (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

DownloadBodyWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

Task<ApiResponse<string>> DownloadBodyWithHttpInfoAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<string>>	Task of ApiResponse (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

ForwardEmailAsync(Guid, ForwardEmailOptions, int, CancellationToken)

Forward email to recipients

Declaration

Task<SentEmailDto> ForwardEmailAsync(Guid emailId, ForwardEmailOptions forwardEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email
ForwardEmailOptions	forwardEmailOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<SentEmailDto>	Task 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

ForwardEmailWithHttpInfoAsync(Guid, ForwardEmailOptions, int, CancellationToken)

Forward email to recipients

Declaration

Task<ApiResponse<SentEmailDto>> ForwardEmailWithHttpInfoAsync(Guid emailId, ForwardEmailOptions forwardEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email
ForwardEmailOptions	forwardEmailOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<SentEmailDto>>	Task of ApiResponse (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

GetAttachmentMetaDataAsync(Guid, string, int, CancellationToken)

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

Declaration

Task<AttachmentMetaData> GetAttachmentMetaDataAsync(Guid emailId, string attachmentId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<AttachmentMetaData>	Task 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

GetAttachmentMetaDataWithHttpInfoAsync(Guid, string, int, CancellationToken)

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

Declaration

Task<ApiResponse<AttachmentMetaData>> GetAttachmentMetaDataWithHttpInfoAsync(Guid emailId, string attachmentId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<AttachmentMetaData>>	Task of ApiResponse (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

GetEmailAsync(Guid, int, CancellationToken)

Get hydrated email (headers and body)

Declaration

Task<Email> GetEmailAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<Email>	Task 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

GetEmailAttachmentsAsync(Guid, int, CancellationToken)

List attachment metadata for an email

Declaration

Task<List<AttachmentMetaData>> GetEmailAttachmentsAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<List<AttachmentMetaData>>	Task 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

GetEmailAttachmentsWithHttpInfoAsync(Guid, int, CancellationToken)

List attachment metadata for an email

Declaration

Task<ApiResponse<List<AttachmentMetaData>>> GetEmailAttachmentsWithHttpInfoAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<List<AttachmentMetaData>>>	Task of ApiResponse (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

GetEmailCodesAsync(Guid, ExtractCodesOptions, int, CancellationToken)

Extract verification codes from an email

Declaration

Task<ExtractCodesResult> GetEmailCodesAsync(Guid emailId, ExtractCodesOptions extractCodesOptions = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email to extract codes from
ExtractCodesOptions	extractCodesOptions	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ExtractCodesResult>	Task 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

GetEmailCodesWithHttpInfoAsync(Guid, ExtractCodesOptions, int, CancellationToken)

Extract verification codes from an email

Declaration

Task<ApiResponse<ExtractCodesResult>> GetEmailCodesWithHttpInfoAsync(Guid emailId, ExtractCodesOptions extractCodesOptions = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email to extract codes from
ExtractCodesOptions	extractCodesOptions	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<ExtractCodesResult>>	Task of ApiResponse (ExtractCodesResult)

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetEmailContentMatchAsync(Guid, ContentMatchOptions, int, CancellationToken)

Run regex against hydrated email body and return matches

Declaration

Task<EmailContentMatchResult> GetEmailContentMatchAsync(Guid emailId, ContentMatchOptions contentMatchOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email to match against
ContentMatchOptions	contentMatchOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<EmailContentMatchResult>	Task 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

GetEmailContentMatchWithHttpInfoAsync(Guid, ContentMatchOptions, int, CancellationToken)

Run regex against hydrated email body and return matches

Declaration

Task<ApiResponse<EmailContentMatchResult>> GetEmailContentMatchWithHttpInfoAsync(Guid emailId, ContentMatchOptions contentMatchOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email to match against
ContentMatchOptions	contentMatchOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<EmailContentMatchResult>>	Task of ApiResponse (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

GetEmailContentPartAsync(Guid, string, bool?, int?, int, CancellationToken)

Get email content part by content type

Declaration

Task<EmailContentPartResult> GetEmailContentPartAsync(Guid emailId, string contentType, bool? strict = null, int? index = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<EmailContentPartResult>	Task 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

GetEmailContentPartContentAsync(Guid, string, bool?, int?, int, CancellationToken)

Get multipart content part as raw response

Declaration

Task<string> GetEmailContentPartContentAsync(Guid emailId, string contentType, bool? strict = null, int? index = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<string>	Task 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

GetEmailContentPartContentWithHttpInfoAsync(Guid, string, bool?, int?, int, CancellationToken)

Get multipart content part as raw response

Declaration

Task<ApiResponse<string>> GetEmailContentPartContentWithHttpInfoAsync(Guid emailId, string contentType, bool? strict = null, int? index = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<string>>	Task of ApiResponse (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

GetEmailContentPartWithHttpInfoAsync(Guid, string, bool?, int?, int, CancellationToken)

Get email content part by content type

Declaration

Task<ApiResponse<EmailContentPartResult>> GetEmailContentPartWithHttpInfoAsync(Guid emailId, string contentType, bool? strict = null, int? index = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<EmailContentPartResult>>	Task of ApiResponse (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

GetEmailCountAsync(Guid?, int, CancellationToken)

Get email count

Declaration

Task<CountDto> GetEmailCountAsync(Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	inboxId	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<CountDto>	Task 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

GetEmailCountWithHttpInfoAsync(Guid?, int, CancellationToken)

Get email count

Declaration

Task<ApiResponse<CountDto>> GetEmailCountWithHttpInfoAsync(Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	inboxId	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<CountDto>>	Task of ApiResponse (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

GetEmailHTMLAsync(Guid, bool?, int, CancellationToken)

Get hydrated email HTML for browser rendering

Declaration

Task<string> GetEmailHTMLAsync(Guid emailId, bool? replaceCidImages = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
bool?	replaceCidImages	(optional, default to false)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<string>	Task 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

GetEmailHTMLJsonAsync(Guid, bool?, int, CancellationToken)

Get hydrated email HTML wrapped in JSON

Declaration

Task<EmailHtmlDto> GetEmailHTMLJsonAsync(Guid emailId, bool? replaceCidImages = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
bool?	replaceCidImages	(optional, default to false)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<EmailHtmlDto>	Task 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

GetEmailHTMLJsonWithHttpInfoAsync(Guid, bool?, int, CancellationToken)

Get hydrated email HTML wrapped in JSON

Declaration

Task<ApiResponse<EmailHtmlDto>> GetEmailHTMLJsonWithHttpInfoAsync(Guid emailId, bool? replaceCidImages = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
bool?	replaceCidImages	(optional, default to false)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<EmailHtmlDto>>	Task of ApiResponse (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

GetEmailHTMLQueryAsync(Guid, string, int, CancellationToken)

Query hydrated HTML body and return matching text lines

Declaration

Task<EmailTextLinesResult> GetEmailHTMLQueryAsync(Guid emailId, string htmlSelector, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<EmailTextLinesResult>	Task 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

GetEmailHTMLQueryWithHttpInfoAsync(Guid, string, int, CancellationToken)

Query hydrated HTML body and return matching text lines

Declaration

Task<ApiResponse<EmailTextLinesResult>> GetEmailHTMLQueryWithHttpInfoAsync(Guid emailId, string htmlSelector, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<EmailTextLinesResult>>	Task of ApiResponse (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

GetEmailHTMLWithHttpInfoAsync(Guid, bool?, int, CancellationToken)

Get hydrated email HTML for browser rendering

Declaration

Task<ApiResponse<string>> GetEmailHTMLWithHttpInfoAsync(Guid emailId, bool? replaceCidImages = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
bool?	replaceCidImages	(optional, default to false)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<string>>	Task of ApiResponse (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

GetEmailLinksAsync(Guid, string, int, CancellationToken)

Extract links from an email HTML body

Declaration

Task<EmailLinksResult> GetEmailLinksAsync(Guid emailId, string selector = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<EmailLinksResult>	Task 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

GetEmailLinksWithHttpInfoAsync(Guid, string, int, CancellationToken)

Extract links from an email HTML body

Declaration

Task<ApiResponse<EmailLinksResult>> GetEmailLinksWithHttpInfoAsync(Guid emailId, string selector = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<EmailLinksResult>>	Task of ApiResponse (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

GetEmailPreviewURLsAsync(Guid, int, CancellationToken)

Get email URLs for viewing in browser or downloading

Declaration

Task<EmailPreviewUrls> GetEmailPreviewURLsAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<EmailPreviewUrls>	Task 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

GetEmailPreviewURLsWithHttpInfoAsync(Guid, int, CancellationToken)

Get email URLs for viewing in browser or downloading

Declaration

Task<ApiResponse<EmailPreviewUrls>> GetEmailPreviewURLsWithHttpInfoAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<EmailPreviewUrls>>	Task of ApiResponse (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

GetEmailScreenshotAsBase64Async(Guid, GetEmailScreenshotOptions, int, CancellationToken)

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

Declaration

Task<EmailScreenshotResult> GetEmailScreenshotAsBase64Async(Guid emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
GetEmailScreenshotOptions	getEmailScreenshotOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<EmailScreenshotResult>	Task 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

GetEmailScreenshotAsBase64WithHttpInfoAsync(Guid, GetEmailScreenshotOptions, int, CancellationToken)

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

Declaration

Task<ApiResponse<EmailScreenshotResult>> GetEmailScreenshotAsBase64WithHttpInfoAsync(Guid emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
GetEmailScreenshotOptions	getEmailScreenshotOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<EmailScreenshotResult>>	Task of ApiResponse (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

GetEmailScreenshotAsBinaryAsync(Guid, GetEmailScreenshotOptions, int, CancellationToken)

Take a screenshot of an email in a browser

Declaration

Task GetEmailScreenshotAsBinaryAsync(Guid emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
GetEmailScreenshotOptions	getEmailScreenshotOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of 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

GetEmailScreenshotAsBinaryWithHttpInfoAsync(Guid, GetEmailScreenshotOptions, int, CancellationToken)

Take a screenshot of an email in a browser

Declaration

Task<ApiResponse<object>> GetEmailScreenshotAsBinaryWithHttpInfoAsync(Guid emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
GetEmailScreenshotOptions	getEmailScreenshotOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

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

GetEmailSignatureAsync(Guid, int, CancellationToken)

Extract signature from an inbound email

Declaration

Task<EmailSignatureParseResult> GetEmailSignatureAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email to extract signature from
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<EmailSignatureParseResult>	Task 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

GetEmailSignatureWithHttpInfoAsync(Guid, int, CancellationToken)

Extract signature from an inbound email

Declaration

Task<ApiResponse<EmailSignatureParseResult>> GetEmailSignatureWithHttpInfoAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email to extract signature from
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<EmailSignatureParseResult>>	Task of ApiResponse (EmailSignatureParseResult)

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetEmailSummaryAsync(Guid, bool?, int, CancellationToken)

Get email summary (headers/metadata only)

Declaration

Task<EmailPreview> GetEmailSummaryAsync(Guid emailId, bool? decode = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
bool?	decode	Deprecated and ignored. Retained for backwards compatibility. (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<EmailPreview>	Task 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

GetEmailSummaryWithHttpInfoAsync(Guid, bool?, int, CancellationToken)

Get email summary (headers/metadata only)

Declaration

Task<ApiResponse<EmailPreview>> GetEmailSummaryWithHttpInfoAsync(Guid emailId, bool? decode = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
bool?	decode	Deprecated and ignored. Retained for backwards compatibility. (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<EmailPreview>>	Task of ApiResponse (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

GetEmailTextLinesAsync(Guid, bool?, string, int, CancellationToken)

Extract normalized text lines from email body

Declaration

Task<EmailTextLinesResult> GetEmailTextLinesAsync(Guid emailId, bool? decodeHtmlEntities = null, string lineSeparator = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<EmailTextLinesResult>	Task 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

GetEmailTextLinesWithHttpInfoAsync(Guid, bool?, string, int, CancellationToken)

Extract normalized text lines from email body

Declaration

Task<ApiResponse<EmailTextLinesResult>> GetEmailTextLinesWithHttpInfoAsync(Guid emailId, bool? decodeHtmlEntities = null, string lineSeparator = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<EmailTextLinesResult>>	Task of ApiResponse (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

GetEmailThreadAsync(Guid, int, CancellationToken)

Get email thread metadata by thread ID

Declaration

Task<EmailThreadDto> GetEmailThreadAsync(Guid threadId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	threadId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<EmailThreadDto>	Task 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

GetEmailThreadItemsAsync(Guid, string, int, CancellationToken)

Get messages in a specific email thread

Declaration

Task<EmailThreadItemsDto> GetEmailThreadItemsAsync(Guid threadId, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<EmailThreadItemsDto>	Task 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

GetEmailThreadItemsWithHttpInfoAsync(Guid, string, int, CancellationToken)

Get messages in a specific email thread

Declaration

Task<ApiResponse<EmailThreadItemsDto>> GetEmailThreadItemsWithHttpInfoAsync(Guid threadId, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<EmailThreadItemsDto>>	Task of ApiResponse (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

GetEmailThreadWithHttpInfoAsync(Guid, int, CancellationToken)

Get email thread metadata by thread ID

Declaration

Task<ApiResponse<EmailThreadDto>> GetEmailThreadWithHttpInfoAsync(Guid threadId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	threadId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<EmailThreadDto>>	Task of ApiResponse (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

GetEmailThreadsAsync(Guid?, int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

List email threads in paginated form

Declaration

Task<PageEmailThreadProjection> GetEmailThreadsAsync(Guid? htmlSelector = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageEmailThreadProjection>	Task 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

GetEmailThreadsWithHttpInfoAsync(Guid?, int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

List email threads in paginated form

Declaration

Task<ApiResponse<PageEmailThreadProjection>> GetEmailThreadsWithHttpInfoAsync(Guid? htmlSelector = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageEmailThreadProjection>>	Task of ApiResponse (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

GetEmailWithHttpInfoAsync(Guid, int, CancellationToken)

Get hydrated email (headers and body)

Declaration

Task<ApiResponse<Email>> GetEmailWithHttpInfoAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<Email>>	Task of ApiResponse (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

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

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

Declaration

Task<PageEmailProjection> GetEmailsOffsetPaginatedAsync(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, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageEmailProjection>	Task 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

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

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

Declaration

Task<ApiResponse<PageEmailProjection>> GetEmailsOffsetPaginatedWithHttpInfoAsync(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, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageEmailProjection>>	Task of ApiResponse (PageEmailProjection)

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

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

Declaration

Task<PageEmailProjection> GetEmailsPaginatedAsync(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, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageEmailProjection>	Task 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

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

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

Declaration

Task<ApiResponse<PageEmailProjection>> GetEmailsPaginatedWithHttpInfoAsync(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, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageEmailProjection>>	Task of ApiResponse (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

GetGravatarUrlForEmailAddressAsync(string, string, int, CancellationToken)

Get Gravatar URL for an email address

Declaration

Task<GravatarUrl> GetGravatarUrlForEmailAddressAsync(string emailAddress, string size = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	emailAddress
string	size	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<GravatarUrl>	Task 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

GetGravatarUrlForEmailAddressWithHttpInfoAsync(string, string, int, CancellationToken)

Get Gravatar URL for an email address

Declaration

Task<ApiResponse<GravatarUrl>> GetGravatarUrlForEmailAddressWithHttpInfoAsync(string emailAddress, string size = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	emailAddress
string	size	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<GravatarUrl>>	Task of ApiResponse (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

GetLatestEmailAsync(List<Guid>, int, CancellationToken)

Get latest email in all inboxes. Most recently received.

Declaration

Task<Email> GetLatestEmailAsync(List<Guid> inboxIds = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<Email>	Task 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

GetLatestEmailInInbox1Async(Guid, int, CancellationToken)

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

Declaration

Task<Email> GetLatestEmailInInbox1Async(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<Email>	Task 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

GetLatestEmailInInbox1WithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

Task<ApiResponse<Email>> GetLatestEmailInInbox1WithHttpInfoAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<Email>>	Task of ApiResponse (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

GetLatestEmailWithHttpInfoAsync(List<Guid>, int, CancellationToken)

Get latest email in all inboxes. Most recently received.

Declaration

Task<ApiResponse<Email>> GetLatestEmailWithHttpInfoAsync(List<Guid> inboxIds = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<Email>>	Task of ApiResponse (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

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

List organization-visible emails

Declaration

Task<PageEmailProjection> GetOrganizationEmailsPaginatedAsync(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, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageEmailProjection>	Task 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

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

List organization-visible emails

Declaration

Task<ApiResponse<PageEmailProjection>> GetOrganizationEmailsPaginatedWithHttpInfoAsync(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, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageEmailProjection>>	Task of ApiResponse (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

GetRawEmailContentsAsync(Guid, int, CancellationToken)

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

Declaration

Task GetRawEmailContentsAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of 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

GetRawEmailContentsWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

Task<ApiResponse<object>> GetRawEmailContentsWithHttpInfoAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

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

GetRawEmailJsonAsync(Guid, int, CancellationToken)

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

Declaration

Task<RawEmailJson> GetRawEmailJsonAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<RawEmailJson>	Task 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

GetRawEmailJsonWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

Task<ApiResponse<RawEmailJson>> GetRawEmailJsonWithHttpInfoAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<RawEmailJson>>	Task of ApiResponse (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

GetUnreadEmailCountAsync(Guid?, int, CancellationToken)

Get unread email count

Declaration

Task<UnreadCount> GetUnreadEmailCountAsync(Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	inboxId	Inbox ID filter for unread count scope (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<UnreadCount>	Task 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

GetUnreadEmailCountWithHttpInfoAsync(Guid?, int, CancellationToken)

Get unread email count

Declaration

Task<ApiResponse<UnreadCount>> GetUnreadEmailCountWithHttpInfoAsync(Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	inboxId	Inbox ID filter for unread count scope (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<UnreadCount>>	Task of ApiResponse (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

MarkAllAsReadAsync(bool?, Guid?, int, CancellationToken)

Mark all emails as read or unread

Declaration

Task MarkAllAsReadAsync(bool? read = null, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of 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

MarkAllAsReadWithHttpInfoAsync(bool?, Guid?, int, CancellationToken)

Mark all emails as read or unread

Declaration

Task<ApiResponse<object>> MarkAllAsReadWithHttpInfoAsync(bool? read = null, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

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

MarkAsReadAsync(Guid, bool?, int, CancellationToken)

Mark an email as read or unread

Declaration

Task<EmailPreview> MarkAsReadAsync(Guid emailId, bool? read = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<EmailPreview>	Task 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

MarkAsReadWithHttpInfoAsync(Guid, bool?, int, CancellationToken)

Mark an email as read or unread

Declaration

Task<ApiResponse<EmailPreview>> MarkAsReadWithHttpInfoAsync(Guid emailId, bool? read = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<EmailPreview>>	Task of ApiResponse (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

ReplyToEmailAsync(Guid, ReplyToEmailOptions, int, CancellationToken)

Reply to an email

Declaration

Task<SentEmailDto> ReplyToEmailAsync(Guid emailId, ReplyToEmailOptions replyToEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of the email that should be replied to
ReplyToEmailOptions	replyToEmailOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<SentEmailDto>	Task 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

ReplyToEmailWithHttpInfoAsync(Guid, ReplyToEmailOptions, int, CancellationToken)

Reply to an email

Declaration

Task<ApiResponse<SentEmailDto>> ReplyToEmailWithHttpInfoAsync(Guid emailId, ReplyToEmailOptions replyToEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of the email that should be replied to
ReplyToEmailOptions	replyToEmailOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<SentEmailDto>>	Task of ApiResponse (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

SearchEmailsAsync(SearchEmailsOptions, bool?, bool?, Guid?, int, CancellationToken)

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

Declaration

Task<PageEmailProjection> SearchEmailsAsync(SearchEmailsOptions searchEmailsOptions, bool? syncConnectors = null, bool? favourited = null, Guid? plusAddressId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageEmailProjection>	Task 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

SearchEmailsWithHttpInfoAsync(SearchEmailsOptions, bool?, bool?, Guid?, int, CancellationToken)

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

Declaration

Task<ApiResponse<PageEmailProjection>> SearchEmailsWithHttpInfoAsync(SearchEmailsOptions searchEmailsOptions, bool? syncConnectors = null, bool? favourited = null, Guid? plusAddressId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageEmailProjection>>	Task of ApiResponse (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

SendEmailSourceOptionalAsync(SendEmailOptions, Guid?, bool?, bool?, int, CancellationToken)

Send email

Declaration

Task SendEmailSourceOptionalAsync(SendEmailOptions sendEmailOptions, Guid? inboxId = null, bool? useDomainPool = null, bool? virtualSend = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of 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

SendEmailSourceOptionalWithHttpInfoAsync(SendEmailOptions, Guid?, bool?, bool?, int, CancellationToken)

Send email

Declaration

Task<ApiResponse<object>> SendEmailSourceOptionalWithHttpInfoAsync(SendEmailOptions sendEmailOptions, Guid? inboxId = null, bool? useDomainPool = null, bool? virtualSend = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

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

SetEmailFavouritedAsync(Guid, bool, int, CancellationToken)

Set email favourited state

Declaration

Task SetEmailFavouritedAsync(Guid emailId, bool favourited, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email to set favourite state
bool	favourited
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of 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

SetEmailFavouritedWithHttpInfoAsync(Guid, bool, int, CancellationToken)

Set email favourited state

Declaration

Task<ApiResponse<object>> SetEmailFavouritedWithHttpInfoAsync(Guid emailId, bool favourited, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email to set favourite state
bool	favourited
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Remarks

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ValidateEmailAsync(Guid, int, CancellationToken)

Validate email HTML contents

Declaration

Task<ValidationDto> ValidateEmailAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ValidationDto>	Task 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

View Source

ValidateEmailWithHttpInfoAsync(Guid, int, CancellationToken)

Validate email HTML contents

Declaration

Task<ApiResponse<ValidationDto>> ValidateEmailWithHttpInfoAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<ValidationDto>>	Task of ApiResponse (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