Interface IImapControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IImapControllerApiAsync : IApiAccessor

Methods

View Source

ImapServerFetchAsync(long, Guid?, int, CancellationToken)

Fetch message in an inbox

Declaration
Task<ImapServerFetchResult> ImapServerFetchAsync(long seqNum, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
long seqNum
System.Guid? inboxId

Inbox ID to search (optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ImapServerFetchResult>

Task of ImapServerFetchResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ImapServerFetchWithHttpInfoAsync(long, Guid?, int, CancellationToken)

Fetch message in an inbox

Declaration
Task<ApiResponse<ImapServerFetchResult>> ImapServerFetchWithHttpInfoAsync(long seqNum, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
long seqNum
System.Guid? inboxId

Inbox ID to search (optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<ImapServerFetchResult>>

Task of ApiResponse (ImapServerFetchResult)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ImapServerGetAsync(Guid, Guid?, int, CancellationToken)

Get a message by email ID

Declaration
Task<ImapServerGetResult> ImapServerGetAsync(Guid emailId, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.Guid emailId

Email ID to get
System.Guid? inboxId

Inbox ID to search (optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ImapServerGetResult>

Task of ImapServerGetResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ImapServerGetWithHttpInfoAsync(Guid, Guid?, int, CancellationToken)

Get a message by email ID

Declaration
Task<ApiResponse<ImapServerGetResult>> ImapServerGetWithHttpInfoAsync(Guid emailId, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.Guid emailId

Email ID to get
System.Guid? inboxId

Inbox ID to search (optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<ImapServerGetResult>>

Task of ApiResponse (ImapServerGetResult)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ImapServerListAsync(ImapServerListOptions, Guid?, int, CancellationToken)

List messages in an inbox

Declaration
Task<ImapServerListResult> ImapServerListAsync(ImapServerListOptions imapServerListOptions, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ImapServerListOptions imapServerListOptions
System.Guid? inboxId

Inbox ID to list (optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ImapServerListResult>

Task of ImapServerListResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ImapServerListWithHttpInfoAsync(ImapServerListOptions, Guid?, int, CancellationToken)

List messages in an inbox

Declaration
Task<ApiResponse<ImapServerListResult>> ImapServerListWithHttpInfoAsync(ImapServerListOptions imapServerListOptions, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ImapServerListOptions imapServerListOptions
System.Guid? inboxId

Inbox ID to list (optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<ImapServerListResult>>

Task of ApiResponse (ImapServerListResult)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ImapServerMailboxAsync(string, int, CancellationToken)

Create a new mailbox if possible

Declaration
Task<ImapServerMailboxResult> ImapServerMailboxAsync(string name, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string name

Inbox email address to create
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ImapServerMailboxResult>

Task of ImapServerMailboxResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ImapServerMailboxWithHttpInfoAsync(string, int, CancellationToken)

Create a new mailbox if possible

Declaration
Task<ApiResponse<ImapServerMailboxResult>> ImapServerMailboxWithHttpInfoAsync(string name, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string name

Inbox email address to create
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<ImapServerMailboxResult>>

Task of ApiResponse (ImapServerMailboxResult)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ImapServerSearchAsync(ImapServerSearchOptions, Guid?, int, CancellationToken)

Search messages in an inbox

Declaration
Task<ImapServerSearchResult> ImapServerSearchAsync(ImapServerSearchOptions imapServerSearchOptions, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ImapServerSearchOptions imapServerSearchOptions
System.Guid? inboxId

Inbox ID to search (optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ImapServerSearchResult>

Task of ImapServerSearchResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ImapServerSearchWithHttpInfoAsync(ImapServerSearchOptions, Guid?, int, CancellationToken)

Search messages in an inbox

Declaration
Task<ApiResponse<ImapServerSearchResult>> ImapServerSearchWithHttpInfoAsync(ImapServerSearchOptions imapServerSearchOptions, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ImapServerSearchOptions imapServerSearchOptions
System.Guid? inboxId

Inbox ID to search (optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<ImapServerSearchResult>>

Task of ApiResponse (ImapServerSearchResult)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ImapServerStatusAsync(ImapServerStatusOptions, Guid?, int, CancellationToken)

Get status for mailbox

Declaration
Task<ImapServerStatusResult> ImapServerStatusAsync(ImapServerStatusOptions imapServerStatusOptions, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ImapServerStatusOptions imapServerStatusOptions
System.Guid? inboxId

Inbox ID to list (optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ImapServerStatusResult>

Task of ImapServerStatusResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ImapServerStatusWithHttpInfoAsync(ImapServerStatusOptions, Guid?, int, CancellationToken)

Get status for mailbox

Declaration
Task<ApiResponse<ImapServerStatusResult>> ImapServerStatusWithHttpInfoAsync(ImapServerStatusOptions imapServerStatusOptions, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ImapServerStatusOptions imapServerStatusOptions
System.Guid? inboxId

Inbox ID to list (optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<ImapServerStatusResult>>

Task of ApiResponse (ImapServerStatusResult)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ImapServerUpdateFlagsAsync(ImapUpdateFlagsOptions, Guid?, int, CancellationToken)

Declaration
Task ImapServerUpdateFlagsAsync(ImapUpdateFlagsOptions imapUpdateFlagsOptions, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ImapUpdateFlagsOptions imapUpdateFlagsOptions
System.Guid? inboxId

(optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task

Task of void
Remarks

Update message flags

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ImapServerUpdateFlagsWithHttpInfoAsync(ImapUpdateFlagsOptions, Guid?, int, CancellationToken)

Declaration
Task<ApiResponse<object>> ImapServerUpdateFlagsWithHttpInfoAsync(ImapUpdateFlagsOptions imapUpdateFlagsOptions, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ImapUpdateFlagsOptions imapUpdateFlagsOptions
System.Guid? inboxId

(optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<object>>

Task of ApiResponse
Remarks

Update message flags

Exceptions
Type Condition
ApiException

Thrown when fails to make API call