MailSlurpInboxRulesetControllerApi

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

MethodHTTP requestDescription
CreateNewInboxRulesetPost /rulesetsCreate an inbox ruleset
DeleteInboxRulesetDelete /rulesets/{id}Delete an inbox ruleset
DeleteInboxRulesetsDelete /rulesetsDelete inbox rulesets
GetInboxRulesetGet /rulesets/{id}Get an inbox ruleset
GetInboxRulesetsGet /rulesetsList inbox rulesets
TestInboxRulesetPost /rulesets/{id}/testTest an inbox ruleset
TestInboxRulesetsForInboxPut /rulesetsTest inbox rulesets for inbox
TestNewInboxRulesetPatch /rulesetsTest new inbox ruleset

CreateNewInboxRuleset

InboxRulesetDto CreateNewInboxRuleset(ctx, createInboxRulesetOptions, optional)

Create an inbox ruleset

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

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
createInboxRulesetOptionsCreateInboxRulesetOptionscreateInboxRulesetOptions
optional*CreateNewInboxRulesetOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreateNewInboxRulesetOpts struct

NameTypeDescriptionNotes

inboxId | optional.Interface of string| Inbox id to attach ruleset to |

Return type

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 ]

DeleteInboxRuleset

DeleteInboxRuleset(ctx, id)

Delete an inbox ruleset

Delete inbox ruleset

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
idstringID of inbox ruleset

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 ]

DeleteInboxRulesets

DeleteInboxRulesets(ctx, optional)

Delete inbox rulesets

Delete inbox rulesets. Accepts optional inboxId filter.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
optional*DeleteInboxRulesetsOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DeleteInboxRulesetsOpts struct

NameTypeDescriptionNotes
inboxIdoptional.Interface of stringOptional 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 ]

GetInboxRuleset

InboxRulesetDto GetInboxRuleset(ctx, id)

Get an inbox ruleset

Get inbox ruleset

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
idstringID of inbox ruleset

Return type

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 ]

GetInboxRulesets

PageInboxRulesetDto GetInboxRulesets(ctx, optional)

List inbox rulesets

List all rulesets attached to an inbox

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
optional*GetInboxRulesetsOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetInboxRulesetsOpts struct

NameTypeDescriptionNotes
beforeoptional.TimeFilter by created at before the given timestamp
inboxIdoptional.Interface of stringOptional inbox id to get rulesets from
pageoptional.Int32Optional page in inbox ruleset list pagination[default to 0]
searchFilteroptional.StringOptional search filter
sinceoptional.TimeFilter by created at after the given timestamp
sizeoptional.Int32Optional page size in inbox ruleset list pagination[default to 20]
sortoptional.StringOptional createdAt sort direction ASC or DESC[default to ASC]

Return type

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 ]

TestInboxRuleset

InboxRulesetTestResult TestInboxRuleset(ctx, id, inboxRulesetTestOptions)

Test an inbox ruleset

Test an inbox ruleset

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
idstringID of inbox ruleset
inboxRulesetTestOptionsInboxRulesetTestOptionsinboxRulesetTestOptions

Return type

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 ]

TestInboxRulesetsForInbox

InboxRulesetTestResult TestInboxRulesetsForInbox(ctx, inboxId, inboxRulesetTestOptions)

Test inbox rulesets for inbox

Test inbox rulesets for inbox

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
inboxIdstringID of inbox
inboxRulesetTestOptionsInboxRulesetTestOptionsinboxRulesetTestOptions

Return type

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 ]

TestNewInboxRuleset

InboxRulesetTestResult TestNewInboxRuleset(ctx, testNewInboxRulesetOptions)

Test new inbox ruleset

Test new inbox ruleset

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
testNewInboxRulesetOptionsTestNewInboxRulesetOptionstestNewInboxRulesetOptions

Return type

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 ]