MailSlurpAPI.Api.InboxRulesetController (mailslurp v15.4.1)
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 an inbox ruleset Test an inbox ruleset
Test inbox rulesets for inbox Test inbox rulesets for inbox
Test new inbox ruleset Test new inbox ruleset
Link to this section Functions
create_new_inbox_ruleset(connection, inbox_id, create_inbox_ruleset_options, opts \\ [])
Specs
create_new_inbox_ruleset( Tesla.Env.client(), String.t(), MailSlurpAPI.Model.CreateInboxRulesetOptions.t(), keyword() ) :: {:ok, MailSlurpAPI.Model.InboxRulesetDto.t()} | {:error, Tesla.Env.t()}
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
- inbox_id (String.t): Inbox id to attach ruleset to
- create_inbox_ruleset_options (CreateInboxRulesetOptions):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
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
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
} on success {:error, info} on failure
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
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
- :size (integer()): Optional page size in inbox ruleset list pagination
- :sort (String.t): Optional createdAt sort direction ASC or DESC
- :search_filter (String.t): Optional search filter
- :since (DateTime.t): Filter by created at after the given timestamp
- :before (DateTime.t): Filter by created at before the given timestamp
Returns
} on success {:error, info} on failure
test_inbox_ruleset(connection, id, inbox_ruleset_test_options, opts \\ [])
Specs
test_inbox_ruleset( Tesla.Env.client(), String.t(), MailSlurpAPI.Model.InboxRulesetTestOptions.t(), keyword() ) :: {:ok, MailSlurpAPI.Model.InboxRulesetTestResult.t()} | {:error, Tesla.Env.t()}
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):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
test_inbox_rulesets_for_inbox(connection, inbox_id, inbox_ruleset_test_options, opts \\ [])
Specs
test_inbox_rulesets_for_inbox( Tesla.Env.client(), String.t(), MailSlurpAPI.Model.InboxRulesetTestOptions.t(), keyword() ) :: {:ok, MailSlurpAPI.Model.InboxRulesetTestResult.t()} | {:error, Tesla.Env.t()}
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):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
test_new_inbox_ruleset(connection, test_new_inbox_ruleset_options, opts \\ [])
Specs
test_new_inbox_ruleset( Tesla.Env.client(), MailSlurpAPI.Model.TestNewInboxRulesetOptions.t(), keyword() ) :: {:ok, MailSlurpAPI.Model.InboxRulesetTestResult.t()} | {:error, Tesla.Env.t()}
Test new inbox ruleset Test new inbox ruleset
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- test_new_inbox_ruleset_options (TestNewInboxRulesetOptions):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure