CommonActionsControllerAPI
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
createNewEmailAddress | POST /newEmailAddress | Create new random inbox |
createRandomInbox | POST /createInbox | Create new random inbox |
deleteEmailAddress | DELETE /deleteEmailAddress | Delete inbox email address by inbox id |
emptyInbox | DELETE /emptyInbox | Delete all emails in an inbox |
sendEmailSimple | POST /sendEmail | Send an email |
open class func createNewEmailAddress( allowTeamAccess: Bool? = nil, useDomainPool: Bool? = nil, expiresAt: Date? = nil, expiresIn: Int64? = nil, emailAddress: String? = nil, inboxType: InboxType_createNewEmailAddress? = nil, _description: String? = nil, name: String? = nil, tags: [String]? = nil, favourite: Bool? = nil, virtualInbox: Bool? = nil, useShortAddress: Bool? = nil) -> Promise<InboxDto>
Create new random inbox
Returns an Inbox with an id
and an emailAddress
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 allowTeamAccess = true // Bool | (optional)
let useDomainPool = true // Bool | (optional)
let expiresAt = Date() // Date | (optional)
let expiresIn = 987 // Int64 | (optional)
let emailAddress = "emailAddress_example" // String | (optional)
let inboxType = "inboxType_example" // String | (optional)
let _description = "_description_example" // String | (optional)
let name = "name_example" // String | (optional)
let tags = ["inner_example"] // [String] | (optional)
let favourite = true // Bool | (optional)
let virtualInbox = true // Bool | (optional)
let useShortAddress = true // Bool | (optional)
// Create new random inbox
CommonActionsControllerAPI.createNewEmailAddress(allowTeamAccess: allowTeamAccess, useDomainPool: useDomainPool, expiresAt: expiresAt, expiresIn: expiresIn, emailAddress: emailAddress, inboxType: inboxType, _description: _description, name: name, tags: tags, favourite: favourite, virtualInbox: virtualInbox, useShortAddress: useShortAddress).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 |
---|---|---|---|
allowTeamAccess | Bool | [optional] | |
useDomainPool | Bool | [optional] | |
expiresAt | Date | [optional] | |
expiresIn | Int64 | [optional] | |
emailAddress | String | [optional] | |
inboxType | String | [optional] | |
_description | String | [optional] | |
name | String | [optional] | |
tags | [String] | [optional] | |
favourite | Bool | [optional] | |
virtualInbox | Bool | [optional] | |
useShortAddress | Bool | [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 createRandomInbox( allowTeamAccess: Bool? = nil, useDomainPool: Bool? = nil, expiresAt: Date? = nil, expiresIn: Int64? = nil, emailAddress: String? = nil, inboxType: InboxType_createRandomInbox? = nil, _description: String? = nil, name: String? = nil, tags: [String]? = nil, favourite: Bool? = nil, virtualInbox: Bool? = nil, useShortAddress: Bool? = nil) -> Promise<InboxDto>
Create new random inbox
Returns an Inbox with an id
and an emailAddress
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 allowTeamAccess = true // Bool | (optional)
let useDomainPool = true // Bool | (optional)
let expiresAt = Date() // Date | (optional)
let expiresIn = 987 // Int64 | (optional)
let emailAddress = "emailAddress_example" // String | (optional)
let inboxType = "inboxType_example" // String | (optional)
let _description = "_description_example" // String | (optional)
let name = "name_example" // String | (optional)
let tags = ["inner_example"] // [String] | (optional)
let favourite = true // Bool | (optional)
let virtualInbox = true // Bool | (optional)
let useShortAddress = true // Bool | (optional)
// Create new random inbox
CommonActionsControllerAPI.createRandomInbox(allowTeamAccess: allowTeamAccess, useDomainPool: useDomainPool, expiresAt: expiresAt, expiresIn: expiresIn, emailAddress: emailAddress, inboxType: inboxType, _description: _description, name: name, tags: tags, favourite: favourite, virtualInbox: virtualInbox, useShortAddress: useShortAddress).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 |
---|---|---|---|
allowTeamAccess | Bool | [optional] | |
useDomainPool | Bool | [optional] | |
expiresAt | Date | [optional] | |
expiresIn | Int64 | [optional] | |
emailAddress | String | [optional] | |
inboxType | String | [optional] | |
_description | String | [optional] | |
name | String | [optional] | |
tags | [String] | [optional] | |
favourite | Bool | [optional] | |
virtualInbox | Bool | [optional] | |
useShortAddress | Bool | [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 ]
Delete inbox email address by inbox id
Deletes inbox email address
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 |
// Delete inbox email address by inbox id
CommonActionsControllerAPI.deleteEmailAddress(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 |
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 all emails in an inbox
Deletes all emails
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 |
// Delete all emails in an inbox
CommonActionsControllerAPI.emptyInbox(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 |
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 ]
Send an email
If no senderId or inboxId provided a random email address will be used to send from.
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 simpleSendEmailOptions = SimpleSendEmailOptions(senderId: 123, to: "to_example", body: "body_example", subject: "subject_example") // SimpleSendEmailOptions |
// Send an email
CommonActionsControllerAPI.sendEmailSimple(simpleSendEmailOptions: simpleSendEmailOptions).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 |
---|---|---|---|
simpleSendEmailOptions | SimpleSendEmailOptions |
Return type
Void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to ]