Interface IInboxControllerApiSync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IInboxControllerApiSync : IApiAccessor

Methods

View Source

CancelScheduledJob(Guid, int)

Cancel a scheduled email job

Declaration

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

Remarks

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CancelScheduledJobWithHttpInfo(Guid, int)

Cancel a scheduled email job

Declaration

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

Remarks

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

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.

Declaration

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

Remarks

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.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateInboxRuleset(Guid, CreateInboxRulesetOptions, int)

Create an inbox ruleset

Declaration

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

Remarks

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateInboxRulesetWithHttpInfo(Guid, CreateInboxRulesetOptions, int)

Create an inbox ruleset

Declaration

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

Remarks

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

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

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

CreateInboxWithDefaultsWithHttpInfo(int)

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

Declaration

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

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

Declaration

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

Remarks

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.

Declaration

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

Remarks

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

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.

Declaration

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

Remarks

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllInboxEmails(Guid, int)

Delete all emails in a given inboxes.

Declaration

void DeleteAllInboxEmails(Guid inboxId, int operationIndex = 0)

Parameters

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

Remarks

Deletes all emails in an inbox. Be careful as emails cannot be recovered

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllInboxEmailsWithHttpInfo(Guid, int)

Delete all emails in a given inboxes.

Declaration

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)

Remarks

Deletes all emails in an inbox. Be careful as emails cannot be recovered

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllInboxes(int)

Delete all inboxes

Declaration

void DeleteAllInboxes(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Remarks

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.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllInboxesByDescription(string, int)

Delete inboxes by description

Declaration

void DeleteAllInboxesByDescription(string description, int operationIndex = 0)

Parameters

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

Remarks

Permanently delete all inboxes by description

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllInboxesByDescriptionWithHttpInfo(string, int)

Delete inboxes by description

Declaration

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)

Remarks

Permanently delete all inboxes by description

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllInboxesByName(string, int)

Delete inboxes by name

Declaration

void DeleteAllInboxesByName(string name, int operationIndex = 0)

Parameters

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

Remarks

Permanently delete all inboxes by name

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllInboxesByNameWithHttpInfo(string, int)

Delete inboxes by name

Declaration

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)

Remarks

Permanently delete all inboxes by name

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllInboxesByTag(string, int)

Delete inboxes by tag

Declaration

void DeleteAllInboxesByTag(string tag, int operationIndex = 0)

Parameters

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

Remarks

Permanently delete all inboxes by tag

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllInboxesByTagWithHttpInfo(string, int)

Delete inboxes by tag

Declaration

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)

Remarks

Permanently delete all inboxes by tag

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllInboxesWithHttpInfo(int)

Delete all inboxes

Declaration

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)

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteInbox(Guid, int)

Delete inbox

Declaration

void DeleteInbox(Guid inboxId, int operationIndex = 0)

Parameters

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

Remarks

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.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteInboxWithHttpInfo(Guid, int)

Delete inbox

Declaration

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)

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DoesInboxExist(string, bool?, int)

Does inbox exist

Declaration

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

Remarks

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DoesInboxExistWithHttpInfo(string, bool?, int)

Does inbox exist

Declaration

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

Remarks

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

FlushExpired(DateTime?, int)

Remove expired inboxes

Declaration

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

Remarks

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

FlushExpiredWithHttpInfo(DateTime?, int)

Remove expired inboxes

Declaration

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

Remarks

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

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

Declaration

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

Remarks

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.

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

Declaration

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

Remarks

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)

List All Inboxes Offset Paginated

Declaration

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

Remarks

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)

List All Inboxes Paginated

Declaration

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

Remarks

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

Declaration

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

Remarks

Schedule sending of emails using scheduled jobs. These can be inbox or account level.

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

Declaration

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

Remarks

Schedule sending of emails using scheduled jobs. These can be inbox or account level.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Declaration

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

Remarks

Get all email delivery statuses for an inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Declaration

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

Remarks

Get all email delivery statuses for an inbox

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.

Declaration

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>

Remarks

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

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

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>

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapAccess(Guid?, int)

Declaration

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

Remarks

Get IMAP access usernames and passwords

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapAccessWithHttpInfo(Guid?, int)

Declaration

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

Remarks

Get IMAP access usernames and passwords

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapSmtpAccess(Guid?, int)

Declaration

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

Remarks

Get IMAP and SMTP access usernames and passwords

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapSmtpAccessEnv(Guid?, int)

Declaration

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

Remarks

Get IMAP and SMTP access details in .env format

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapSmtpAccessEnvWithHttpInfo(Guid?, int)

Declaration

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

Remarks

Get IMAP and SMTP access details in .env format

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapSmtpAccessServers(int)

Declaration

ImapSmtpAccessServers GetImapSmtpAccessServers(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ImapSmtpAccessServers	ImapSmtpAccessServers

Remarks

Get IMAP and SMTP server hosts

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapSmtpAccessServersWithHttpInfo(int)

Declaration

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

Remarks

Get IMAP and SMTP server hosts

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetImapSmtpAccessWithHttpInfo(Guid?, int)

Declaration

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

Remarks

Get IMAP and SMTP access usernames and passwords

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInbox(Guid, int)

Get Inbox. Returns properties of an inbox.

Declaration

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

Remarks

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

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

Declaration

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

Remarks

Get a inbox result by email address

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

Declaration

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

Remarks

Get a inbox result by email address

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxByName(string, int)

Search for an inbox with the given name

Declaration

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

Remarks

Get a inbox result by name

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxByNameWithHttpInfo(string, int)

Search for an inbox with the given name

Declaration

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

Remarks

Get a inbox result by name

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxCount(int)

Get total inbox count

Declaration

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

GetInboxCountWithHttpInfo(int)

Get total inbox count

Declaration

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

GetInboxEmailCount(Guid, int)

Get email count in inbox

Declaration

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

GetInboxEmailCountWithHttpInfo(Guid, int)

Get email count in inbox

Declaration

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

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

Get inbox emails paginated

Declaration

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

Remarks

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

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

Declaration

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

Remarks

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

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

Declaration

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

Remarks

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.

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

Declaration

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

Remarks

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.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxIds(int)

Get all inbox IDs

Declaration

[Obsolete]
InboxIdsResult GetInboxIds(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxIdsResult	InboxIdsResult

Remarks

Get list of inbox IDs

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxIdsWithHttpInfo(int)

Get all inbox IDs

Declaration

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

Remarks

Get list of inbox IDs

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

Declaration

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

Remarks

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.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get Inbox Sent Emails

Declaration

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

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxTags(int)

Get inbox tags

Declaration

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

Remarks

Get all inbox tags

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxTagsWithHttpInfo(int)

Get inbox tags

Declaration

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

Remarks

Get all inbox tags

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxWithHttpInfo(Guid, int)

Get Inbox. Returns properties of an inbox.

Declaration

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

Remarks

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

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.

Declaration

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

Remarks

Get the newest email in an inbox or wait for one to arrive

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.

Declaration

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

Remarks

Get the newest email in an inbox or wait for one to arrive

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

Declaration

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

Remarks

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List Organization Inboxes Paginated

Declaration

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

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetScheduledJob(Guid, int)

Get a scheduled email job

Declaration

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

Remarks

Get a scheduled email job details.

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

Declaration

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

Remarks

Schedule sending of emails using scheduled jobs.

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

Declaration

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

Remarks

Schedule sending of emails using scheduled jobs.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetScheduledJobWithHttpInfo(Guid, int)

Get a scheduled email job

Declaration

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

Remarks

Get a scheduled email job details.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetSmtpAccess(Guid?, int)

Declaration

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

Remarks

Get SMTP access usernames and passwords

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetSmtpAccessWithHttpInfo(Guid?, int)

Declaration

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

Remarks

Get SMTP access usernames and passwords

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

IsEmailAddressAvailable(string, int)

Is email address available

Declaration

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

Remarks

Returns whether an email address is available

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

IsEmailAddressAvailableWithHttpInfo(string, int)

Is email address available

Declaration

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

Remarks

Returns whether an email address is available

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

Declaration

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

Remarks

List all rulesets attached to an inbox

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

Declaration

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

Remarks

List all rulesets attached to an inbox

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

Declaration

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

Remarks

List all tracking pixels sent from an inbox

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

Declaration

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

Remarks

List all tracking pixels sent from an inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SearchInboxes(SearchInboxesOptions, int)

Search all inboxes and return matching inboxes

Declaration

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

Remarks

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.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SearchInboxesWithHttpInfo(SearchInboxesOptions, int)

Search all inboxes and return matching inboxes

Declaration

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

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmail(Guid, SendEmailOptions, int)

Send Email

Declaration

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.

Remarks

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.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailAndConfirm(Guid, SendEmailOptions, int)

Send email and return sent confirmation

Declaration

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

Remarks

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.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailAndConfirmWithHttpInfo(Guid, SendEmailOptions, int)

Send email and return sent confirmation

Declaration

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

Remarks

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.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailWithHttpInfo(Guid, SendEmailOptions, int)

Send Email

Declaration

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)

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailWithQueue(Guid, bool, SendEmailOptions, int)

Send email with queue

Declaration

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.

Remarks

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.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailWithQueueWithHttpInfo(Guid, bool, SendEmailOptions, int)

Send email with queue

Declaration

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)

Remarks

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

Declaration

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

Remarks

Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY.

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

Declaration

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

Remarks

Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendTestEmail(Guid, int)

Send a test email to inbox

Declaration

void SendTestEmail(Guid inboxId, int operationIndex = 0)

Parameters

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

Remarks

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendTestEmailWithHttpInfo(Guid, int)

Send a test email to inbox

Declaration

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)

Remarks

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

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

Declaration

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

Remarks

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.

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

Declaration

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

Remarks

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.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SetInboxFavourited(Guid, SetInboxFavouritedOptions, int)

Set inbox favourited state

Declaration

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

Remarks

Set and return new favourite state for an inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SetInboxFavouritedWithHttpInfo(Guid, SetInboxFavouritedOptions, int)

Set inbox favourited state

Declaration

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

Remarks

Set and return new favourite state for an inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateImapAccess(UpdateImapAccessOptions, Guid?, int)

Declaration

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.

Remarks

Update IMAP access usernames and passwords

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateImapAccessWithHttpInfo(UpdateImapAccessOptions, Guid?, int)

Declaration

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)

Remarks

Update IMAP access usernames and passwords

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.

Declaration

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

Remarks

Update editable fields on an inbox

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.

Declaration

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

Remarks

Update editable fields on an inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateSmtpAccess(UpdateSmtpAccessOptions, Guid?, int)

Declaration

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.

Remarks

Update SMTP access usernames and passwords

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateSmtpAccessWithHttpInfo(UpdateSmtpAccessOptions, Guid?, int)

Declaration

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)

Remarks

Update SMTP access usernames and passwords

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call