MailSlurpAPI.Api.SentEmailsController (mailslurp v15.14.0)

API calls for all endpoints tagged SentEmailsController.

Link to this section Summary

Functions

Delete all sent email receipts

Get all sent email tracking pixels in paginated form

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

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

Get all sent email delivery statuses

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.

Get all tracking pixels for a sent email in paginated form

Get all sent emails in paginated form

Get results of email sent with queues in paginated form

Get all sent organization emails in paginated form

Link to this section Functions

Link to this function

delete_all_sent_emails(connection, opts \\ [])

@spec delete_all_sent_emails(Tesla.Env.client(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Delete all sent email receipts

parameters

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

} on success {:error, info} on failure

Link to this function

delete_sent_email(connection, id, opts \\ [])

@spec delete_sent_email(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Delete sent email receipt

parameters

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • id (String.t):
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

} on success {:error, info} on failure

Link to this function

get_all_sent_tracking_pixels(connection, opts \\ [])

@spec get_all_sent_tracking_pixels(Tesla.Env.client(), keyword()) ::
  {:ok, MailSlurpAPI.Model.PageTrackingPixelProjection.t()}
  | {:error, Tesla.Env.t()}

Get all sent email tracking pixels in paginated form

parameters

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :page (integer()): Optional page index in sent email tracking pixel list pagination
    • :size (integer()): Optional page size in sent email tracking pixel list pagination
    • :sort (String.t): Optional createdAt sort direction ASC or DESC
    • :search_filter (String.t): Optional search filter
    • :since (DateTime.t): Filter by created at after the given timestamp
    • :before (DateTime.t): Filter by created at before the given timestamp

returns

Returns

} on success {:error, info} on failure

Link to this function

get_raw_sent_email_contents(connection, email_id, opts \\ [])

@spec get_raw_sent_email_contents(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, String.t()} | {:error, Tesla.Env.t()}

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

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • email_id (String.t): ID of email
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

} on success {:error, info} on failure

Link to this function

get_raw_sent_email_json(connection, email_id, opts \\ [])

@spec get_raw_sent_email_json(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, MailSlurpAPI.Model.RawEmailJson.t()} | {:error, Tesla.Env.t()}

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

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • email_id (String.t): ID of email
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

} on success {:error, info} on failure

Link to this function

get_sent_delivery_status(connection, delivery_id, opts \\ [])

@spec get_sent_delivery_status(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, MailSlurpAPI.Model.DeliveryStatusDto.t()} | {:error, Tesla.Env.t()}

Get a sent email delivery status

parameters

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • delivery_id (String.t):
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

} on success {:error, info} on failure

Link to this function

get_sent_delivery_statuses(connection, opts \\ [])

@spec get_sent_delivery_statuses(Tesla.Env.client(), keyword()) ::
  {:ok, MailSlurpAPI.Model.PageDeliveryStatus.t()} | {:error, Tesla.Env.t()}

Get all sent email delivery statuses

parameters

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :page (integer()): Optional page index in delivery status list pagination
    • :size (integer()): Optional page size in delivery status list pagination
    • :sort (String.t): Optional createdAt sort direction ASC or DESC
    • :since (DateTime.t): Filter by created at after the given timestamp
    • :before (DateTime.t): Filter by created at before the given timestamp

returns

Returns

} on success {:error, info} on failure

Link to this function

get_sent_delivery_statuses_by_sent_id(connection, sent_id, opts \\ [])

@spec get_sent_delivery_statuses_by_sent_id(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, MailSlurpAPI.Model.PageDeliveryStatus.t()} | {:error, Tesla.Env.t()}

Get all sent email delivery statuses

parameters

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • sent_id (String.t):
  • opts (KeywordList): [optional] Optional parameters
    • :page (integer()): Optional page index in delivery status list pagination
    • :size (integer()): Optional page size in delivery status list pagination
    • :sort (String.t): Optional createdAt sort direction ASC or DESC
    • :since (DateTime.t): Filter by created at after the given timestamp
    • :before (DateTime.t): Filter by created at before the given timestamp

returns

Returns

} on success {:error, info} on failure

Link to this function

get_sent_email(connection, id, opts \\ [])

@spec get_sent_email(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, MailSlurpAPI.Model.SentEmailDto.t()} | {:error, Tesla.Env.t()}

Get sent email receipt

parameters

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • id (String.t):
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

} on success {:error, info} on failure

Link to this function

get_sent_email_html_content(connection, id, opts \\ [])

@spec get_sent_email_html_content(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, String.t()} | {:error, Tesla.Env.t()}

Get sent email HTML content

parameters

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • id (String.t):
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

} on success {:error, info} on failure

Link to this function

get_sent_email_preview_ur_ls(connection, id, opts \\ [])

@spec get_sent_email_preview_ur_ls(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, MailSlurpAPI.Model.EmailPreviewUrls.t()} | {:error, Tesla.Env.t()}

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

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • id (String.t):
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

} on success {:error, info} on failure

Link to this function

get_sent_email_tracking_pixels(connection, id, opts \\ [])

@spec get_sent_email_tracking_pixels(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, MailSlurpAPI.Model.PageTrackingPixelProjection.t()}
  | {:error, Tesla.Env.t()}

Get all tracking pixels for a sent email in paginated form

parameters

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • id (String.t):
  • opts (KeywordList): [optional] Optional parameters
    • :page (integer()): Optional page index in sent email tracking pixel list pagination
    • :size (integer()): Optional page size in sent email tracking pixel list pagination
    • :sort (String.t): Optional createdAt sort direction ASC or DESC
    • :search_filter (String.t): Optional search filter
    • :since (DateTime.t): Filter by created at after the given timestamp
    • :before (DateTime.t): Filter by created at before the given timestamp

returns

Returns

} on success {:error, info} on failure

Link to this function

get_sent_emails(connection, opts \\ [])

@spec get_sent_emails(Tesla.Env.client(), keyword()) ::
  {:ok, MailSlurpAPI.Model.PageSentEmailProjection.t()}
  | {:error, Tesla.Env.t()}

Get all sent emails in paginated form

parameters

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :inbox_id (String.t): Optional inboxId to filter sender of sent emails by
    • :page (integer()): Optional page index in inbox sent email list pagination
    • :size (integer()): Optional page size in inbox sent email list pagination
    • :sort (String.t): Optional createdAt sort direction ASC or DESC
    • :search_filter (String.t): Optional search filter
    • :since (DateTime.t): Filter by created at after the given timestamp
    • :before (DateTime.t): Filter by created at before the given timestamp

returns

Returns

} on success {:error, info} on failure

Link to this function

get_sent_emails_with_queue_results(connection, opts \\ [])

@spec get_sent_emails_with_queue_results(Tesla.Env.client(), keyword()) ::
  {:ok, MailSlurpAPI.Model.PageSentEmailWithQueueProjection.t()}
  | {:error, Tesla.Env.t()}

Get results of email sent with queues in paginated form

parameters

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :page (integer()): Optional page index in inbox sent email list pagination
    • :size (integer()): Optional page size in inbox sent email list pagination
    • :sort (String.t): Optional createdAt sort direction ASC or DESC
    • :since (DateTime.t): Filter by created at after the given timestamp
    • :before (DateTime.t): Filter by created at before the given timestamp

returns

Returns

} on success {:error, info} on failure

Link to this function

get_sent_organization_emails(connection, opts \\ [])

@spec get_sent_organization_emails(Tesla.Env.client(), keyword()) ::
  {:ok, MailSlurpAPI.Model.PageSentEmailProjection.t()}
  | {:error, Tesla.Env.t()}

Get all sent organization emails in paginated form

parameters

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :inbox_id (String.t): Optional inboxId to filter sender of sent emails by
    • :page (integer()): Optional page index in sent email list pagination
    • :size (integer()): Optional page size in sent email list pagination
    • :sort (String.t): Optional createdAt sort direction ASC or DESC
    • :search_filter (String.t): Optional search filter
    • :since (DateTime.t): Filter by created at after the given timestamp
    • :before (DateTime.t): Filter by created at before the given timestamp

returns

Returns

} on success {:error, info} on failure

Link to this function

wait_for_delivery_statuses(connection, opts \\ [])

@spec wait_for_delivery_statuses(Tesla.Env.client(), keyword()) ::
  {:ok, MailSlurpAPI.Model.DeliveryStatusDto.t()} | {:error, Tesla.Env.t()}

Wait for delivery statuses

parameters

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :sent_id (String.t): Optional sent email ID filter
    • :inbox_id (String.t): Optional inbox ID filter
    • :timeout (integer()): Optional timeout milliseconds
    • :index (integer()): Zero based index of the delivery status to wait for. If 1 delivery status already and you want to wait for the 2nd pass index=1
    • :since (DateTime.t): Filter by created at after the given timestamp
    • :before (DateTime.t): Filter by created at before the given timestamp

returns

Returns

} on success {:error, info} on failure