getExpiredInboxesWithHttpInfo method

Future<Response> getExpiredInboxesWithHttpInfo({
  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

Note: This method returns the HTTP Response.

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<Response> getExpiredInboxesWithHttpInfo({ int? page, int? size, String? sort, DateTime? since, DateTime? before, }) async {
  // ignore: prefer_const_declarations
  final path = r'/expired';

  // ignore: prefer_final_locals
  Object? postBody;

  final queryParams = <QueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  if (page != null) {
    queryParams.addAll(_queryParams('', 'page', page));
  }
  if (size != null) {
    queryParams.addAll(_queryParams('', 'size', size));
  }
  if (sort != null) {
    queryParams.addAll(_queryParams('', 'sort', sort));
  }
  if (since != null) {
    queryParams.addAll(_queryParams('', 'since', since));
  }
  if (before != null) {
    queryParams.addAll(_queryParams('', 'before', before));
  }

  const contentTypes = <String>[];


  return apiClient.invokeAPI(
    path,
    'GET',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}