Class EmailControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

EmailControllerApi

Implements

IEmailControllerApi

IEmailControllerApiSync

IEmailControllerApiAsync

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public class EmailControllerApi : IEmailControllerApi, IEmailControllerApiSync, IEmailControllerApiAsync, IApiAccessor

Constructors

EmailControllerApi()

Initializes a new instance of the EmailControllerApi class.

Declaration

public EmailControllerApi()

EmailControllerApi(string)

Initializes a new instance of the EmailControllerApi class.

Declaration

public EmailControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

EmailControllerApi(Configuration)

Initializes a new instance of the EmailControllerApi class using Configuration object

Declaration

public EmailControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

EmailControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

Initializes a new instance of the EmailControllerApi class using a Configuration object and client instance.

Declaration

public EmailControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)

Parameters

Type	Name	Description
ISynchronousClient	client	The client interface for synchronous API access.
IAsynchronousClient	asyncClient	The client interface for asynchronous API access.
IReadableConfiguration	configuration	The configuration object.

Properties

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

ApplyImapFlagOperation(Guid, ImapFlagOperationOptions, int)

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

Declaration

public EmailPreview ApplyImapFlagOperation(Guid emailId, ImapFlagOperationOptions imapFlagOperationOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
ImapFlagOperationOptions	imapFlagOperationOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmailPreview	EmailPreview

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ApplyImapFlagOperationAsync(Guid, ImapFlagOperationOptions, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ApplyImapFlagOperationWithHttpInfo(Guid, ImapFlagOperationOptions, int)

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

Declaration

public ApiResponse<EmailPreview> ApplyImapFlagOperationWithHttpInfo(Guid emailId, ImapFlagOperationOptions imapFlagOperationOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
ImapFlagOperationOptions	imapFlagOperationOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmailPreview>	ApiResponse of EmailPreview

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ApplyImapFlagOperationWithHttpInfoAsync(Guid, ImapFlagOperationOptions, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CanSend(Guid, SendEmailOptions, int)

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

Declaration

public CanSendEmailResults CanSend(Guid inboxId, SendEmailOptions sendEmailOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	inboxId	ID of the inbox you want to send the email from
SendEmailOptions	sendEmailOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CanSendEmailResults	CanSendEmailResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CanSendAsync(Guid, SendEmailOptions, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CanSendWithHttpInfo(Guid, SendEmailOptions, int)

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

Declaration

public ApiResponse<CanSendEmailResults> CanSendWithHttpInfo(Guid inboxId, SendEmailOptions sendEmailOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	inboxId	ID of the inbox you want to send the email from
SendEmailOptions	sendEmailOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CanSendEmailResults>	ApiResponse of CanSendEmailResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CanSendWithHttpInfoAsync(Guid, SendEmailOptions, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CheckEmailBody(Guid, int)

Check email body for broken links, images, and spelling issues 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.

Declaration

public CheckEmailBodyResults CheckEmailBody(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CheckEmailBodyResults	CheckEmailBodyResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CheckEmailBodyAsync(Guid, int, CancellationToken)

Check email body for broken links, images, and spelling issues 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.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CheckEmailBodyFeatureSupport(Guid, int)

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

Declaration

public CheckEmailBodyFeatureSupportResults CheckEmailBodyFeatureSupport(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CheckEmailBodyFeatureSupportResults	CheckEmailBodyFeatureSupportResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CheckEmailBodyFeatureSupportAsync(Guid, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CheckEmailBodyFeatureSupportWithHttpInfo(Guid, int)

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

Declaration

public ApiResponse<CheckEmailBodyFeatureSupportResults> CheckEmailBodyFeatureSupportWithHttpInfo(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CheckEmailBodyFeatureSupportResults>	ApiResponse of CheckEmailBodyFeatureSupportResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CheckEmailBodyFeatureSupportWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CheckEmailBodyWithHttpInfo(Guid, int)

Check email body for broken links, images, and spelling issues 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.

Declaration

public ApiResponse<CheckEmailBodyResults> CheckEmailBodyWithHttpInfo(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CheckEmailBodyResults>	ApiResponse of CheckEmailBodyResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CheckEmailBodyWithHttpInfoAsync(Guid, int, CancellationToken)

Check email body for broken links, images, and spelling issues 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.

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CheckEmailClientSupport(CheckEmailClientSupportOptions, int)

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

Declaration

public CheckEmailClientSupportResults CheckEmailClientSupport(CheckEmailClientSupportOptions checkEmailClientSupportOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CheckEmailClientSupportOptions	checkEmailClientSupportOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CheckEmailClientSupportResults	CheckEmailClientSupportResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CheckEmailClientSupportAsync(CheckEmailClientSupportOptions, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CheckEmailClientSupportWithHttpInfo(CheckEmailClientSupportOptions, int)

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

Declaration

public ApiResponse<CheckEmailClientSupportResults> CheckEmailClientSupportWithHttpInfo(CheckEmailClientSupportOptions checkEmailClientSupportOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CheckEmailClientSupportOptions	checkEmailClientSupportOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CheckEmailClientSupportResults>	ApiResponse of CheckEmailClientSupportResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CheckEmailClientSupportWithHttpInfoAsync(CheckEmailClientSupportOptions, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteAllEmails(int)

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

Declaration

public void DeleteAllEmails(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteAllEmailsAsync(int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteAllEmailsWithHttpInfo(int)

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

Declaration

public ApiResponse<object> DeleteAllEmailsWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteAllEmailsWithHttpInfoAsync(int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteEmail(Guid, int)

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

Declaration

public void DeleteEmail(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email to delete
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteEmailAsync(Guid, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteEmailWithHttpInfo(Guid, int)

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

Declaration

public ApiResponse<object> DeleteEmailWithHttpInfo(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email to delete
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteEmailWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DownloadAttachment(Guid, string, string, int)

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

Declaration

public byte[] DownloadAttachment(Guid emailId, string attachmentId, string apiKey = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email
string	attachmentId	ID of attachment
string	apiKey	Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
byte[]	byte[]

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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. Returns attachment bytes by attachment ID. Use attachment IDs from email payloads or attachment listing endpoints.

Declaration

public 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[]

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DownloadAttachmentBase64(Guid, string, int)

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

Declaration

public DownloadAttachmentDto DownloadAttachmentBase64(Guid emailId, string attachmentId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DownloadAttachmentDto	DownloadAttachmentDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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. Returns attachment payload as base64 in JSON. Useful for clients that cannot reliably consume binary streaming responses.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DownloadAttachmentBase64WithHttpInfo(Guid, string, int)

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

Declaration

public ApiResponse<DownloadAttachmentDto> DownloadAttachmentBase64WithHttpInfo(Guid emailId, string attachmentId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DownloadAttachmentDto>	ApiResponse of DownloadAttachmentDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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. Returns attachment payload as base64 in JSON. Useful for clients that cannot reliably consume binary streaming responses.

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DownloadAttachmentWithHttpInfo(Guid, string, string, int)

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

Declaration

public ApiResponse<byte[]> DownloadAttachmentWithHttpInfo(Guid emailId, string attachmentId, string apiKey = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email
string	attachmentId	ID of attachment
string	apiKey	Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<byte[]>	ApiResponse of byte[]

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DownloadAttachmentWithHttpInfoAsync(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. Returns attachment bytes by attachment ID. Use attachment IDs from email payloads or attachment listing endpoints.

Declaration

public 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[])

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DownloadBody(Guid, int)

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

Declaration

public string DownloadBody(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.

Returns

Type	Description
string	string

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DownloadBodyAsync(Guid, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DownloadBodyBytes(Guid, int)

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

Declaration

public byte[] DownloadBodyBytes(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.

Returns

Type	Description
byte[]	byte[]

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DownloadBodyBytesAsync(Guid, int, CancellationToken)

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

Declaration

public 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[]

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DownloadBodyBytesWithHttpInfo(Guid, int)

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

Declaration

public ApiResponse<byte[]> DownloadBodyBytesWithHttpInfo(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<byte[]>	ApiResponse of byte[]

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DownloadBodyBytesWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

public 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[])

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DownloadBodyWithHttpInfo(Guid, int)

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

Declaration

public ApiResponse<string> DownloadBodyWithHttpInfo(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<string>	ApiResponse of string

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DownloadBodyWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ForwardEmail(Guid, ForwardEmailOptions, int)

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

Declaration

public SentEmailDto ForwardEmail(Guid emailId, ForwardEmailOptions forwardEmailOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email
ForwardEmailOptions	forwardEmailOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
SentEmailDto	SentEmailDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ForwardEmailAsync(Guid, ForwardEmailOptions, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ForwardEmailWithHttpInfo(Guid, ForwardEmailOptions, int)

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

Declaration

public ApiResponse<SentEmailDto> ForwardEmailWithHttpInfo(Guid emailId, ForwardEmailOptions forwardEmailOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email
ForwardEmailOptions	forwardEmailOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<SentEmailDto>	ApiResponse of SentEmailDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ForwardEmailWithHttpInfoAsync(Guid, ForwardEmailOptions, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAttachmentMetaData(Guid, string, int)

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

Declaration

public AttachmentMetaData GetAttachmentMetaData(Guid emailId, string attachmentId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.

Returns

Type	Description
AttachmentMetaData	AttachmentMetaData

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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. Returns metadata for a specific attachment ID (name, content type, and size fields).

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAttachmentMetaDataWithHttpInfo(Guid, string, int)

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

Declaration

public ApiResponse<AttachmentMetaData> GetAttachmentMetaDataWithHttpInfo(Guid emailId, string attachmentId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<AttachmentMetaData>	ApiResponse of AttachmentMetaData

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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. Returns metadata for a specific attachment ID (name, content type, and size fields).

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

GetEmail(Guid, int)

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

Declaration

public Email GetEmail(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
Email	Email

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailAsync(Guid, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailAttachments(Guid, int)

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

Declaration

public List<AttachmentMetaData> GetEmailAttachments(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.

Returns

Type	Description
List<AttachmentMetaData>	List<AttachmentMetaData>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailAttachmentsAsync(Guid, int, CancellationToken)

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

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailAttachmentsWithHttpInfo(Guid, int)

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

Declaration

public ApiResponse<List<AttachmentMetaData>> GetEmailAttachmentsWithHttpInfo(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<List<AttachmentMetaData>>	ApiResponse of List<AttachmentMetaData>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailAttachmentsWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

public 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>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailCodes(Guid, ExtractCodesOptions, int)

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

Declaration

public ExtractCodesResult GetEmailCodes(Guid emailId, ExtractCodesOptions extractCodesOptions = null, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ExtractCodesResult	ExtractCodesResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailCodesAsync(Guid, ExtractCodesOptions, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailCodesWithHttpInfo(Guid, ExtractCodesOptions, int)

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

Declaration

public ApiResponse<ExtractCodesResult> GetEmailCodesWithHttpInfo(Guid emailId, ExtractCodesOptions extractCodesOptions = null, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<ExtractCodesResult>	ApiResponse of ExtractCodesResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailCodesWithHttpInfoAsync(Guid, ExtractCodesOptions, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailContentMatch(Guid, ContentMatchOptions, int)

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

Declaration

public EmailContentMatchResult GetEmailContentMatch(Guid emailId, ContentMatchOptions contentMatchOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email to match against
ContentMatchOptions	contentMatchOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmailContentMatchResult	EmailContentMatchResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailContentMatchAsync(Guid, ContentMatchOptions, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailContentMatchWithHttpInfo(Guid, ContentMatchOptions, int)

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

Declaration

public ApiResponse<EmailContentMatchResult> GetEmailContentMatchWithHttpInfo(Guid emailId, ContentMatchOptions contentMatchOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email to match against
ContentMatchOptions	contentMatchOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmailContentMatchResult>	ApiResponse of EmailContentMatchResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailContentMatchWithHttpInfoAsync(Guid, ContentMatchOptions, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public EmailContentPartResult GetEmailContentPart(Guid emailId, string contentType, bool? strict = null, int? index = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email to match against
string	contentType	Content type
bool?	strict	Strict content type match (optional)
int?	index	Index of content type part if multiple (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmailContentPartResult	EmailContentPartResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public string GetEmailContentPartContent(Guid emailId, string contentType, bool? strict = null, int? index = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email to match against
string	contentType	Content type
bool?	strict	Strict content type match (optional)
int?	index	Index of content type part if multiple. Starts from 0 and applies to the result list after selecting for your content type. Content type parts are sorted by order found in original MIME message. (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
string	string

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public ApiResponse<string> GetEmailContentPartContentWithHttpInfo(Guid emailId, string contentType, bool? strict = null, int? index = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email to match against
string	contentType	Content type
bool?	strict	Strict content type match (optional)
int?	index	Index of content type part if multiple. Starts from 0 and applies to the result list after selecting for your content type. Content type parts are sorted by order found in original MIME message. (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<string>	ApiResponse of string

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public ApiResponse<EmailContentPartResult> GetEmailContentPartWithHttpInfo(Guid emailId, string contentType, bool? strict = null, int? index = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email to match against
string	contentType	Content type
bool?	strict	Strict content type match (optional)
int?	index	Index of content type part if multiple (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmailContentPartResult>	ApiResponse of EmailContentPartResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailCount(Guid?, int)

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

Declaration

public CountDto GetEmailCount(Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	inboxId	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CountDto	CountDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailCountAsync(Guid?, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailCountWithHttpInfo(Guid?, int)

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

Declaration

public ApiResponse<CountDto> GetEmailCountWithHttpInfo(Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	inboxId	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CountDto>	ApiResponse of CountDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailCountWithHttpInfoAsync(Guid?, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailHTML(Guid, bool?, int)

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

Declaration

public string GetEmailHTML(Guid emailId, bool? replaceCidImages = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
bool?	replaceCidImages	(optional, default to false)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
string	string

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailHTMLAsync(Guid, bool?, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailHTMLJson(Guid, bool?, int)

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

Declaration

public EmailHtmlDto GetEmailHTMLJson(Guid emailId, bool? replaceCidImages = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
bool?	replaceCidImages	(optional, default to false)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmailHtmlDto	EmailHtmlDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailHTMLJsonAsync(Guid, bool?, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailHTMLJsonWithHttpInfo(Guid, bool?, int)

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

Declaration

public ApiResponse<EmailHtmlDto> GetEmailHTMLJsonWithHttpInfo(Guid emailId, bool? replaceCidImages = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
bool?	replaceCidImages	(optional, default to false)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmailHtmlDto>	ApiResponse of EmailHtmlDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailHTMLJsonWithHttpInfoAsync(Guid, bool?, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailHTMLQuery(Guid, string, int)

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

Declaration

public EmailTextLinesResult GetEmailHTMLQuery(Guid emailId, string htmlSelector, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email to perform HTML query on
string	htmlSelector	HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information.
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmailTextLinesResult	EmailTextLinesResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailHTMLQueryAsync(Guid, string, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailHTMLQueryWithHttpInfo(Guid, string, int)

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

Declaration

public ApiResponse<EmailTextLinesResult> GetEmailHTMLQueryWithHttpInfo(Guid emailId, string htmlSelector, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email to perform HTML query on
string	htmlSelector	HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information.
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmailTextLinesResult>	ApiResponse of EmailTextLinesResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailHTMLQueryWithHttpInfoAsync(Guid, string, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailHTMLWithHttpInfo(Guid, bool?, int)

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

Declaration

public ApiResponse<string> GetEmailHTMLWithHttpInfo(Guid emailId, bool? replaceCidImages = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
bool?	replaceCidImages	(optional, default to false)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<string>	ApiResponse of string

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailHTMLWithHttpInfoAsync(Guid, bool?, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailLinks(Guid, string, int)

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

Declaration

public EmailLinksResult GetEmailLinks(Guid emailId, string selector = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email to fetch text for
string	selector	Optional HTML query selector for links (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmailLinksResult	EmailLinksResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailLinksAsync(Guid, string, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailLinksWithHttpInfo(Guid, string, int)

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

Declaration

public ApiResponse<EmailLinksResult> GetEmailLinksWithHttpInfo(Guid emailId, string selector = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email to fetch text for
string	selector	Optional HTML query selector for links (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmailLinksResult>	ApiResponse of EmailLinksResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailLinksWithHttpInfoAsync(Guid, string, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailPreviewURLs(Guid, int)

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

Declaration

public EmailPreviewUrls GetEmailPreviewURLs(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmailPreviewUrls	EmailPreviewUrls

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailPreviewURLsAsync(Guid, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailPreviewURLsWithHttpInfo(Guid, int)

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

Declaration

public ApiResponse<EmailPreviewUrls> GetEmailPreviewURLsWithHttpInfo(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmailPreviewUrls>	ApiResponse of EmailPreviewUrls

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailPreviewURLsWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailScreenshotAsBase64(Guid, GetEmailScreenshotOptions, int)

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

Declaration

public EmailScreenshotResult GetEmailScreenshotAsBase64(Guid emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
GetEmailScreenshotOptions	getEmailScreenshotOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmailScreenshotResult	EmailScreenshotResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailScreenshotAsBase64Async(Guid, GetEmailScreenshotOptions, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailScreenshotAsBase64WithHttpInfo(Guid, GetEmailScreenshotOptions, int)

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

Declaration

public ApiResponse<EmailScreenshotResult> GetEmailScreenshotAsBase64WithHttpInfo(Guid emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
GetEmailScreenshotOptions	getEmailScreenshotOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmailScreenshotResult>	ApiResponse of EmailScreenshotResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailScreenshotAsBase64WithHttpInfoAsync(Guid, GetEmailScreenshotOptions, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailScreenshotAsBinary(Guid, GetEmailScreenshotOptions, int)

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

Declaration

public void GetEmailScreenshotAsBinary(Guid emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
GetEmailScreenshotOptions	getEmailScreenshotOptions
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailScreenshotAsBinaryAsync(Guid, GetEmailScreenshotOptions, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailScreenshotAsBinaryWithHttpInfo(Guid, GetEmailScreenshotOptions, int)

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

Declaration

public ApiResponse<object> GetEmailScreenshotAsBinaryWithHttpInfo(Guid emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
GetEmailScreenshotOptions	getEmailScreenshotOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailScreenshotAsBinaryWithHttpInfoAsync(Guid, GetEmailScreenshotOptions, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailSignature(Guid, int)

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

Declaration

public EmailSignatureParseResult GetEmailSignature(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email to extract signature from
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmailSignatureParseResult	EmailSignatureParseResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailSignatureAsync(Guid, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailSignatureWithHttpInfo(Guid, int)

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

Declaration

public ApiResponse<EmailSignatureParseResult> GetEmailSignatureWithHttpInfo(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email to extract signature from
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmailSignatureParseResult>	ApiResponse of EmailSignatureParseResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailSignatureWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailSummary(Guid, bool?, int)

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

Declaration

public EmailPreview GetEmailSummary(Guid emailId, bool? decode = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
bool?	decode	Deprecated and ignored. Retained for backwards compatibility. (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmailPreview	EmailPreview

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailSummaryAsync(Guid, bool?, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailSummaryWithHttpInfo(Guid, bool?, int)

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

Declaration

public ApiResponse<EmailPreview> GetEmailSummaryWithHttpInfo(Guid emailId, bool? decode = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
bool?	decode	Deprecated and ignored. Retained for backwards compatibility. (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmailPreview>	ApiResponse of EmailPreview

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailSummaryWithHttpInfoAsync(Guid, bool?, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailTextLines(Guid, bool?, string, int)

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

Declaration

public EmailTextLinesResult GetEmailTextLines(Guid emailId, bool? decodeHtmlEntities = null, string lineSeparator = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email to fetch text for
bool?	decodeHtmlEntities	Decode HTML entities (optional)
string	lineSeparator	Line separator character (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmailTextLinesResult	EmailTextLinesResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailTextLinesWithHttpInfo(Guid, bool?, string, int)

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

Declaration

public ApiResponse<EmailTextLinesResult> GetEmailTextLinesWithHttpInfo(Guid emailId, bool? decodeHtmlEntities = null, string lineSeparator = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email to fetch text for
bool?	decodeHtmlEntities	Decode HTML entities (optional)
string	lineSeparator	Line separator character (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmailTextLinesResult>	ApiResponse of EmailTextLinesResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailThread(Guid, int)

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

Declaration

public EmailThreadDto GetEmailThread(Guid threadId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	threadId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmailThreadDto	EmailThreadDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailThreadAsync(Guid, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailThreadItems(Guid, string, int)

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

Declaration

public EmailThreadItemsDto GetEmailThreadItems(Guid threadId, string sort = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	threadId
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmailThreadItemsDto	EmailThreadItemsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailThreadItemsAsync(Guid, string, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailThreadItemsWithHttpInfo(Guid, string, int)

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

Declaration

public ApiResponse<EmailThreadItemsDto> GetEmailThreadItemsWithHttpInfo(Guid threadId, string sort = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	threadId
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmailThreadItemsDto>	ApiResponse of EmailThreadItemsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailThreadItemsWithHttpInfoAsync(Guid, string, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailThreadWithHttpInfo(Guid, int)

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

Declaration

public ApiResponse<EmailThreadDto> GetEmailThreadWithHttpInfo(Guid threadId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	threadId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmailThreadDto>	ApiResponse of EmailThreadDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailThreadWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public PageEmailThreadProjection GetEmailThreads(Guid? htmlSelector = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	htmlSelector	Optional inbox filter. Query parameter name is htmlSelector for legacy compatibility. (optional)
int?	page	Optional page index in email thread pagination (optional, default to 0)
int?	size	Optional page size in email thread pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter search filter for email threads. (optional)
DateTime?	since	Optional filter email threads created since time (optional)
DateTime?	before	Optional filter emails threads created before given date time (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageEmailThreadProjection	PageEmailThreadProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

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

Parameters

Type	Name	Description
Guid?	htmlSelector	Optional inbox filter. Query parameter name is htmlSelector for legacy compatibility. (optional)
int?	page	Optional page index in email thread pagination (optional, default to 0)
int?	size	Optional page size in email thread pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter search filter for email threads. (optional)
DateTime?	since	Optional filter email threads created since time (optional)
DateTime?	before	Optional filter emails threads created before given date time (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageEmailThreadProjection>	ApiResponse of PageEmailThreadProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailWithHttpInfo(Guid, int)

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

Declaration

public ApiResponse<Email> GetEmailWithHttpInfo(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<Email>	ApiResponse of Email

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get all emails in all inboxes in paginated form. Email API list all. 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.

Declaration

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

Parameters

Type	Name	Description
List<Guid>	inboxId	Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
int?	page	Optional page index in email list pagination (optional, default to 0)
int?	size	Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool?	unreadOnly	Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
string	searchFilter	Optional search filter. Full email addresses match sender and receiving inbox email or receiving plus-address full address exactly. Address-like fragments containing @ (for example +alias@) also match sender, receiving inbox email, and receiving plus-address full address by contains. General text search matches sender, subject, and ID. (optional)
DateTime?	since	Optional filter emails received after given date time (optional)
DateTime?	before	Optional filter emails received before given date time (optional)
bool?	favourited	Optional filter emails that are favourited (optional)
bool?	syncConnectors	Sync connectors (optional)
Guid?	plusAddressId	Optional plus address ID filter (optional)
List<Guid>	include	Optional list of IDs to include in result (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageEmailProjection	PageEmailProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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. 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.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get all emails in all inboxes in paginated form. Email API list all. 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.

Declaration

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

Parameters

Type	Name	Description
List<Guid>	inboxId	Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
int?	page	Optional page index in email list pagination (optional, default to 0)
int?	size	Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool?	unreadOnly	Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
string	searchFilter	Optional search filter. Full email addresses match sender and receiving inbox email or receiving plus-address full address exactly. Address-like fragments containing @ (for example +alias@) also match sender, receiving inbox email, and receiving plus-address full address by contains. General text search matches sender, subject, and ID. (optional)
DateTime?	since	Optional filter emails received after given date time (optional)
DateTime?	before	Optional filter emails received before given date time (optional)
bool?	favourited	Optional filter emails that are favourited (optional)
bool?	syncConnectors	Sync connectors (optional)
Guid?	plusAddressId	Optional plus address ID filter (optional)
List<Guid>	include	Optional list of IDs to include in result (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageEmailProjection>	ApiResponse of PageEmailProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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. 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.

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get all emails in all inboxes in paginated form. Email API list all. 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.

Declaration

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

Parameters

Type	Name	Description
List<Guid>	inboxId	Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
int?	page	Optional page index in email list pagination (optional, default to 0)
int?	size	Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool?	unreadOnly	Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
string	searchFilter	Optional search filter. Full email addresses match sender and receiving inbox email or receiving plus-address full address exactly. Address-like fragments containing @ (for example +alias@) also match sender, receiving inbox email, and receiving plus-address full address by contains. General text search matches sender, subject, and ID. (optional)
DateTime?	since	Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional)
DateTime?	before	Optional filter emails received before given date time (optional)
bool?	syncConnectors	Sync connectors (optional)
Guid?	plusAddressId	Optional plus address ID filter (optional)
bool?	favourited	Optional filter emails that are favourited (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageEmailProjection	PageEmailProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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. 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.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get all emails in all inboxes in paginated form. Email API list all. 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.

Declaration

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

Parameters

Type	Name	Description
List<Guid>	inboxId	Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
int?	page	Optional page index in email list pagination (optional, default to 0)
int?	size	Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool?	unreadOnly	Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
string	searchFilter	Optional search filter. Full email addresses match sender and receiving inbox email or receiving plus-address full address exactly. Address-like fragments containing @ (for example +alias@) also match sender, receiving inbox email, and receiving plus-address full address by contains. General text search matches sender, subject, and ID. (optional)
DateTime?	since	Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional)
DateTime?	before	Optional filter emails received before given date time (optional)
bool?	syncConnectors	Sync connectors (optional)
Guid?	plusAddressId	Optional plus address ID filter (optional)
bool?	favourited	Optional filter emails that are favourited (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageEmailProjection>	ApiResponse of PageEmailProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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. 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.

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetGravatarUrlForEmailAddress(string, string, int)

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

Declaration

public GravatarUrl GetGravatarUrlForEmailAddress(string emailAddress, string size = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress
string	size	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
GravatarUrl	GravatarUrl

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetGravatarUrlForEmailAddressAsync(string, string, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetGravatarUrlForEmailAddressWithHttpInfo(string, string, int)

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

Declaration

public ApiResponse<GravatarUrl> GetGravatarUrlForEmailAddressWithHttpInfo(string emailAddress, string size = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress
string	size	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<GravatarUrl>	ApiResponse of GravatarUrl

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetGravatarUrlForEmailAddressWithHttpInfoAsync(string, string, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetLatestEmail(List<Guid>, int)

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

Declaration

public Email GetLatestEmail(List<Guid> inboxIds = null, int operationIndex = 0)

Parameters

Type	Name	Description
List<Guid>	inboxIds	Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
Email	Email

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetLatestEmailAsync(List<Guid>, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetLatestEmailInInbox1(Guid, int)

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

Declaration

public Email GetLatestEmailInInbox1(Guid inboxId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	inboxId	ID of the inbox you want to get the latest email from
int	operationIndex	Index associated with the operation.

Returns

Type	Description
Email	Email

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetLatestEmailInInbox1Async(Guid, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetLatestEmailInInbox1WithHttpInfo(Guid, int)

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

Declaration

public ApiResponse<Email> GetLatestEmailInInbox1WithHttpInfo(Guid inboxId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	inboxId	ID of the inbox you want to get the latest email from
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<Email>	ApiResponse of Email

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetLatestEmailInInbox1WithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetLatestEmailWithHttpInfo(List<Guid>, int)

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

Declaration

public ApiResponse<Email> GetLatestEmailWithHttpInfo(List<Guid> inboxIds = null, int operationIndex = 0)

Parameters

Type	Name	Description
List<Guid>	inboxIds	Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<Email>	ApiResponse of Email

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetLatestEmailWithHttpInfoAsync(List<Guid>, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

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

Parameters

Type	Name	Description
List<Guid>	inboxId	Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
int?	page	Optional page index in email list pagination (optional, default to 0)
int?	size	Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool?	unreadOnly	Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
string	searchFilter	Optional search filter search filter for emails. (optional)
DateTime?	since	Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional)
DateTime?	before	Optional filter emails received before given date time (optional)
bool?	syncConnectors	Sync connectors (optional)
bool?	favourited	Search only favorited emails (optional)
Guid?	plusAddressId	Optional plus address ID filter (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageEmailProjection	PageEmailProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

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

Parameters

Type	Name	Description
List<Guid>	inboxId	Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
int?	page	Optional page index in email list pagination (optional, default to 0)
int?	size	Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool?	unreadOnly	Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
string	searchFilter	Optional search filter search filter for emails. (optional)
DateTime?	since	Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional)
DateTime?	before	Optional filter emails received before given date time (optional)
bool?	syncConnectors	Sync connectors (optional)
bool?	favourited	Search only favorited emails (optional)
Guid?	plusAddressId	Optional plus address ID filter (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageEmailProjection>	ApiResponse of PageEmailProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetRawEmailContents(Guid, int)

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

Declaration

public void GetRawEmailContents(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetRawEmailContentsAsync(Guid, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetRawEmailContentsWithHttpInfo(Guid, int)

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

Declaration

public ApiResponse<object> GetRawEmailContentsWithHttpInfo(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetRawEmailContentsWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetRawEmailJson(Guid, int)

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

Declaration

public RawEmailJson GetRawEmailJson(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.

Returns

Type	Description
RawEmailJson	RawEmailJson

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetRawEmailJsonAsync(Guid, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetRawEmailJsonWithHttpInfo(Guid, int)

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

Declaration

public ApiResponse<RawEmailJson> GetRawEmailJsonWithHttpInfo(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<RawEmailJson>	ApiResponse of RawEmailJson

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetRawEmailJsonWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetUnreadEmailCount(Guid?, int)

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

Declaration

public UnreadCount GetUnreadEmailCount(Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	inboxId	Inbox ID filter for unread count scope (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
UnreadCount	UnreadCount

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetUnreadEmailCountAsync(Guid?, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetUnreadEmailCountWithHttpInfo(Guid?, int)

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

Declaration

public ApiResponse<UnreadCount> GetUnreadEmailCountWithHttpInfo(Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	inboxId	Inbox ID filter for unread count scope (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<UnreadCount>	ApiResponse of UnreadCount

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetUnreadEmailCountWithHttpInfoAsync(Guid?, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

MarkAllAsRead(bool?, Guid?, int)

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

Declaration

public void MarkAllAsRead(bool? read = null, Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
bool?	read	What value to assign to email read property. Default true. (optional, default to true)
Guid?	inboxId	Optional inbox ID filter (optional)
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

MarkAllAsReadWithHttpInfo(bool?, Guid?, int)

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

Declaration

public ApiResponse<object> MarkAllAsReadWithHttpInfo(bool? read = null, Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
bool?	read	What value to assign to email read property. Default true. (optional, default to true)
Guid?	inboxId	Optional inbox ID filter (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

MarkAsRead(Guid, bool?, int)

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

Declaration

public EmailPreview MarkAsRead(Guid emailId, bool? read = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
bool?	read	What value to assign to email read property. Default true. (optional, default to true)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmailPreview	EmailPreview

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

MarkAsReadAsync(Guid, bool?, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

MarkAsReadWithHttpInfo(Guid, bool?, int)

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

Declaration

public ApiResponse<EmailPreview> MarkAsReadWithHttpInfo(Guid emailId, bool? read = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
bool?	read	What value to assign to email read property. Default true. (optional, default to true)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmailPreview>	ApiResponse of EmailPreview

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

MarkAsReadWithHttpInfoAsync(Guid, bool?, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ReplyToEmail(Guid, ReplyToEmailOptions, int)

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

Declaration

public SentEmailDto ReplyToEmail(Guid emailId, ReplyToEmailOptions replyToEmailOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of the email that should be replied to
ReplyToEmailOptions	replyToEmailOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
SentEmailDto	SentEmailDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ReplyToEmailAsync(Guid, ReplyToEmailOptions, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ReplyToEmailWithHttpInfo(Guid, ReplyToEmailOptions, int)

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

Declaration

public ApiResponse<SentEmailDto> ReplyToEmailWithHttpInfo(Guid emailId, ReplyToEmailOptions replyToEmailOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of the email that should be replied to
ReplyToEmailOptions	replyToEmailOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<SentEmailDto>	ApiResponse of SentEmailDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ReplyToEmailWithHttpInfoAsync(Guid, ReplyToEmailOptions, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public PageEmailProjection SearchEmails(SearchEmailsOptions searchEmailsOptions, bool? syncConnectors = null, bool? favourited = null, Guid? plusAddressId = null, int operationIndex = 0)

Parameters

Type	Name	Description
SearchEmailsOptions	searchEmailsOptions
bool?	syncConnectors	Sync connectors (optional)
bool?	favourited	Search only favourited emails (optional)
Guid?	plusAddressId	Optional plus address ID filter (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageEmailProjection	PageEmailProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public ApiResponse<PageEmailProjection> SearchEmailsWithHttpInfo(SearchEmailsOptions searchEmailsOptions, bool? syncConnectors = null, bool? favourited = null, Guid? plusAddressId = null, int operationIndex = 0)

Parameters

Type	Name	Description
SearchEmailsOptions	searchEmailsOptions
bool?	syncConnectors	Sync connectors (optional)
bool?	favourited	Search only favourited emails (optional)
Guid?	plusAddressId	Optional plus address ID filter (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageEmailProjection>	ApiResponse of PageEmailProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public void SendEmailSourceOptional(SendEmailOptions sendEmailOptions, Guid? inboxId = null, bool? useDomainPool = null, bool? virtualSend = null, int operationIndex = 0)

Parameters

Type	Name	Description
SendEmailOptions	sendEmailOptions
Guid?	inboxId	ID of the inbox you want to send the email from (optional)
bool?	useDomainPool	Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional)
bool?	virtualSend	Optionally create inbox to send from that is a virtual inbox and won't send to external addresses (optional)
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public ApiResponse<object> SendEmailSourceOptionalWithHttpInfo(SendEmailOptions sendEmailOptions, Guid? inboxId = null, bool? useDomainPool = null, bool? virtualSend = null, int operationIndex = 0)

Parameters

Type	Name	Description
SendEmailOptions	sendEmailOptions
Guid?	inboxId	ID of the inbox you want to send the email from (optional)
bool?	useDomainPool	Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional)
bool?	virtualSend	Optionally create inbox to send from that is a virtual inbox and won't send to external addresses (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SetEmailFavourited(Guid, bool, int)

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

Declaration

public void SetEmailFavourited(Guid emailId, bool favourited, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email to set favourite state
bool	favourited
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SetEmailFavouritedAsync(Guid, bool, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SetEmailFavouritedWithHttpInfo(Guid, bool, int)

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

Declaration

public ApiResponse<object> SetEmailFavouritedWithHttpInfo(Guid emailId, bool favourited, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email to set favourite state
bool	favourited
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SetEmailFavouritedWithHttpInfoAsync(Guid, bool, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ValidateEmail(Guid, int)

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

Declaration

public ValidationDto ValidateEmail(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ValidationDto	ValidationDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ValidateEmailAsync(Guid, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ValidateEmailWithHttpInfo(Guid, int)

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

Declaration

public ApiResponse<ValidationDto> ValidateEmailWithHttpInfo(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<ValidationDto>	ApiResponse of ValidationDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ValidateEmailWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

IEmailControllerApi

IEmailControllerApiSync

IEmailControllerApiAsync

IApiAccessor