Constructor Detail

• BounceControllerApi

  BounceControllerApi(String xApiKey, String basePath)

Method Detail

• getBaseUrl

   final String getBaseUrl()

• getBouncedEmail

   final BouncedEmailDto getBouncedEmail(UUID id)

  Get a bounced email. Bounced emails are email you have sent that were rejected by a recipient

  Parameters:

  id - ID of the bounced email to fetch

• getBouncedEmailRequestConfig

   final RequestConfig getBouncedEmailRequestConfig(UUID id)

  To obtain the request config of the operation getBouncedEmail

  Parameters:

  id - ID of the bounced email to fetch

• getBouncedEmails

   final PageBouncedEmail getBouncedEmails(OffsetDateTime before, Integer page, OffsetDateTime since, Integer size, String sort)

  Get paginated list of bounced emails. Bounced emails are email you have sent that were rejected by a recipient

  Parameters:

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

  page - Optional page index (optional, default to 0)

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

  size - Optional page size (optional, default to 20)

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

• getBouncedEmailsRequestConfig

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

  To obtain the request config of the operation getBouncedEmails

  Parameters:

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

  page - Optional page index (optional, default to 0)

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

  size - Optional page size (optional, default to 20)

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

• getBouncedRecipient

   final BouncedRecipientDto getBouncedRecipient(UUID id)

  Get a bounced email. Bounced emails are email you have sent that were rejected by a recipient

  Parameters:

  id - ID of the bounced recipient

• getBouncedRecipientRequestConfig

   final RequestConfig getBouncedRecipientRequestConfig(UUID id)

  To obtain the request config of the operation getBouncedRecipient

  Parameters:

  id - ID of the bounced recipient

• getBouncedRecipients

   final PageBouncedRecipients getBouncedRecipients(OffsetDateTime before, Integer page, OffsetDateTime since, Integer size, String sort)

  Get paginated list of bounced recipients. Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address.

  Parameters:

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

  page - Optional page index (optional, default to 0)

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

  size - Optional page size (optional, default to 20)

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

• getBouncedRecipientsRequestConfig

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

  To obtain the request config of the operation getBouncedRecipients

  Parameters:

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

  page - Optional page index (optional, default to 0)

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

  size - Optional page size (optional, default to 20)

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