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(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)

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

  Parameters:

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

  size - Optional page size (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)

• getBouncedEmailsRequestConfig

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

  To obtain the request config of the operation getBouncedEmails

  Parameters:

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

  size - Optional page size (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)

• 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(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)

  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:

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

  size - Optional page size (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)

• getBouncedRecipientsRequestConfig

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

  To obtain the request config of the operation getBouncedRecipients

  Parameters:

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

  size - Optional page size (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)