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 |
Get default expiration settings
Return default times used for inbox expiration
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(ExpiredControllerApi::class.java)
val result : ExpirationDefaults = webService.getExpirationDefaults()
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
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
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(ExpiredControllerApi::class.java)
val inboxId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | ID of inbox you want to retrieve (not the inbox ID)
val result : ExpiredInboxDto = webService.getExpiredInboxByInboxId(inboxId)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inboxId | java.util.UUID | ID of inbox you want to retrieve (not the inbox ID) |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
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
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(ExpiredControllerApi::class.java)
val expiredId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.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
val result : ExpiredInboxDto = webService.getExpiredInboxRecord(expiredId)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
expiredId | java.util.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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
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
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(ExpiredControllerApi::class.java)
val page : kotlin.Int = 56 // kotlin.Int | Optional page in inbox sent email list pagination
val size : kotlin.Int = 56 // kotlin.Int | Optional page size in inbox sent email list pagination
val sort : kotlin.String = sort_example // kotlin.String | Optional createdAt sort direction ASC or DESC
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
val result : PageExpiredInboxRecordProjection = webService.getExpiredInboxes(page, size, sort, since, before)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
page | kotlin.Int | Optional page in inbox sent email list pagination | [optional] [default to 0] |
size | kotlin.Int | Optional page size in inbox sent email list pagination | [optional] [default to 20] |
sort | kotlin.String | Optional createdAt sort direction ASC or DESC | [optional] [default to ASC] [enum: ASC, DESC] |
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
PageExpiredInboxRecordProjection
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /