Constructor Detail

• InboxForwarderControllerApi

  InboxForwarderControllerApi(String xApiKey, String basePath)

Method Detail

• getBaseUrl

   final String getBaseUrl()

• createNewInboxForwarder

   final InboxForwarderDto createNewInboxForwarder(CreateInboxForwarderOptions createInboxForwarderOptions, UUID inboxId)

  Create an inbox forwarder Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

  Parameters:

  createInboxForwarderOptions - createInboxForwarderOptions

  inboxId - Inbox id to attach forwarder to (optional)

• createNewInboxForwarderRequestConfig

   final RequestConfig createNewInboxForwarderRequestConfig(CreateInboxForwarderOptions createInboxForwarderOptions, UUID inboxId)

  To obtain the request config of the operation createNewInboxForwarder

  Parameters:

  createInboxForwarderOptions - createInboxForwarderOptions

  inboxId - Inbox id to attach forwarder to (optional)

• deleteInboxForwarder

   final Unit deleteInboxForwarder(UUID id)

  Delete an inbox forwarder Delete inbox forwarder

  Parameters:

  id - ID of inbox forwarder

• deleteInboxForwarderRequestConfig

   final RequestConfig deleteInboxForwarderRequestConfig(UUID id)

  To obtain the request config of the operation deleteInboxForwarder

  Parameters:

  id - ID of inbox forwarder

• deleteInboxForwarders

   final Unit deleteInboxForwarders(UUID inboxId)

  Delete inbox forwarders Delete inbox forwarders. Accepts optional inboxId filter.

  Parameters:

  inboxId - Optional inbox id to attach forwarder to (optional)

• deleteInboxForwardersRequestConfig

   final RequestConfig deleteInboxForwardersRequestConfig(UUID inboxId)

  To obtain the request config of the operation deleteInboxForwarders

  Parameters:

  inboxId - Optional inbox id to attach forwarder to (optional)

• getInboxForwarder

   final InboxForwarderDto getInboxForwarder(UUID id)

  Get an inbox forwarder Get inbox ruleset

  Parameters:

  id - ID of inbox forwarder

• getInboxForwarderRequestConfig

   final RequestConfig getInboxForwarderRequestConfig(UUID id)

  To obtain the request config of the operation getInboxForwarder

  Parameters:

  id - ID of inbox forwarder

• getInboxForwarders

   final PageInboxForwarderDto getInboxForwarders(OffsetDateTime before, UUID inboxId, Integer page, String searchFilter, OffsetDateTime since, Integer size, String sort)

  List inbox forwarders List all forwarders attached to an inbox

  Parameters:

  before - Filter by created at before the given timestamp (optional)

  inboxId - Optional inbox id to get forwarders from (optional)

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

  searchFilter - Optional search filter (optional)

  since - Filter by created at after the given timestamp (optional)

  size - Optional page size in inbox forwarder list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

• getInboxForwardersRequestConfig

   final RequestConfig getInboxForwardersRequestConfig(OffsetDateTime before, UUID inboxId, Integer page, String searchFilter, OffsetDateTime since, Integer size, String sort)

  To obtain the request config of the operation getInboxForwarders

  Parameters:

  before - Filter by created at before the given timestamp (optional)

  inboxId - Optional inbox id to get forwarders from (optional)

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

  searchFilter - Optional search filter (optional)

  since - Filter by created at after the given timestamp (optional)

  size - Optional page size in inbox forwarder list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

• testInboxForwarder

   final InboxForwarderTestResult testInboxForwarder(UUID id, InboxForwarderTestOptions inboxForwarderTestOptions)

  Test an inbox forwarder Test an inbox forwarder

  Parameters:

  id - ID of inbox forwarder

  inboxForwarderTestOptions - inboxForwarderTestOptions

• testInboxForwarderRequestConfig

   final RequestConfig testInboxForwarderRequestConfig(UUID id, InboxForwarderTestOptions inboxForwarderTestOptions)

  To obtain the request config of the operation testInboxForwarder

  Parameters:

  id - ID of inbox forwarder

  inboxForwarderTestOptions - inboxForwarderTestOptions

• testInboxForwardersForInbox

   final InboxForwarderTestResult testInboxForwardersForInbox(UUID inboxId, InboxForwarderTestOptions inboxForwarderTestOptions)

  Test inbox forwarders for inbox Test inbox forwarders for inbox

  Parameters:

  inboxId - ID of inbox

  inboxForwarderTestOptions - inboxForwarderTestOptions

• testInboxForwardersForInboxRequestConfig

   final RequestConfig testInboxForwardersForInboxRequestConfig(UUID inboxId, InboxForwarderTestOptions inboxForwarderTestOptions)

  To obtain the request config of the operation testInboxForwardersForInbox

  Parameters:

  inboxId - ID of inbox

  inboxForwarderTestOptions - inboxForwarderTestOptions

• testNewInboxForwarder

   final InboxForwarderTestResult testNewInboxForwarder(TestNewInboxForwarderOptions testNewInboxForwarderOptions)

  Test new inbox forwarder Test new inbox forwarder

  Parameters:

  testNewInboxForwarderOptions - testNewInboxForwarderOptions

• testNewInboxForwarderRequestConfig

   final RequestConfig testNewInboxForwarderRequestConfig(TestNewInboxForwarderOptions testNewInboxForwarderOptions)

  To obtain the request config of the operation testNewInboxForwarder

  Parameters:

  testNewInboxForwarderOptions - testNewInboxForwarderOptions