Constructor Detail

• SentEmailsControllerApi

  SentEmailsControllerApi(String xApiKey, String basePath)

Method Detail

• getBaseUrl

   final String getBaseUrl()

• deleteAllSentEmails

   final Unit deleteAllSentEmails()

  Delete all sent email receipts

• deleteAllSentEmailsRequestConfig

   final RequestConfig deleteAllSentEmailsRequestConfig()

  To obtain the request config of the operation deleteAllSentEmails

• deleteSentEmail

   final Unit deleteSentEmail(UUID id)

  Delete sent email receipt

• deleteSentEmailRequestConfig

   final RequestConfig deleteSentEmailRequestConfig(UUID id)

  To obtain the request config of the operation deleteSentEmail

• getAllSentTrackingPixels

   final PageTrackingPixelProjection getAllSentTrackingPixels(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before)

  Get all sent email tracking pixels in paginated form

  Parameters:

  page - Optional page index in sent email tracking pixel list pagination (optional, default to 0)

  size - Optional page size in sent email tracking pixel list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  searchFilter - Optional search filter (optional)

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)

• getAllSentTrackingPixelsRequestConfig

   final RequestConfig getAllSentTrackingPixelsRequestConfig(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before)

  To obtain the request config of the operation getAllSentTrackingPixels

  Parameters:

  page - Optional page index in sent email tracking pixel list pagination (optional, default to 0)

  size - Optional page size in sent email tracking pixel list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  searchFilter - Optional search filter (optional)

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)

• getRawSentEmailContents

   final String getRawSentEmailContents(UUID 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

  Parameters:

  emailId - ID of email

• getRawSentEmailContentsRequestConfig

   final RequestConfig getRawSentEmailContentsRequestConfig(UUID emailId)

  To obtain the request config of the operation getRawSentEmailContents

  Parameters:

  emailId - ID of email

• getRawSentEmailJson

   final RawEmailJson getRawSentEmailJson(UUID 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

  Parameters:

  emailId - ID of email

• getRawSentEmailJsonRequestConfig

   final RequestConfig getRawSentEmailJsonRequestConfig(UUID emailId)

  To obtain the request config of the operation getRawSentEmailJson

  Parameters:

  emailId - ID of email

• getSentDeliveryStatus

   final DeliveryStatusDto getSentDeliveryStatus(UUID deliveryId)

  Get a sent email delivery status

• getSentDeliveryStatusRequestConfig

   final RequestConfig getSentDeliveryStatusRequestConfig(UUID deliveryId)

  To obtain the request config of the operation getSentDeliveryStatus

• getSentDeliveryStatuses

   final PageDeliveryStatus getSentDeliveryStatuses(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)

  Get all sent email delivery statuses

  Parameters:

  page - Optional page index in delivery status list pagination (optional, default to 0)

  size - Optional page size in delivery status list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)

• getSentDeliveryStatusesRequestConfig

   final RequestConfig getSentDeliveryStatusesRequestConfig(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)

  To obtain the request config of the operation getSentDeliveryStatuses

  Parameters:

  page - Optional page index in delivery status list pagination (optional, default to 0)

  size - Optional page size in delivery status list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)

• getSentDeliveryStatusesBySentId

   final PageDeliveryStatus getSentDeliveryStatusesBySentId(UUID sentId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)

  Get all sent email delivery statuses

  Parameters:

  page - Optional page index in delivery status list pagination (optional, default to 0)

  size - Optional page size in delivery status list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)

• getSentDeliveryStatusesBySentIdRequestConfig

   final RequestConfig getSentDeliveryStatusesBySentIdRequestConfig(UUID sentId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)

  To obtain the request config of the operation getSentDeliveryStatusesBySentId

  Parameters:

  page - Optional page index in delivery status list pagination (optional, default to 0)

  size - Optional page size in delivery status list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)

• getSentEmail

   final SentEmailDto getSentEmail(UUID id)

  Get sent email receipt

• getSentEmailRequestConfig

   final RequestConfig getSentEmailRequestConfig(UUID id)

  To obtain the request config of the operation getSentEmail

• getSentEmailHTMLContent

   final String getSentEmailHTMLContent(UUID id)

  Get sent email HTML content

• getSentEmailHTMLContentRequestConfig

   final RequestConfig getSentEmailHTMLContentRequestConfig(UUID id)

  To obtain the request config of the operation getSentEmailHTMLContent

• getSentEmailPreviewURLs

   final EmailPreviewUrls getSentEmailPreviewURLs(UUID 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.

• getSentEmailPreviewURLsRequestConfig

   final RequestConfig getSentEmailPreviewURLsRequestConfig(UUID id)

  To obtain the request config of the operation getSentEmailPreviewURLs

• getSentEmailTrackingPixels

   final PageTrackingPixelProjection getSentEmailTrackingPixels(UUID id, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before)

  Get all tracking pixels for a sent email in paginated form

  Parameters:

  page - Optional page index in sent email tracking pixel list pagination (optional, default to 0)

  size - Optional page size in sent email tracking pixel list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  searchFilter - Optional search filter (optional)

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)

• getSentEmailTrackingPixelsRequestConfig

   final RequestConfig getSentEmailTrackingPixelsRequestConfig(UUID id, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before)

  To obtain the request config of the operation getSentEmailTrackingPixels

  Parameters:

  page - Optional page index in sent email tracking pixel list pagination (optional, default to 0)

  size - Optional page size in sent email tracking pixel list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  searchFilter - Optional search filter (optional)

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)

• getSentEmails

   final PageSentEmailProjection getSentEmails(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before)

  Get all sent emails in paginated form

  Parameters:

  inboxId - Optional inboxId to filter sender of sent emails by (optional)

  page - Optional page index in inbox sent email list pagination (optional, default to 0)

  size - Optional page size in inbox sent email list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  searchFilter - Optional search filter (optional)

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)

• getSentEmailsRequestConfig

   final RequestConfig getSentEmailsRequestConfig(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before)

  To obtain the request config of the operation getSentEmails

  Parameters:

  inboxId - Optional inboxId to filter sender of sent emails by (optional)

  page - Optional page index in inbox sent email list pagination (optional, default to 0)

  size - Optional page size in inbox sent email list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  searchFilter - Optional search filter (optional)

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)

• getSentEmailsWithQueueResults

   final PageSentEmailWithQueueProjection getSentEmailsWithQueueResults(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)

  Get results of email sent with queues in paginated form

  Parameters:

  page - Optional page index in inbox sent email list pagination (optional, default to 0)

  size - Optional page size in inbox sent email list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)

• getSentEmailsWithQueueResultsRequestConfig

   final RequestConfig getSentEmailsWithQueueResultsRequestConfig(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)

  To obtain the request config of the operation getSentEmailsWithQueueResults

  Parameters:

  page - Optional page index in inbox sent email list pagination (optional, default to 0)

  size - Optional page size in inbox sent email list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)

• getSentOrganizationEmails

   final PageSentEmailProjection getSentOrganizationEmails(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before)

  Get all sent organization emails in paginated form

  Parameters:

  inboxId - Optional inboxId to filter sender of sent emails by (optional)

  page - Optional page index in sent email list pagination (optional, default to 0)

  size - Optional page size in sent email list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  searchFilter - Optional search filter (optional)

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)

• getSentOrganizationEmailsRequestConfig

   final RequestConfig getSentOrganizationEmailsRequestConfig(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before)

  To obtain the request config of the operation getSentOrganizationEmails

  Parameters:

  inboxId - Optional inboxId to filter sender of sent emails by (optional)

  page - Optional page index in sent email list pagination (optional, default to 0)

  size - Optional page size in sent email list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  searchFilter - Optional search filter (optional)

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)

• waitForDeliveryStatuses

   final DeliveryStatusDto waitForDeliveryStatuses(UUID sentId, UUID inboxId, Long timeout, Integer index, OffsetDateTime since, OffsetDateTime before)

  Wait for delivery statuses

  Parameters:

  sentId - Optional sent email ID filter (optional)

  inboxId - Optional inbox ID filter (optional)

  timeout - Optional timeout milliseconds (optional)

  index - Zero based index of the delivery status to wait for.

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)

• waitForDeliveryStatusesRequestConfig

   final RequestConfig waitForDeliveryStatusesRequestConfig(UUID sentId, UUID inboxId, Long timeout, Integer index, OffsetDateTime since, OffsetDateTime before)

  To obtain the request config of the operation waitForDeliveryStatuses

  Parameters:

  sentId - Optional sent email ID filter (optional)

  inboxId - Optional inbox ID filter (optional)

  timeout - Optional timeout milliseconds (optional)

  index - Zero based index of the delivery status to wait for.

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)