OSTIP_EXARI v0.1.0 Swagger.Client.Api.ApiDocsmailboxesFormat View Source

API calls for all endpoints tagged ApiDocsmailboxesFormat.

Link to this section Summary

Destroy a mailbox

Retrieve the current state of a mailbox

List all mailboxes

Change the state of a mailbox. (Note - implicitly creates the mailbox)

delete(connection, mailbox_name, opts \\ [])

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

Destroy a mailbox.

{:ok, %{}} on success {:error, info} on failure

get(connection, mailbox_name, opts \\ [])

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

Retrieve the current state of a mailbox.

{:ok, %{}} on success {:error, info} on failure

list(connection, opts \\ [])

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

List all mailboxes.

{:ok, %{}} on success {:error, info} on failure

update(connection, mailbox_name, old_messages, new_messages, opts \\ [])

update(Tesla.Env.client(), String.t(), integer(), integer(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Change the state of a mailbox. (Note - implicitly creates the mailbox).

{:ok, %{}} on success {:error, info} on failure