Constructor Detail

• InboxRulesetControllerApi

  InboxRulesetControllerApi(String xApiKey, String basePath)

Method Detail

• getBaseUrl

   final String getBaseUrl()

• createNewInboxRuleset

   final InboxRulesetDto createNewInboxRuleset(CreateInboxRulesetOptions createInboxRulesetOptions, UUID inboxId)

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

  Parameters:

  createInboxRulesetOptions - createInboxRulesetOptions

  inboxId - Inbox id to attach ruleset to (optional)

• createNewInboxRulesetRequestConfig

   final RequestConfig createNewInboxRulesetRequestConfig(CreateInboxRulesetOptions createInboxRulesetOptions, UUID inboxId)

  To obtain the request config of the operation createNewInboxRuleset

  Parameters:

  createInboxRulesetOptions - createInboxRulesetOptions

  inboxId - Inbox id to attach ruleset to (optional)

• deleteInboxRuleset

   final Unit deleteInboxRuleset(UUID id)

  Delete an inbox ruleset Delete inbox ruleset

  Parameters:

  id - ID of inbox ruleset

• deleteInboxRulesetRequestConfig

   final RequestConfig deleteInboxRulesetRequestConfig(UUID id)

  To obtain the request config of the operation deleteInboxRuleset

  Parameters:

  id - ID of inbox ruleset

• deleteInboxRulesets

   final Unit deleteInboxRulesets(UUID inboxId)

  Delete inbox rulesets Delete inbox rulesets. Accepts optional inboxId filter.

  Parameters:

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

• deleteInboxRulesetsRequestConfig

   final RequestConfig deleteInboxRulesetsRequestConfig(UUID inboxId)

  To obtain the request config of the operation deleteInboxRulesets

  Parameters:

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

• getInboxRuleset

   final InboxRulesetDto getInboxRuleset(UUID id)

  Get an inbox ruleset Get inbox ruleset

  Parameters:

  id - ID of inbox ruleset

• getInboxRulesetRequestConfig

   final RequestConfig getInboxRulesetRequestConfig(UUID id)

  To obtain the request config of the operation getInboxRuleset

  Parameters:

  id - ID of inbox ruleset

• getInboxRulesets

   final PageInboxRulesetDto getInboxRulesets(OffsetDateTime before, UUID inboxId, Integer page, String searchFilter, OffsetDateTime since, Integer size, String sort)

  List inbox rulesets List all rulesets attached to an inbox

  Parameters:

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

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

  page - Optional page index in inbox ruleset 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 ruleset list pagination (optional, default to 20)

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

• getInboxRulesetsRequestConfig

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

  To obtain the request config of the operation getInboxRulesets

  Parameters:

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

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

  page - Optional page index in inbox ruleset 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 ruleset list pagination (optional, default to 20)

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

• testInboxRuleset

   final InboxRulesetTestResult testInboxRuleset(UUID id, InboxRulesetTestOptions inboxRulesetTestOptions)

  Test an inbox ruleset Test an inbox ruleset

  Parameters:

  id - ID of inbox ruleset

  inboxRulesetTestOptions - inboxRulesetTestOptions

• testInboxRulesetRequestConfig

   final RequestConfig testInboxRulesetRequestConfig(UUID id, InboxRulesetTestOptions inboxRulesetTestOptions)

  To obtain the request config of the operation testInboxRuleset

  Parameters:

  id - ID of inbox ruleset

  inboxRulesetTestOptions - inboxRulesetTestOptions

• testInboxRulesetsForInbox

   final InboxRulesetTestResult testInboxRulesetsForInbox(UUID inboxId, InboxRulesetTestOptions inboxRulesetTestOptions)

  Test inbox rulesets for inbox Test inbox rulesets for inbox

  Parameters:

  inboxId - ID of inbox

  inboxRulesetTestOptions - inboxRulesetTestOptions

• testInboxRulesetsForInboxRequestConfig

   final RequestConfig testInboxRulesetsForInboxRequestConfig(UUID inboxId, InboxRulesetTestOptions inboxRulesetTestOptions)

  To obtain the request config of the operation testInboxRulesetsForInbox

  Parameters:

  inboxId - ID of inbox

  inboxRulesetTestOptions - inboxRulesetTestOptions

• testNewInboxRuleset

   final InboxRulesetTestResult testNewInboxRuleset(TestNewInboxRulesetOptions testNewInboxRulesetOptions)

  Test new inbox ruleset Test new inbox ruleset

  Parameters:

  testNewInboxRulesetOptions - testNewInboxRulesetOptions

• testNewInboxRulesetRequestConfig

   final RequestConfig testNewInboxRulesetRequestConfig(TestNewInboxRulesetOptions testNewInboxRulesetOptions)

  To obtain the request config of the operation testNewInboxRuleset

  Parameters:

  testNewInboxRulesetOptions - testNewInboxRulesetOptions