MailSlurp\InboxRulesetControllerApi
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
CreateNewInboxRuleset | Post /rulesets | Create an inbox ruleset |
DeleteInboxRuleset | Delete /rulesets/{id} | Delete an inbox ruleset |
DeleteInboxRulesets | Delete /rulesets | Delete inbox rulesets |
GetInboxRuleset | Get /rulesets/{id} | Get an inbox ruleset |
GetInboxRulesets | Get /rulesets | List inbox rulesets |
TestInboxRuleset | Post /rulesets/{id}/test | Test an inbox ruleset |
TestInboxRulesetsForInbox | Put /rulesets | Test inbox rulesets for inbox |
TestNewInboxRuleset | Patch /rulesets | Test new inbox ruleset |
CreateNewInboxRuleset
InboxRulesetDto CreateNewInboxRuleset(ctx, inboxId, createInboxRulesetOptions)
Create an inbox ruleset
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
inboxId | string | Inbox id to attach ruleset to | |
createInboxRulesetOptions | CreateInboxRulesetOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
DeleteInboxRuleset
DeleteInboxRuleset(ctx, id)
Delete an inbox ruleset
Delete inbox ruleset
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | ID of inbox ruleset |
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 ]
DeleteInboxRulesets
DeleteInboxRulesets(ctx, optional)
Delete inbox rulesets
Delete inbox rulesets. Accepts optional inboxId filter.
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
optional | *DeleteInboxRulesetsOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a DeleteInboxRulesetsOpts struct
Name | Type | Description | Notes |
---|---|---|---|
inboxId | optional.Interface of 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 ]
GetInboxRuleset
InboxRulesetDto GetInboxRuleset(ctx, id)
Get an inbox ruleset
Get inbox ruleset
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | ID of inbox ruleset |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
GetInboxRulesets
PageInboxRulesetDto GetInboxRulesets(ctx, optional)
List inbox rulesets
List all rulesets attached to an inbox
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
optional | *GetInboxRulesetsOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a GetInboxRulesetsOpts struct
Name | Type | Description | Notes |
---|---|---|---|
inboxId | optional.Interface of string | Optional inbox id to get rulesets from | |
page | optional.Int32 | Optional page in inbox ruleset list pagination | [default to 0] |
size | optional.Int32 | Optional page size in inbox ruleset list pagination | [default to 20] |
sort | optional.String | Optional createdAt sort direction ASC or DESC | [default to ASC] |
searchFilter | optional.String | Optional search filter | |
since | optional.Time | Filter by created at after the given timestamp | |
before | optional.Time | Filter by created at before the given timestamp |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
TestInboxRuleset
InboxRulesetTestResult TestInboxRuleset(ctx, id, inboxRulesetTestOptions)
Test an inbox ruleset
Test an inbox ruleset
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | ID of inbox ruleset | |
inboxRulesetTestOptions | InboxRulesetTestOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
TestInboxRulesetsForInbox
InboxRulesetTestResult TestInboxRulesetsForInbox(ctx, inboxId, inboxRulesetTestOptions)
Test inbox rulesets for inbox
Test inbox rulesets for inbox
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
inboxId | string | ID of inbox | |
inboxRulesetTestOptions | InboxRulesetTestOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
TestNewInboxRuleset
InboxRulesetTestResult TestNewInboxRuleset(ctx, testNewInboxRulesetOptions)
Test new inbox ruleset
Test new inbox ruleset
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
testNewInboxRulesetOptions | TestNewInboxRulesetOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]