MailSlurpAPI.Api.InboxRulesetController (mailslurp v12.8.4)

API calls for all endpoints tagged InboxRulesetController.

Link to this section Summary

Functions

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

Delete an inbox ruleset Delete inbox ruleset

Delete inbox rulesets Delete inbox rulesets. Accepts optional inboxId filter.

Get an inbox ruleset Get inbox ruleset

List inbox rulesets List all rulesets attached to an inbox

Test inbox rulesets for inbox Test inbox rulesets for inbox

Link to this section Functions

Link to this function

create_new_inbox_ruleset(connection, create_inbox_ruleset_options, opts \\ [])

Specs

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

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • create_inbox_ruleset_options (CreateInboxRulesetOptions): createInboxRulesetOptions
  • opts (KeywordList): [optional] Optional parameters
    • :inbox_id (String.t): Inbox id to attach ruleset to

      Returns

} on success {:error, info} on failure

Link to this function

delete_inbox_ruleset(connection, id, opts \\ [])

Specs

delete_inbox_ruleset(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Delete an inbox ruleset Delete inbox ruleset

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • id (String.t): ID of inbox ruleset
  • opts (KeywordList): [optional] Optional parameters

    Returns

} on success {:error, info} on failure

Link to this function

delete_inbox_rulesets(connection, opts \\ [])

Specs

delete_inbox_rulesets(Tesla.Env.client(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Delete inbox rulesets Delete inbox rulesets. Accepts optional inboxId filter.

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :inbox_id (String.t): Optional inbox id to attach ruleset to

      Returns

} on success {:error, info} on failure

Link to this function

get_inbox_ruleset(connection, id, opts \\ [])

Specs

get_inbox_ruleset(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, MailSlurpAPI.Model.InboxRulesetDto.t()} | {:error, Tesla.Env.t()}

Get an inbox ruleset Get inbox ruleset

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • id (String.t): ID of inbox ruleset
  • opts (KeywordList): [optional] Optional parameters

    Returns

} on success {:error, info} on failure

Link to this function

get_inbox_rulesets(connection, opts \\ [])

Specs

get_inbox_rulesets(Tesla.Env.client(), keyword()) ::
  {:ok, MailSlurpAPI.Model.PageInboxRulesetDto.t()} | {:error, Tesla.Env.t()}

List inbox rulesets List all rulesets attached to an inbox

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :inbox_id (String.t): Optional inbox id to get rulesets from
    • :page (integer()): Optional page index in inbox ruleset list pagination
    • :search_filter (String.t): Optional search filter
    • :size (integer()): Optional page size in inbox ruleset list pagination
    • :sort (String.t): Optional createdAt sort direction ASC or DESC

      Returns

} on success {:error, info} on failure

Link to this function

test_inbox_ruleset(connection, id, inbox_ruleset_test_options, opts \\ [])

Specs

Test an inbox ruleset Test an inbox ruleset

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • id (String.t): ID of inbox ruleset
  • inbox_ruleset_test_options (InboxRulesetTestOptions): inboxRulesetTestOptions
  • opts (KeywordList): [optional] Optional parameters

    Returns

} on success {:error, info} on failure

Link to this function

test_inbox_rulesets_for_inbox(connection, inbox_id, inbox_ruleset_test_options, opts \\ [])

Specs

Test inbox rulesets for inbox Test inbox rulesets for inbox

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • inbox_id (String.t): ID of inbox
  • inbox_ruleset_test_options (InboxRulesetTestOptions): inboxRulesetTestOptions
  • opts (KeywordList): [optional] Optional parameters

    Returns

} on success {:error, info} on failure

Link to this function

test_new_inbox_ruleset(connection, test_new_inbox_ruleset_options, opts \\ [])

Specs

Test new inbox ruleset Test new inbox ruleset

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • test_new_inbox_ruleset_options (TestNewInboxRulesetOptions): testNewInboxRulesetOptions
  • opts (KeywordList): [optional] Optional parameters

    Returns

} on success {:error, info} on failure