InboxForwarderControllerApi

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

MethodHTTP requestDescription
create_new_inbox_forwarderpost /forwardersCreate an inbox forwarder
delete_inbox_forwarderdelete /forwarders/{id}Delete an inbox forwarder
delete_inbox_forwardersdelete /forwardersDelete inbox forwarders
get_inbox_forwarderget /forwarders/{id}Get an inbox forwarder
get_inbox_forwardersget /forwardersList inbox forwarders
test_inbox_forwarderpost /forwarders/{id}/testTest an inbox forwarder
test_inbox_forwarders_for_inboxput /forwardersTest inbox forwarders for inbox
test_new_inbox_forwarderpatch /forwardersTest new inbox forwarder

create_new_inbox_forwarder

crate::models::InboxForwarderDto create_new_inbox_forwarder(create_inbox_forwarder_options, inbox_id) Create an inbox forwarder

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

Parameters

NameTypeDescriptionRequiredNotes
create_inbox_forwarder_optionsCreateInboxForwarderOptionscreateInboxForwarderOptions[required]
inbox_idOption<String>Inbox id to attach forwarder to

Return type

crate::models::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 ]

delete_inbox_forwarder

delete_inbox_forwarder(id) Delete an inbox forwarder

Delete inbox forwarder

Parameters

NameTypeDescriptionRequiredNotes
idStringID of inbox forwarder[required]

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 ]

delete_inbox_forwarders

delete_inbox_forwarders(inbox_id) Delete inbox forwarders

Delete inbox forwarders. Accepts optional inboxId filter.

Parameters

NameTypeDescriptionRequiredNotes
inbox_idOption<String>Optional 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 ]

get_inbox_forwarder

crate::models::InboxForwarderDto get_inbox_forwarder(id) Get an inbox forwarder

Get inbox ruleset

Parameters

NameTypeDescriptionRequiredNotes
idStringID of inbox forwarder[required]

Return type

crate::models::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 ]

get_inbox_forwarders

crate::models::PageInboxForwarderDto get_inbox_forwarders(before, inbox_id, page, search_filter, since, size, sort) List inbox forwarders

List all forwarders attached to an inbox

Parameters

NameTypeDescriptionRequiredNotes
beforeOption<String>Filter by created at before the given timestamp
inbox_idOption<String>Optional inbox id to get forwarders from
pageOption<i32>Optional page in inbox forwarder list pagination[default to 0]
search_filterOption<String>Optional search filter
sinceOption<String>Filter by created at after the given timestamp
sizeOption<i32>Optional page size in inbox forwarder list pagination[default to 20]
sortOption<String>Optional createdAt sort direction ASC or DESC[default to ASC]

Return type

crate::models::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 ]

test_inbox_forwarder

crate::models::InboxForwarderTestResult test_inbox_forwarder(id, inbox_forwarder_test_options) Test an inbox forwarder

Test an inbox forwarder

Parameters

NameTypeDescriptionRequiredNotes
idStringID of inbox forwarder[required]
inbox_forwarder_test_optionsInboxForwarderTestOptionsinboxForwarderTestOptions[required]

Return type

crate::models::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 ]

test_inbox_forwarders_for_inbox

crate::models::InboxForwarderTestResult test_inbox_forwarders_for_inbox(inbox_id, inbox_forwarder_test_options) Test inbox forwarders for inbox

Test inbox forwarders for inbox

Parameters

NameTypeDescriptionRequiredNotes
inbox_idStringID of inbox[required]
inbox_forwarder_test_optionsInboxForwarderTestOptionsinboxForwarderTestOptions[required]

Return type

crate::models::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 ]

test_new_inbox_forwarder

crate::models::InboxForwarderTestResult test_new_inbox_forwarder(test_new_inbox_forwarder_options) Test new inbox forwarder

Test new inbox forwarder

Parameters

NameTypeDescriptionRequiredNotes
test_new_inbox_forwarder_optionsTestNewInboxForwarderOptionstestNewInboxForwarderOptions[required]

Return type

crate::models::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 ]