mailslurp
v15.17.22

MailSlurpAPI.Api.InboxReplierController (mailslurp v15.17.22)

API calls for all endpoints tagged InboxReplierController.

Summary

Functions

create_new_inbox_replier(connection, create_inbox_replier_options, opts \\ [])

Create an inbox replier Create a new inbox rule for reply toing, blocking, and allowing emails when sending and receiving

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

Delete an inbox replier Delete inbox replier

delete_inbox_repliers(connection, opts \\ [])

Delete inbox repliers Delete inbox repliers. Accepts optional inboxId filter.

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

Get an inbox replier Get inbox ruleset

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

Get an inbox replier event list Get inbox ruleset events

get_inbox_repliers(connection, opts \\ [])

List inbox repliers List all repliers attached to an inbox

update_inbox_replier(connection, id, update_inbox_replier_options, opts \\ [])

Update an inbox replier Update inbox ruleset

Functions

Link to this function

create_new_inbox_replier(connection, create_inbox_replier_options, opts \\ [])

@spec create_new_inbox_replier(
  Tesla.Env.client(),
  MailSlurpAPI.Model.CreateInboxReplierOptions.t(),
  keyword()
) :: {:ok, MailSlurpAPI.Model.InboxReplierDto.t()} | {:error, Tesla.Env.t()}

Create an inbox replier Create a new inbox rule for reply toing, blocking, and allowing emails when sending and receiving

Parameters

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

Returns

} on success {:error, info} on failure

Link to this function

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

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

Delete an inbox replier Delete inbox replier

Parameters

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

Returns

} on success {:error, info} on failure

Link to this function

delete_inbox_repliers(connection, opts \\ [])

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

Delete inbox repliers Delete inbox repliers. 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 replier to

Returns

} on success {:error, info} on failure

Link to this function

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

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

Get an inbox replier Get inbox ruleset

Parameters

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

Returns

} on success {:error, info} on failure

Link to this function

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

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

Get an inbox replier event list Get inbox ruleset events

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • id (String.t): ID of inbox replier
  • opts (KeywordList): [optional] Optional parameters
    • :page (integer()): Optional page index in inbox replier event list pagination
    • :size (integer()): Optional page size in inbox replier 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_repliers(connection, opts \\ [])

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

List inbox repliers List all repliers 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 repliers from
    • :page (integer()): Optional page index in inbox replier list pagination
    • :size (integer()): Optional page size in inbox replier list pagination
    • :sort (String.t): Optional createdAt sort direction ASC or DESC
    • :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

update_inbox_replier(connection, id, update_inbox_replier_options, opts \\ [])

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

Update an inbox replier Update inbox ruleset

Parameters

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

Returns

} on success {:error, info} on failure