InboxRulesetControllerApi

All URIs are relative to https://api.mailslurp.com

MethodHTTP requestDescription
create_new_inbox_rulesetpost /rulesetsCreate an inbox ruleset
delete_inbox_rulesetdelete /rulesets/{id}Delete an inbox ruleset
delete_inbox_rulesetsdelete /rulesetsDelete inbox rulesets
get_inbox_rulesetget /rulesets/{id}Get an inbox ruleset
get_inbox_rulesetsget /rulesetsList inbox rulesets
test_inbox_rulesetpost /rulesets/{id}/testTest an inbox ruleset
test_inbox_rulesets_for_inboxput /rulesetsTest inbox rulesets for inbox
test_new_inbox_rulesetpatch /rulesetsTest new inbox ruleset

create_new_inbox_ruleset

crate::models::InboxRulesetDto create_new_inbox_ruleset(create_inbox_ruleset_options, inbox_id) Create an inbox ruleset

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

Parameters

NameTypeDescriptionRequiredNotes
create_inbox_ruleset_optionsCreateInboxRulesetOptionscreateInboxRulesetOptions[required]
inbox_idOption<String>Inbox id to attach ruleset to

Return type

crate::models::InboxRulesetDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

delete_inbox_ruleset

delete_inbox_ruleset(id) Delete an inbox ruleset

Delete inbox ruleset

Parameters

NameTypeDescriptionRequiredNotes
idStringID of inbox ruleset[required]

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

delete_inbox_rulesets

delete_inbox_rulesets(inbox_id) Delete inbox rulesets

Delete inbox rulesets. Accepts optional inboxId filter.

Parameters

NameTypeDescriptionRequiredNotes
inbox_idOption<String>Optional inbox id to attach ruleset to

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_inbox_ruleset

crate::models::InboxRulesetDto get_inbox_ruleset(id) Get an inbox ruleset

Get inbox ruleset

Parameters

NameTypeDescriptionRequiredNotes
idStringID of inbox ruleset[required]

Return type

crate::models::InboxRulesetDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_inbox_rulesets

crate::models::PageInboxRulesetDto get_inbox_rulesets(before, inbox_id, page, search_filter, since, size, sort) List inbox rulesets

List all rulesets attached to an inbox

Parameters

NameTypeDescriptionRequiredNotes
beforeOption<String>Filter by created at before the given timestamp
inbox_idOption<String>Optional inbox id to get rulesets from
pageOption<i32>Optional page in inbox ruleset list pagination[default to 0]
search_filterOption<String>Optional search filter
sinceOption<String>Filter by created at after the given timestamp
sizeOption<i32>Optional page size in inbox ruleset list pagination[default to 20]
sortOption<String>Optional createdAt sort direction ASC or DESC[default to ASC]

Return type

crate::models::PageInboxRulesetDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

test_inbox_ruleset

crate::models::InboxRulesetTestResult test_inbox_ruleset(id, inbox_ruleset_test_options) Test an inbox ruleset

Test an inbox ruleset

Parameters

NameTypeDescriptionRequiredNotes
idStringID of inbox ruleset[required]
inbox_ruleset_test_optionsInboxRulesetTestOptionsinboxRulesetTestOptions[required]

Return type

crate::models::InboxRulesetTestResult

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

test_inbox_rulesets_for_inbox

crate::models::InboxRulesetTestResult test_inbox_rulesets_for_inbox(inbox_id, inbox_ruleset_test_options) Test inbox rulesets for inbox

Test inbox rulesets for inbox

Parameters

NameTypeDescriptionRequiredNotes
inbox_idStringID of inbox[required]
inbox_ruleset_test_optionsInboxRulesetTestOptionsinboxRulesetTestOptions[required]

Return type

crate::models::InboxRulesetTestResult

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

test_new_inbox_ruleset

crate::models::InboxRulesetTestResult test_new_inbox_ruleset(test_new_inbox_ruleset_options) Test new inbox ruleset

Test new inbox ruleset

Parameters

NameTypeDescriptionRequiredNotes
test_new_inbox_ruleset_optionsTestNewInboxRulesetOptionstestNewInboxRulesetOptions[required]

Return type

crate::models::InboxRulesetTestResult

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]