Skip to content

\InboxForwarderControllerApi

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

Method HTTP request Description
create_new_inbox_forwarder post /forwarders Create an inbox forwarder
delete_inbox_forwarder delete /forwarders/{id} Delete an inbox forwarder
delete_inbox_forwarders delete /forwarders Delete inbox forwarders
get_inbox_forwarder get /forwarders/{id} Get an inbox forwarder
get_inbox_forwarders get /forwarders List inbox forwarders
test_inbox_forwarder post /forwarders/{id}/test Test an inbox forwarder
test_inbox_forwarders_for_inbox put /forwarders Test inbox forwarders for inbox
test_new_inbox_forwarder patch /forwarders Test new inbox forwarder

create_new_inbox_forwarder

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

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

Parameters

Name Type Description Required Notes
inbox_id String Inbox id to attach forwarder to [required]
create_inbox_forwarder_options CreateInboxForwarderOptions [required]

Return type

crate::models::InboxForwarderDto

Authorization

API_KEY

HTTP request headers

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

[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

Name Type Description Required Notes
id String ID 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

Name Type Description Required Notes
inbox_id Option<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

Name Type Description Required Notes
id String ID of inbox forwarder [required]

Return type

crate::models::InboxForwarderDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_inbox_forwarders

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

List all forwarders attached to an inbox

Parameters

Name Type Description Required Notes
inbox_id Option<String> Optional inbox id to get forwarders from
page Option<i32> Optional page in inbox forwarder list pagination [default to 0]
size Option<i32> Optional page size in inbox forwarder list pagination [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
search_filter Option<String> Optional search filter
since Option<String> Filter by created at after the given timestamp
before Option<String> Filter by created at before the given timestamp

Return type

crate::models::PageInboxForwarderDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[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

Name Type Description Required Notes
id String ID of inbox forwarder [required]
inbox_forwarder_test_options InboxForwarderTestOptions [required]

Return type

crate::models::InboxForwarderTestResult

Authorization

API_KEY

HTTP request headers

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

[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

Name Type Description Required Notes
inbox_id String ID of inbox [required]
inbox_forwarder_test_options InboxForwarderTestOptions [required]

Return type

crate::models::InboxForwarderTestResult

Authorization

API_KEY

HTTP request headers

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

[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

Name Type Description Required Notes
test_new_inbox_forwarder_options TestNewInboxForwarderOptions [required]

Return type

crate::models::InboxForwarderTestResult

Authorization

API_KEY

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to ]