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

MethodHTTP requestDescription
createNewInboxForwarderPOST /forwardersCreate an inbox forwarder
deleteInboxForwarderDELETE /forwarders/{id}Delete an inbox forwarder
deleteInboxForwardersDELETE /forwardersDelete inbox forwarders
getInboxForwarderGET /forwarders/{id}Get an inbox forwarder
getInboxForwardersGET /forwardersList inbox forwarders
testInboxForwarderPOST /forwarders/{id}/testTest an inbox forwarder
testInboxForwardersForInboxPUT /forwardersTest inbox forwarders for inbox
testNewInboxForwarderPATCH /forwardersTest new inbox forwarder

InboxForwarderDto createNewInboxForwarder(inboxId, CreateInboxForwarderOptions)

Create an inbox forwarder

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

Parameters

NameTypeDescriptionNotes
inboxIdUUIDInbox id to attach forwarder to[default to null]
CreateInboxForwarderOptionsCreateInboxForwarderOptions

Return type

InboxForwarderDto

Authorization

API_KEY

HTTP request headers

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

deleteInboxForwarder(id)

Delete an inbox forwarder

Delete inbox forwarder

Parameters

NameTypeDescriptionNotes
idUUIDID of inbox forwarder[default to null]

Return type

null (empty response body)

Authorization

API_KEY

HTTP request headers

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

deleteInboxForwarders(inboxId)

Delete inbox forwarders

Delete inbox forwarders. Accepts optional inboxId filter.

Parameters

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

Return type

null (empty response body)

Authorization

API_KEY

HTTP request headers

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

InboxForwarderDto getInboxForwarder(id)

Get an inbox forwarder

Get inbox ruleset

Parameters

NameTypeDescriptionNotes
idUUIDID of inbox forwarder[default to null]

Return type

InboxForwarderDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

PageInboxForwarderDto getInboxForwarders(inboxId, page, size, sort, searchFilter, since, before)

List inbox forwarders

List all forwarders attached to an inbox

Parameters

NameTypeDescriptionNotes
inboxIdUUIDOptional inbox id to get forwarders from[optional] [default to null]
pageIntegerOptional page in inbox forwarder list pagination[optional] [default to 0]
sizeIntegerOptional page size in inbox forwarder 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

PageInboxForwarderDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

InboxForwarderTestResult testInboxForwarder(id, InboxForwarderTestOptions)

Test an inbox forwarder

Test an inbox forwarder

Parameters

NameTypeDescriptionNotes
idUUIDID of inbox forwarder[default to null]
InboxForwarderTestOptionsInboxForwarderTestOptions

Return type

InboxForwarderTestResult

Authorization

API_KEY

HTTP request headers

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

InboxForwarderTestResult testInboxForwardersForInbox(inboxId, InboxForwarderTestOptions)

Test inbox forwarders for inbox

Test inbox forwarders for inbox

Parameters

NameTypeDescriptionNotes
inboxIdUUIDID of inbox[default to null]
InboxForwarderTestOptionsInboxForwarderTestOptions

Return type

InboxForwarderTestResult

Authorization

API_KEY

HTTP request headers

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

InboxForwarderTestResult testNewInboxForwarder(TestNewInboxForwarderOptions)

Test new inbox forwarder

Test new inbox forwarder

Parameters

NameTypeDescriptionNotes
TestNewInboxForwarderOptionsTestNewInboxForwarderOptions

Return type

InboxForwarderTestResult

Authorization

API_KEY

HTTP request headers

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