Class InboxControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

InboxControllerApi

Implements

IInboxControllerApi

IInboxControllerApiSync

IInboxControllerApiAsync

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 InboxControllerApi : IInboxControllerApi, IInboxControllerApiSync, IInboxControllerApiAsync, IApiAccessor

Constructors

View Source

InboxControllerApi()

Initializes a new instance of the InboxControllerApi class.

Declaration

public InboxControllerApi()

View Source

InboxControllerApi(Configuration)

Initializes a new instance of the InboxControllerApi class using Configuration object

Declaration

public InboxControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

View Source

InboxControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

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

Declaration

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

View Source

InboxControllerApi(string)

Initializes a new instance of the InboxControllerApi class.

Declaration

public InboxControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

Properties

View Source

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

View Source

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

View Source

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

View Source

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

View Source

CancelScheduledJob(Guid, int)

Cancel a scheduled email job Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete.

Declaration

public ScheduledJobDto CancelScheduledJob(Guid jobId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ScheduledJobDto	ScheduledJobDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CancelScheduledJobAsync(Guid, int, CancellationToken)

Cancel a scheduled email job Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete.

Declaration

public Task<ScheduledJobDto> CancelScheduledJobAsync(Guid jobId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<ScheduledJobDto>	Task of ScheduledJobDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CancelScheduledJobWithHttpInfo(Guid, int)

Cancel a scheduled email job Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete.

Declaration

public ApiResponse<ScheduledJobDto> CancelScheduledJobWithHttpInfo(Guid jobId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<ScheduledJobDto>	ApiResponse of ScheduledJobDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CancelScheduledJobWithHttpInfoAsync(Guid, int, CancellationToken)

Cancel a scheduled email job Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete.

Declaration

public Task<ApiResponse<ScheduledJobDto>> CancelScheduledJobWithHttpInfoAsync(Guid jobId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either SMTP or HTTP inboxes. Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.

Declaration

public InboxDto CreateInbox(string emailAddress = null, List<string> tags = null, string name = null, string description = null, bool? useDomainPool = null, bool? favourite = null, DateTime? expiresAt = null, long? expiresIn = null, bool? allowTeamAccess = null, string inboxType = null, bool? virtualInbox = null, bool? useShortAddress = null, Guid? domainId = null, string domainName = null, string prefix = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress	A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. (optional)
System.Collections.Generic.List<T><string>	tags	Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. (optional)
string	name	Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. (optional)
string	description	Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional)
bool?	useDomainPool	Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. (optional)
bool?	favourite	Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering (optional)
DateTime?	expiresAt	Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. (optional)
long?	expiresIn	Number of milliseconds that inbox should exist for (optional)
bool?	allowTeamAccess	DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional)
string	inboxType	HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mxslurp.click`. (optional)
bool?	virtualInbox	Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. (optional)
bool?	useShortAddress	Use a shorter email address under 31 characters (optional)
System.Guid?	domainId	ID of custom domain to use for email address. (optional)
string	domainName	FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. (optional)
string	prefix	Prefix to add before the email address for easier labelling or identification. (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxDto	InboxDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Declaration

public Task<InboxDto> CreateInboxAsync(string emailAddress = null, List<string> tags = null, string name = null, string description = null, bool? useDomainPool = null, bool? favourite = null, DateTime? expiresAt = null, long? expiresIn = null, bool? allowTeamAccess = null, string inboxType = null, bool? virtualInbox = null, bool? useShortAddress = null, Guid? domainId = null, string domainName = null, string prefix = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	emailAddress	A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. (optional)
System.Collections.Generic.List<T><string>	tags	Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. (optional)
string	name	Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. (optional)
string	description	Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional)
bool?	useDomainPool	Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. (optional)
bool?	favourite	Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering (optional)
DateTime?	expiresAt	Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. (optional)
long?	expiresIn	Number of milliseconds that inbox should exist for (optional)
bool?	allowTeamAccess	DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional)
string	inboxType	HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mxslurp.click`. (optional)
bool?	virtualInbox	Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. (optional)
bool?	useShortAddress	Use a shorter email address under 31 characters (optional)
System.Guid?	domainId	ID of custom domain to use for email address. (optional)
string	domainName	FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. (optional)
string	prefix	Prefix to add before the email address for easier labelling or identification. (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<InboxDto>	Task of InboxDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateInboxRuleset(Guid, CreateInboxRulesetOptions, int)

Create an inbox ruleset Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

Declaration

public InboxRulesetDto CreateInboxRuleset(Guid inboxId, CreateInboxRulesetOptions createInboxRulesetOptions, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId	inboxId
CreateInboxRulesetOptions	createInboxRulesetOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxRulesetDto	InboxRulesetDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateInboxRulesetAsync(Guid, CreateInboxRulesetOptions, int, CancellationToken)

Create an inbox ruleset Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

Declaration

public Task<InboxRulesetDto> CreateInboxRulesetAsync(Guid inboxId, CreateInboxRulesetOptions createInboxRulesetOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	inboxId
CreateInboxRulesetOptions	createInboxRulesetOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<InboxRulesetDto>	Task of InboxRulesetDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateInboxRulesetWithHttpInfo(Guid, CreateInboxRulesetOptions, int)

Create an inbox ruleset Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

Declaration

public ApiResponse<InboxRulesetDto> CreateInboxRulesetWithHttpInfo(Guid inboxId, CreateInboxRulesetOptions createInboxRulesetOptions, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId	inboxId
CreateInboxRulesetOptions	createInboxRulesetOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxRulesetDto>	ApiResponse of InboxRulesetDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateInboxRulesetWithHttpInfoAsync(Guid, CreateInboxRulesetOptions, int, CancellationToken)

Create an inbox ruleset Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

Declaration

public Task<ApiResponse<InboxRulesetDto>> CreateInboxRulesetWithHttpInfoAsync(Guid inboxId, CreateInboxRulesetOptions createInboxRulesetOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	inboxId
CreateInboxRulesetOptions	createInboxRulesetOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateInboxWithDefaults(int)

Create an inbox with default options. Uses MailSlurp domain pool address and is private.

Declaration

public InboxDto CreateInboxWithDefaults(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxDto	InboxDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateInboxWithDefaultsAsync(int, CancellationToken)

Create an inbox with default options. Uses MailSlurp domain pool address and is private.

Declaration

public Task<InboxDto> CreateInboxWithDefaultsAsync(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<InboxDto>	Task of InboxDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateInboxWithDefaultsWithHttpInfo(int)

Create an inbox with default options. Uses MailSlurp domain pool address and is private.

Declaration

public ApiResponse<InboxDto> CreateInboxWithDefaultsWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxDto>	ApiResponse of InboxDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateInboxWithDefaultsWithHttpInfoAsync(int, CancellationToken)

Create an inbox with default options. Uses MailSlurp domain pool address and is private.

Declaration

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Declaration

public ApiResponse<InboxDto> CreateInboxWithHttpInfo(string emailAddress = null, List<string> tags = null, string name = null, string description = null, bool? useDomainPool = null, bool? favourite = null, DateTime? expiresAt = null, long? expiresIn = null, bool? allowTeamAccess = null, string inboxType = null, bool? virtualInbox = null, bool? useShortAddress = null, Guid? domainId = null, string domainName = null, string prefix = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress	A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. (optional)
System.Collections.Generic.List<T><string>	tags	Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. (optional)
string	name	Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. (optional)
string	description	Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional)
bool?	useDomainPool	Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. (optional)
bool?	favourite	Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering (optional)
DateTime?	expiresAt	Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. (optional)
long?	expiresIn	Number of milliseconds that inbox should exist for (optional)
bool?	allowTeamAccess	DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional)
string	inboxType	HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mxslurp.click`. (optional)
bool?	virtualInbox	Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. (optional)
bool?	useShortAddress	Use a shorter email address under 31 characters (optional)
System.Guid?	domainId	ID of custom domain to use for email address. (optional)
string	domainName	FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. (optional)
string	prefix	Prefix to add before the email address for easier labelling or identification. (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxDto>	ApiResponse of InboxDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Declaration

public Task<ApiResponse<InboxDto>> CreateInboxWithHttpInfoAsync(string emailAddress = null, List<string> tags = null, string name = null, string description = null, bool? useDomainPool = null, bool? favourite = null, DateTime? expiresAt = null, long? expiresIn = null, bool? allowTeamAccess = null, string inboxType = null, bool? virtualInbox = null, bool? useShortAddress = null, Guid? domainId = null, string domainName = null, string prefix = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	emailAddress	A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. (optional)
System.Collections.Generic.List<T><string>	tags	Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. (optional)
string	name	Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. (optional)
string	description	Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional)
bool?	useDomainPool	Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. (optional)
bool?	favourite	Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering (optional)
DateTime?	expiresAt	Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. (optional)
long?	expiresIn	Number of milliseconds that inbox should exist for (optional)
bool?	allowTeamAccess	DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional)
string	inboxType	HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mxslurp.click`. (optional)
bool?	virtualInbox	Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. (optional)
bool?	useShortAddress	Use a shorter email address under 31 characters (optional)
System.Guid?	domainId	ID of custom domain to use for email address. (optional)
string	domainName	FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. (optional)
string	prefix	Prefix to add before the email address for easier labelling or identification. (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateInboxWithOptions(CreateInboxDto, int)

Create an inbox with options. Extended options for inbox creation. Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.

Declaration

public InboxDto CreateInboxWithOptions(CreateInboxDto createInboxDto, int operationIndex = 0)

Parameters

Type	Name	Description
CreateInboxDto	createInboxDto
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxDto	InboxDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateInboxWithOptionsAsync(CreateInboxDto, int, CancellationToken)

Create an inbox with options. Extended options for inbox creation. Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.

Declaration

public Task<InboxDto> CreateInboxWithOptionsAsync(CreateInboxDto createInboxDto, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<InboxDto>	Task of InboxDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateInboxWithOptionsWithHttpInfo(CreateInboxDto, int)

Create an inbox with options. Extended options for inbox creation. Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.

Declaration

public ApiResponse<InboxDto> CreateInboxWithOptionsWithHttpInfo(CreateInboxDto createInboxDto, int operationIndex = 0)

Parameters

Type	Name	Description
CreateInboxDto	createInboxDto
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxDto>	ApiResponse of InboxDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateInboxWithOptionsWithHttpInfoAsync(CreateInboxDto, int, CancellationToken)

Create an inbox with options. Extended options for inbox creation. Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.

Declaration

public Task<ApiResponse<InboxDto>> CreateInboxWithOptionsWithHttpInfoAsync(CreateInboxDto createInboxDto, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllInboxEmails(Guid, int)

Delete all emails in a given inboxes. Deletes all emails in an inbox. Be careful as emails cannot be recovered

Declaration

public void DeleteAllInboxEmails(Guid inboxId, int operationIndex = 0)

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllInboxEmailsAsync(Guid, int, CancellationToken)

Delete all emails in a given inboxes. Deletes all emails in an inbox. Be careful as emails cannot be recovered

Declaration

public Task DeleteAllInboxEmailsAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
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

View Source

DeleteAllInboxEmailsWithHttpInfo(Guid, int)

Delete all emails in a given inboxes. Deletes all emails in an inbox. Be careful as emails cannot be recovered

Declaration

public ApiResponse<object> DeleteAllInboxEmailsWithHttpInfo(Guid inboxId, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId
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

View Source

DeleteAllInboxEmailsWithHttpInfoAsync(Guid, int, CancellationToken)

Delete all emails in a given inboxes. Deletes all emails in an inbox. Be careful as emails cannot be recovered

Declaration

public Task<ApiResponse<object>> DeleteAllInboxEmailsWithHttpInfoAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
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

View Source

DeleteAllInboxes(int)

Delete all inboxes Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have.

Declaration

public void DeleteAllInboxes(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

View Source

DeleteAllInboxesAsync(int, CancellationToken)

Declaration

public Task DeleteAllInboxesAsync(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

View Source

DeleteAllInboxesByDescription(string, int)

Delete inboxes by description Permanently delete all inboxes by description

Declaration

public void DeleteAllInboxesByDescription(string description, int operationIndex = 0)

Parameters

Type	Name	Description
string	description
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllInboxesByDescriptionAsync(string, int, CancellationToken)

Delete inboxes by description Permanently delete all inboxes by description

Declaration

public Task DeleteAllInboxesByDescriptionAsync(string description, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

View Source

DeleteAllInboxesByDescriptionWithHttpInfo(string, int)

Delete inboxes by description Permanently delete all inboxes by description

Declaration

public ApiResponse<object> DeleteAllInboxesByDescriptionWithHttpInfo(string description, int operationIndex = 0)

Parameters

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

View Source

DeleteAllInboxesByDescriptionWithHttpInfoAsync(string, int, CancellationToken)

Delete inboxes by description Permanently delete all inboxes by description

Declaration

public Task<ApiResponse<object>> DeleteAllInboxesByDescriptionWithHttpInfoAsync(string description, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

View Source

DeleteAllInboxesByName(string, int)

Delete inboxes by name Permanently delete all inboxes by name

Declaration

public void DeleteAllInboxesByName(string name, int operationIndex = 0)

Parameters

Type	Name	Description
string	name
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllInboxesByNameAsync(string, int, CancellationToken)

Delete inboxes by name Permanently delete all inboxes by name

Declaration

public Task DeleteAllInboxesByNameAsync(string name, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name
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

View Source

DeleteAllInboxesByNameWithHttpInfo(string, int)

Delete inboxes by name Permanently delete all inboxes by name

Declaration

public ApiResponse<object> DeleteAllInboxesByNameWithHttpInfo(string name, int operationIndex = 0)

Parameters

Type	Name	Description
string	name
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

View Source

DeleteAllInboxesByNameWithHttpInfoAsync(string, int, CancellationToken)

Delete inboxes by name Permanently delete all inboxes by name

Declaration

public Task<ApiResponse<object>> DeleteAllInboxesByNameWithHttpInfoAsync(string name, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name
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

View Source

DeleteAllInboxesByTag(string, int)

Delete inboxes by tag Permanently delete all inboxes by tag

Declaration

public void DeleteAllInboxesByTag(string tag, int operationIndex = 0)

Parameters

Type	Name	Description
string	tag
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllInboxesByTagAsync(string, int, CancellationToken)

Delete inboxes by tag Permanently delete all inboxes by tag

Declaration

public Task DeleteAllInboxesByTagAsync(string tag, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	tag
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

View Source

DeleteAllInboxesByTagWithHttpInfo(string, int)

Delete inboxes by tag Permanently delete all inboxes by tag

Declaration

public ApiResponse<object> DeleteAllInboxesByTagWithHttpInfo(string tag, int operationIndex = 0)

Parameters

Type	Name	Description
string	tag
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

View Source

DeleteAllInboxesByTagWithHttpInfoAsync(string, int, CancellationToken)

Delete inboxes by tag Permanently delete all inboxes by tag

Declaration

public Task<ApiResponse<object>> DeleteAllInboxesByTagWithHttpInfoAsync(string tag, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	tag
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

View Source

DeleteAllInboxesWithHttpInfo(int)

Declaration

public ApiResponse<object> DeleteAllInboxesWithHttpInfo(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

View Source

DeleteAllInboxesWithHttpInfoAsync(int, CancellationToken)

Declaration

public Task<ApiResponse<object>> DeleteAllInboxesWithHttpInfoAsync(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

View Source

DeleteInbox(Guid, int)

Delete inbox Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request.

Declaration

public void DeleteInbox(Guid inboxId, int operationIndex = 0)

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteInboxAsync(Guid, int, CancellationToken)

Declaration

public Task DeleteInboxAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
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

View Source

DeleteInboxWithHttpInfo(Guid, int)

Declaration

public ApiResponse<object> DeleteInboxWithHttpInfo(Guid inboxId, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId
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

View Source

DeleteInboxWithHttpInfoAsync(Guid, int, CancellationToken)

Declaration

public Task<ApiResponse<object>> DeleteInboxWithHttpInfoAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
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

View Source

DoesInboxExist(string, bool?, int)

Does inbox exist Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses

Declaration

public InboxExistsDto DoesInboxExist(string emailAddress, bool? allowCatchAll = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress	Email address
bool?	allowCatchAll	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxExistsDto	InboxExistsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DoesInboxExistAsync(string, bool?, int, CancellationToken)

Does inbox exist Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses

Declaration

public Task<InboxExistsDto> DoesInboxExistAsync(string emailAddress, bool? allowCatchAll = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	emailAddress	Email address
bool?	allowCatchAll	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<InboxExistsDto>	Task of InboxExistsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DoesInboxExistWithHttpInfo(string, bool?, int)

Does inbox exist Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses

Declaration

public ApiResponse<InboxExistsDto> DoesInboxExistWithHttpInfo(string emailAddress, bool? allowCatchAll = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress	Email address
bool?	allowCatchAll	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxExistsDto>	ApiResponse of InboxExistsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DoesInboxExistWithHttpInfoAsync(string, bool?, int, CancellationToken)

Does inbox exist Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses

Declaration

public Task<ApiResponse<InboxExistsDto>> DoesInboxExistWithHttpInfoAsync(string emailAddress, bool? allowCatchAll = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	emailAddress	Email address
bool?	allowCatchAll	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

FlushExpired(DateTime?, int)

Remove expired inboxes Remove any expired inboxes for your account (instead of waiting for scheduled removal on server)

Declaration

public FlushExpiredInboxesResult FlushExpired(DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
DateTime?	before	Optional expired at before flag to flush expired inboxes that have expired before the given time (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
FlushExpiredInboxesResult	FlushExpiredInboxesResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

FlushExpiredAsync(DateTime?, int, CancellationToken)

Remove expired inboxes Remove any expired inboxes for your account (instead of waiting for scheduled removal on server)

Declaration

public Task<FlushExpiredInboxesResult> FlushExpiredAsync(DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
DateTime?	before	Optional expired at before flag to flush expired inboxes that have expired before the given time (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<FlushExpiredInboxesResult>	Task of FlushExpiredInboxesResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

FlushExpiredWithHttpInfo(DateTime?, int)

Remove expired inboxes Remove any expired inboxes for your account (instead of waiting for scheduled removal on server)

Declaration

public ApiResponse<FlushExpiredInboxesResult> FlushExpiredWithHttpInfo(DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
DateTime?	before	Optional expired at before flag to flush expired inboxes that have expired before the given time (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<FlushExpiredInboxesResult>	ApiResponse of FlushExpiredInboxesResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

FlushExpiredWithHttpInfoAsync(DateTime?, int, CancellationToken)

Remove expired inboxes Remove any expired inboxes for your account (instead of waiting for scheduled removal on server)

Declaration

public Task<ApiResponse<FlushExpiredInboxesResult>> FlushExpiredWithHttpInfoAsync(DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
DateTime?	before	Optional expired at before flag to flush expired inboxes that have expired before the given time (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllInboxes(int?, int?, string, bool?, string, string, bool?, DateTime?, DateTime?, string, string, Guid?, int)

List All Inboxes Paginated List inboxes in paginated form. The results are available on the content property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative getInboxes method returns a full list of inboxes but is limited to 100 results.

Declaration

public PageInboxProjection GetAllInboxes(int? page = null, int? size = null, string sort = null, bool? favourite = null, string search = null, string tag = null, bool? teamAccess = null, DateTime? since = null, DateTime? before = null, string inboxType = null, string inboxFunction = null, Guid? domainId = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool?	favourite	Optionally filter results for favourites only (optional, default to false)
string	search	Optionally filter by search words partial matching ID, tags, name, and email address (optional)
string	tag	Optionally filter by tags. Will return inboxes that include given tags (optional)
bool?	teamAccess	DEPRECATED. Optionally filter by team access. (optional) (deprecated)
DateTime?	since	Optional filter by created after given date time (optional)
DateTime?	before	Optional filter by created before given date time (optional)
string	inboxType	Optional filter by inbox type (optional)
string	inboxFunction	Optional filter by inbox function (optional)
System.Guid?	domainId	Optional domain ID filter (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageInboxProjection	PageInboxProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllInboxesAsync(int?, int?, string, bool?, string, string, bool?, DateTime?, DateTime?, string, string, Guid?, int, CancellationToken)

Declaration

public Task<PageInboxProjection> GetAllInboxesAsync(int? page = null, int? size = null, string sort = null, bool? favourite = null, string search = null, string tag = null, bool? teamAccess = null, DateTime? since = null, DateTime? before = null, string inboxType = null, string inboxFunction = null, Guid? domainId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool?	favourite	Optionally filter results for favourites only (optional, default to false)
string	search	Optionally filter by search words partial matching ID, tags, name, and email address (optional)
string	tag	Optionally filter by tags. Will return inboxes that include given tags (optional)
bool?	teamAccess	DEPRECATED. Optionally filter by team access. (optional) (deprecated)
DateTime?	since	Optional filter by created after given date time (optional)
DateTime?	before	Optional filter by created before given date time (optional)
string	inboxType	Optional filter by inbox type (optional)
string	inboxFunction	Optional filter by inbox function (optional)
System.Guid?	domainId	Optional domain ID filter (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageInboxProjection>	Task of PageInboxProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllInboxesOffsetPaginated(int?, int?, string, bool?, string, string, bool?, DateTime?, DateTime?, string, string, Guid?, int)

List All Inboxes Offset Paginated List inboxes in paginated form. The results are available on the content property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative getInboxes method returns a full list of inboxes but is limited to 100 results.

Declaration

public PageInboxProjection GetAllInboxesOffsetPaginated(int? page = null, int? size = null, string sort = null, bool? favourite = null, string search = null, string tag = null, bool? teamAccess = null, DateTime? since = null, DateTime? before = null, string inboxType = null, string inboxFunction = null, Guid? domainId = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool?	favourite	Optionally filter results for favourites only (optional, default to false)
string	search	Optionally filter by search words partial matching ID, tags, name, and email address (optional)
string	tag	Optionally filter by tags. Will return inboxes that include given tags (optional)
bool?	teamAccess	DEPRECATED. Optionally filter by team access. (optional) (deprecated)
DateTime?	since	Optional filter by created after given date time (optional)
DateTime?	before	Optional filter by created before given date time (optional)
string	inboxType	Optional filter by inbox type (optional)
string	inboxFunction	Optional filter by inbox function (optional)
System.Guid?	domainId	Optional domain ID filter (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageInboxProjection	PageInboxProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllInboxesOffsetPaginatedAsync(int?, int?, string, bool?, string, string, bool?, DateTime?, DateTime?, string, string, Guid?, int, CancellationToken)

Declaration

public Task<PageInboxProjection> GetAllInboxesOffsetPaginatedAsync(int? page = null, int? size = null, string sort = null, bool? favourite = null, string search = null, string tag = null, bool? teamAccess = null, DateTime? since = null, DateTime? before = null, string inboxType = null, string inboxFunction = null, Guid? domainId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool?	favourite	Optionally filter results for favourites only (optional, default to false)
string	search	Optionally filter by search words partial matching ID, tags, name, and email address (optional)
string	tag	Optionally filter by tags. Will return inboxes that include given tags (optional)
bool?	teamAccess	DEPRECATED. Optionally filter by team access. (optional) (deprecated)
DateTime?	since	Optional filter by created after given date time (optional)
DateTime?	before	Optional filter by created before given date time (optional)
string	inboxType	Optional filter by inbox type (optional)
string	inboxFunction	Optional filter by inbox function (optional)
System.Guid?	domainId	Optional domain ID filter (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageInboxProjection>	Task of PageInboxProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllInboxesOffsetPaginatedWithHttpInfo(int?, int?, string, bool?, string, string, bool?, DateTime?, DateTime?, string, string, Guid?, int)

Declaration

public ApiResponse<PageInboxProjection> GetAllInboxesOffsetPaginatedWithHttpInfo(int? page = null, int? size = null, string sort = null, bool? favourite = null, string search = null, string tag = null, bool? teamAccess = null, DateTime? since = null, DateTime? before = null, string inboxType = null, string inboxFunction = null, Guid? domainId = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool?	favourite	Optionally filter results for favourites only (optional, default to false)
string	search	Optionally filter by search words partial matching ID, tags, name, and email address (optional)
string	tag	Optionally filter by tags. Will return inboxes that include given tags (optional)
bool?	teamAccess	DEPRECATED. Optionally filter by team access. (optional) (deprecated)
DateTime?	since	Optional filter by created after given date time (optional)
DateTime?	before	Optional filter by created before given date time (optional)
string	inboxType	Optional filter by inbox type (optional)
string	inboxFunction	Optional filter by inbox function (optional)
System.Guid?	domainId	Optional domain ID filter (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageInboxProjection>	ApiResponse of PageInboxProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllInboxesOffsetPaginatedWithHttpInfoAsync(int?, int?, string, bool?, string, string, bool?, DateTime?, DateTime?, string, string, Guid?, int, CancellationToken)

Declaration

public Task<ApiResponse<PageInboxProjection>> GetAllInboxesOffsetPaginatedWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, bool? favourite = null, string search = null, string tag = null, bool? teamAccess = null, DateTime? since = null, DateTime? before = null, string inboxType = null, string inboxFunction = null, Guid? domainId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool?	favourite	Optionally filter results for favourites only (optional, default to false)
string	search	Optionally filter by search words partial matching ID, tags, name, and email address (optional)
string	tag	Optionally filter by tags. Will return inboxes that include given tags (optional)
bool?	teamAccess	DEPRECATED. Optionally filter by team access. (optional) (deprecated)
DateTime?	since	Optional filter by created after given date time (optional)
DateTime?	before	Optional filter by created before given date time (optional)
string	inboxType	Optional filter by inbox type (optional)
string	inboxFunction	Optional filter by inbox function (optional)
System.Guid?	domainId	Optional domain ID filter (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllInboxesWithHttpInfo(int?, int?, string, bool?, string, string, bool?, DateTime?, DateTime?, string, string, Guid?, int)

Declaration

public ApiResponse<PageInboxProjection> GetAllInboxesWithHttpInfo(int? page = null, int? size = null, string sort = null, bool? favourite = null, string search = null, string tag = null, bool? teamAccess = null, DateTime? since = null, DateTime? before = null, string inboxType = null, string inboxFunction = null, Guid? domainId = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool?	favourite	Optionally filter results for favourites only (optional, default to false)
string	search	Optionally filter by search words partial matching ID, tags, name, and email address (optional)
string	tag	Optionally filter by tags. Will return inboxes that include given tags (optional)
bool?	teamAccess	DEPRECATED. Optionally filter by team access. (optional) (deprecated)
DateTime?	since	Optional filter by created after given date time (optional)
DateTime?	before	Optional filter by created before given date time (optional)
string	inboxType	Optional filter by inbox type (optional)
string	inboxFunction	Optional filter by inbox function (optional)
System.Guid?	domainId	Optional domain ID filter (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageInboxProjection>	ApiResponse of PageInboxProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllInboxesWithHttpInfoAsync(int?, int?, string, bool?, string, string, bool?, DateTime?, DateTime?, string, string, Guid?, int, CancellationToken)

Declaration

public Task<ApiResponse<PageInboxProjection>> GetAllInboxesWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, bool? favourite = null, string search = null, string tag = null, bool? teamAccess = null, DateTime? since = null, DateTime? before = null, string inboxType = null, string inboxFunction = null, Guid? domainId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool?	favourite	Optionally filter results for favourites only (optional, default to false)
string	search	Optionally filter by search words partial matching ID, tags, name, and email address (optional)
string	tag	Optionally filter by tags. Will return inboxes that include given tags (optional)
bool?	teamAccess	DEPRECATED. Optionally filter by team access. (optional) (deprecated)
DateTime?	since	Optional filter by created after given date time (optional)
DateTime?	before	Optional filter by created before given date time (optional)
string	inboxType	Optional filter by inbox type (optional)
string	inboxFunction	Optional filter by inbox function (optional)
System.Guid?	domainId	Optional domain ID filter (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllScheduledJobs(int?, int?, string, DateTime?, DateTime?, int)

Get all scheduled email sending jobs for account Schedule sending of emails using scheduled jobs. These can be inbox or account level.

Declaration

public PageScheduledJobs GetAllScheduledJobs(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index in scheduled job list pagination (optional, default to 0)
int?	size	Optional page size in scheduled job list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageScheduledJobs	PageScheduledJobs

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllScheduledJobsAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get all scheduled email sending jobs for account Schedule sending of emails using scheduled jobs. These can be inbox or account level.

Declaration

public Task<PageScheduledJobs> GetAllScheduledJobsAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in scheduled job list pagination (optional, default to 0)
int?	size	Optional page size in scheduled job list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageScheduledJobs>	Task of PageScheduledJobs

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllScheduledJobsWithHttpInfo(int?, int?, string, DateTime?, DateTime?, int)

Get all scheduled email sending jobs for account Schedule sending of emails using scheduled jobs. These can be inbox or account level.

Declaration

public ApiResponse<PageScheduledJobs> GetAllScheduledJobsWithHttpInfo(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index in scheduled job list pagination (optional, default to 0)
int?	size	Optional page size in scheduled job list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageScheduledJobs>	ApiResponse of PageScheduledJobs

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllScheduledJobsWithHttpInfoAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get all scheduled email sending jobs for account Schedule sending of emails using scheduled jobs. These can be inbox or account level.

Declaration

public Task<ApiResponse<PageScheduledJobs>> GetAllScheduledJobsWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in scheduled job list pagination (optional, default to 0)
int?	size	Optional page size in scheduled job list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

View Source

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

Get all email delivery statuses for an inbox

Declaration

[Obsolete]
public PageDeliveryStatus GetDeliveryStatusesByInboxId(Guid inboxId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId
int?	page	Optional page index in delivery status list pagination (optional, default to 0)
int?	size	Optional page size in delivery status list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageDeliveryStatus	PageDeliveryStatus

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get all email delivery statuses for an inbox

Declaration

[Obsolete]
public Task<PageDeliveryStatus> GetDeliveryStatusesByInboxIdAsync(Guid inboxId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
int?	page	Optional page index in delivery status list pagination (optional, default to 0)
int?	size	Optional page size in delivery status list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageDeliveryStatus>	Task of PageDeliveryStatus

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get all email delivery statuses for an inbox

Declaration

[Obsolete]
public ApiResponse<PageDeliveryStatus> GetDeliveryStatusesByInboxIdWithHttpInfo(Guid inboxId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId
int?	page	Optional page index in delivery status list pagination (optional, default to 0)
int?	size	Optional page size in delivery status list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageDeliveryStatus>	ApiResponse of PageDeliveryStatus

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get all email delivery statuses for an inbox

Declaration

[Obsolete]
public Task<ApiResponse<PageDeliveryStatus>> GetDeliveryStatusesByInboxIdWithHttpInfoAsync(Guid inboxId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
int?	page	Optional page index in delivery status list pagination (optional, default to 0)
int?	size	Optional page size in delivery status list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetEmails(Guid, int?, int?, string, long?, long?, long?, bool?, DateTime?, DateTime?, int)

Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead. List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the minCount parameter. The server will retry the inbox database until the minCount is satisfied or the retryTimeout is reached

Declaration

public List<EmailPreview> GetEmails(Guid inboxId, int? size = null, int? limit = null, string sort = null, long? retryTimeout = null, long? delayTimeout = null, long? minCount = null, bool? unreadOnly = null, DateTime? before = null, DateTime? since = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId	Id of inbox that emails belongs to
int?	size	Alias for limit. Assessed first before assessing any passed limit. (optional)
int?	limit	Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller (optional)
string	sort	Sort the results by received date and direction ASC or DESC (optional)
long?	retryTimeout	Maximum milliseconds to spend retrying inbox database until minCount emails are returned (optional)
long?	delayTimeout	(optional)
long?	minCount	Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. (optional)
bool?	unreadOnly	(optional)
DateTime?	before	Exclude emails received after this ISO 8601 date time (optional)
DateTime?	since	Exclude emails received before this ISO 8601 date time (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
System.Collections.Generic.List<T><EmailPreview>	List<EmailPreview>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetEmailsAsync(Guid, int?, int?, string, long?, long?, long?, bool?, DateTime?, DateTime?, int, CancellationToken)

Declaration

public Task<List<EmailPreview>> GetEmailsAsync(Guid inboxId, int? size = null, int? limit = null, string sort = null, long? retryTimeout = null, long? delayTimeout = null, long? minCount = null, bool? unreadOnly = null, DateTime? before = null, DateTime? since = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	Id of inbox that emails belongs to
int?	size	Alias for limit. Assessed first before assessing any passed limit. (optional)
int?	limit	Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller (optional)
string	sort	Sort the results by received date and direction ASC or DESC (optional)
long?	retryTimeout	Maximum milliseconds to spend retrying inbox database until minCount emails are returned (optional)
long?	delayTimeout	(optional)
long?	minCount	Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. (optional)
bool?	unreadOnly	(optional)
DateTime?	before	Exclude emails received after this ISO 8601 date time (optional)
DateTime?	since	Exclude emails received before this ISO 8601 date time (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<System.Collections.Generic.List<T><EmailPreview>>	Task of List<EmailPreview>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetEmailsWithHttpInfo(Guid, int?, int?, string, long?, long?, long?, bool?, DateTime?, DateTime?, int)

Declaration

public ApiResponse<List<EmailPreview>> GetEmailsWithHttpInfo(Guid inboxId, int? size = null, int? limit = null, string sort = null, long? retryTimeout = null, long? delayTimeout = null, long? minCount = null, bool? unreadOnly = null, DateTime? before = null, DateTime? since = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId	Id of inbox that emails belongs to
int?	size	Alias for limit. Assessed first before assessing any passed limit. (optional)
int?	limit	Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller (optional)
string	sort	Sort the results by received date and direction ASC or DESC (optional)
long?	retryTimeout	Maximum milliseconds to spend retrying inbox database until minCount emails are returned (optional)
long?	delayTimeout	(optional)
long?	minCount	Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. (optional)
bool?	unreadOnly	(optional)
DateTime?	before	Exclude emails received after this ISO 8601 date time (optional)
DateTime?	since	Exclude emails received before this ISO 8601 date time (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<System.Collections.Generic.List<T><EmailPreview>>	ApiResponse of List<EmailPreview>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetEmailsWithHttpInfoAsync(Guid, int?, int?, string, long?, long?, long?, bool?, DateTime?, DateTime?, int, CancellationToken)

Declaration

public Task<ApiResponse<List<EmailPreview>>> GetEmailsWithHttpInfoAsync(Guid inboxId, int? size = null, int? limit = null, string sort = null, long? retryTimeout = null, long? delayTimeout = null, long? minCount = null, bool? unreadOnly = null, DateTime? before = null, DateTime? since = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	Id of inbox that emails belongs to
int?	size	Alias for limit. Assessed first before assessing any passed limit. (optional)
int?	limit	Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller (optional)
string	sort	Sort the results by received date and direction ASC or DESC (optional)
long?	retryTimeout	Maximum milliseconds to spend retrying inbox database until minCount emails are returned (optional)
long?	delayTimeout	(optional)
long?	minCount	Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. (optional)
bool?	unreadOnly	(optional)
DateTime?	before	Exclude emails received after this ISO 8601 date time (optional)
DateTime?	since	Exclude emails received before this ISO 8601 date time (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<System.Collections.Generic.List<T><EmailPreview>>>	Task of ApiResponse (List<EmailPreview>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapAccess(Guid?, int)

Get IMAP access usernames and passwords

Declaration

public ImapAccessDetails GetImapAccess(Guid? inboxId = null, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ImapAccessDetails	ImapAccessDetails

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapAccessAsync(Guid?, int, CancellationToken)

Get IMAP access usernames and passwords

Declaration

public Task<ImapAccessDetails> GetImapAccessAsync(Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<ImapAccessDetails>	Task of ImapAccessDetails

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapAccessWithHttpInfo(Guid?, int)

Get IMAP access usernames and passwords

Declaration

public ApiResponse<ImapAccessDetails> GetImapAccessWithHttpInfo(Guid? inboxId = null, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<ImapAccessDetails>	ApiResponse of ImapAccessDetails

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapAccessWithHttpInfoAsync(Guid?, int, CancellationToken)

Get IMAP access usernames and passwords

Declaration

public Task<ApiResponse<ImapAccessDetails>> GetImapAccessWithHttpInfoAsync(Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapSmtpAccess(Guid?, int)

Get IMAP and SMTP access usernames and passwords

Declaration

public ImapSmtpAccessDetails GetImapSmtpAccess(Guid? inboxId = null, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ImapSmtpAccessDetails	ImapSmtpAccessDetails

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapSmtpAccessAsync(Guid?, int, CancellationToken)

Get IMAP and SMTP access usernames and passwords

Declaration

public Task<ImapSmtpAccessDetails> GetImapSmtpAccessAsync(Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<ImapSmtpAccessDetails>	Task of ImapSmtpAccessDetails

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapSmtpAccessEnv(Guid?, int)

Get IMAP and SMTP access details in .env format

Declaration

public string GetImapSmtpAccessEnv(Guid? inboxId = null, int operationIndex = 0)

Parameters

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

Returns

Type	Description
string	string

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapSmtpAccessEnvAsync(Guid?, int, CancellationToken)

Get IMAP and SMTP access details in .env format

Declaration

public Task<string> GetImapSmtpAccessEnvAsync(Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<string>	Task of string

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapSmtpAccessEnvWithHttpInfo(Guid?, int)

Get IMAP and SMTP access details in .env format

Declaration

public ApiResponse<string> GetImapSmtpAccessEnvWithHttpInfo(Guid? inboxId = null, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<string>	ApiResponse of string

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapSmtpAccessEnvWithHttpInfoAsync(Guid?, int, CancellationToken)

Get IMAP and SMTP access details in .env format

Declaration

public Task<ApiResponse<string>> GetImapSmtpAccessEnvWithHttpInfoAsync(Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapSmtpAccessServers(int)

Get IMAP and SMTP server hosts

Declaration

public ImapSmtpAccessServers GetImapSmtpAccessServers(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ImapSmtpAccessServers	ImapSmtpAccessServers

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapSmtpAccessServersAsync(int, CancellationToken)

Get IMAP and SMTP server hosts

Declaration

public Task<ImapSmtpAccessServers> GetImapSmtpAccessServersAsync(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<ImapSmtpAccessServers>	Task of ImapSmtpAccessServers

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapSmtpAccessServersWithHttpInfo(int)

Get IMAP and SMTP server hosts

Declaration

public ApiResponse<ImapSmtpAccessServers> GetImapSmtpAccessServersWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<ImapSmtpAccessServers>	ApiResponse of ImapSmtpAccessServers

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapSmtpAccessServersWithHttpInfoAsync(int, CancellationToken)

Get IMAP and SMTP server hosts

Declaration

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapSmtpAccessWithHttpInfo(Guid?, int)

Get IMAP and SMTP access usernames and passwords

Declaration

public ApiResponse<ImapSmtpAccessDetails> GetImapSmtpAccessWithHttpInfo(Guid? inboxId = null, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<ImapSmtpAccessDetails>	ApiResponse of ImapSmtpAccessDetails

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapSmtpAccessWithHttpInfoAsync(Guid?, int, CancellationToken)

Get IMAP and SMTP access usernames and passwords

Declaration

public Task<ApiResponse<ImapSmtpAccessDetails>> GetImapSmtpAccessWithHttpInfoAsync(Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInbox(Guid, int)

Get Inbox. Returns properties of an inbox. Returns an inbox's properties, including its email address and ID.

Declaration

public InboxDto GetInbox(Guid inboxId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
InboxDto	InboxDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxAsync(Guid, int, CancellationToken)

Get Inbox. Returns properties of an inbox. Returns an inbox's properties, including its email address and ID.

Declaration

public Task<InboxDto> GetInboxAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<InboxDto>	Task of InboxDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxByEmailAddress(string, int)

Search for an inbox with the provided email address Get a inbox result by email address

Declaration

public InboxByEmailAddressResult GetInboxByEmailAddress(string emailAddress, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxByEmailAddressResult	InboxByEmailAddressResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxByEmailAddressAsync(string, int, CancellationToken)

Search for an inbox with the provided email address Get a inbox result by email address

Declaration

public Task<InboxByEmailAddressResult> GetInboxByEmailAddressAsync(string emailAddress, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<InboxByEmailAddressResult>	Task of InboxByEmailAddressResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxByEmailAddressWithHttpInfo(string, int)

Search for an inbox with the provided email address Get a inbox result by email address

Declaration

public ApiResponse<InboxByEmailAddressResult> GetInboxByEmailAddressWithHttpInfo(string emailAddress, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxByEmailAddressResult>	ApiResponse of InboxByEmailAddressResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxByEmailAddressWithHttpInfoAsync(string, int, CancellationToken)

Search for an inbox with the provided email address Get a inbox result by email address

Declaration

public Task<ApiResponse<InboxByEmailAddressResult>> GetInboxByEmailAddressWithHttpInfoAsync(string emailAddress, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxByName(string, int)

Search for an inbox with the given name Get a inbox result by name

Declaration

public InboxByNameResult GetInboxByName(string name, int operationIndex = 0)

Parameters

Type	Name	Description
string	name
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxByNameResult	InboxByNameResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxByNameAsync(string, int, CancellationToken)

Search for an inbox with the given name Get a inbox result by name

Declaration

public Task<InboxByNameResult> GetInboxByNameAsync(string name, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<InboxByNameResult>	Task of InboxByNameResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxByNameWithHttpInfo(string, int)

Search for an inbox with the given name Get a inbox result by name

Declaration

public ApiResponse<InboxByNameResult> GetInboxByNameWithHttpInfo(string name, int operationIndex = 0)

Parameters

Type	Name	Description
string	name
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxByNameResult>	ApiResponse of InboxByNameResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxByNameWithHttpInfoAsync(string, int, CancellationToken)

Search for an inbox with the given name Get a inbox result by name

Declaration

public Task<ApiResponse<InboxByNameResult>> GetInboxByNameWithHttpInfoAsync(string name, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxCount(int)

Get total inbox count

Declaration

public CountDto GetInboxCount(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

View Source

GetInboxCountAsync(int, CancellationToken)

Get total inbox count

Declaration

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

View Source

GetInboxCountWithHttpInfo(int)

Get total inbox count

Declaration

public ApiResponse<CountDto> GetInboxCountWithHttpInfo(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

View Source

GetInboxCountWithHttpInfoAsync(int, CancellationToken)

Get total inbox count

Declaration

public Task<ApiResponse<CountDto>> GetInboxCountWithHttpInfoAsync(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

View Source

GetInboxEmailCount(Guid, int)

Get email count in inbox

Declaration

public CountDto GetInboxEmailCount(Guid inboxId, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId	Id of inbox that emails belongs to
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CountDto	CountDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxEmailCountAsync(Guid, int, CancellationToken)

Get email count in inbox

Declaration

public Task<CountDto> GetInboxEmailCountAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	Id of inbox that emails belongs to
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

View Source

GetInboxEmailCountWithHttpInfo(Guid, int)

Get email count in inbox

Declaration

public ApiResponse<CountDto> GetInboxEmailCountWithHttpInfo(Guid inboxId, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId	Id of inbox that emails belongs to
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

View Source

GetInboxEmailCountWithHttpInfoAsync(Guid, int, CancellationToken)

Get email count in inbox

Declaration

public Task<ApiResponse<CountDto>> GetInboxEmailCountWithHttpInfoAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	Id of inbox that emails belongs to
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

View Source

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

Get inbox emails paginated Get a paginated list of emails in an inbox. Does not hold connections open.

Declaration

public PageEmailPreview GetInboxEmailsPaginated(Guid inboxId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId	Id of inbox that emails belongs to
int?	page	Optional page index in inbox emails list pagination (optional, default to 0)
int?	size	Optional page size in inbox emails list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Optional filter by received after given date time (optional)
DateTime?	before	Optional filter by received before given date time (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageEmailPreview	PageEmailPreview

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get inbox emails paginated Get a paginated list of emails in an inbox. Does not hold connections open.

Declaration

public Task<PageEmailPreview> GetInboxEmailsPaginatedAsync(Guid inboxId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	Id of inbox that emails belongs to
int?	page	Optional page index in inbox emails list pagination (optional, default to 0)
int?	size	Optional page size in inbox emails list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Optional filter by received after given date time (optional)
DateTime?	before	Optional filter by 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<PageEmailPreview>	Task of PageEmailPreview

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get inbox emails paginated Get a paginated list of emails in an inbox. Does not hold connections open.

Declaration

public ApiResponse<PageEmailPreview> GetInboxEmailsPaginatedWithHttpInfo(Guid inboxId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId	Id of inbox that emails belongs to
int?	page	Optional page index in inbox emails list pagination (optional, default to 0)
int?	size	Optional page size in inbox emails list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Optional filter by received after given date time (optional)
DateTime?	before	Optional filter by received before given date time (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageEmailPreview>	ApiResponse of PageEmailPreview

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get inbox emails paginated Get a paginated list of emails in an inbox. Does not hold connections open.

Declaration

public Task<ApiResponse<PageEmailPreview>> GetInboxEmailsPaginatedWithHttpInfoAsync(Guid inboxId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	Id of inbox that emails belongs to
int?	page	Optional page index in inbox emails list pagination (optional, default to 0)
int?	size	Optional page size in inbox emails list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Optional filter by received after given date time (optional)
DateTime?	before	Optional filter by 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<PageEmailPreview>>	Task of ApiResponse (PageEmailPreview)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxes(int?, string, DateTime?, bool?, DateTime?, int)

List Inboxes and email addresses List the inboxes you have created. Note use of the more advanced getAllInboxes is recommended and allows paginated access using a limit and sort parameter.

Declaration

[Obsolete]
public List<InboxDto> GetInboxes(int? size = null, string sort = null, DateTime? since = null, bool? excludeCatchAllInboxes = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	size	Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. (optional, default to 100)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Optional filter by created after given date time (optional)
bool?	excludeCatchAllInboxes	Optional exclude catch all inboxes (optional)
DateTime?	before	Optional filter by created before given date time (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
System.Collections.Generic.List<T><InboxDto>	List<InboxDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxesAsync(int?, string, DateTime?, bool?, DateTime?, int, CancellationToken)

List Inboxes and email addresses List the inboxes you have created. Note use of the more advanced getAllInboxes is recommended and allows paginated access using a limit and sort parameter.

Declaration

[Obsolete]
public Task<List<InboxDto>> GetInboxesAsync(int? size = null, string sort = null, DateTime? since = null, bool? excludeCatchAllInboxes = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	size	Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. (optional, default to 100)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Optional filter by created after given date time (optional)
bool?	excludeCatchAllInboxes	Optional exclude catch all inboxes (optional)
DateTime?	before	Optional filter by created before given date time (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<System.Collections.Generic.List<T><InboxDto>>	Task of List<InboxDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxesWithHttpInfo(int?, string, DateTime?, bool?, DateTime?, int)

List Inboxes and email addresses List the inboxes you have created. Note use of the more advanced getAllInboxes is recommended and allows paginated access using a limit and sort parameter.

Declaration

[Obsolete]
public ApiResponse<List<InboxDto>> GetInboxesWithHttpInfo(int? size = null, string sort = null, DateTime? since = null, bool? excludeCatchAllInboxes = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	size	Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. (optional, default to 100)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Optional filter by created after given date time (optional)
bool?	excludeCatchAllInboxes	Optional exclude catch all inboxes (optional)
DateTime?	before	Optional filter by created before given date time (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<System.Collections.Generic.List<T><InboxDto>>	ApiResponse of List<InboxDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxesWithHttpInfoAsync(int?, string, DateTime?, bool?, DateTime?, int, CancellationToken)

List Inboxes and email addresses List the inboxes you have created. Note use of the more advanced getAllInboxes is recommended and allows paginated access using a limit and sort parameter.

Declaration

[Obsolete]
public Task<ApiResponse<List<InboxDto>>> GetInboxesWithHttpInfoAsync(int? size = null, string sort = null, DateTime? since = null, bool? excludeCatchAllInboxes = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	size	Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. (optional, default to 100)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Optional filter by created after given date time (optional)
bool?	excludeCatchAllInboxes	Optional exclude catch all inboxes (optional)
DateTime?	before	Optional filter by created before given date time (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<System.Collections.Generic.List<T><InboxDto>>>	Task of ApiResponse (List<InboxDto>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxIds(int)

Get all inbox IDs Get list of inbox IDs

Declaration

[Obsolete]
public InboxIdsResult GetInboxIds(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxIdsResult	InboxIdsResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxIdsAsync(int, CancellationToken)

Get all inbox IDs Get list of inbox IDs

Declaration

[Obsolete]
public Task<InboxIdsResult> GetInboxIdsAsync(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<InboxIdsResult>	Task of InboxIdsResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxIdsWithHttpInfo(int)

Get all inbox IDs Get list of inbox IDs

Declaration

[Obsolete]
public ApiResponse<InboxIdsResult> GetInboxIdsWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxIdsResult>	ApiResponse of InboxIdsResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxIdsWithHttpInfoAsync(int, CancellationToken)

Get all inbox IDs Get list of inbox IDs

Declaration

[Obsolete]
public Task<ApiResponse<InboxIdsResult>> GetInboxIdsWithHttpInfoAsync(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<InboxIdsResult>>	Task of ApiResponse (InboxIdsResult)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get Inbox Sent Emails Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead.

Declaration

[Obsolete]
public PageSentEmailProjection GetInboxSentEmails(Guid inboxId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId
int?	page	Optional page index in inbox sent email list pagination (optional, default to 0)
int?	size	Optional page size in inbox sent email list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional sent email search (optional)
DateTime?	since	Optional filter by sent after given date time (optional)
DateTime?	before	Optional filter by sent before given date time (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageSentEmailProjection	PageSentEmailProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Declaration

[Obsolete]
public Task<PageSentEmailProjection> GetInboxSentEmailsAsync(Guid inboxId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
int?	page	Optional page index in inbox sent email list pagination (optional, default to 0)
int?	size	Optional page size in inbox sent email list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional sent email search (optional)
DateTime?	since	Optional filter by sent after given date time (optional)
DateTime?	before	Optional filter by sent before given date time (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageSentEmailProjection>	Task of PageSentEmailProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Declaration

[Obsolete]
public ApiResponse<PageSentEmailProjection> GetInboxSentEmailsWithHttpInfo(Guid inboxId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId
int?	page	Optional page index in inbox sent email list pagination (optional, default to 0)
int?	size	Optional page size in inbox sent email list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional sent email search (optional)
DateTime?	since	Optional filter by sent after given date time (optional)
DateTime?	before	Optional filter by sent before given date time (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageSentEmailProjection>	ApiResponse of PageSentEmailProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Declaration

[Obsolete]
public Task<ApiResponse<PageSentEmailProjection>> GetInboxSentEmailsWithHttpInfoAsync(Guid inboxId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
int?	page	Optional page index in inbox sent email list pagination (optional, default to 0)
int?	size	Optional page size in inbox sent email list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional sent email search (optional)
DateTime?	since	Optional filter by sent after given date time (optional)
DateTime?	before	Optional filter by sent 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<PageSentEmailProjection>>	Task of ApiResponse (PageSentEmailProjection)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxTags(int)

Get inbox tags Get all inbox tags

Declaration

[Obsolete]
public List<string> GetInboxTags(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
System.Collections.Generic.List<T><string>	List<string>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxTagsAsync(int, CancellationToken)

Get inbox tags Get all inbox tags

Declaration

[Obsolete]
public Task<List<string>> GetInboxTagsAsync(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<System.Collections.Generic.List<T><string>>	Task of List<string>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxTagsWithHttpInfo(int)

Get inbox tags Get all inbox tags

Declaration

[Obsolete]
public ApiResponse<List<string>> GetInboxTagsWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<System.Collections.Generic.List<T><string>>	ApiResponse of List<string>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxTagsWithHttpInfoAsync(int, CancellationToken)

Get inbox tags Get all inbox tags

Declaration

[Obsolete]
public Task<ApiResponse<List<string>>> GetInboxTagsWithHttpInfoAsync(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<System.Collections.Generic.List<T><string>>>	Task of ApiResponse (List<string>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxWithHttpInfo(Guid, int)

Get Inbox. Returns properties of an inbox. Returns an inbox's properties, including its email address and ID.

Declaration

public ApiResponse<InboxDto> GetInboxWithHttpInfo(Guid inboxId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<InboxDto>	ApiResponse of InboxDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxWithHttpInfoAsync(Guid, int, CancellationToken)

Get Inbox. Returns properties of an inbox. Returns an inbox's properties, including its email address and ID.

Declaration

public Task<ApiResponse<InboxDto>> GetInboxWithHttpInfoAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetLatestEmailInInbox(Guid, long, int)

Get latest email in an inbox. Use WaitForController to get emails that may not have arrived yet. Get the newest email in an inbox or wait for one to arrive

Declaration

public Email GetLatestEmailInInbox(Guid inboxId, long timeoutMillis, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of the inbox you want to get the latest email from
long	timeoutMillis	Timeout milliseconds to wait for latest email
int	operationIndex	Index associated with the operation.

Returns

Type	Description
Email	Email

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetLatestEmailInInboxAsync(Guid, long, int, CancellationToken)

Get latest email in an inbox. Use WaitForController to get emails that may not have arrived yet. Get the newest email in an inbox or wait for one to arrive

Declaration

public Task<Email> GetLatestEmailInInboxAsync(Guid inboxId, long timeoutMillis, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of the inbox you want to get the latest email from
long	timeoutMillis	Timeout milliseconds to wait for latest email
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

View Source

GetLatestEmailInInboxWithHttpInfo(Guid, long, int)

Get latest email in an inbox. Use WaitForController to get emails that may not have arrived yet. Get the newest email in an inbox or wait for one to arrive

Declaration

public ApiResponse<Email> GetLatestEmailInInboxWithHttpInfo(Guid inboxId, long timeoutMillis, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of the inbox you want to get the latest email from
long	timeoutMillis	Timeout milliseconds to wait for latest email
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

View Source

GetLatestEmailInInboxWithHttpInfoAsync(Guid, long, int, CancellationToken)

Get latest email in an inbox. Use WaitForController to get emails that may not have arrived yet. Get the newest email in an inbox or wait for one to arrive

Declaration

public Task<ApiResponse<Email>> GetLatestEmailInInboxWithHttpInfoAsync(Guid inboxId, long timeoutMillis, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of the inbox you want to get the latest email from
long	timeoutMillis	Timeout milliseconds to wait for latest email
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

View Source

GetOrganizationInboxes(int?, int?, string, string, DateTime?, DateTime?, int)

List Organization Inboxes Paginated List organization inboxes in paginated form. These are inboxes created with allowTeamAccess flag enabled. Organization inboxes are readOnly for non-admin users. The results are available on the content property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time).

Declaration

[Obsolete]
public PageOrganizationInboxProjection GetOrganizationInboxes(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Optional filter by created after given date time (optional)
DateTime?	before	Optional filter by created before given date time (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageOrganizationInboxProjection	PageOrganizationInboxProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetOrganizationInboxesAsync(int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

Declaration

[Obsolete]
public Task<PageOrganizationInboxProjection> GetOrganizationInboxesAsync(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Optional filter by created after given date time (optional)
DateTime?	before	Optional filter by created before given date time (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageOrganizationInboxProjection>	Task of PageOrganizationInboxProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetOrganizationInboxesWithHttpInfo(int?, int?, string, string, DateTime?, DateTime?, int)

Declaration

[Obsolete]
public ApiResponse<PageOrganizationInboxProjection> GetOrganizationInboxesWithHttpInfo(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Optional filter by created after given date time (optional)
DateTime?	before	Optional filter by created before given date time (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageOrganizationInboxProjection>	ApiResponse of PageOrganizationInboxProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetOrganizationInboxesWithHttpInfoAsync(int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

Declaration

[Obsolete]
public Task<ApiResponse<PageOrganizationInboxProjection>> GetOrganizationInboxesWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Optional filter by created after given date time (optional)
DateTime?	before	Optional filter by created before given date time (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetScheduledJob(Guid, int)

Get a scheduled email job Get a scheduled email job details.

Declaration

public ScheduledJobDto GetScheduledJob(Guid jobId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ScheduledJobDto	ScheduledJobDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetScheduledJobAsync(Guid, int, CancellationToken)

Get a scheduled email job Get a scheduled email job details.

Declaration

public Task<ScheduledJobDto> GetScheduledJobAsync(Guid jobId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<ScheduledJobDto>	Task of ScheduledJobDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get all scheduled email sending jobs for the inbox Schedule sending of emails using scheduled jobs.

Declaration

public PageScheduledJobs GetScheduledJobsByInboxId(Guid inboxId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId
int?	page	Optional page index in scheduled job list pagination (optional, default to 0)
int?	size	Optional page size in scheduled job list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageScheduledJobs	PageScheduledJobs

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get all scheduled email sending jobs for the inbox Schedule sending of emails using scheduled jobs.

Declaration

public Task<PageScheduledJobs> GetScheduledJobsByInboxIdAsync(Guid inboxId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
int?	page	Optional page index in scheduled job list pagination (optional, default to 0)
int?	size	Optional page size in scheduled job list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageScheduledJobs>	Task of PageScheduledJobs

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get all scheduled email sending jobs for the inbox Schedule sending of emails using scheduled jobs.

Declaration

public ApiResponse<PageScheduledJobs> GetScheduledJobsByInboxIdWithHttpInfo(Guid inboxId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId
int?	page	Optional page index in scheduled job list pagination (optional, default to 0)
int?	size	Optional page size in scheduled job list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageScheduledJobs>	ApiResponse of PageScheduledJobs

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get all scheduled email sending jobs for the inbox Schedule sending of emails using scheduled jobs.

Declaration

public Task<ApiResponse<PageScheduledJobs>> GetScheduledJobsByInboxIdWithHttpInfoAsync(Guid inboxId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
int?	page	Optional page index in scheduled job list pagination (optional, default to 0)
int?	size	Optional page size in scheduled job list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetScheduledJobWithHttpInfo(Guid, int)

Get a scheduled email job Get a scheduled email job details.

Declaration

public ApiResponse<ScheduledJobDto> GetScheduledJobWithHttpInfo(Guid jobId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<ScheduledJobDto>	ApiResponse of ScheduledJobDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetScheduledJobWithHttpInfoAsync(Guid, int, CancellationToken)

Get a scheduled email job Get a scheduled email job details.

Declaration

public Task<ApiResponse<ScheduledJobDto>> GetScheduledJobWithHttpInfoAsync(Guid jobId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetSmtpAccess(Guid?, int)

Get SMTP access usernames and passwords

Declaration

public SmtpAccessDetails GetSmtpAccess(Guid? inboxId = null, int operationIndex = 0)

Parameters

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

Returns

Type	Description
SmtpAccessDetails	SmtpAccessDetails

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetSmtpAccessAsync(Guid?, int, CancellationToken)

Get SMTP access usernames and passwords

Declaration

public Task<SmtpAccessDetails> GetSmtpAccessAsync(Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<SmtpAccessDetails>	Task of SmtpAccessDetails

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetSmtpAccessWithHttpInfo(Guid?, int)

Get SMTP access usernames and passwords

Declaration

public ApiResponse<SmtpAccessDetails> GetSmtpAccessWithHttpInfo(Guid? inboxId = null, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<SmtpAccessDetails>	ApiResponse of SmtpAccessDetails

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetSmtpAccessWithHttpInfoAsync(Guid?, int, CancellationToken)

Get SMTP access usernames and passwords

Declaration

public Task<ApiResponse<SmtpAccessDetails>> GetSmtpAccessWithHttpInfoAsync(Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

IsEmailAddressAvailable(string, int)

Is email address available Returns whether an email address is available

Declaration

public EmailAvailableResult IsEmailAddressAvailable(string emailAddress, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmailAvailableResult	EmailAvailableResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

IsEmailAddressAvailableAsync(string, int, CancellationToken)

Is email address available Returns whether an email address is available

Declaration

public Task<EmailAvailableResult> IsEmailAddressAvailableAsync(string emailAddress, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<EmailAvailableResult>	Task of EmailAvailableResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

IsEmailAddressAvailableWithHttpInfo(string, int)

Is email address available Returns whether an email address is available

Declaration

public ApiResponse<EmailAvailableResult> IsEmailAddressAvailableWithHttpInfo(string emailAddress, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmailAvailableResult>	ApiResponse of EmailAvailableResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

IsEmailAddressAvailableWithHttpInfoAsync(string, int, CancellationToken)

Is email address available Returns whether an email address is available

Declaration

public Task<ApiResponse<EmailAvailableResult>> IsEmailAddressAvailableWithHttpInfoAsync(string emailAddress, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List inbox rulesets List all rulesets attached to an inbox

Declaration

public PageInboxRulesetDto ListInboxRulesets(Guid inboxId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId
int?	page	Optional page index in inbox ruleset list pagination (optional, default to 0)
int?	size	Optional page size in inbox ruleset list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Optional filter by created after given date time (optional)
DateTime?	before	Optional filter by created before given date time (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageInboxRulesetDto	PageInboxRulesetDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List inbox rulesets List all rulesets attached to an inbox

Declaration

public Task<PageInboxRulesetDto> ListInboxRulesetsAsync(Guid inboxId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
int?	page	Optional page index in inbox ruleset list pagination (optional, default to 0)
int?	size	Optional page size in inbox ruleset list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Optional filter by created after given date time (optional)
DateTime?	before	Optional filter by created before given date time (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageInboxRulesetDto>	Task of PageInboxRulesetDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List inbox rulesets List all rulesets attached to an inbox

Declaration

public ApiResponse<PageInboxRulesetDto> ListInboxRulesetsWithHttpInfo(Guid inboxId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId
int?	page	Optional page index in inbox ruleset list pagination (optional, default to 0)
int?	size	Optional page size in inbox ruleset list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Optional filter by created after given date time (optional)
DateTime?	before	Optional filter by created before given date time (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageInboxRulesetDto>	ApiResponse of PageInboxRulesetDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List inbox rulesets List all rulesets attached to an inbox

Declaration

public Task<ApiResponse<PageInboxRulesetDto>> ListInboxRulesetsWithHttpInfoAsync(Guid inboxId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
int?	page	Optional page index in inbox ruleset list pagination (optional, default to 0)
int?	size	Optional page size in inbox ruleset list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Optional filter by created after given date time (optional)
DateTime?	before	Optional filter by created before given date time (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List inbox tracking pixels List all tracking pixels sent from an inbox

Declaration

public PageTrackingPixelProjection ListInboxTrackingPixels(Guid inboxId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId
int?	page	Optional page index in inbox tracking pixel list pagination (optional, default to 0)
int?	size	Optional page size in inbox tracking pixel list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Optional filter by created after given date time (optional)
DateTime?	before	Optional filter by created before given date time (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageTrackingPixelProjection	PageTrackingPixelProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List inbox tracking pixels List all tracking pixels sent from an inbox

Declaration

public Task<PageTrackingPixelProjection> ListInboxTrackingPixelsAsync(Guid inboxId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
int?	page	Optional page index in inbox tracking pixel list pagination (optional, default to 0)
int?	size	Optional page size in inbox tracking pixel list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Optional filter by created after given date time (optional)
DateTime?	before	Optional filter by created before given date time (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageTrackingPixelProjection>	Task of PageTrackingPixelProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List inbox tracking pixels List all tracking pixels sent from an inbox

Declaration

public ApiResponse<PageTrackingPixelProjection> ListInboxTrackingPixelsWithHttpInfo(Guid inboxId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId
int?	page	Optional page index in inbox tracking pixel list pagination (optional, default to 0)
int?	size	Optional page size in inbox tracking pixel list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Optional filter by created after given date time (optional)
DateTime?	before	Optional filter by created before given date time (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageTrackingPixelProjection>	ApiResponse of PageTrackingPixelProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List inbox tracking pixels List all tracking pixels sent from an inbox

Declaration

public Task<ApiResponse<PageTrackingPixelProjection>> ListInboxTrackingPixelsWithHttpInfoAsync(Guid inboxId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
int?	page	Optional page index in inbox tracking pixel list pagination (optional, default to 0)
int?	size	Optional page size in inbox tracking pixel list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Optional filter by created after given date time (optional)
DateTime?	before	Optional filter by created before given date time (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SearchInboxes(SearchInboxesOptions, int)

Search all inboxes and return matching inboxes Search inboxes and return in paginated form. The results are available on the content property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative getInboxes method returns a full list of inboxes but is limited to 100 results.

Declaration

public PageInboxProjection SearchInboxes(SearchInboxesOptions searchInboxesOptions, int operationIndex = 0)

Parameters

Type	Name	Description
SearchInboxesOptions	searchInboxesOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageInboxProjection	PageInboxProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SearchInboxesAsync(SearchInboxesOptions, int, CancellationToken)

Declaration

public Task<PageInboxProjection> SearchInboxesAsync(SearchInboxesOptions searchInboxesOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<PageInboxProjection>	Task of PageInboxProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SearchInboxesWithHttpInfo(SearchInboxesOptions, int)

Declaration

public ApiResponse<PageInboxProjection> SearchInboxesWithHttpInfo(SearchInboxesOptions searchInboxesOptions, int operationIndex = 0)

Parameters

Type	Name	Description
SearchInboxesOptions	searchInboxesOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageInboxProjection>	ApiResponse of PageInboxProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SearchInboxesWithHttpInfoAsync(SearchInboxesOptions, int, CancellationToken)

Declaration

public Task<ApiResponse<PageInboxProjection>> SearchInboxesWithHttpInfoAsync(SearchInboxesOptions searchInboxesOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmail(Guid, SendEmailOptions, int)

Send Email Send an email from an inbox's email address. The request body should contain the SendEmailOptions that include recipients, attachments, body etc. See SendEmailOptions for all available properties. Note the inboxId refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method sendEmailAndConfirm.

Declaration

public void SendEmail(Guid inboxId, SendEmailOptions sendEmailOptions, int operationIndex = 0)

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailAndConfirm(Guid, SendEmailOptions, int)

Send email and return sent confirmation Sister method for standard sendEmail method with the benefit of returning a SentEmail entity confirming the successful sending of the email with a link to the sent object created for it.

Declaration

public SentEmailDto SendEmailAndConfirm(Guid inboxId, SendEmailOptions sendEmailOptions, int operationIndex = 0)

Parameters

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

Returns

Type	Description
SentEmailDto	SentEmailDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailAndConfirmAsync(Guid, SendEmailOptions, int, CancellationToken)

Declaration

public Task<SentEmailDto> SendEmailAndConfirmAsync(Guid inboxId, SendEmailOptions sendEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of the inbox you want to send the email from
SendEmailOptions	sendEmailOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<SentEmailDto>	Task of SentEmailDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailAndConfirmWithHttpInfo(Guid, SendEmailOptions, int)

Declaration

public ApiResponse<SentEmailDto> SendEmailAndConfirmWithHttpInfo(Guid inboxId, SendEmailOptions sendEmailOptions, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<SentEmailDto>	ApiResponse of SentEmailDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailAndConfirmWithHttpInfoAsync(Guid, SendEmailOptions, int, CancellationToken)

Declaration

public Task<ApiResponse<SentEmailDto>> SendEmailAndConfirmWithHttpInfoAsync(Guid inboxId, SendEmailOptions sendEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of the inbox you want to send the email from
SendEmailOptions	sendEmailOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailAsync(Guid, SendEmailOptions, int, CancellationToken)

Declaration

public Task SendEmailAsync(Guid inboxId, SendEmailOptions sendEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of the inbox you want to send the email from
SendEmailOptions	sendEmailOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailWithHttpInfo(Guid, SendEmailOptions, int)

Declaration

public ApiResponse<object> SendEmailWithHttpInfo(Guid inboxId, SendEmailOptions sendEmailOptions, int operationIndex = 0)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailWithHttpInfoAsync(Guid, SendEmailOptions, int, CancellationToken)

Declaration

public Task<ApiResponse<object>> SendEmailWithHttpInfoAsync(Guid inboxId, SendEmailOptions sendEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of the inbox you want to send the email from
SendEmailOptions	sendEmailOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailWithQueue(Guid, bool, SendEmailOptions, int)

Send email with queue Send an email using a queue. Will place the email onto a queue that will then be processed and sent. Use this queue method to enable any failed email sending to be recovered. This will prevent lost emails when sending if your account encounters a block or payment issue.

Declaration

public void SendEmailWithQueue(Guid inboxId, bool validateBeforeEnqueue, SendEmailOptions sendEmailOptions, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of the inbox you want to send the email from
bool	validateBeforeEnqueue	Validate before adding to queue
SendEmailOptions	sendEmailOptions
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailWithQueueAsync(Guid, bool, SendEmailOptions, int, CancellationToken)

Declaration

public Task SendEmailWithQueueAsync(Guid inboxId, bool validateBeforeEnqueue, SendEmailOptions sendEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of the inbox you want to send the email from
bool	validateBeforeEnqueue	Validate before adding to queue
SendEmailOptions	sendEmailOptions
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

View Source

SendEmailWithQueueWithHttpInfo(Guid, bool, SendEmailOptions, int)

Declaration

public ApiResponse<object> SendEmailWithQueueWithHttpInfo(Guid inboxId, bool validateBeforeEnqueue, SendEmailOptions sendEmailOptions, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of the inbox you want to send the email from
bool	validateBeforeEnqueue	Validate before adding to queue
SendEmailOptions	sendEmailOptions
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

View Source

SendEmailWithQueueWithHttpInfoAsync(Guid, bool, SendEmailOptions, int, CancellationToken)

Declaration

public Task<ApiResponse<object>> SendEmailWithQueueWithHttpInfoAsync(Guid inboxId, bool validateBeforeEnqueue, SendEmailOptions sendEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of the inbox you want to send the email from
bool	validateBeforeEnqueue	Validate before adding to queue
SendEmailOptions	sendEmailOptions
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

View Source

SendSmtpEnvelope(Guid, SendSMTPEnvelopeOptions, int)

Send email using an SMTP mail envelope and message body and return sent confirmation Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY.

Declaration

public SentEmailDto SendSmtpEnvelope(Guid inboxId, SendSMTPEnvelopeOptions sendSMTPEnvelopeOptions, int operationIndex = 0)

Parameters

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

Returns

Type	Description
SentEmailDto	SentEmailDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendSmtpEnvelopeAsync(Guid, SendSMTPEnvelopeOptions, int, CancellationToken)

Send email using an SMTP mail envelope and message body and return sent confirmation Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY.

Declaration

public Task<SentEmailDto> SendSmtpEnvelopeAsync(Guid inboxId, SendSMTPEnvelopeOptions sendSMTPEnvelopeOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of the inbox you want to send the email from
SendSMTPEnvelopeOptions	sendSMTPEnvelopeOptions
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

View Source

SendSmtpEnvelopeWithHttpInfo(Guid, SendSMTPEnvelopeOptions, int)

Send email using an SMTP mail envelope and message body and return sent confirmation Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY.

Declaration

public ApiResponse<SentEmailDto> SendSmtpEnvelopeWithHttpInfo(Guid inboxId, SendSMTPEnvelopeOptions sendSMTPEnvelopeOptions, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of the inbox you want to send the email from
SendSMTPEnvelopeOptions	sendSMTPEnvelopeOptions
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

View Source

SendSmtpEnvelopeWithHttpInfoAsync(Guid, SendSMTPEnvelopeOptions, int, CancellationToken)

Send email using an SMTP mail envelope and message body and return sent confirmation Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY.

Declaration

public Task<ApiResponse<SentEmailDto>> SendSmtpEnvelopeWithHttpInfoAsync(Guid inboxId, SendSMTPEnvelopeOptions sendSMTPEnvelopeOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of the inbox you want to send the email from
SendSMTPEnvelopeOptions	sendSMTPEnvelopeOptions
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

View Source

SendTestEmail(Guid, int)

Send a test email to inbox Send an inbox a test email to test email receiving is working

Declaration

public void SendTestEmail(Guid inboxId, int operationIndex = 0)

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendTestEmailAsync(Guid, int, CancellationToken)

Send a test email to inbox Send an inbox a test email to test email receiving is working

Declaration

public Task SendTestEmailAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
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

View Source

SendTestEmailWithHttpInfo(Guid, int)

Send a test email to inbox Send an inbox a test email to test email receiving is working

Declaration

public ApiResponse<object> SendTestEmailWithHttpInfo(Guid inboxId, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId
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

View Source

SendTestEmailWithHttpInfoAsync(Guid, int, CancellationToken)

Send a test email to inbox Send an inbox a test email to test email receiving is working

Declaration

public Task<ApiResponse<object>> SendTestEmailWithHttpInfoAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
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

View Source

SendWithSchedule(Guid, SendEmailOptions, DateTime?, long?, bool?, int)

Send email with with delay or schedule Send an email using a delay. Will place the email onto a scheduler that will then be processed and sent. Use delays to schedule email sending.

Declaration

public ScheduledJobDto SendWithSchedule(Guid inboxId, SendEmailOptions sendEmailOptions, DateTime? sendAtTimestamp = null, long? sendAtNowPlusSeconds = null, bool? validateBeforeEnqueue = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of the inbox you want to send the email from
SendEmailOptions	sendEmailOptions
DateTime?	sendAtTimestamp	Sending timestamp (optional)
long?	sendAtNowPlusSeconds	Send after n seconds (optional)
bool?	validateBeforeEnqueue	Validate before adding to queue (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ScheduledJobDto	ScheduledJobDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendWithScheduleAsync(Guid, SendEmailOptions, DateTime?, long?, bool?, int, CancellationToken)

Send email with with delay or schedule Send an email using a delay. Will place the email onto a scheduler that will then be processed and sent. Use delays to schedule email sending.

Declaration

public Task<ScheduledJobDto> SendWithScheduleAsync(Guid inboxId, SendEmailOptions sendEmailOptions, DateTime? sendAtTimestamp = null, long? sendAtNowPlusSeconds = null, bool? validateBeforeEnqueue = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of the inbox you want to send the email from
SendEmailOptions	sendEmailOptions
DateTime?	sendAtTimestamp	Sending timestamp (optional)
long?	sendAtNowPlusSeconds	Send after n seconds (optional)
bool?	validateBeforeEnqueue	Validate before adding to queue (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ScheduledJobDto>	Task of ScheduledJobDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendWithScheduleWithHttpInfo(Guid, SendEmailOptions, DateTime?, long?, bool?, int)

Send email with with delay or schedule Send an email using a delay. Will place the email onto a scheduler that will then be processed and sent. Use delays to schedule email sending.

Declaration

public ApiResponse<ScheduledJobDto> SendWithScheduleWithHttpInfo(Guid inboxId, SendEmailOptions sendEmailOptions, DateTime? sendAtTimestamp = null, long? sendAtNowPlusSeconds = null, bool? validateBeforeEnqueue = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of the inbox you want to send the email from
SendEmailOptions	sendEmailOptions
DateTime?	sendAtTimestamp	Sending timestamp (optional)
long?	sendAtNowPlusSeconds	Send after n seconds (optional)
bool?	validateBeforeEnqueue	Validate before adding to queue (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<ScheduledJobDto>	ApiResponse of ScheduledJobDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendWithScheduleWithHttpInfoAsync(Guid, SendEmailOptions, DateTime?, long?, bool?, int, CancellationToken)

Send email with with delay or schedule Send an email using a delay. Will place the email onto a scheduler that will then be processed and sent. Use delays to schedule email sending.

Declaration

public Task<ApiResponse<ScheduledJobDto>> SendWithScheduleWithHttpInfoAsync(Guid inboxId, SendEmailOptions sendEmailOptions, DateTime? sendAtTimestamp = null, long? sendAtNowPlusSeconds = null, bool? validateBeforeEnqueue = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of the inbox you want to send the email from
SendEmailOptions	sendEmailOptions
DateTime?	sendAtTimestamp	Sending timestamp (optional)
long?	sendAtNowPlusSeconds	Send after n seconds (optional)
bool?	validateBeforeEnqueue	Validate before adding to queue (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SetInboxFavourited(Guid, SetInboxFavouritedOptions, int)

Set inbox favourited state Set and return new favourite state for an inbox

Declaration

public InboxDto SetInboxFavourited(Guid inboxId, SetInboxFavouritedOptions setInboxFavouritedOptions, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of inbox to set favourite state
SetInboxFavouritedOptions	setInboxFavouritedOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxDto	InboxDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SetInboxFavouritedAsync(Guid, SetInboxFavouritedOptions, int, CancellationToken)

Set inbox favourited state Set and return new favourite state for an inbox

Declaration

public Task<InboxDto> SetInboxFavouritedAsync(Guid inboxId, SetInboxFavouritedOptions setInboxFavouritedOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of inbox to set favourite state
SetInboxFavouritedOptions	setInboxFavouritedOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<InboxDto>	Task of InboxDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SetInboxFavouritedWithHttpInfo(Guid, SetInboxFavouritedOptions, int)

Set inbox favourited state Set and return new favourite state for an inbox

Declaration

public ApiResponse<InboxDto> SetInboxFavouritedWithHttpInfo(Guid inboxId, SetInboxFavouritedOptions setInboxFavouritedOptions, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of inbox to set favourite state
SetInboxFavouritedOptions	setInboxFavouritedOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxDto>	ApiResponse of InboxDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SetInboxFavouritedWithHttpInfoAsync(Guid, SetInboxFavouritedOptions, int, CancellationToken)

Set inbox favourited state Set and return new favourite state for an inbox

Declaration

public Task<ApiResponse<InboxDto>> SetInboxFavouritedWithHttpInfoAsync(Guid inboxId, SetInboxFavouritedOptions setInboxFavouritedOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of inbox to set favourite state
SetInboxFavouritedOptions	setInboxFavouritedOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateImapAccess(UpdateImapAccessOptions, Guid?, int)

Update IMAP access usernames and passwords

Declaration

public void UpdateImapAccess(UpdateImapAccessOptions updateImapAccessOptions, Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
UpdateImapAccessOptions	updateImapAccessOptions
System.Guid?	inboxId	Inbox ID (optional)
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateImapAccessAsync(UpdateImapAccessOptions, Guid?, int, CancellationToken)

Update IMAP access usernames and passwords

Declaration

public Task UpdateImapAccessAsync(UpdateImapAccessOptions updateImapAccessOptions, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateImapAccessOptions	updateImapAccessOptions
System.Guid?	inboxId	Inbox ID (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

View Source

UpdateImapAccessWithHttpInfo(UpdateImapAccessOptions, Guid?, int)

Update IMAP access usernames and passwords

Declaration

public ApiResponse<object> UpdateImapAccessWithHttpInfo(UpdateImapAccessOptions updateImapAccessOptions, Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
UpdateImapAccessOptions	updateImapAccessOptions
System.Guid?	inboxId	Inbox ID (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

View Source

UpdateImapAccessWithHttpInfoAsync(UpdateImapAccessOptions, Guid?, int, CancellationToken)

Update IMAP access usernames and passwords

Declaration

public Task<ApiResponse<object>> UpdateImapAccessWithHttpInfoAsync(UpdateImapAccessOptions updateImapAccessOptions, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateImapAccessOptions	updateImapAccessOptions
System.Guid?	inboxId	Inbox ID (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

View Source

UpdateInbox(Guid, UpdateInboxOptions, int)

Update Inbox. Change name and description. Email address is not editable. Update editable fields on an inbox

Declaration

public InboxDto UpdateInbox(Guid inboxId, UpdateInboxOptions updateInboxOptions, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId
UpdateInboxOptions	updateInboxOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxDto	InboxDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateInboxAsync(Guid, UpdateInboxOptions, int, CancellationToken)

Update Inbox. Change name and description. Email address is not editable. Update editable fields on an inbox

Declaration

public Task<InboxDto> UpdateInboxAsync(Guid inboxId, UpdateInboxOptions updateInboxOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
UpdateInboxOptions	updateInboxOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<InboxDto>	Task of InboxDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateInboxWithHttpInfo(Guid, UpdateInboxOptions, int)

Update Inbox. Change name and description. Email address is not editable. Update editable fields on an inbox

Declaration

public ApiResponse<InboxDto> UpdateInboxWithHttpInfo(Guid inboxId, UpdateInboxOptions updateInboxOptions, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	inboxId
UpdateInboxOptions	updateInboxOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxDto>	ApiResponse of InboxDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateInboxWithHttpInfoAsync(Guid, UpdateInboxOptions, int, CancellationToken)

Update Inbox. Change name and description. Email address is not editable. Update editable fields on an inbox

Declaration

public Task<ApiResponse<InboxDto>> UpdateInboxWithHttpInfoAsync(Guid inboxId, UpdateInboxOptions updateInboxOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
UpdateInboxOptions	updateInboxOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateSmtpAccess(UpdateSmtpAccessOptions, Guid?, int)

Update SMTP access usernames and passwords

Declaration

public void UpdateSmtpAccess(UpdateSmtpAccessOptions updateSmtpAccessOptions, Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
UpdateSmtpAccessOptions	updateSmtpAccessOptions
System.Guid?	inboxId	Inbox ID (optional)
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateSmtpAccessAsync(UpdateSmtpAccessOptions, Guid?, int, CancellationToken)

Update SMTP access usernames and passwords

Declaration

public Task UpdateSmtpAccessAsync(UpdateSmtpAccessOptions updateSmtpAccessOptions, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateSmtpAccessOptions	updateSmtpAccessOptions
System.Guid?	inboxId	Inbox ID (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

View Source

UpdateSmtpAccessWithHttpInfo(UpdateSmtpAccessOptions, Guid?, int)

Update SMTP access usernames and passwords

Declaration

public ApiResponse<object> UpdateSmtpAccessWithHttpInfo(UpdateSmtpAccessOptions updateSmtpAccessOptions, Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
UpdateSmtpAccessOptions	updateSmtpAccessOptions
System.Guid?	inboxId	Inbox ID (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

View Source

UpdateSmtpAccessWithHttpInfoAsync(UpdateSmtpAccessOptions, Guid?, int, CancellationToken)

Update SMTP access usernames and passwords

Declaration

public Task<ApiResponse<object>> UpdateSmtpAccessWithHttpInfoAsync(UpdateSmtpAccessOptions updateSmtpAccessOptions, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateSmtpAccessOptions	updateSmtpAccessOptions
System.Guid?	inboxId	Inbox ID (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

Implements

IInboxControllerApi

IInboxControllerApiSync

IInboxControllerApiAsync

IApiAccessor