SentEmailsControllerAPI

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

MethodHTTP requestDescription
getAllSentTrackingPixelsGET /sent/tracking-pixelsGet all sent email tracking pixels in paginated form
getSentEmailGET /sent/{id}Get sent email receipt
getSentEmailHTMLContentGET /sent/{id}/htmlGet sent email HTML content
getSentEmailTrackingPixelsGET /sent/{id}/tracking-pixelsGet all tracking pixels for a sent email in paginated form
getSentEmailsGET /sentGet all sent emails in paginated form
getSentOrganizationEmailsGET /sent/organizationGet all sent organization emails in paginated form

getAllSentTrackingPixels

    open class func getAllSentTrackingPixels( before: Date? = nil,  page: Int? = nil,  searchFilter: String? = nil,  since: Date? = nil,  size: Int? = nil,  sort: Sort_getAllSentTrackingPixels? = nil) -> Promise<PageTrackingPixelProjection>

Get all sent email tracking pixels 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 before = Date() // Date | Filter by created at before the given timestamp (optional)
let page = 987 // Int | Optional page  in sent email tracking pixel list pagination (optional) (default to 0)
let searchFilter = "searchFilter_example" // String | Optional search filter (optional)
let since = Date() // Date | Filter by created at after the given timestamp (optional)
let size = 987 // Int | Optional page size in sent email tracking pixel list pagination (optional) (default to 20)
let sort = "sort_example" // String | Optional createdAt sort direction ASC or DESC (optional) (default to .asc)

// Get all sent email tracking pixels in paginated form
SentEmailsControllerAPI.getAllSentTrackingPixels(before: before, page: page, searchFilter: searchFilter, since: since, size: size, sort: sort).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

NameTypeDescriptionNotes
beforeDateFilter by created at before the given timestamp[optional]
pageIntOptional page in sent email tracking pixel list pagination[optional] [default to 0]
searchFilterStringOptional search filter[optional]
sinceDateFilter by created at after the given timestamp[optional]
sizeIntOptional page size in sent email tracking pixel list pagination[optional] [default to 20]
sortStringOptional createdAt sort direction ASC or DESC[optional] [default to .asc]

Return type

PageTrackingPixelProjection

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 ]

getSentEmail

    open class func getSentEmail( _id: UUID) -> Promise<SentEmailDto>

Get sent email receipt

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 _id = 987 // UUID | id

// Get sent email receipt
SentEmailsControllerAPI.getSentEmail(_id: _id).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

NameTypeDescriptionNotes
_idUUIDid

Return type

SentEmailDto

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 ]

getSentEmailHTMLContent

    open class func getSentEmailHTMLContent( _id: UUID) -> Promise<String>

Get sent email HTML content

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 _id = 987 // UUID | id

// Get sent email HTML content
SentEmailsControllerAPI.getSentEmailHTMLContent(_id: _id).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

NameTypeDescriptionNotes
_idUUIDid

Return type

String

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/html

[Back to top] [Back to API list] [Back to Model list] [Back to ]

getSentEmailTrackingPixels

    open class func getSentEmailTrackingPixels( _id: UUID,  before: Date? = nil,  page: Int? = nil,  searchFilter: String? = nil,  since: Date? = nil,  size: Int? = nil,  sort: Sort_getSentEmailTrackingPixels? = nil) -> Promise<PageTrackingPixelProjection>

Get all tracking pixels for a sent email 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 _id = 987 // UUID | id
let before = Date() // Date | Filter by created at before the given timestamp (optional)
let page = 987 // Int | Optional page  in sent email tracking pixel list pagination (optional) (default to 0)
let searchFilter = "searchFilter_example" // String | Optional search filter (optional)
let since = Date() // Date | Filter by created at after the given timestamp (optional)
let size = 987 // Int | Optional page size in sent email tracking pixel list pagination (optional) (default to 20)
let sort = "sort_example" // String | Optional createdAt sort direction ASC or DESC (optional) (default to .asc)

// Get all tracking pixels for a sent email in paginated form
SentEmailsControllerAPI.getSentEmailTrackingPixels(_id: _id, before: before, page: page, searchFilter: searchFilter, since: since, size: size, sort: sort).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

NameTypeDescriptionNotes
_idUUIDid
beforeDateFilter by created at before the given timestamp[optional]
pageIntOptional page in sent email tracking pixel list pagination[optional] [default to 0]
searchFilterStringOptional search filter[optional]
sinceDateFilter by created at after the given timestamp[optional]
sizeIntOptional page size in sent email tracking pixel list pagination[optional] [default to 20]
sortStringOptional createdAt sort direction ASC or DESC[optional] [default to .asc]

Return type

PageTrackingPixelProjection

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 ]

getSentEmails

    open class func getSentEmails( before: Date? = nil,  inboxId: UUID? = nil,  page: Int? = nil,  searchFilter: String? = nil,  since: Date? = nil,  size: Int? = nil,  sort: Sort_getSentEmails? = nil) -> Promise<PageSentEmailProjection>

Get all sent emails 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 before = Date() // Date | Filter by created at before the given timestamp (optional)
let inboxId = 987 // UUID | Optional inboxId to filter sender of sent emails by (optional)
let page = 987 // Int | Optional page  in inbox sent email list pagination (optional) (default to 0)
let searchFilter = "searchFilter_example" // String | Optional search filter (optional)
let since = Date() // Date | Filter by created at after the given timestamp (optional)
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)

// Get all sent emails in paginated form
SentEmailsControllerAPI.getSentEmails(before: before, inboxId: inboxId, page: page, searchFilter: searchFilter, since: since, size: size, sort: sort).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

NameTypeDescriptionNotes
beforeDateFilter by created at before the given timestamp[optional]
inboxIdUUIDOptional inboxId to filter sender of sent emails by[optional]
pageIntOptional page in inbox sent email list pagination[optional] [default to 0]
searchFilterStringOptional search filter[optional]
sinceDateFilter by created at after the given timestamp[optional]
sizeIntOptional page size in inbox sent email list pagination[optional] [default to 20]
sortStringOptional createdAt sort direction ASC or DESC[optional] [default to .asc]

Return type

PageSentEmailProjection

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 ]

getSentOrganizationEmails

    open class func getSentOrganizationEmails( before: Date? = nil,  inboxId: UUID? = nil,  page: Int? = nil,  searchFilter: String? = nil,  since: Date? = nil,  size: Int? = nil,  sort: Sort_getSentOrganizationEmails? = nil) -> Promise<PageSentEmailProjection>

Get all sent organization emails 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 before = Date() // Date | Filter by created at before the given timestamp (optional)
let inboxId = 987 // UUID | Optional inboxId to filter sender of sent emails by (optional)
let page = 987 // Int | Optional page  in sent email list pagination (optional) (default to 0)
let searchFilter = "searchFilter_example" // String | Optional search filter (optional)
let since = Date() // Date | Filter by created at after the given timestamp (optional)
let size = 987 // Int | Optional page size in sent email list pagination (optional) (default to 20)
let sort = "sort_example" // String | Optional createdAt sort direction ASC or DESC (optional) (default to .asc)

// Get all sent organization emails in paginated form
SentEmailsControllerAPI.getSentOrganizationEmails(before: before, inboxId: inboxId, page: page, searchFilter: searchFilter, since: since, size: size, sort: sort).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

NameTypeDescriptionNotes
beforeDateFilter by created at before the given timestamp[optional]
inboxIdUUIDOptional inboxId to filter sender of sent emails by[optional]
pageIntOptional page in sent email list pagination[optional] [default to 0]
searchFilterStringOptional search filter[optional]
sinceDateFilter by created at after the given timestamp[optional]
sizeIntOptional page size in sent email list pagination[optional] [default to 20]
sortStringOptional createdAt sort direction ASC or DESC[optional] [default to .asc]

Return type

PageSentEmailProjection

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 ]