Search Results for

    Show / Hide Table of Contents

    Interface IInboxReplierControllerApiSync

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

    Methods

    View Source

    CreateNewInboxReplier(CreateInboxReplierOptions, int)

    Create an inbox replier

    Declaration
    InboxReplierDto CreateNewInboxReplier(CreateInboxReplierOptions createInboxReplierOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    CreateInboxReplierOptions createInboxReplierOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    InboxReplierDto

    InboxReplierDto

    Remarks

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

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    CreateNewInboxReplierWithHttpInfo(CreateInboxReplierOptions, int)

    Create an inbox replier

    Declaration
    ApiResponse<InboxReplierDto> CreateNewInboxReplierWithHttpInfo(CreateInboxReplierOptions createInboxReplierOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    CreateInboxReplierOptions createInboxReplierOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<InboxReplierDto>

    ApiResponse of InboxReplierDto

    Remarks

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

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteInboxReplier(Guid, int)

    Delete an inbox replier

    Declaration
    void DeleteInboxReplier(Guid id, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid id

    ID of inbox replier

    int operationIndex

    Index associated with the operation.

    Remarks

    Delete inbox replier

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteInboxRepliers(Guid?, int)

    Delete inbox repliers

    Declaration
    void DeleteInboxRepliers(Guid? inboxId = null, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid? inboxId

    Optional inbox id to attach replier to (optional)

    int operationIndex

    Index associated with the operation.

    Remarks

    Delete inbox repliers. Accepts optional inboxId filter.

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteInboxRepliersWithHttpInfo(Guid?, int)

    Delete inbox repliers

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

    Optional inbox id to attach replier to (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<object>

    ApiResponse of Object(void)

    Remarks

    Delete inbox repliers. Accepts optional inboxId filter.

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteInboxReplierWithHttpInfo(Guid, int)

    Delete an inbox replier

    Declaration
    ApiResponse<object> DeleteInboxReplierWithHttpInfo(Guid id, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid id

    ID of inbox replier

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<object>

    ApiResponse of Object(void)

    Remarks

    Delete inbox replier

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetInboxReplier(Guid, int)

    Get an inbox replier

    Declaration
    InboxReplierDto GetInboxReplier(Guid id, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid id

    ID of inbox replier

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    InboxReplierDto

    InboxReplierDto

    Remarks

    Get inbox ruleset

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetInboxReplierEvents(Guid, int?, int?, string, int)

    Get an inbox replier event list

    Declaration
    PageInboxReplierEvents GetInboxReplierEvents(Guid id, int? page = null, int? size = null, string sort = null, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid id

    ID of inbox replier

    int? page

    Optional page index in inbox replier event list pagination (optional, default to 0)

    int? size

    Optional page size in inbox replier event list pagination (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    PageInboxReplierEvents

    PageInboxReplierEvents

    Remarks

    Get inbox ruleset events

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetInboxReplierEventsWithHttpInfo(Guid, int?, int?, string, int)

    Get an inbox replier event list

    Declaration
    ApiResponse<PageInboxReplierEvents> GetInboxReplierEventsWithHttpInfo(Guid id, int? page = null, int? size = null, string sort = null, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid id

    ID of inbox replier

    int? page

    Optional page index in inbox replier event list pagination (optional, default to 0)

    int? size

    Optional page size in inbox replier event list pagination (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<PageInboxReplierEvents>

    ApiResponse of PageInboxReplierEvents

    Remarks

    Get inbox ruleset events

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

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

    List inbox repliers

    Declaration
    PageInboxReplierDto GetInboxRepliers(Guid? inboxId = null, 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

    Optional inbox id to get repliers from (optional)

    int? page

    Optional page index in inbox replier list pagination (optional, default to 0)

    int? size

    Optional page size in inbox replier 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
    PageInboxReplierDto

    PageInboxReplierDto

    Remarks

    List all repliers attached to an inbox

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

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

    List inbox repliers

    Declaration
    ApiResponse<PageInboxReplierDto> GetInboxRepliersWithHttpInfo(Guid? inboxId = null, 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

    Optional inbox id to get repliers from (optional)

    int? page

    Optional page index in inbox replier list pagination (optional, default to 0)

    int? size

    Optional page size in inbox replier 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<PageInboxReplierDto>

    ApiResponse of PageInboxReplierDto

    Remarks

    List all repliers attached to an inbox

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetInboxReplierWithHttpInfo(Guid, int)

    Get an inbox replier

    Declaration
    ApiResponse<InboxReplierDto> GetInboxReplierWithHttpInfo(Guid id, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid id

    ID of inbox replier

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<InboxReplierDto>

    ApiResponse of InboxReplierDto

    Remarks

    Get inbox ruleset

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    UpdateInboxReplier(Guid, UpdateInboxReplierOptions, int)

    Update an inbox replier

    Declaration
    InboxReplierDto UpdateInboxReplier(Guid id, UpdateInboxReplierOptions updateInboxReplierOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid id

    ID of inbox replier

    UpdateInboxReplierOptions updateInboxReplierOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    InboxReplierDto

    InboxReplierDto

    Remarks

    Update inbox ruleset

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    UpdateInboxReplierWithHttpInfo(Guid, UpdateInboxReplierOptions, int)

    Update an inbox replier

    Declaration
    ApiResponse<InboxReplierDto> UpdateInboxReplierWithHttpInfo(Guid id, UpdateInboxReplierOptions updateInboxReplierOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid id

    ID of inbox replier

    UpdateInboxReplierOptions updateInboxReplierOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<InboxReplierDto>

    ApiResponse of InboxReplierDto

    Remarks

    Update inbox ruleset

    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.