Search Results for

    Show / Hide Table of Contents

    Interface IInboxRulesetControllerApiSync

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

    Methods

    View Source

    CreateNewInboxRuleset(CreateInboxRulesetOptions, Guid?, int)

    Create an inbox ruleset

    Declaration
    InboxRulesetDto CreateNewInboxRuleset(CreateInboxRulesetOptions createInboxRulesetOptions, Guid? inboxId = null, int operationIndex = 0)
    Parameters
    Type Name Description
    CreateInboxRulesetOptions createInboxRulesetOptions
    System.Guid? inboxId

    Inbox id to attach ruleset to (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    InboxRulesetDto

    InboxRulesetDto

    Remarks

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

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    CreateNewInboxRulesetWithHttpInfo(CreateInboxRulesetOptions, Guid?, int)

    Create an inbox ruleset

    Declaration
    ApiResponse<InboxRulesetDto> CreateNewInboxRulesetWithHttpInfo(CreateInboxRulesetOptions createInboxRulesetOptions, Guid? inboxId = null, int operationIndex = 0)
    Parameters
    Type Name Description
    CreateInboxRulesetOptions createInboxRulesetOptions
    System.Guid? inboxId

    Inbox id to attach ruleset to (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<InboxRulesetDto>

    ApiResponse of InboxRulesetDto

    Remarks

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

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteInboxRuleset(Guid, int)

    Delete an inbox ruleset

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

    ID of inbox ruleset

    int operationIndex

    Index associated with the operation.

    Remarks

    Delete inbox ruleset

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteInboxRulesets(Guid?, int)

    Delete inbox rulesets

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

    Optional inbox id to attach ruleset to (optional)

    int operationIndex

    Index associated with the operation.

    Remarks

    Delete inbox rulesets. Accepts optional inboxId filter.

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteInboxRulesetsWithHttpInfo(Guid?, int)

    Delete inbox rulesets

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

    Optional inbox id to attach ruleset to (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<object>

    ApiResponse of Object(void)

    Remarks

    Delete inbox rulesets. Accepts optional inboxId filter.

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteInboxRulesetWithHttpInfo(Guid, int)

    Delete an inbox ruleset

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

    ID of inbox ruleset

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<object>

    ApiResponse of Object(void)

    Remarks

    Delete inbox ruleset

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetInboxRuleset(Guid, int)

    Get an inbox ruleset

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

    ID of inbox ruleset

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    InboxRulesetDto

    InboxRulesetDto

    Remarks

    Get inbox ruleset

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

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

    List inbox rulesets

    Declaration
    PageInboxRulesetDto GetInboxRulesets(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid? inboxId

    Optional inbox id to get rulesets from (optional)

    int? page

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

    int? size

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

    string sort

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

    string searchFilter

    Optional search filter (optional)

    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
    PageInboxRulesetDto

    PageInboxRulesetDto

    Remarks

    List all rulesets attached to an inbox

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

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

    List inbox rulesets

    Declaration
    ApiResponse<PageInboxRulesetDto> GetInboxRulesetsWithHttpInfo(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid? inboxId

    Optional inbox id to get rulesets from (optional)

    int? page

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

    int? size

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

    string sort

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

    string searchFilter

    Optional search filter (optional)

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

    ApiResponse of PageInboxRulesetDto

    Remarks

    List all rulesets attached to an inbox

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetInboxRulesetWithHttpInfo(Guid, int)

    Get an inbox ruleset

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

    ID of inbox ruleset

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<InboxRulesetDto>

    ApiResponse of InboxRulesetDto

    Remarks

    Get inbox ruleset

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    TestInboxRuleset(Guid, InboxRulesetTestOptions, int)

    Test an inbox ruleset

    Declaration
    InboxRulesetTestResult TestInboxRuleset(Guid id, InboxRulesetTestOptions inboxRulesetTestOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid id

    ID of inbox ruleset

    InboxRulesetTestOptions inboxRulesetTestOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    InboxRulesetTestResult

    InboxRulesetTestResult

    Remarks

    Test an inbox ruleset

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    TestInboxRulesetReceiving(TestInboxRulesetReceivingOptions, int)

    Test receiving with inbox rulesets

    Declaration
    TestInboxRulesetReceivingResult TestInboxRulesetReceiving(TestInboxRulesetReceivingOptions testInboxRulesetReceivingOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    TestInboxRulesetReceivingOptions testInboxRulesetReceivingOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    TestInboxRulesetReceivingResult

    TestInboxRulesetReceivingResult

    Remarks

    Test whether inbound emails from an email address would be blocked or allowed by inbox rulesets

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    TestInboxRulesetReceivingWithHttpInfo(TestInboxRulesetReceivingOptions, int)

    Test receiving with inbox rulesets

    Declaration
    ApiResponse<TestInboxRulesetReceivingResult> TestInboxRulesetReceivingWithHttpInfo(TestInboxRulesetReceivingOptions testInboxRulesetReceivingOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    TestInboxRulesetReceivingOptions testInboxRulesetReceivingOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<TestInboxRulesetReceivingResult>

    ApiResponse of TestInboxRulesetReceivingResult

    Remarks

    Test whether inbound emails from an email address would be blocked or allowed by inbox rulesets

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    TestInboxRulesetSending(TestInboxRulesetSendingOptions, int)

    Test sending with inbox rulesets

    Declaration
    TestInboxRulesetSendingResult TestInboxRulesetSending(TestInboxRulesetSendingOptions testInboxRulesetSendingOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    TestInboxRulesetSendingOptions testInboxRulesetSendingOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    TestInboxRulesetSendingResult

    TestInboxRulesetSendingResult

    Remarks

    Test whether outbound emails to an email address would be blocked or allowed by inbox rulesets

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    TestInboxRulesetSendingWithHttpInfo(TestInboxRulesetSendingOptions, int)

    Test sending with inbox rulesets

    Declaration
    ApiResponse<TestInboxRulesetSendingResult> TestInboxRulesetSendingWithHttpInfo(TestInboxRulesetSendingOptions testInboxRulesetSendingOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    TestInboxRulesetSendingOptions testInboxRulesetSendingOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<TestInboxRulesetSendingResult>

    ApiResponse of TestInboxRulesetSendingResult

    Remarks

    Test whether outbound emails to an email address would be blocked or allowed by inbox rulesets

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    TestInboxRulesetsForInbox(Guid, InboxRulesetTestOptions, int)

    Test inbox rulesets for inbox

    Declaration
    InboxRulesetTestResult TestInboxRulesetsForInbox(Guid inboxId, InboxRulesetTestOptions inboxRulesetTestOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid inboxId

    ID of inbox

    InboxRulesetTestOptions inboxRulesetTestOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    InboxRulesetTestResult

    InboxRulesetTestResult

    Remarks

    Test inbox rulesets for inbox

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    TestInboxRulesetsForInboxWithHttpInfo(Guid, InboxRulesetTestOptions, int)

    Test inbox rulesets for inbox

    Declaration
    ApiResponse<InboxRulesetTestResult> TestInboxRulesetsForInboxWithHttpInfo(Guid inboxId, InboxRulesetTestOptions inboxRulesetTestOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid inboxId

    ID of inbox

    InboxRulesetTestOptions inboxRulesetTestOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<InboxRulesetTestResult>

    ApiResponse of InboxRulesetTestResult

    Remarks

    Test inbox rulesets for inbox

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    TestInboxRulesetWithHttpInfo(Guid, InboxRulesetTestOptions, int)

    Test an inbox ruleset

    Declaration
    ApiResponse<InboxRulesetTestResult> TestInboxRulesetWithHttpInfo(Guid id, InboxRulesetTestOptions inboxRulesetTestOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid id

    ID of inbox ruleset

    InboxRulesetTestOptions inboxRulesetTestOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<InboxRulesetTestResult>

    ApiResponse of InboxRulesetTestResult

    Remarks

    Test an inbox ruleset

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    TestNewInboxRuleset(TestNewInboxRulesetOptions, int)

    Test new inbox ruleset

    Declaration
    InboxRulesetTestResult TestNewInboxRuleset(TestNewInboxRulesetOptions testNewInboxRulesetOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    TestNewInboxRulesetOptions testNewInboxRulesetOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    InboxRulesetTestResult

    InboxRulesetTestResult

    Remarks

    Test new inbox ruleset

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    TestNewInboxRulesetWithHttpInfo(TestNewInboxRulesetOptions, int)

    Test new inbox ruleset

    Declaration
    ApiResponse<InboxRulesetTestResult> TestNewInboxRulesetWithHttpInfo(TestNewInboxRulesetOptions testNewInboxRulesetOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    TestNewInboxRulesetOptions testNewInboxRulesetOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<InboxRulesetTestResult>

    ApiResponse of InboxRulesetTestResult

    Remarks

    Test new 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.