# ExpiredControllerAPI

All URIs are relative to https://api.mailslurp.com

Method HTTP request Description
getExpirationDefaults GET /expired/defaults Get default expiration settings
getExpiredInboxByInboxId GET /expired/inbox/{inboxId} Get expired inbox record for a previously existing inbox
getExpiredInboxRecord GET /expired/{expiredId} Get an expired inbox record
getExpiredInboxes GET /expired List records of expired inboxes

# getExpirationDefaults

    open class func getExpirationDefaults(completion: @escaping (_ data: ExpirationDefaults?, _ error: Error?) -> Void)

Get default expiration settings

Return default times used for inbox expiration

# Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
// Get default expiration settings
ExpiredControllerAPI.getExpirationDefaults() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

# Parameters

This endpoint does not need any parameter.

# Return type

ExpirationDefaults

# 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 README]

# getExpiredInboxByInboxId

    open class func getExpiredInboxByInboxId(inboxId: UUID, completion: @escaping (_ data: ExpiredInboxDto?, _ error: Error?) -> Void)

Get expired inbox record for a previously existing inbox

Use the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxId

# 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 you want to retrieve (not the inbox ID)
// Get expired inbox record for a previously existing inbox
ExpiredControllerAPI.getExpiredInboxByInboxId(inboxId: inboxId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

# Parameters

Name Type Description Notes
inboxId UUID ID of inbox you want to retrieve (not the inbox ID)

# Return type

ExpiredInboxDto

# 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 README]

# getExpiredInboxRecord

    open class func getExpiredInboxRecord(expiredId: UUID, completion: @escaping (_ data: ExpiredInboxDto?, _ error: Error?) -> Void)

Get an expired inbox record

Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties

# 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 expiredId = 987 // UUID | ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId)
// Get an expired inbox record
ExpiredControllerAPI.getExpiredInboxRecord(expiredId: expiredId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

# Parameters

Name Type Description Notes
expiredId UUID ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId)

# Return type

ExpiredInboxDto

# 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 README]

# getExpiredInboxes

    open class func getExpiredInboxes(page: Int? = nil, size: Int? = nil, sort: Sort_getExpiredInboxes? = nil, completion: @escaping (_ data: PageExpiredInboxRecordProjection?, _ error: Error?) -> Void)

List records of expired inboxes

Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties

# 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 inbox sent email list pagination (optional) (default to 0)
let size = 987 // Int | Optional page size in inbox sent email list pagination (optional) (default to 20)
let sort = "sort_example" // String | Optional createdAt sort direction ASC or DESC (optional) (default to .asc)
// List records of expired inboxes
ExpiredControllerAPI.getExpiredInboxes(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 inbox sent email list pagination [optional] [default to 0]
size Int Optional page size in inbox sent email list pagination [optional] [default to 20]
sort String Optional createdAt sort direction ASC or DESC [optional] [default to .asc]

# Return type

PageExpiredInboxRecordProjection

# 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 README]