\InboxRulesetControllerApi
All URIs are relative to https://api.mailslurp.com
| Method | HTTP request | Description |
|---|---|---|
| create_new_inbox_ruleset | post /rulesets | Create an inbox ruleset |
| delete_inbox_ruleset | delete /rulesets/{id} | Delete an inbox ruleset |
| delete_inbox_rulesets | delete /rulesets | Delete inbox rulesets |
| get_inbox_ruleset | get /rulesets/{id} | Get an inbox ruleset |
| get_inbox_rulesets | get /rulesets | List inbox rulesets |
| test_inbox_ruleset | post /rulesets/{id}/test | Test an inbox ruleset |
| test_inbox_rulesets_for_inbox | put /rulesets | Test inbox rulesets for inbox |
| test_new_inbox_ruleset | patch /rulesets | Test new inbox ruleset |
create_new_inbox_ruleset
crate::models::InboxRulesetDto create_new_inbox_ruleset(inbox_id, create_inbox_ruleset_options) Create an inbox ruleset
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| inbox_id | String | Inbox id to attach ruleset to | [required] | |
| create_inbox_ruleset_options | CreateInboxRulesetOptions | [required] |
Return type
crate::models::InboxRulesetDto
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[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
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | String | ID of inbox ruleset | [required] |
Return type
(empty response body)
Authorization
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
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| inbox_id | Option<String> | Optional inbox id to attach ruleset to |
Return type
(empty response body)
Authorization
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
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | String | ID of inbox ruleset | [required] |
Return type
crate::models::InboxRulesetDto
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
get_inbox_rulesets
crate::models::PageInboxRulesetDto get_inbox_rulesets(inbox_id, page, size, sort, search_filter, since, before) List inbox rulesets
List all rulesets attached to an inbox
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| inbox_id | Option<String> | Optional inbox id to get rulesets from | ||
| page | Option<i32> | Optional page in inbox ruleset list pagination | [default to 0] | |
| size | Option<i32> | Optional page size in inbox ruleset list pagination | [default to 20] | |
| sort | Option<String> | Optional createdAt sort direction ASC or DESC | [default to ASC] | |
| search_filter | Option<String> | Optional search filter | ||
| since | Option<String> | Filter by created at after the given timestamp | ||
| before | Option<String> | Filter by created at before the given timestamp |
Return type
crate::models::PageInboxRulesetDto
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[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
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | String | ID of inbox ruleset | [required] | |
| inbox_ruleset_test_options | InboxRulesetTestOptions | [required] |
Return type
crate::models::InboxRulesetTestResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[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
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| inbox_id | String | ID of inbox | [required] | |
| inbox_ruleset_test_options | InboxRulesetTestOptions | [required] |
Return type
crate::models::InboxRulesetTestResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[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
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| test_new_inbox_ruleset_options | TestNewInboxRulesetOptions | [required] |
Return type
crate::models::InboxRulesetTestResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]