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)

• 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

• 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)

• 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)