Constructor Detail

• ExpiredControllerApi

  ExpiredControllerApi(String xApiKey, String basePath)

Method Detail

• getBaseUrl

   final String getBaseUrl()

• getExpirationDefaults

   final ExpirationDefaults getExpirationDefaults()

  Get default expiration settings Return default times used for inbox expiration

• getExpirationDefaultsRequestConfig

   final RequestConfig getExpirationDefaultsRequestConfig()

  To obtain the request config of the operation getExpirationDefaults

• getExpiredInboxByInboxId

   final ExpiredInboxDto getExpiredInboxByInboxId(UUID inboxId)

  Get expired inbox record for a previously existing inbox Use the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxId

  Parameters:

  inboxId - ID of inbox you want to retrieve (not the inbox ID)

• getExpiredInboxByInboxIdRequestConfig

   final RequestConfig getExpiredInboxByInboxIdRequestConfig(UUID inboxId)

  To obtain the request config of the operation getExpiredInboxByInboxId

  Parameters:

  inboxId - ID of inbox you want to retrieve (not the inbox ID)

• getExpiredInboxRecord

   final ExpiredInboxDto getExpiredInboxRecord(UUID expiredId)

  Get an expired inbox record Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties

  Parameters:

  expiredId - ID of the ExpiredInboxRecord you want to retrieve.

• getExpiredInboxRecordRequestConfig

   final RequestConfig getExpiredInboxRecordRequestConfig(UUID expiredId)

  To obtain the request config of the operation getExpiredInboxRecord

  Parameters:

  expiredId - ID of the ExpiredInboxRecord you want to retrieve.

• getExpiredInboxes

   final PageExpiredInboxRecordProjection getExpiredInboxes(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime 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:

  page - Optional page index in inbox sent email list pagination (optional, default to 0)

  size - Optional page size in inbox sent email list pagination (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)

• getExpiredInboxesRequestConfig

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

  To obtain the request config of the operation getExpiredInboxes

  Parameters:

  page - Optional page index in inbox sent email list pagination (optional, default to 0)

  size - Optional page size in inbox sent email list pagination (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)