Interface ICommonActionsControllerApiSync

Represents a collection of functions to interact with the API endpoints

Inherited Members

IApiAccessor.Configuration

IApiAccessor.GetBasePath()

IApiAccessor.ExceptionFactory

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface ICommonActionsControllerApiSync : IApiAccessor

Methods

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

Create new random inbox

Declaration

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

Parameters

Type	Name	Description
bool?	allowTeamAccess	(optional)
bool?	useDomainPool	(optional)
DateTime?	expiresAt	(optional)
long?	expiresIn	(optional)
string	emailAddress	(optional)
string	inboxType	(optional)
string	description	(optional)
string	name	(optional)
List<string>	tags	(optional)
bool?	favourite	(optional)
bool?	virtualInbox	(optional)
bool?	useShortAddress	(optional)
string	domainName	(optional)
Guid?	domainId	(optional)
string	prefix	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxDto	InboxDto

Remarks

Returns an Inbox with an id and an emailAddress

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Create new random inbox

Declaration

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

Parameters

Type	Name	Description
bool?	allowTeamAccess	(optional)
bool?	useDomainPool	(optional)
DateTime?	expiresAt	(optional)
long?	expiresIn	(optional)
string	emailAddress	(optional)
string	inboxType	(optional)
string	description	(optional)
string	name	(optional)
List<string>	tags	(optional)
bool?	favourite	(optional)
bool?	virtualInbox	(optional)
bool?	useShortAddress	(optional)
string	domainName	(optional)
Guid?	domainId	(optional)
string	prefix	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxDto>	ApiResponse of InboxDto

Remarks

Returns an Inbox with an id and an emailAddress

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Create new random inbox

Declaration

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

Parameters

Type	Name	Description
bool?	allowTeamAccess	(optional)
bool?	useDomainPool	(optional)
DateTime?	expiresAt	(optional)
long?	expiresIn	(optional)
string	emailAddress	(optional)
string	inboxType	(optional)
string	description	(optional)
string	name	(optional)
List<string>	tags	(optional)
bool?	favourite	(optional)
bool?	virtualInbox	(optional)
bool?	useShortAddress	(optional)
string	domainName	(optional)
Guid?	domainId	(optional)
string	prefix	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxDto	InboxDto

Remarks

Returns an Inbox with an id and an emailAddress

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Create new random inbox

Declaration

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

Parameters

Type	Name	Description
bool?	allowTeamAccess	(optional)
bool?	useDomainPool	(optional)
DateTime?	expiresAt	(optional)
long?	expiresIn	(optional)
string	emailAddress	(optional)
string	inboxType	(optional)
string	description	(optional)
string	name	(optional)
List<string>	tags	(optional)
bool?	favourite	(optional)
bool?	virtualInbox	(optional)
bool?	useShortAddress	(optional)
string	domainName	(optional)
Guid?	domainId	(optional)
string	prefix	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxDto>	ApiResponse of InboxDto

Remarks

Returns an Inbox with an id and an emailAddress

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteEmailAddress(Guid, int)

Delete inbox email address by inbox id

Declaration

void DeleteEmailAddress(Guid inboxId, int operationIndex = 0)

Parameters

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

Remarks

Deletes inbox email address

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteEmailAddressWithHttpInfo(Guid, int)

Delete inbox email address by inbox id

Declaration

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

Parameters

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

Returns

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

Remarks

Deletes inbox email address

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

EmptyInbox(Guid, int)

Delete all emails in an inbox

Declaration

void EmptyInbox(Guid inboxId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	inboxId	ID of inbox to empty
int	operationIndex	Index associated with the operation.

Remarks

Deletes all emails

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

EmptyInboxWithHttpInfo(Guid, int)

Delete all emails in an inbox

Declaration

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

Parameters

Type	Name	Description
Guid	inboxId	ID of inbox to empty
int	operationIndex	Index associated with the operation.

Returns

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

Remarks

Deletes all emails

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SendEmailQuery(string, Guid?, string, string, int)

Send an email using query parameters

Declaration

void SendEmailQuery(string to, Guid? senderId = null, string body = null, string subject = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	to	Email address to send to
Guid?	senderId	ID of inbox to send from. If null an inbox will be created for sending (optional)
string	body	Body of the email message. Supports HTML (optional)
string	subject	Subject line of the email (optional)
int	operationIndex	Index associated with the operation.

Remarks

If no senderId or inboxId provided a random email address will be used to send from. Ensure your parameters are URL encoded.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SendEmailQueryWithHttpInfo(string, Guid?, string, string, int)

Send an email using query parameters

Declaration

ApiResponse<object> SendEmailQueryWithHttpInfo(string to, Guid? senderId = null, string body = null, string subject = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	to	Email address to send to
Guid?	senderId	ID of inbox to send from. If null an inbox will be created for sending (optional)
string	body	Body of the email message. Supports HTML (optional)
string	subject	Subject line of the email (optional)
int	operationIndex	Index associated with the operation.

Returns

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

Remarks

If no senderId or inboxId provided a random email address will be used to send from. Ensure your parameters are URL encoded.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SendEmailSimple(SimpleSendEmailOptions, int)

Send an email

Declaration

void SendEmailSimple(SimpleSendEmailOptions simpleSendEmailOptions, int operationIndex = 0)

Parameters

Type	Name	Description
SimpleSendEmailOptions	simpleSendEmailOptions
int	operationIndex	Index associated with the operation.

Remarks

If no senderId or inboxId provided a random email address will be used to send from.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SendEmailSimpleWithHttpInfo(SimpleSendEmailOptions, int)

Send an email

Declaration

ApiResponse<object> SendEmailSimpleWithHttpInfo(SimpleSendEmailOptions simpleSendEmailOptions, int operationIndex = 0)

Parameters

Type	Name	Description
SimpleSendEmailOptions	simpleSendEmailOptions
int	operationIndex	Index associated with the operation.

Returns

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

Remarks

If no senderId or inboxId provided a random email address will be used to send from.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call