Search Results for

    Show / Hide Table of Contents

    Interface IImapControllerApiSync

    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 IImapControllerApiSync : IApiAccessor

    Methods

    View Source

    ImapServerFetch(long, Guid?, int)

    Fetch message in an inbox

    Declaration
    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

    ImapServerFetchWithHttpInfo(long, Guid?, int)

    Fetch message in an inbox

    Declaration
    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

    ImapServerGet(Guid, Guid?, int)

    Get a message by email ID

    Declaration
    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

    ImapServerGetWithHttpInfo(Guid, Guid?, int)

    Get a message by email ID

    Declaration
    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

    ImapServerList(ImapServerListOptions, Guid?, int)

    List messages in an inbox

    Declaration
    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

    ImapServerListWithHttpInfo(ImapServerListOptions, Guid?, int)

    List messages in an inbox

    Declaration
    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

    ImapServerMailbox(string, int)

    Create a new mailbox if possible

    Declaration
    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

    ImapServerMailboxWithHttpInfo(string, int)

    Create a new mailbox if possible

    Declaration
    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

    ImapServerSearch(ImapServerSearchOptions, Guid?, int)

    Search messages in an inbox

    Declaration
    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

    ImapServerSearchWithHttpInfo(ImapServerSearchOptions, Guid?, int)

    Search messages in an inbox

    Declaration
    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

    ImapServerStatus(ImapServerStatusOptions, Guid?, int)

    Get status for mailbox

    Declaration
    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

    ImapServerStatusWithHttpInfo(ImapServerStatusOptions, Guid?, int)

    Get status for mailbox

    Declaration
    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

    ImapServerUpdateFlags(ImapUpdateFlagsOptions, Guid?, int)

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

    Remarks

    Update message flags

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    ImapServerUpdateFlagsWithHttpInfo(ImapUpdateFlagsOptions, Guid?, int)

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

    Remarks

    Update message flags

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

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