Skip to content

\SentEmailsControllerApi

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

Method HTTP request Description
delete_all_sent_emails delete /sent Delete all sent email receipts
delete_sent_email delete /sent/{id} Delete sent email receipt
get_all_sent_tracking_pixels get /sent/tracking-pixels
get_raw_sent_email_contents get /sent/{emailId}/raw Get raw sent email string. Returns unparsed raw SMTP message with headers and body.
get_raw_sent_email_json get /sent/{emailId}/raw/json Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format.
get_sent_email get /sent/{id} Get sent email receipt
get_sent_email_html_content get /sent/{id}/html Get sent email HTML content
get_sent_email_preview_urls get /sent/{id}/urls Get sent email URL for viewing in browser or downloading
get_sent_email_tracking_pixels get /sent/{id}/tracking-pixels
get_sent_emails get /sent Get all sent emails in paginated form
get_sent_organization_emails get /sent/organization

delete_all_sent_emails

delete_all_sent_emails() Delete all sent email receipts

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

delete_sent_email

delete_sent_email(id) Delete sent email receipt

Parameters

Name Type Description Required Notes
id String [required]

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

get_all_sent_tracking_pixels

crate::models::PageTrackingPixelProjection get_all_sent_tracking_pixels(page, size, sort, search_filter, since, before)

Get all sent email tracking pixels in paginated form

Parameters

Name Type Description Required Notes
page Option<i32> Optional page in sent email tracking pixel list pagination [default to 0]
size Option<i32> Optional page size in sent email tracking pixel list pagination [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
search_filter Option<String> Optional search filter
since Option<String> Filter by created at after the given timestamp
before Option<String> Filter by created at before the given timestamp

Return type

crate::models::PageTrackingPixelProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

get_raw_sent_email_contents

String get_raw_sent_email_contents(email_id) 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

Parameters

Name Type Description Required Notes
email_id String ID of email [required]

Return type

String

Authorization

API_KEY

HTTP request headers

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

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

get_raw_sent_email_json

crate::models::RawEmailJson get_raw_sent_email_json(email_id) 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

Parameters

Name Type Description Required Notes
email_id String ID of email [required]

Return type

crate::models::RawEmailJson

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

get_sent_email

crate::models::SentEmailDto get_sent_email(id) Get sent email receipt

Parameters

Name Type Description Required Notes
id String [required]

Return type

crate::models::SentEmailDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

get_sent_email_html_content

String get_sent_email_html_content(id) Get sent email HTML content

Parameters

Name Type Description Required Notes
id String [required]

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 ]

get_sent_email_preview_urls

crate::models::EmailPreviewUrls get_sent_email_preview_urls(id) 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.

Parameters

Name Type Description Required Notes
id String [required]

Return type

crate::models::EmailPreviewUrls

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

get_sent_email_tracking_pixels

crate::models::PageTrackingPixelProjection get_sent_email_tracking_pixels(id, page, size, sort, search_filter, since, before)

Get all tracking pixels for a sent email in paginated form

Parameters

Name Type Description Required Notes
id String [required]
page Option<i32> Optional page in sent email tracking pixel list pagination [default to 0]
size Option<i32> Optional page size in sent email tracking pixel list pagination [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
search_filter Option<String> Optional search filter
since Option<String> Filter by created at after the given timestamp
before Option<String> Filter by created at before the given timestamp

Return type

crate::models::PageTrackingPixelProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

get_sent_emails

crate::models::PageSentEmailProjection get_sent_emails(inbox_id, page, size, sort, search_filter, since, before) Get all sent emails in paginated form

Parameters

Name Type Description Required Notes
inbox_id Option<String> Optional inboxId to filter sender of sent emails by
page Option<i32> Optional page in inbox sent email list pagination [default to 0]
size Option<i32> Optional page size in inbox sent email list pagination [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
search_filter Option<String> Optional search filter
since Option<String> Filter by created at after the given timestamp
before Option<String> Filter by created at before the given timestamp

Return type

crate::models::PageSentEmailProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

get_sent_organization_emails

crate::models::PageSentEmailProjection get_sent_organization_emails(inbox_id, page, size, sort, search_filter, since, before)

Get all sent organization emails in paginated form

Parameters

Name Type Description Required Notes
inbox_id Option<String> Optional inboxId to filter sender of sent emails by
page Option<i32> Optional page in sent email list pagination [default to 0]
size Option<i32> Optional page size in sent email list pagination [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
search_filter Option<String> Optional search filter
since Option<String> Filter by created at after the given timestamp
before Option<String> Filter by created at before the given timestamp

Return type

crate::models::PageSentEmailProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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