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

EmailControllerApi(string)

Initializes a new instance of the EmailControllerApi class.

Declaration

public EmailControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

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. Apply RFC3501 section-2.3.2 IMAP flag operations on an email

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. Apply RFC3501 section-2.3.2 IMAP flag operations on an email

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. Apply RFC3501 section-2.3.2 IMAP flag operations on an email

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. Apply RFC3501 section-2.3.2 IMAP flag operations on an email

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

DeleteAllEmails(int)

Delete all emails in all inboxes. Deletes all emails in your account. Be careful as emails cannot be recovered

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 in your account. Be careful as emails cannot be recovered

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 in your account. Be careful as emails cannot be recovered

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 in your account. Be careful as emails cannot be recovered

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 an email and removes it from the inbox. Deleted emails cannot be recovered.

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 an email and removes it from the inbox. Deleted emails cannot be recovered.

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 an email and removes it from the inbox. Deleted emails cannot be recovered.

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 an email and removes it from the inbox. Deleted emails cannot be recovered.

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 the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.

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 the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.

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 the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the downloadAttachment method but allows some clients to get around issues with binary 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 the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the downloadAttachment method but allows some clients to get around issues with binary 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 the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the downloadAttachment method but allows some clients to get around issues with binary 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 the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the downloadAttachment method but allows some clients to get around issues with binary 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 the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.

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 the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.

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 the specified email body for a given email as a string

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 the specified email body for a given email as a string

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. Returns the specified email body for a given email as a stream / array of bytes.

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. Returns the specified email body for a given email as a stream / array of bytes.

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. Returns the specified email body for a given email as a stream / array of bytes.

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. Returns the specified email body for a given email as a stream / array of bytes.

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 the specified email body for a given email as a string

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 the specified email body for a given email as a string

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 Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the from option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints.

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 Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the from option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints.

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 Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the from option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints.

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 Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the from option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints.

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 the metadata such as name and content-type for a given attachment and email.

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 the metadata such as name and content-type for a given attachment and email.

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 the metadata such as name and content-type for a given attachment and email.

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 the metadata such as name and content-type for a given attachment and email.

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, bool?, int)

Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints

Declaration

public Email GetEmail(Guid emailId, bool? decode = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
bool?	decode	Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance =D7). This can be a pain for testing (optional, default to false)
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, bool?, int, CancellationToken)

Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints

Declaration

public Task<Email> GetEmailAsync(Guid emailId, bool? decode = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
bool?	decode	Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance =D7). This can be a pain for testing (optional, default to false)
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)

Get all email attachment metadata. Metadata includes name and size of attachments. Returns an array of attachment metadata such as name and content-type for a given email if present.

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)

Get all email attachment metadata. Metadata includes name and size of attachments. Returns an array of attachment metadata such as name and content-type for a given email if present.

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)

Get all email attachment metadata. Metadata includes name and size of attachments. Returns an array of attachment metadata such as name and content-type for a given email if present.

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)

Get all email attachment metadata. Metadata includes name and size of attachments. Returns an array of attachment metadata such as name and content-type for a given email if present.

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

GetEmailContentMatch(Guid, ContentMatchOptions, int)

Get email content regex pattern match results. Runs regex against email body and returns match groups. Return the matches for a given Java style regex pattern. Do not include the typical / at start or end of regex in some languages. Given an example your code is: 12345 the pattern to extract match looks like code is: (\\d{6}). This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: ['code is: 123456', '123456'] See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns.

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)

Get email content regex pattern match results. Runs regex against email body and returns match groups. Return the matches for a given Java style regex pattern. Do not include the typical / at start or end of regex in some languages. Given an example your code is: 12345 the pattern to extract match looks like code is: (\\d{6}). This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: ['code is: 123456', '123456'] See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns.

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)

Get email content regex pattern match results. Runs regex against email body and returns match groups. Return the matches for a given Java style regex pattern. Do not include the typical / at start or end of regex in some languages. Given an example your code is: 12345 the pattern to extract match looks like code is: (\\d{6}). This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: ['code is: 123456', '123456'] See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns.

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)

Get email content regex pattern match results. Runs regex against email body and returns match groups. Return the matches for a given Java style regex pattern. Do not include the typical / at start or end of regex in some languages. Given an example your code is: 12345 the pattern to extract match looks like code is: (\\d{6}). This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: ['code is: 123456', '123456'] See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns.

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

GetEmailCount(int)

Get email count

Declaration

public CountDto GetEmailCount(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CountDto	CountDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailCountAsync(int, CancellationToken)

Get email count

Declaration

public Task<CountDto> GetEmailCountAsync(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<CountDto>	Task of CountDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailCountWithHttpInfo(int)

Get email count

Declaration

public ApiResponse<CountDto> GetEmailCountWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
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(int, CancellationToken)

Get email count

Declaration

public Task<ApiResponse<CountDto>> GetEmailCountWithHttpInfoAsync(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<CountDto>>	Task of ApiResponse (CountDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailHTML(Guid, bool?, int)

Get email content as HTML. For displaying emails in browser context. Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: ?apiKey=xxx. Returns content-type text/html;charset=utf-8 so you must call expecting that content response not JSON. For JSON response see the getEmailHTMLJson method.

Declaration

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

Parameters

Type	Name	Description
Guid	emailId
bool?	decode	(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 email content as HTML. For displaying emails in browser context. Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: ?apiKey=xxx. Returns content-type text/html;charset=utf-8 so you must call expecting that content response not JSON. For JSON response see the getEmailHTMLJson method.

Declaration

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

Parameters

Type	Name	Description
Guid	emailId
bool?	decode	(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 email content as HTML in JSON wrapper. For fetching entity decoded HTML content Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type application/json;charset=utf-8 so you must call expecting that content response not JSON.

Declaration

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

Parameters

Type	Name	Description
Guid	emailId
bool?	decode	(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 email content as HTML in JSON wrapper. For fetching entity decoded HTML content Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type application/json;charset=utf-8 so you must call expecting that content response not JSON.

Declaration

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

Parameters

Type	Name	Description
Guid	emailId
bool?	decode	(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 email content as HTML in JSON wrapper. For fetching entity decoded HTML content Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type application/json;charset=utf-8 so you must call expecting that content response not JSON.

Declaration

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

Parameters

Type	Name	Description
Guid	emailId
bool?	decode	(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 email content as HTML in JSON wrapper. For fetching entity decoded HTML content Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type application/json;charset=utf-8 so you must call expecting that content response not JSON.

Declaration

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

Parameters

Type	Name	Description
Guid	emailId
bool?	decode	(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)

Parse and return text from an email, stripping HTML and decoding encoded characters Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors

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)

Parse and return text from an email, stripping HTML and decoding encoded characters Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors

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)

Parse and return text from an email, stripping HTML and decoding encoded characters Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors

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)

Parse and return text from an email, stripping HTML and decoding encoded characters Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors

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 email content as HTML. For displaying emails in browser context. Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: ?apiKey=xxx. Returns content-type text/html;charset=utf-8 so you must call expecting that content response not JSON. For JSON response see the getEmailHTMLJson method.

Declaration

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

Parameters

Type	Name	Description
Guid	emailId
bool?	decode	(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 email content as HTML. For displaying emails in browser context. Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: ?apiKey=xxx. Returns content-type text/html;charset=utf-8 so you must call expecting that content response not JSON. For JSON response see the getEmailHTMLJson method.

Declaration

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

Parameters

Type	Name	Description
Guid	emailId
bool?	decode	(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, int)

Parse and return list of links found in an email (only works for HTML content) HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes

Declaration

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

Parameters

Type	Name	Description
Guid	emailId	ID of email to fetch text for
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, int, CancellationToken)

Parse and return list of links found in an email (only works for HTML content) HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes

Declaration

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

Parameters

Type	Name	Description
Guid	emailId	ID of email to fetch text for
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, int)

Parse and return list of links found in an email (only works for HTML content) HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes

Declaration

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

Parameters

Type	Name	Description
Guid	emailId	ID of email to fetch text for
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, int, CancellationToken)

Parse and return list of links found in an email (only works for HTML content) HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes

Declaration

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

Parameters

Type	Name	Description
Guid	emailId	ID of email to fetch text for
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 Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser.

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 Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser.

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 Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser.

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 Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser.

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

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

Get all emails in all inboxes in paginated form. Email API list all. By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages

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, 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. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional)
DateTime?	since	Optional filter emails received after given date time (optional)
DateTime?	before	Optional filter emails received before given date time (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?, int, CancellationToken)

Get all emails in all inboxes in paginated form. Email API list all. By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages

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, 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. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional)
DateTime?	since	Optional filter emails received after given date time (optional)
DateTime?	before	Optional filter emails received before given date time (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?, int)

Get all emails in all inboxes in paginated form. Email API list all. By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages

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, 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. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional)
DateTime?	since	Optional filter emails received after given date time (optional)
DateTime?	before	Optional filter emails received before given date time (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?, int, CancellationToken)

Get all emails in all inboxes in paginated form. Email API list all. By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages

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, 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. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional)
DateTime?	since	Optional filter emails received after given date time (optional)
DateTime?	before	Optional filter emails received 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<PageEmailProjection>>	Task of ApiResponse (PageEmailProjection)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmailTextLines(Guid, bool?, string, int)

Parse and return text from an email, stripping HTML and decoding encoded characters Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators.

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)

Parse and return text from an email, stripping HTML and decoding encoded characters Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators.

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)

Parse and return text from an email, stripping HTML and decoding encoded characters Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators.

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)

Parse and return text from an email, stripping HTML and decoding encoded characters Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators.

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

GetEmailWithHttpInfo(Guid, bool?, int)

Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints

Declaration

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

Parameters

Type	Name	Description
Guid	emailId
bool?	decode	Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance =D7). This can be a pain for testing (optional, default to false)
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, bool?, int, CancellationToken)

Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints

Declaration

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

Parameters

Type	Name	Description
Guid	emailId
bool?	decode	Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance =D7). This can be a pain for testing (optional, default to false)
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

GetGravatarUrlForEmailAddress(string, string, int)

Get gravatar url for email address

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 email address

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 email address

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 email address

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. Get the newest email in all inboxes or in a passed set 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. Get the newest email in all inboxes or in a passed set 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. Get the newest email in all inboxes or in a passed set of inbox IDs

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. Get the newest email in all inboxes or in a passed set of inbox IDs

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. Get the newest email in all inboxes or in a passed set of inbox IDs

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. Get the newest email in all inboxes or in a passed set of inbox IDs

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. Get the newest email in all inboxes or in a passed set 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. Get the newest email in all inboxes or in a passed set 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?, int)

Get all organization emails. List team or shared test email accounts By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages

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, 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 (optional)
DateTime?	before	Optional filter emails received before given date time (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?, int, CancellationToken)

Get all organization emails. List team or shared test email accounts By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages

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, 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 (optional)
DateTime?	before	Optional filter emails received before given date time (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?, int)

Get all organization emails. List team or shared test email accounts By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages

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, 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 (optional)
DateTime?	before	Optional filter emails received before given date time (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?, int, CancellationToken)

Get all organization emails. List team or shared test email accounts By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages

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, 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 (optional)
DateTime?	before	Optional filter emails received 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<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 a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint

Declaration

public string GetRawEmailContents(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

GetRawEmailContentsAsync(Guid, int, CancellationToken)

Get raw email string. Returns unparsed raw SMTP message with headers and body. Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint

Declaration

public Task<string> 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<string>	Task of string

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 a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint

Declaration

public ApiResponse<string> 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<string>	ApiResponse of string

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 a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint

Declaration

public Task<ApiResponse<string>> 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<string>>	Task of ApiResponse (string)

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 a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response

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 a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response

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 a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response

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 a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response

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(int)

Get unread email count Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response

Declaration

public UnreadCount GetUnreadEmailCount(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
UnreadCount	UnreadCount

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetUnreadEmailCountAsync(int, CancellationToken)

Get unread email count Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response

Declaration

public Task<UnreadCount> GetUnreadEmailCountAsync(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<UnreadCount>	Task of UnreadCount

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetUnreadEmailCountWithHttpInfo(int)

Get unread email count Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response

Declaration

public ApiResponse<UnreadCount> GetUnreadEmailCountWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
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(int, CancellationToken)

Get unread email count Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response

Declaration

public Task<ApiResponse<UnreadCount>> GetUnreadEmailCountWithHttpInfoAsync(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<UnreadCount>>	Task of ApiResponse (UnreadCount)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

MarkAsRead(Guid, bool?, int)

Mark an email as read on unread Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it 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 on unread Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it 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 on unread Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it 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 on unread Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it 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 Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails to, cc, and bcc.

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 Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails to, cc, and bcc.

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 Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails to, cc, and bcc.

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 Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails to, cc, and bcc.

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

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

Send email Alias for InboxController.sendEmail method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email.

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 Alias for InboxController.sendEmail method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email.

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 Alias for InboxController.sendEmail method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email.

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 Alias for InboxController.sendEmail method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email.

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

ValidateEmail(Guid, int)

Validate email HTML contents Validate the HTML content of email if HTML is found. Considered valid if no HTML is present.

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 Validate the HTML content of email if HTML is found. Considered valid if no HTML is present.

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 Validate the HTML content of email if HTML is found. Considered valid if no HTML is present.

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 Validate the HTML content of email if HTML is found. Considered valid if no HTML is present.

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