Skip to content

InboxForwarderControllerApi

All URIs are relative to https://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
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

InboxForwarderDto createNewInboxForwarder(inboxId, createInboxForwarderOptions)

Create an inbox forwarder

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

Example

// Import classes:
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*

val apiInstance = InboxForwarderControllerApi()
val inboxId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | Inbox id to attach forwarder to
val createInboxForwarderOptions : CreateInboxForwarderOptions =  // CreateInboxForwarderOptions | 
try {
    val result : InboxForwarderDto = apiInstance.createNewInboxForwarder(inboxId, createInboxForwarderOptions)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling InboxForwarderControllerApi#createNewInboxForwarder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling InboxForwarderControllerApi#createNewInboxForwarder")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
inboxId java.util.UUID Inbox id to attach forwarder to
createInboxForwarderOptions CreateInboxForwarderOptions

Return type

InboxForwarderDto

Authorization

Configure API_KEY: ApiClient.apiKey["x-api-key"] = "" ApiClient.apiKeyPrefix["x-api-key"] = ""

HTTP request headers

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

deleteInboxForwarder(id)

Delete an inbox forwarder

Delete inbox forwarder

Example

// Import classes:
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*

val apiInstance = InboxForwarderControllerApi()
val id : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | ID of inbox forwarder
try {
    apiInstance.deleteInboxForwarder(id)
} catch (e: ClientException) {
    println("4xx response calling InboxForwarderControllerApi#deleteInboxForwarder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling InboxForwarderControllerApi#deleteInboxForwarder")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.util.UUID ID of inbox forwarder

Return type

null (empty response body)

Authorization

Configure API_KEY: ApiClient.apiKey["x-api-key"] = "" ApiClient.apiKeyPrefix["x-api-key"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

deleteInboxForwarders(inboxId)

Delete inbox forwarders

Delete inbox forwarders. Accepts optional inboxId filter.

Example

// Import classes:
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*

val apiInstance = InboxForwarderControllerApi()
val inboxId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | Optional inbox id to attach forwarder to
try {
    apiInstance.deleteInboxForwarders(inboxId)
} catch (e: ClientException) {
    println("4xx response calling InboxForwarderControllerApi#deleteInboxForwarders")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling InboxForwarderControllerApi#deleteInboxForwarders")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
inboxId java.util.UUID Optional inbox id to attach forwarder to [optional]

Return type

null (empty response body)

Authorization

Configure API_KEY: ApiClient.apiKey["x-api-key"] = "" ApiClient.apiKeyPrefix["x-api-key"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

InboxForwarderDto getInboxForwarder(id)

Get an inbox forwarder

Get inbox ruleset

Example

// Import classes:
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*

val apiInstance = InboxForwarderControllerApi()
val id : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | ID of inbox forwarder
try {
    val result : InboxForwarderDto = apiInstance.getInboxForwarder(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling InboxForwarderControllerApi#getInboxForwarder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling InboxForwarderControllerApi#getInboxForwarder")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.util.UUID ID of inbox forwarder

Return type

InboxForwarderDto

Authorization

Configure API_KEY: ApiClient.apiKey["x-api-key"] = "" ApiClient.apiKeyPrefix["x-api-key"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

PageInboxForwarderDto getInboxForwarders(inboxId, page, size, sort, searchFilter, since, before)

List inbox forwarders

List all forwarders attached to an inbox

Example

// Import classes:
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*

val apiInstance = InboxForwarderControllerApi()
val inboxId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | Optional inbox id to get forwarders from
val page : kotlin.Int = 56 // kotlin.Int | Optional page  in inbox forwarder list pagination
val size : kotlin.Int = 56 // kotlin.Int | Optional page size in inbox forwarder list pagination
val sort : kotlin.String = sort_example // kotlin.String | Optional createdAt sort direction ASC or DESC
val searchFilter : kotlin.String = searchFilter_example // kotlin.String | Optional search filter
val since : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | Filter by created at after the given timestamp
val before : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | Filter by created at before the given timestamp
try {
    val result : PageInboxForwarderDto = apiInstance.getInboxForwarders(inboxId, page, size, sort, searchFilter, since, before)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling InboxForwarderControllerApi#getInboxForwarders")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling InboxForwarderControllerApi#getInboxForwarders")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
inboxId java.util.UUID Optional inbox id to get forwarders from [optional]
page kotlin.Int Optional page in inbox forwarder list pagination [optional] [default to 0]
size kotlin.Int Optional page size in inbox forwarder list pagination [optional] [default to 20]
sort kotlin.String Optional createdAt sort direction ASC or DESC [optional] [default to ASC] [enum: ASC, DESC]
searchFilter kotlin.String Optional search filter [optional]
since java.time.OffsetDateTime Filter by created at after the given timestamp [optional]
before java.time.OffsetDateTime Filter by created at before the given timestamp [optional]

Return type

PageInboxForwarderDto

Authorization

Configure API_KEY: ApiClient.apiKey["x-api-key"] = "" ApiClient.apiKeyPrefix["x-api-key"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

InboxForwarderTestResult testInboxForwarder(id, inboxForwarderTestOptions)

Test an inbox forwarder

Test an inbox forwarder

Example

// Import classes:
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*

val apiInstance = InboxForwarderControllerApi()
val id : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | ID of inbox forwarder
val inboxForwarderTestOptions : InboxForwarderTestOptions =  // InboxForwarderTestOptions | 
try {
    val result : InboxForwarderTestResult = apiInstance.testInboxForwarder(id, inboxForwarderTestOptions)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling InboxForwarderControllerApi#testInboxForwarder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling InboxForwarderControllerApi#testInboxForwarder")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.util.UUID ID of inbox forwarder
inboxForwarderTestOptions InboxForwarderTestOptions

Return type

InboxForwarderTestResult

Authorization

Configure API_KEY: ApiClient.apiKey["x-api-key"] = "" ApiClient.apiKeyPrefix["x-api-key"] = ""

HTTP request headers

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

InboxForwarderTestResult testInboxForwardersForInbox(inboxId, inboxForwarderTestOptions)

Test inbox forwarders for inbox

Test inbox forwarders for inbox

Example

// Import classes:
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*

val apiInstance = InboxForwarderControllerApi()
val inboxId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | ID of inbox
val inboxForwarderTestOptions : InboxForwarderTestOptions =  // InboxForwarderTestOptions | 
try {
    val result : InboxForwarderTestResult = apiInstance.testInboxForwardersForInbox(inboxId, inboxForwarderTestOptions)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling InboxForwarderControllerApi#testInboxForwardersForInbox")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling InboxForwarderControllerApi#testInboxForwardersForInbox")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
inboxId java.util.UUID ID of inbox
inboxForwarderTestOptions InboxForwarderTestOptions

Return type

InboxForwarderTestResult

Authorization

Configure API_KEY: ApiClient.apiKey["x-api-key"] = "" ApiClient.apiKeyPrefix["x-api-key"] = ""

HTTP request headers

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

InboxForwarderTestResult testNewInboxForwarder(testNewInboxForwarderOptions)

Test new inbox forwarder

Test new inbox forwarder

Example

// Import classes:
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*

val apiInstance = InboxForwarderControllerApi()
val testNewInboxForwarderOptions : TestNewInboxForwarderOptions =  // TestNewInboxForwarderOptions | 
try {
    val result : InboxForwarderTestResult = apiInstance.testNewInboxForwarder(testNewInboxForwarderOptions)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling InboxForwarderControllerApi#testNewInboxForwarder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling InboxForwarderControllerApi#testNewInboxForwarder")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
testNewInboxForwarderOptions TestNewInboxForwarderOptions

Return type

InboxForwarderTestResult

Authorization

Configure API_KEY: ApiClient.apiKey["x-api-key"] = "" ApiClient.apiKeyPrefix["x-api-key"] = ""

HTTP request headers

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