InboxForwarderControllerAPI

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

    open class func createNewInboxForwarder( createInboxForwarderOptions: CreateInboxForwarderOptions,  inboxId: UUID? = nil) -> Promise<InboxForwarderDto>

Create an inbox forwarder

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let createInboxForwarderOptions = CreateInboxForwarderOptions(field: "field_example", match: "match_example", forwardToRecipients: ["forwardToRecipients_example"]) // CreateInboxForwarderOptions | createInboxForwarderOptions
let inboxId = 987 // UUID | Inbox id to attach forwarder to (optional)

// Create an inbox forwarder
InboxForwarderControllerAPI.createNewInboxForwarder(createInboxForwarderOptions: createInboxForwarderOptions, inboxId: inboxId).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
createInboxForwarderOptionsCreateInboxForwarderOptionscreateInboxForwarderOptions
inboxIdUUIDInbox id to attach forwarder to[optional]

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

    open class func deleteInboxForwarder( _id: UUID) -> Promise<Void>

Delete an inbox forwarder

Delete inbox forwarder

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let _id = 987 // UUID | ID of inbox forwarder

// Delete an inbox forwarder
InboxForwarderControllerAPI.deleteInboxForwarder(_id: _id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
_idUUIDID of inbox forwarder

Return type

Void (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

    open class func deleteInboxForwarders( inboxId: UUID? = nil) -> Promise<Void>

Delete inbox forwarders

Delete inbox forwarders. Accepts optional inboxId filter.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let inboxId = 987 // UUID | Optional inbox id to attach forwarder to (optional)

// Delete inbox forwarders
InboxForwarderControllerAPI.deleteInboxForwarders(inboxId: inboxId).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
inboxIdUUIDOptional inbox id to attach forwarder to[optional]

Return type

Void (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

    open class func getInboxForwarder( _id: UUID) -> Promise<InboxForwarderDto>

Get an inbox forwarder

Get inbox ruleset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let _id = 987 // UUID | ID of inbox forwarder

// Get an inbox forwarder
InboxForwarderControllerAPI.getInboxForwarder(_id: _id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
_idUUIDID 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

    open class func getInboxForwarders( inboxId: UUID? = nil,  page: Int? = nil,  searchFilter: String? = nil,  size: Int? = nil,  sort: Sort_getInboxForwarders? = nil) -> Promise<PageInboxForwarderDto>

List inbox forwarders

List all forwarders attached to an inbox

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let inboxId = 987 // UUID | Optional inbox id to get forwarders from (optional)
let page = 987 // Int | Optional page  in inbox forwarder list pagination (optional) (default to 0)
let searchFilter = "searchFilter_example" // String | Optional search filter (optional)
let size = 987 // Int | Optional page size in inbox forwarder list pagination (optional) (default to 20)
let sort = "sort_example" // String | Optional createdAt sort direction ASC or DESC (optional) (default to .asc)

// List inbox forwarders
InboxForwarderControllerAPI.getInboxForwarders(inboxId: inboxId, page: page, searchFilter: searchFilter, size: size, sort: sort).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
inboxIdUUIDOptional inbox id to get forwarders from[optional]
pageIntOptional page in inbox forwarder list pagination[optional] [default to 0]
searchFilterStringOptional search filter[optional]
sizeIntOptional page size in inbox forwarder list pagination[optional] [default to 20]
sortStringOptional createdAt sort direction ASC or DESC[optional] [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

    open class func testInboxForwarder( _id: UUID,  inboxForwarderTestOptions: InboxForwarderTestOptions) -> Promise<InboxForwarderTestResult>

Test an inbox forwarder

Test an inbox forwarder

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let _id = 987 // UUID | ID of inbox forwarder
let inboxForwarderTestOptions = InboxForwarderTestOptions(testValue: "testValue_example") // InboxForwarderTestOptions | inboxForwarderTestOptions

// Test an inbox forwarder
InboxForwarderControllerAPI.testInboxForwarder(_id: _id, inboxForwarderTestOptions: inboxForwarderTestOptions).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
_idUUIDID 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

    open class func testInboxForwardersForInbox( inboxId: UUID,  inboxForwarderTestOptions: InboxForwarderTestOptions) -> Promise<InboxForwarderTestResult>

Test inbox forwarders for inbox

Test inbox forwarders for inbox

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let inboxId = 987 // UUID | ID of inbox
let inboxForwarderTestOptions = InboxForwarderTestOptions(testValue: "testValue_example") // InboxForwarderTestOptions | inboxForwarderTestOptions

// Test inbox forwarders for inbox
InboxForwarderControllerAPI.testInboxForwardersForInbox(inboxId: inboxId, inboxForwarderTestOptions: inboxForwarderTestOptions).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
inboxIdUUIDID 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

    open class func testNewInboxForwarder( testNewInboxForwarderOptions: TestNewInboxForwarderOptions) -> Promise<InboxForwarderTestResult>

Test new inbox forwarder

Test new inbox forwarder

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let testNewInboxForwarderOptions = TestNewInboxForwarderOptions(inboxForwarderTestOptions: InboxForwarderTestOptions(testValue: "testValue_example"), createInboxForwarderOptions: CreateInboxForwarderOptions(field: "field_example", match: "match_example", forwardToRecipients: ["forwardToRecipients_example"])) // TestNewInboxForwarderOptions | testNewInboxForwarderOptions

// Test new inbox forwarder
InboxForwarderControllerAPI.testNewInboxForwarder(testNewInboxForwarderOptions: testNewInboxForwarderOptions).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
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 ]