SentEmailsControllerApi
All URIs are relative to https://api.mailslurp.com
| Method | HTTP request | Description |
|---|---|---|
| deleteAllSentEmails | DELETE /sent | Delete all sent email receipts |
| deleteSentEmail | DELETE /sent/{id} | Delete sent email receipt |
| getAllSentTrackingPixels | GET /sent/tracking-pixels | |
| getRawSentEmailContents | GET /sent/{emailId}/raw | Get raw sent email string. Returns unparsed raw SMTP message with headers and body. |
| getRawSentEmailJson | GET /sent/{emailId}/raw/json | Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format. |
| getSentDeliveryStatus | GET /sent/delivery-status/{deliveryId} | |
| getSentDeliveryStatuses | GET /sent/delivery-status | |
| getSentDeliveryStatusesBySentId | GET /sent/{sentId}/delivery-status | |
| getSentEmail | GET /sent/{id} | Get sent email receipt |
| getSentEmailHTMLContent | GET /sent/{id}/html | Get sent email HTML content |
| getSentEmailPreviewURLs | GET /sent/{id}/urls | Get sent email URL for viewing in browser or downloading |
| getSentEmailTrackingPixels | GET /sent/{id}/tracking-pixels | |
| getSentEmails | GET /sent | Get all sent emails in paginated form |
| getSentEmailsWithQueueResults | GET /sent/queue-results | Get results of email sent with queues in paginated form |
| getSentOrganizationEmails | GET /sent/organization | |
| waitForDeliveryStatuses | GET /sent/delivery-status/wait-for |
Delete all sent email receipts
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(SentEmailsControllerApi::class.java)
webService.deleteAllSentEmails()
Parameters
This endpoint does not need any parameter.
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
Delete sent email receipt
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(SentEmailsControllerApi::class.java)
val id : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID |
webService.deleteSentEmail(id)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | java.util.UUID |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
Get all sent email tracking pixels in paginated form
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(SentEmailsControllerApi::class.java)
val page : kotlin.Int = 56 // kotlin.Int | Optional page in sent email tracking pixel list pagination
val size : kotlin.Int = 56 // kotlin.Int | Optional page size in sent email tracking pixel list pagination
val sort : kotlin.String = sort_example // kotlin.String | Optional createdAt sort direction ASC or DESC
val searchFilter : kotlin.String = searchFilter_example // kotlin.String | Optional search filter
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 : PageTrackingPixelProjection = webService.getAllSentTrackingPixels(page, size, sort, searchFilter, since, before)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | kotlin.Int | Optional page in sent email tracking pixel list pagination | [optional] [default to 0] |
| size | kotlin.Int | Optional page size in sent email tracking pixel list pagination | [optional] [default to 20] |
| sort | kotlin.String | Optional createdAt sort direction ASC or DESC | [optional] [default to ASC] [enum: ASC, DESC] |
| searchFilter | kotlin.String | Optional search filter | [optional] |
| 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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
Get raw sent email string. Returns unparsed raw SMTP message with headers and body.
Returns a raw, unparsed, and unprocessed sent email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawSentEmailJson endpoint
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(SentEmailsControllerApi::class.java)
val emailId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | ID of email
val result : kotlin.String = webService.getRawSentEmailContents(emailId)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| emailId | java.util.UUID | ID of email |
Return type
kotlin.String
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: text/plain
Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format.
Returns a raw, unparsed, and unprocessed sent email wrapped in a JSON response object for easier handling when compared with the getRawSentEmail text/plain response
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(SentEmailsControllerApi::class.java)
val emailId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | ID of email
val result : RawEmailJson = webService.getRawSentEmailJson(emailId)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| emailId | java.util.UUID | ID of email |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
Get a sent email delivery status
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(SentEmailsControllerApi::class.java)
val deliveryId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID |
val result : DeliveryStatusDto = webService.getSentDeliveryStatus(deliveryId)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| deliveryId | java.util.UUID |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
Get all sent email delivery statuses
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(SentEmailsControllerApi::class.java)
val page : kotlin.Int = 56 // kotlin.Int | Optional page in delivery status list pagination
val size : kotlin.Int = 56 // kotlin.Int | Optional page size in delivery status 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 : PageDeliveryStatus = webService.getSentDeliveryStatuses(page, size, sort, since, before)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | kotlin.Int | Optional page in delivery status list pagination | [optional] [default to 0] |
| size | kotlin.Int | Optional page size in delivery status 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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
Get all sent email delivery statuses
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(SentEmailsControllerApi::class.java)
val sentId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID |
val page : kotlin.Int = 56 // kotlin.Int | Optional page in delivery status list pagination
val size : kotlin.Int = 56 // kotlin.Int | Optional page size in delivery status 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 : PageDeliveryStatus = webService.getSentDeliveryStatusesBySentId(sentId, page, size, sort, since, before)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| sentId | java.util.UUID | ||
| page | kotlin.Int | Optional page in delivery status list pagination | [optional] [default to 0] |
| size | kotlin.Int | Optional page size in delivery status 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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
Get sent email receipt
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(SentEmailsControllerApi::class.java)
val id : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID |
val result : SentEmailDto = webService.getSentEmail(id)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | java.util.UUID |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
Get sent email HTML content
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(SentEmailsControllerApi::class.java)
val id : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID |
val result : kotlin.String = webService.getSentEmailHTMLContent(id)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | java.util.UUID |
Return type
kotlin.String
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: text/html
Get sent email URL for viewing in browser or downloading
Get a list of URLs for sent email content as text/html or raw SMTP message for viewing the message in a browser.
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(SentEmailsControllerApi::class.java)
val id : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID |
val result : EmailPreviewUrls = webService.getSentEmailPreviewURLs(id)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | java.util.UUID |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
Get all tracking pixels for a sent email in paginated form
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(SentEmailsControllerApi::class.java)
val id : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID |
val page : kotlin.Int = 56 // kotlin.Int | Optional page in sent email tracking pixel list pagination
val size : kotlin.Int = 56 // kotlin.Int | Optional page size in sent email tracking pixel list pagination
val sort : kotlin.String = sort_example // kotlin.String | Optional createdAt sort direction ASC or DESC
val searchFilter : kotlin.String = searchFilter_example // kotlin.String | Optional search filter
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 : PageTrackingPixelProjection = webService.getSentEmailTrackingPixels(id, page, size, sort, searchFilter, since, before)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | java.util.UUID | ||
| page | kotlin.Int | Optional page in sent email tracking pixel list pagination | [optional] [default to 0] |
| size | kotlin.Int | Optional page size in sent email tracking pixel list pagination | [optional] [default to 20] |
| sort | kotlin.String | Optional createdAt sort direction ASC or DESC | [optional] [default to ASC] [enum: ASC, DESC] |
| searchFilter | kotlin.String | Optional search filter | [optional] |
| 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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
Get all sent emails in paginated form
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(SentEmailsControllerApi::class.java)
val inboxId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | Optional inboxId to filter sender of sent emails by
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 searchFilter : kotlin.String = searchFilter_example // kotlin.String | Optional search filter
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 : PageSentEmailProjection = webService.getSentEmails(inboxId, page, size, sort, searchFilter, since, before)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| inboxId | java.util.UUID | Optional inboxId to filter sender of sent emails by | [optional] |
| 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] |
| searchFilter | kotlin.String | Optional search filter | [optional] |
| 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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
Get results of email sent with queues in paginated form
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(SentEmailsControllerApi::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 : PageSentEmailWithQueueProjection = webService.getSentEmailsWithQueueResults(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
PageSentEmailWithQueueProjection
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
Get all sent organization emails in paginated form
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(SentEmailsControllerApi::class.java)
val inboxId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | Optional inboxId to filter sender of sent emails by
val page : kotlin.Int = 56 // kotlin.Int | Optional page in sent email list pagination
val size : kotlin.Int = 56 // kotlin.Int | Optional page size in sent email list pagination
val sort : kotlin.String = sort_example // kotlin.String | Optional createdAt sort direction ASC or DESC
val searchFilter : kotlin.String = searchFilter_example // kotlin.String | Optional search filter
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 : PageSentEmailProjection = webService.getSentOrganizationEmails(inboxId, page, size, sort, searchFilter, since, before)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| inboxId | java.util.UUID | Optional inboxId to filter sender of sent emails by | [optional] |
| page | kotlin.Int | Optional page in sent email list pagination | [optional] [default to 0] |
| size | kotlin.Int | Optional page size in 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] |
| searchFilter | kotlin.String | Optional search filter | [optional] |
| 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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
Wait for delivery statuses
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(SentEmailsControllerApi::class.java)
val sentId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | Optional sent email ID filter
val inboxId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | Optional inbox ID filter
val timeout : kotlin.Long = 789 // kotlin.Long | Optional timeout milliseconds
val : kotlin.Int = 56 // kotlin.Int | Zero based of the delivery status to wait for. If 1 delivery status already and you want to wait for the 2nd pass =1
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 : DeliveryStatusDto = webService.waitForDeliveryStatuses(sentId, inboxId, timeout, , since, before)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| sentId | java.util.UUID | Optional sent email ID filter | [optional] |
| inboxId | java.util.UUID | Optional inbox ID filter | [optional] |
| timeout | kotlin.Long | Optional timeout milliseconds | [optional] |
| **** | kotlin.Int | Zero based of the delivery status to wait for. If 1 delivery status already and you want to wait for the 2nd pass =1 | [optional] |
| 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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /