# AliasControllerAPI
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
createAlias | POST /aliases | Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active. |
deleteAlias | DELETE /aliases/{aliasId} | Delete an email alias |
getAlias | GET /aliases/{aliasId} | Get an email alias |
getAliasEmails | GET /aliases/{aliasId}/emails | Get emails for an alias |
getAliasThreads | GET /aliases/{aliasId}/threads | Get threads created for an alias |
getAliases | GET /aliases | Get all email aliases you have created |
replyToAliasEmail | PUT /aliases/{aliasId}/emails/{emailId} | Reply to an email |
sendAliasEmail | POST /aliases/{aliasId}/emails | Send an email from an alias inbox |
updateAlias | PUT /aliases/{aliasId} | Update an email alias |
# createAlias
open class func createAlias(createAliasOptions: CreateAliasOptions, completion: @escaping (_ data: AliasDto?, _ error: Error?) -> Void)
Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active.
Email aliases use a MailSlurp randomly generated email address (or a custom domain inbox that you provide) to mask or proxy a real email address. Emails sent to the alias address will be forwarded to the hidden email address it was created for. If you want to send a reply use the threadId attached
# 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 createAliasOptions = CreateAliasOptions(emailAddress: "emailAddress_example", inboxId: 123, name: "name_example", useThreads: false) // CreateAliasOptions | createAliasOptions
// Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active.
AliasControllerAPI.createAlias(createAliasOptions: createAliasOptions) { (response, error) in
guard error == nil else {
print(error)
return
}
if (response) {
dump(response)
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
createAliasOptions | CreateAliasOptions | createAliasOptions |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# deleteAlias
open class func deleteAlias(aliasId: UUID, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)
Delete an email alias
# 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 aliasId = 987 // UUID | aliasId
// Delete an email alias
AliasControllerAPI.deleteAlias(aliasId: aliasId) { (response, error) in
guard error == nil else {
print(error)
return
}
if (response) {
dump(response)
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
aliasId | UUID | aliasId |
# 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 README]
# getAlias
open class func getAlias(aliasId: UUID, completion: @escaping (_ data: AliasDto?, _ error: Error?) -> Void)
Get an email alias
Get an email alias by ID
# 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 aliasId = 987 // UUID | aliasId
// Get an email alias
AliasControllerAPI.getAlias(aliasId: aliasId) { (response, error) in
guard error == nil else {
print(error)
return
}
if (response) {
dump(response)
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
aliasId | UUID | aliasId |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# getAliasEmails
open class func getAliasEmails(aliasId: UUID, page: Int? = nil, size: Int? = nil, sort: Sort_getAliasEmails? = nil, completion: @escaping (_ data: PageEmailProjection?, _ error: Error?) -> Void)
Get emails for an alias
Get paginated emails for an alias by ID
# 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 aliasId = 987 // UUID | aliasId
let page = 987 // Int | Optional page index alias email list pagination (optional) (default to 0)
let size = 987 // Int | Optional page size alias email list pagination (optional) (default to 20)
let sort = "sort_example" // String | Optional createdAt sort direction ASC or DESC (optional) (default to .asc)
// Get emails for an alias
AliasControllerAPI.getAliasEmails(aliasId: aliasId, page: page, size: size, sort: sort) { (response, error) in
guard error == nil else {
print(error)
return
}
if (response) {
dump(response)
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
aliasId | UUID | aliasId | |
page | Int | Optional page index alias email list pagination | [optional] [default to 0] |
size | Int | Optional page size alias email list pagination | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to .asc] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# getAliasThreads
open class func getAliasThreads(aliasId: UUID, page: Int? = nil, size: Int? = nil, sort: Sort_getAliasThreads? = nil, completion: @escaping (_ data: PageThreadProjection?, _ error: Error?) -> Void)
Get threads created for an alias
Returns threads created for an email alias in paginated form
# 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 aliasId = 987 // UUID | aliasId
let page = 987 // Int | Optional page index in thread list pagination (optional) (default to 0)
let size = 987 // Int | Optional page size in thread list pagination (optional) (default to 20)
let sort = "sort_example" // String | Optional createdAt sort direction ASC or DESC (optional) (default to .asc)
// Get threads created for an alias
AliasControllerAPI.getAliasThreads(aliasId: aliasId, page: page, size: size, sort: sort) { (response, error) in
guard error == nil else {
print(error)
return
}
if (response) {
dump(response)
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
aliasId | UUID | aliasId | |
page | Int | Optional page index in thread list pagination | [optional] [default to 0] |
size | Int | Optional page size in thread list pagination | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to .asc] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# getAliases
open class func getAliases(page: Int? = nil, size: Int? = nil, sort: Sort_getAliases? = nil, completion: @escaping (_ data: PageAlias?, _ error: Error?) -> Void)
Get all email aliases you have created
Get all email aliases in paginated form
# 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 page = 987 // Int | Optional page index in alias list pagination (optional) (default to 0)
let size = 987 // Int | Optional page size in alias list pagination (optional) (default to 20)
let sort = "sort_example" // String | Optional createdAt sort direction ASC or DESC (optional) (default to .asc)
// Get all email aliases you have created
AliasControllerAPI.getAliases(page: page, size: size, sort: sort) { (response, error) in
guard error == nil else {
print(error)
return
}
if (response) {
dump(response)
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
page | Int | Optional page index in alias list pagination | [optional] [default to 0] |
size | Int | Optional page size in alias list pagination | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to .asc] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# replyToAliasEmail
open class func replyToAliasEmail(aliasId: UUID, emailId: UUID, replyToAliasEmailOptions: ReplyToAliasEmailOptions, completion: @escaping (_ data: SentEmailDto?, _ error: Error?) -> Void)
Reply to an email
Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails to
, cc
, and bcc
.
# 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 aliasId = 987 // UUID | ID of the alias that email belongs to
let emailId = 987 // UUID | ID of the email that should be replied to
let replyToAliasEmailOptions = ReplyToAliasEmailOptions(attachments: ["attachments_example"], body: "body_example", charset: "charset_example", isHTML: false, sendStrategy: "sendStrategy_example", template: 123, templateVariables: 123) // ReplyToAliasEmailOptions | replyToAliasEmailOptions
// Reply to an email
AliasControllerAPI.replyToAliasEmail(aliasId: aliasId, emailId: emailId, replyToAliasEmailOptions: replyToAliasEmailOptions) { (response, error) in
guard error == nil else {
print(error)
return
}
if (response) {
dump(response)
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
aliasId | UUID | ID of the alias that email belongs to | |
emailId | UUID | ID of the email that should be replied to | |
replyToAliasEmailOptions | ReplyToAliasEmailOptions | replyToAliasEmailOptions |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# sendAliasEmail
open class func sendAliasEmail(aliasId: UUID, sendEmailOptions: SendEmailOptions? = nil, completion: @escaping (_ data: SentEmailDto?, _ error: Error?) -> Void)
Send an email from an alias inbox
Send an email from an alias. Replies to the email will be forwarded to the alias masked 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 aliasId = 987 // UUID | aliasId
let sendEmailOptions = SendEmailOptions(attachments: ["attachments_example"], bcc: ["bcc_example"], body: "body_example", cc: ["cc_example"], charset: "charset_example", from: "from_example", isHTML: false, replyTo: "replyTo_example", sendStrategy: "sendStrategy_example", subject: "subject_example", template: 123, templateVariables: 123, to: ["to_example"], toContacts: [123], toGroup: 123) // SendEmailOptions | Options for the email to be sent (optional)
// Send an email from an alias inbox
AliasControllerAPI.sendAliasEmail(aliasId: aliasId, sendEmailOptions: sendEmailOptions) { (response, error) in
guard error == nil else {
print(error)
return
}
if (response) {
dump(response)
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
aliasId | UUID | aliasId | |
sendEmailOptions | SendEmailOptions | Options for the email to be sent | [optional] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# updateAlias
open class func updateAlias(aliasId: UUID, updateAliasOptions: UpdateAliasOptions, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)
Update an email alias
# 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 aliasId = 987 // UUID | aliasId
let updateAliasOptions = UpdateAliasOptions(name: "name_example") // UpdateAliasOptions | updateAliasOptions
// Update an email alias
AliasControllerAPI.updateAlias(aliasId: aliasId, updateAliasOptions: updateAliasOptions) { (response, error) in
guard error == nil else {
print(error)
return
}
if (response) {
dump(response)
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
aliasId | UUID | aliasId | |
updateAliasOptions | UpdateAliasOptions | updateAliasOptions |
# Return type
Void (empty response body)
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]