getExpiredInboxes method

Future<PageExpiredInboxRecordProjection?> getExpiredInboxes({
  1. int? page,
  2. int? size,
  3. String? sort,
  4. DateTime? since,
  5. DateTime? before,
})

List records of expired inboxes

Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties

Parameters:

  • int page: Optional page index in inbox sent email list pagination

  • int size: Optional page size in inbox sent email list pagination

  • 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<PageExpiredInboxRecordProjection?> getExpiredInboxes({ int? page, int? size, String? sort, DateTime? since, DateTime? before, }) async {
  final response = await getExpiredInboxesWithHttpInfo( 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), 'PageExpiredInboxRecordProjection',) as PageExpiredInboxRecordProjection;

  }
  return null;
}