mailslurp
v15.17.22

MailSlurpAPI.Api.InboxForwarderController (mailslurp v15.17.22)

API calls for all endpoints tagged InboxForwarderController.

Summary

Functions

create_new_inbox_forwarder(connection, inbox_id, create_inbox_forwarder_options, opts \\ [])

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

delete_inbox_forwarder(connection, id, opts \\ [])

Delete an inbox forwarder Delete inbox forwarder

delete_inbox_forwarders(connection, opts \\ [])

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

get_inbox_forwarder(connection, id, opts \\ [])

Get an inbox forwarder Get inbox ruleset

get_inbox_forwarder_events(connection, id, opts \\ [])

Get an inbox forwarder event list Get inbox ruleset events

get_inbox_forwarders(connection, opts \\ [])

List inbox forwarders List all forwarders attached to an inbox

test_inbox_forwarder(connection, id, inbox_forwarder_test_options, opts \\ [])

Test an inbox forwarder Test an inbox forwarder

test_inbox_forwarders_for_inbox(connection, inbox_id, inbox_forwarder_test_options, opts \\ [])

Test inbox forwarders for inbox Test inbox forwarders for inbox

test_new_inbox_forwarder(connection, test_new_inbox_forwarder_options, opts \\ [])

Test new inbox forwarder Test new inbox forwarder

update_inbox_forwarder(connection, id, create_inbox_forwarder_options, opts \\ [])

Update an inbox forwarder Update inbox ruleset

Functions

Link to this function

create_new_inbox_forwarder(connection, inbox_id, create_inbox_forwarder_options, opts \\ [])

@spec create_new_inbox_forwarder(
  Tesla.Env.client(),
  String.t(),
  MailSlurpAPI.Model.CreateInboxForwarderOptions.t(),
  keyword()
) :: {:ok, MailSlurpAPI.Model.InboxForwarderDto.t()} | {:error, Tesla.Env.t()}

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

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • inbox_id (String.t): Inbox id to attach forwarder to
  • create_inbox_forwarder_options (CreateInboxForwarderOptions):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

delete_inbox_forwarder(connection, id, opts \\ [])

@spec delete_inbox_forwarder(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Delete an inbox forwarder Delete inbox forwarder

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • id (String.t): ID of inbox forwarder
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

delete_inbox_forwarders(connection, opts \\ [])

@spec delete_inbox_forwarders(Tesla.Env.client(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

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

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :inbox_id (String.t): Optional inbox id to attach forwarder to

Returns

} on success {:error, info} on failure

Link to this function

get_inbox_forwarder(connection, id, opts \\ [])

@spec get_inbox_forwarder(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, MailSlurpAPI.Model.InboxForwarderDto.t()} | {:error, Tesla.Env.t()}

Get an inbox forwarder Get inbox ruleset

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • id (String.t): ID of inbox forwarder
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

get_inbox_forwarder_events(connection, id, opts \\ [])

@spec get_inbox_forwarder_events(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, MailSlurpAPI.Model.PageInboxForwarderEvents.t()}
  | {:error, Tesla.Env.t()}

Get an inbox forwarder event list Get inbox ruleset events

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • id (String.t): ID of inbox forwarder
  • opts (KeywordList): [optional] Optional parameters
    • :page (integer()): Optional page index in inbox forwarder event list pagination
    • :size (integer()): Optional page size in inbox forwarder event list pagination
    • :sort (String.t): Optional createdAt sort direction ASC or DESC

Returns

} on success {:error, info} on failure

Link to this function

get_inbox_forwarders(connection, opts \\ [])

@spec get_inbox_forwarders(Tesla.Env.client(), keyword()) ::
  {:ok, MailSlurpAPI.Model.PageInboxForwarderDto.t()} | {:error, Tesla.Env.t()}

List inbox forwarders List all forwarders attached to an inbox

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :inbox_id (String.t): Optional inbox id to get forwarders from
    • :page (integer()): Optional page index in inbox forwarder list pagination
    • :size (integer()): Optional page size in inbox forwarder list pagination
    • :sort (String.t): Optional createdAt sort direction ASC or DESC
    • :search_filter (String.t): Optional search filter
    • :since (DateTime.t): Filter by created at after the given timestamp
    • :before (DateTime.t): Filter by created at before the given timestamp

Returns

} on success {:error, info} on failure

Link to this function

test_inbox_forwarder(connection, id, inbox_forwarder_test_options, opts \\ [])

@spec test_inbox_forwarder(
  Tesla.Env.client(),
  String.t(),
  MailSlurpAPI.Model.InboxForwarderTestOptions.t(),
  keyword()
) ::
  {:ok, MailSlurpAPI.Model.InboxForwarderTestResult.t()}
  | {:error, Tesla.Env.t()}

Test an inbox forwarder Test an inbox forwarder

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • id (String.t): ID of inbox forwarder
  • inbox_forwarder_test_options (InboxForwarderTestOptions):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

test_inbox_forwarders_for_inbox(connection, inbox_id, inbox_forwarder_test_options, opts \\ [])

@spec test_inbox_forwarders_for_inbox(
  Tesla.Env.client(),
  String.t(),
  MailSlurpAPI.Model.InboxForwarderTestOptions.t(),
  keyword()
) ::
  {:ok, MailSlurpAPI.Model.InboxForwarderTestResult.t()}
  | {:error, Tesla.Env.t()}

Test inbox forwarders for inbox Test inbox forwarders for inbox

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • inbox_id (String.t): ID of inbox
  • inbox_forwarder_test_options (InboxForwarderTestOptions):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

test_new_inbox_forwarder(connection, test_new_inbox_forwarder_options, opts \\ [])

@spec test_new_inbox_forwarder(
  Tesla.Env.client(),
  MailSlurpAPI.Model.TestNewInboxForwarderOptions.t(),
  keyword()
) ::
  {:ok, MailSlurpAPI.Model.InboxForwarderTestResult.t()}
  | {:error, Tesla.Env.t()}

Test new inbox forwarder Test new inbox forwarder

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • test_new_inbox_forwarder_options (TestNewInboxForwarderOptions):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

update_inbox_forwarder(connection, id, create_inbox_forwarder_options, opts \\ [])

@spec update_inbox_forwarder(
  Tesla.Env.client(),
  String.t(),
  MailSlurpAPI.Model.CreateInboxForwarderOptions.t(),
  keyword()
) :: {:ok, MailSlurpAPI.Model.InboxForwarderDto.t()} | {:error, Tesla.Env.t()}

Update an inbox forwarder Update inbox ruleset

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • id (String.t): ID of inbox forwarder
  • create_inbox_forwarder_options (CreateInboxForwarderOptions):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure