InboxRulesetControllerAPI
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
createNewInboxRuleset | POST /rulesets | Create an inbox ruleset |
deleteInboxRuleset | DELETE /rulesets/{id} | Delete an inbox ruleset |
deleteInboxRulesets | DELETE /rulesets | Delete inbox rulesets |
getInboxRuleset | GET /rulesets/{id} | Get an inbox ruleset |
getInboxRulesets | GET /rulesets | List inbox rulesets |
testInboxRuleset | POST /rulesets/{id}/test | Test an inbox ruleset |
testInboxRulesetsForInbox | PUT /rulesets | Test inbox rulesets for inbox |
testNewInboxRuleset | PATCH /rulesets | Test new inbox ruleset |
open class func createNewInboxRuleset( inboxId: UUID, createInboxRulesetOptions: CreateInboxRulesetOptions) -> Promise<InboxRulesetDto>
Create an inbox ruleset
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 inboxId = 987 // UUID | Inbox id to attach ruleset to
let createInboxRulesetOptions = CreateInboxRulesetOptions(scope: "scope_example", action: "action_example", target: "target_example") // CreateInboxRulesetOptions |
// Create an inbox ruleset
InboxRulesetControllerAPI.createNewInboxRuleset(inboxId: inboxId, createInboxRulesetOptions: createInboxRulesetOptions).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
Name | Type | Description | Notes |
---|---|---|---|
inboxId | UUID | Inbox id to attach ruleset to | |
createInboxRulesetOptions | CreateInboxRulesetOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
Delete an inbox ruleset
Delete 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 ruleset
// Delete an inbox ruleset
InboxRulesetControllerAPI.deleteInboxRuleset(_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
Name | Type | Description | Notes |
---|---|---|---|
_id | UUID | ID of inbox ruleset |
Return type
Void (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 ]
Delete inbox rulesets
Delete inbox rulesets. 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 ruleset to (optional)
// Delete inbox rulesets
InboxRulesetControllerAPI.deleteInboxRulesets(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
Name | Type | Description | Notes |
---|---|---|---|
inboxId | UUID | Optional inbox id to attach ruleset to | [optional] |
Return type
Void (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 ]
Get an inbox ruleset
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 ruleset
// Get an inbox ruleset
InboxRulesetControllerAPI.getInboxRuleset(_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
Name | Type | Description | Notes |
---|---|---|---|
_id | UUID | ID of inbox ruleset |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
open class func getInboxRulesets( inboxId: UUID? = nil, page: Int? = nil, size: Int? = nil, sort: Sort_getInboxRulesets? = nil, searchFilter: String? = nil, since: Date? = nil, before: Date? = nil) -> Promise<PageInboxRulesetDto>
List inbox rulesets
List all rulesets 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 rulesets from (optional)
let page = 987 // Int | Optional page in inbox ruleset list pagination (optional) (default to 0)
let size = 987 // Int | Optional page size in inbox ruleset list pagination (optional) (default to 20)
let sort = "sort_example" // String | Optional createdAt sort direction ASC or DESC (optional) (default to .asc)
let searchFilter = "searchFilter_example" // String | Optional search filter (optional)
let since = Date() // Date | Filter by created at after the given timestamp (optional)
let before = Date() // Date | Filter by created at before the given timestamp (optional)
// List inbox rulesets
InboxRulesetControllerAPI.getInboxRulesets(inboxId: inboxId, page: page, size: size, sort: sort, searchFilter: searchFilter, since: since, before: before).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
Name | Type | Description | Notes |
---|---|---|---|
inboxId | UUID | Optional inbox id to get rulesets from | [optional] |
page | Int | Optional page in inbox ruleset list pagination | [optional] [default to 0] |
size | Int | Optional page size in inbox ruleset list pagination | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to .asc] |
searchFilter | String | Optional search filter | [optional] |
since | Date | Filter by created at after the given timestamp | [optional] |
before | Date | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
open class func testInboxRuleset( _id: UUID, inboxRulesetTestOptions: InboxRulesetTestOptions) -> Promise<InboxRulesetTestResult>
Test an inbox ruleset
Test an 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 ruleset
let inboxRulesetTestOptions = InboxRulesetTestOptions(testTarget: "testTarget_example") // InboxRulesetTestOptions |
// Test an inbox ruleset
InboxRulesetControllerAPI.testInboxRuleset(_id: _id, inboxRulesetTestOptions: inboxRulesetTestOptions).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
Name | Type | Description | Notes |
---|---|---|---|
_id | UUID | ID of inbox ruleset | |
inboxRulesetTestOptions | InboxRulesetTestOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
open class func testInboxRulesetsForInbox( inboxId: UUID, inboxRulesetTestOptions: InboxRulesetTestOptions) -> Promise<InboxRulesetTestResult>
Test inbox rulesets for inbox
Test inbox rulesets 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 inboxRulesetTestOptions = InboxRulesetTestOptions(testTarget: "testTarget_example") // InboxRulesetTestOptions |
// Test inbox rulesets for inbox
InboxRulesetControllerAPI.testInboxRulesetsForInbox(inboxId: inboxId, inboxRulesetTestOptions: inboxRulesetTestOptions).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
Name | Type | Description | Notes |
---|---|---|---|
inboxId | UUID | ID of inbox | |
inboxRulesetTestOptions | InboxRulesetTestOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
open class func testNewInboxRuleset( testNewInboxRulesetOptions: TestNewInboxRulesetOptions) -> Promise<InboxRulesetTestResult>
Test new inbox ruleset
Test new 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 testNewInboxRulesetOptions = TestNewInboxRulesetOptions(inboxRulesetTestOptions: InboxRulesetTestOptions(testTarget: "testTarget_example"), createInboxRulesetOptions: CreateInboxRulesetOptions(scope: "scope_example", action: "action_example", target: "target_example")) // TestNewInboxRulesetOptions |
// Test new inbox ruleset
InboxRulesetControllerAPI.testNewInboxRuleset(testNewInboxRulesetOptions: testNewInboxRulesetOptions).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
Name | Type | Description | Notes |
---|---|---|---|
testNewInboxRulesetOptions | TestNewInboxRulesetOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]