MailSlurp\InboxForwarderControllerApi
All URIs are relative to https://golang.api.mailslurp.com
| Method | HTTP request | Description |
|---|---|---|
| CreateNewInboxForwarder | Post /forwarders | Create an inbox forwarder |
| DeleteInboxForwarder | Delete /forwarders/{id} | Delete an inbox forwarder |
| DeleteInboxForwarders | Delete /forwarders | Delete inbox forwarders |
| GetInboxForwarder | Get /forwarders/{id} | Get an inbox forwarder |
| GetInboxForwarderEvents | Get /forwarders/{id}/events | Get an inbox forwarder event list |
| GetInboxForwarders | Get /forwarders | List inbox forwarders |
| TestInboxForwarder | Post /forwarders/{id}/test | Test an inbox forwarder |
| TestInboxForwardersForInbox | Put /forwarders | Test inbox forwarders for inbox |
| TestNewInboxForwarder | Patch /forwarders | Test new inbox forwarder |
| UpdateInboxForwarder | Put /forwarders/{id} | Update an inbox forwarder |
CreateNewInboxForwarder
InboxForwarderDto CreateNewInboxForwarder(ctx, inboxId, createInboxForwarderOptions)
Create an inbox forwarder
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| inboxId | string | Inbox id to attach forwarder to | |
| createInboxForwarderOptions | CreateInboxForwarderOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[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
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID of inbox forwarder |
Return type
(empty response body)
Authorization
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
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *DeleteInboxForwardersOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a DeleteInboxForwardersOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| inboxId | optional.Interface of string | Optional inbox id to attach forwarder to |
Return type
(empty response body)
Authorization
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
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID of inbox forwarder |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
GetInboxForwarderEvents
PageInboxForwarderEvents GetInboxForwarderEvents(ctx, id, optional)
Get an inbox forwarder event list
Get inbox ruleset events
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID of inbox forwarder | |
| optional | *GetInboxForwarderEventsOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a GetInboxForwarderEventsOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
page | optional.Int32| Optional page in inbox forwarder event list pagination | [default to 0] size | optional.Int32| Optional page size in inbox forwarder event list pagination | [default to 20] sort | optional.String| Optional createdAt sort direction ASC or DESC | [default to ASC]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[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
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetInboxForwardersOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a GetInboxForwardersOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| inboxId | optional.Interface of string | Optional inbox id to get forwarders from | |
| page | optional.Int32 | Optional page in inbox forwarder list pagination | [default to 0] |
| size | optional.Int32 | Optional page size in inbox forwarder list pagination | [default to 20] |
| sort | optional.String | Optional createdAt sort direction ASC or DESC | [default to ASC] |
| searchFilter | optional.String | Optional search filter | |
| since | optional.Time | Filter by created at after the given timestamp | |
| before | optional.Time | Filter by created at before the given timestamp |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[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
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID of inbox forwarder | |
| inboxForwarderTestOptions | InboxForwarderTestOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[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
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| inboxId | string | ID of inbox | |
| inboxForwarderTestOptions | InboxForwarderTestOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[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
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| testNewInboxForwarderOptions | TestNewInboxForwarderOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
UpdateInboxForwarder
InboxForwarderDto UpdateInboxForwarder(ctx, id, createInboxForwarderOptions)
Update an inbox forwarder
Update inbox ruleset
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID of inbox forwarder | |
| createInboxForwarderOptions | CreateInboxForwarderOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]