Search Results for

    Show / Hide Table of Contents

    Class ImapControllerApi

    Represents a collection of functions to interact with the API endpoints

    Inheritance
    object
    ImapControllerApi
    Implements
    IImapControllerApi
    IImapControllerApiSync
    IImapControllerApiAsync
    IApiAccessor
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: mailslurp.Api
    Assembly: mailslurp.dll
    Syntax
    public class ImapControllerApi : IImapControllerApi, IImapControllerApiSync, IImapControllerApiAsync, IApiAccessor

    Constructors

    View Source

    ImapControllerApi()

    Initializes a new instance of the ImapControllerApi class.

    Declaration
    public ImapControllerApi()
    View Source

    ImapControllerApi(Configuration)

    Initializes a new instance of the ImapControllerApi class using Configuration object

    Declaration
    public ImapControllerApi(Configuration configuration)
    Parameters
    Type Name Description
    Configuration configuration

    An instance of Configuration

    View Source

    ImapControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

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

    Declaration
    public ImapControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)
    Parameters
    Type Name Description
    ISynchronousClient client

    The client interface for synchronous API access.

    IAsynchronousClient asyncClient

    The client interface for asynchronous API access.

    IReadableConfiguration configuration

    The configuration object.

    View Source

    ImapControllerApi(string)

    Initializes a new instance of the ImapControllerApi class.

    Declaration
    public ImapControllerApi(string basePath)
    Parameters
    Type Name Description
    string basePath

    Properties

    View Source

    AsynchronousClient

    The client for accessing this underlying API asynchronously.

    Declaration
    public IAsynchronousClient AsynchronousClient { get; set; }
    Property Value
    Type Description
    IAsynchronousClient
    View Source

    Client

    The client for accessing this underlying API synchronously.

    Declaration
    public ISynchronousClient Client { get; set; }
    Property Value
    Type Description
    ISynchronousClient
    View Source

    Configuration

    Gets or sets the configuration object

    Declaration
    public IReadableConfiguration Configuration { get; set; }
    Property Value
    Type Description
    IReadableConfiguration

    An instance of the Configuration

    View Source

    ExceptionFactory

    Provides a factory method hook for the creation of exceptions.

    Declaration
    public ExceptionFactory ExceptionFactory { get; set; }
    Property Value
    Type Description
    ExceptionFactory

    Methods

    View Source

    GetBasePath()

    Gets the base path of the API client.

    Declaration
    public string GetBasePath()
    Returns
    Type Description
    string

    The base path

    View Source

    ImapServerFetch(long, Guid?, int)

    Fetch message in an inbox

    Declaration
    public ImapServerFetchResult ImapServerFetch(long seqNum, Guid? inboxId = null, int operationIndex = 0)
    Parameters
    Type Name Description
    long seqNum
    System.Guid? inboxId

    Inbox ID to search (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ImapServerFetchResult

    ImapServerFetchResult

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    ImapServerFetchAsync(long, Guid?, int, CancellationToken)

    Fetch message in an inbox

    Declaration
    public 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

    ImapServerFetchWithHttpInfo(long, Guid?, int)

    Fetch message in an inbox

    Declaration
    public ApiResponse<ImapServerFetchResult> ImapServerFetchWithHttpInfo(long seqNum, Guid? inboxId = null, int operationIndex = 0)
    Parameters
    Type Name Description
    long seqNum
    System.Guid? inboxId

    Inbox ID to search (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<ImapServerFetchResult>

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

    ImapServerGet(Guid, Guid?, int)

    Get a message by email ID

    Declaration
    public ImapServerGetResult ImapServerGet(Guid emailId, Guid? inboxId = null, int operationIndex = 0)
    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.

    Returns
    Type Description
    ImapServerGetResult

    ImapServerGetResult

    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
    public 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

    ImapServerGetWithHttpInfo(Guid, Guid?, int)

    Get a message by email ID

    Declaration
    public ApiResponse<ImapServerGetResult> ImapServerGetWithHttpInfo(Guid emailId, Guid? inboxId = null, int operationIndex = 0)
    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.

    Returns
    Type Description
    ApiResponse<ImapServerGetResult>

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

    ImapServerList(ImapServerListOptions, Guid?, int)

    List messages in an inbox

    Declaration
    public ImapServerListResult ImapServerList(ImapServerListOptions imapServerListOptions, Guid? inboxId = null, int operationIndex = 0)
    Parameters
    Type Name Description
    ImapServerListOptions imapServerListOptions
    System.Guid? inboxId

    Inbox ID to list (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ImapServerListResult

    ImapServerListResult

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    ImapServerListAsync(ImapServerListOptions, Guid?, int, CancellationToken)

    List messages in an inbox

    Declaration
    public 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

    ImapServerListWithHttpInfo(ImapServerListOptions, Guid?, int)

    List messages in an inbox

    Declaration
    public ApiResponse<ImapServerListResult> ImapServerListWithHttpInfo(ImapServerListOptions imapServerListOptions, Guid? inboxId = null, int operationIndex = 0)
    Parameters
    Type Name Description
    ImapServerListOptions imapServerListOptions
    System.Guid? inboxId

    Inbox ID to list (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<ImapServerListResult>

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

    ImapServerMailbox(string, int)

    Create a new mailbox if possible

    Declaration
    public ImapServerMailboxResult ImapServerMailbox(string name, int operationIndex = 0)
    Parameters
    Type Name Description
    string name

    Inbox email address to create

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ImapServerMailboxResult

    ImapServerMailboxResult

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    ImapServerMailboxAsync(string, int, CancellationToken)

    Create a new mailbox if possible

    Declaration
    public 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

    ImapServerMailboxWithHttpInfo(string, int)

    Create a new mailbox if possible

    Declaration
    public ApiResponse<ImapServerMailboxResult> ImapServerMailboxWithHttpInfo(string name, int operationIndex = 0)
    Parameters
    Type Name Description
    string name

    Inbox email address to create

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<ImapServerMailboxResult>

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

    ImapServerSearch(ImapServerSearchOptions, Guid?, int)

    Search messages in an inbox

    Declaration
    public ImapServerSearchResult ImapServerSearch(ImapServerSearchOptions imapServerSearchOptions, Guid? inboxId = null, int operationIndex = 0)
    Parameters
    Type Name Description
    ImapServerSearchOptions imapServerSearchOptions
    System.Guid? inboxId

    Inbox ID to search (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ImapServerSearchResult

    ImapServerSearchResult

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    ImapServerSearchAsync(ImapServerSearchOptions, Guid?, int, CancellationToken)

    Search messages in an inbox

    Declaration
    public 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

    ImapServerSearchWithHttpInfo(ImapServerSearchOptions, Guid?, int)

    Search messages in an inbox

    Declaration
    public ApiResponse<ImapServerSearchResult> ImapServerSearchWithHttpInfo(ImapServerSearchOptions imapServerSearchOptions, Guid? inboxId = null, int operationIndex = 0)
    Parameters
    Type Name Description
    ImapServerSearchOptions imapServerSearchOptions
    System.Guid? inboxId

    Inbox ID to search (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<ImapServerSearchResult>

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

    ImapServerStatus(ImapServerStatusOptions, Guid?, int)

    Get status for mailbox

    Declaration
    public ImapServerStatusResult ImapServerStatus(ImapServerStatusOptions imapServerStatusOptions, Guid? inboxId = null, int operationIndex = 0)
    Parameters
    Type Name Description
    ImapServerStatusOptions imapServerStatusOptions
    System.Guid? inboxId

    Inbox ID to list (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ImapServerStatusResult

    ImapServerStatusResult

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    ImapServerStatusAsync(ImapServerStatusOptions, Guid?, int, CancellationToken)

    Get status for mailbox

    Declaration
    public 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

    ImapServerStatusWithHttpInfo(ImapServerStatusOptions, Guid?, int)

    Get status for mailbox

    Declaration
    public ApiResponse<ImapServerStatusResult> ImapServerStatusWithHttpInfo(ImapServerStatusOptions imapServerStatusOptions, Guid? inboxId = null, int operationIndex = 0)
    Parameters
    Type Name Description
    ImapServerStatusOptions imapServerStatusOptions
    System.Guid? inboxId

    Inbox ID to list (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<ImapServerStatusResult>

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

    ImapServerUpdateFlags(ImapUpdateFlagsOptions, Guid?, int)

    Update message flags

    Declaration
    public void ImapServerUpdateFlags(ImapUpdateFlagsOptions imapUpdateFlagsOptions, Guid? inboxId = null, int operationIndex = 0)
    Parameters
    Type Name Description
    ImapUpdateFlagsOptions imapUpdateFlagsOptions
    System.Guid? inboxId

    (optional)

    int operationIndex

    Index associated with the operation.

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    ImapServerUpdateFlagsAsync(ImapUpdateFlagsOptions, Guid?, int, CancellationToken)

    Update message flags

    Declaration
    public 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

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    ImapServerUpdateFlagsWithHttpInfo(ImapUpdateFlagsOptions, Guid?, int)

    Update message flags

    Declaration
    public ApiResponse<object> ImapServerUpdateFlagsWithHttpInfo(ImapUpdateFlagsOptions imapUpdateFlagsOptions, Guid? inboxId = null, int operationIndex = 0)
    Parameters
    Type Name Description
    ImapUpdateFlagsOptions imapUpdateFlagsOptions
    System.Guid? inboxId

    (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<object>

    ApiResponse of Object(void)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    ImapServerUpdateFlagsWithHttpInfoAsync(ImapUpdateFlagsOptions, Guid?, int, CancellationToken)

    Update message flags

    Declaration
    public 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

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    Implements

    IImapControllerApi
    IImapControllerApiSync
    IImapControllerApiAsync
    IApiAccessor
    • View Source
    In This Article
    Back to top See MailSlurp website for more information.