MailSlurpInboxForwarderControllerApi

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

CreateNewInboxForwarder

InboxForwarderDto CreateNewInboxForwarder(ctx, createInboxForwarderOptions, optional)

Create an inbox forwarder

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.
createInboxForwarderOptionsCreateInboxForwarderOptionscreateInboxForwarderOptions
optional*CreateNewInboxForwarderOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreateNewInboxForwarderOpts struct

NameTypeDescriptionNotes

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

Return type

InboxForwarderDto

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 ]

DeleteInboxForwarder

DeleteInboxForwarder(ctx, id)

Delete an inbox forwarder

Delete inbox forwarder

Required Parameters

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

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 ]

DeleteInboxForwarders

DeleteInboxForwarders(ctx, optional)

Delete inbox forwarders

Delete inbox forwarders. Accepts optional inboxId filter.

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a DeleteInboxForwardersOpts struct

NameTypeDescriptionNotes
inboxIdoptional.Interface of stringOptional inbox id to attach forwarder 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 ]

GetInboxForwarder

InboxForwarderDto GetInboxForwarder(ctx, id)

Get an inbox forwarder

Get inbox ruleset

Required Parameters

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

Return type

InboxForwarderDto

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 ]

GetInboxForwarders

PageInboxForwarderDto GetInboxForwarders(ctx, optional)

List inbox forwarders

List all forwarders attached to an inbox

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetInboxForwardersOpts struct

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

Return type

PageInboxForwarderDto

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 ]

TestInboxForwarder

InboxForwarderTestResult TestInboxForwarder(ctx, id, inboxForwarderTestOptions)

Test an inbox forwarder

Test an inbox forwarder

Required Parameters

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

Return type

InboxForwarderTestResult

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 ]

TestInboxForwardersForInbox

InboxForwarderTestResult TestInboxForwardersForInbox(ctx, inboxId, inboxForwarderTestOptions)

Test inbox forwarders for inbox

Test inbox forwarders for inbox

Required Parameters

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

Return type

InboxForwarderTestResult

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 ]

TestNewInboxForwarder

InboxForwarderTestResult TestNewInboxForwarder(ctx, testNewInboxForwarderOptions)

Test new inbox forwarder

Test new inbox forwarder

Required Parameters

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

Return type

InboxForwarderTestResult

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 ]