getBouncedRecipients method

Future<PageBouncedRecipients?> getBouncedRecipients({
  1. int? page,
  2. int? size,
  3. String? sort,
  4. DateTime? since,
  5. DateTime? 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:

  • int page: Optional page index

  • int size: Optional page size

  • String sort: Optional createdAt sort direction ASC or DESC

  • DateTime since: Filter by created at after the given timestamp

  • DateTime before: Filter by created at before the given timestamp

Implementation

Future<PageBouncedRecipients?> getBouncedRecipients({ int? page, int? size, String? sort, DateTime? since, DateTime? before, }) async {
  final response = await getBouncedRecipientsWithHttpInfo( page: page, size: size, sort: sort, since: since, before: before, );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'PageBouncedRecipients',) as PageBouncedRecipients;

  }
  return null;
}