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

InboxRulesetDto createNewInboxRuleset(inboxId, CreateInboxRulesetOptions)

Create an inbox ruleset

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

Parameters

NameTypeDescriptionNotes
inboxIdUUIDInbox id to attach ruleset to[default to null]
CreateInboxRulesetOptionsCreateInboxRulesetOptions

Return type

InboxRulesetDto

Authorization

API_KEY

HTTP request headers

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

deleteInboxRuleset(id)

Delete an inbox ruleset

Delete inbox ruleset

Parameters

NameTypeDescriptionNotes
idUUIDID of inbox ruleset[default to null]

Return type

null (empty response body)

Authorization

API_KEY

HTTP request headers

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

deleteInboxRulesets(inboxId)

Delete inbox rulesets

Delete inbox rulesets. Accepts optional inboxId filter.

Parameters

NameTypeDescriptionNotes
inboxIdUUIDOptional inbox id to attach ruleset to[optional] [default to null]

Return type

null (empty response body)

Authorization

API_KEY

HTTP request headers

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

InboxRulesetDto getInboxRuleset(id)

Get an inbox ruleset

Get inbox ruleset

Parameters

NameTypeDescriptionNotes
idUUIDID of inbox ruleset[default to null]

Return type

InboxRulesetDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

PageInboxRulesetDto getInboxRulesets(inboxId, page, size, sort, searchFilter, since, before)

List inbox rulesets

List all rulesets attached to an inbox

Parameters

NameTypeDescriptionNotes
inboxIdUUIDOptional inbox id to get rulesets from[optional] [default to null]
pageIntegerOptional page in inbox ruleset list pagination[optional] [default to 0]
sizeIntegerOptional page size in inbox ruleset list pagination[optional] [default to 20]
sortStringOptional createdAt sort direction ASC or DESC[optional] [default to ASC] [enum: ASC, DESC]
searchFilterStringOptional search filter[optional] [default to null]
sinceDateFilter by created at after the given timestamp[optional] [default to null]
beforeDateFilter by created at before the given timestamp[optional] [default to null]

Return type

PageInboxRulesetDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

InboxRulesetTestResult testInboxRuleset(id, InboxRulesetTestOptions)

Test an inbox ruleset

Test an inbox ruleset

Parameters

NameTypeDescriptionNotes
idUUIDID of inbox ruleset[default to null]
InboxRulesetTestOptionsInboxRulesetTestOptions

Return type

InboxRulesetTestResult

Authorization

API_KEY

HTTP request headers

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

InboxRulesetTestResult testInboxRulesetsForInbox(inboxId, InboxRulesetTestOptions)

Test inbox rulesets for inbox

Test inbox rulesets for inbox

Parameters

NameTypeDescriptionNotes
inboxIdUUIDID of inbox[default to null]
InboxRulesetTestOptionsInboxRulesetTestOptions

Return type

InboxRulesetTestResult

Authorization

API_KEY

HTTP request headers

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

InboxRulesetTestResult testNewInboxRuleset(TestNewInboxRulesetOptions)

Test new inbox ruleset

Test new inbox ruleset

Parameters

NameTypeDescriptionNotes
TestNewInboxRulesetOptionsTestNewInboxRulesetOptions

Return type

InboxRulesetTestResult

Authorization

API_KEY

HTTP request headers

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