getInboxEmailsPaginated method

Future<PageEmailPreview?> getInboxEmailsPaginated(
  1. String inboxId, {
  2. int? page,
  3. int? size,
  4. String? sort,
  5. DateTime? since,
  6. DateTime? before,
})

Get inbox emails paginated

Get a paginated list of emails in an inbox. Does not hold connections open.

Parameters:

  • String inboxId (required): Id of inbox that emails belongs to

  • int page: Optional page index in inbox emails list pagination

  • int size: Optional page size in inbox emails list pagination

  • String sort: Optional createdAt sort direction ASC or DESC

  • DateTime since: Optional filter by received after given date time

  • DateTime before: Optional filter by received before given date time

Implementation

Future<PageEmailPreview?> getInboxEmailsPaginated(String inboxId, { int? page, int? size, String? sort, DateTime? since, DateTime? before, }) async {
  final response = await getInboxEmailsPaginatedWithHttpInfo(inboxId,  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), 'PageEmailPreview',) as PageEmailPreview;

  }
  return null;
}