Skip to content

MailSlurp\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.
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
GetSentOrganizationEmails Get /sent/organization

DeleteAllSentEmails

DeleteAllSentEmails(ctx, )

Delete all sent email receipts

Required 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 ]

DeleteSentEmail

DeleteSentEmail(ctx, id)

Delete sent email receipt

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

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 ]

GetAllSentTrackingPixels

PageTrackingPixelProjection GetAllSentTrackingPixels(ctx, optional)

Get all sent email tracking pixels in paginated form

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *GetAllSentTrackingPixelsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAllSentTrackingPixelsOpts struct

Name Type Description Notes
page optional.Int32 Optional page in sent email tracking pixel list pagination [default to 0]
size optional.Int32 Optional page size in sent email tracking pixel list pagination [default to 20]
sort optional.String Optional createdAt sort direction ASC or DESC [default to ASC]
searchFilter optional.String Optional search filter
since optional.Time Filter by created at after the given timestamp
before optional.Time Filter by created at before the given timestamp

Return type

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 ]

GetRawSentEmailContents

string GetRawSentEmailContents(ctx, emailId)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
emailId string ID of email

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 ]

GetRawSentEmailJson

RawEmailJson GetRawSentEmailJson(ctx, emailId)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
emailId string ID of email

Return type

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 ]

GetSentEmail

SentEmailDto GetSentEmail(ctx, id)

Get sent email receipt

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

Return type

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 ]

GetSentEmailHTMLContent

string GetSentEmailHTMLContent(ctx, id)

Get sent email HTML content

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

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 ]

GetSentEmailPreviewURLs

EmailPreviewUrls GetSentEmailPreviewURLs(ctx, 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.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

Return type

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 ]

GetSentEmailTrackingPixels

PageTrackingPixelProjection GetSentEmailTrackingPixels(ctx, id, optional)

Get all tracking pixels for a sent email in paginated form

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string
optional *GetSentEmailTrackingPixelsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetSentEmailTrackingPixelsOpts struct

Name Type Description Notes

page | optional.Int32| Optional page in sent email tracking pixel list pagination | [default to 0] size | optional.Int32| Optional page size in sent email tracking pixel list pagination | [default to 20] sort | optional.String| Optional createdAt sort direction ASC or DESC | [default to ASC] searchFilter | optional.String| Optional search filter | since | optional.Time| Filter by created at after the given timestamp | before | optional.Time| Filter by created at before the given timestamp |

Return type

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 ]

GetSentEmails

PageSentEmailProjection GetSentEmails(ctx, optional)

Get all sent emails in paginated form

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *GetSentEmailsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetSentEmailsOpts struct

Name Type Description Notes
inboxId optional.Interface of string Optional inboxId to filter sender of sent emails by
page optional.Int32 Optional page in inbox sent email list pagination [default to 0]
size optional.Int32 Optional page size in inbox sent email list pagination [default to 20]
sort optional.String Optional createdAt sort direction ASC or DESC [default to ASC]
searchFilter optional.String Optional search filter
since optional.Time Filter by created at after the given timestamp
before optional.Time Filter by created at before the given timestamp

Return type

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 ]

GetSentOrganizationEmails

PageSentEmailProjection GetSentOrganizationEmails(ctx, optional)

Get all sent organization emails in paginated form

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *GetSentOrganizationEmailsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetSentOrganizationEmailsOpts struct

Name Type Description Notes
inboxId optional.Interface of string Optional inboxId to filter sender of sent emails by
page optional.Int32 Optional page in sent email list pagination [default to 0]
size optional.Int32 Optional page size in sent email list pagination [default to 20]
sort optional.String Optional createdAt sort direction ASC or DESC [default to ASC]
searchFilter optional.String Optional search filter
since optional.Time Filter by created at after the given timestamp
before optional.Time Filter by created at before the given timestamp

Return type

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 ]