View Source ImprovMX.Aliases (ImprovMX v0.1.1)

Link to this section Summary

Functions

Add a new alias to a given domain

Delete a given alias

Get the details of a given alias

List aliases for a given domain

Link to this section Functions

Link to this function

add(domain_name, params)

View Source
@spec add(String.t(), params) :: {:ok, map()} | {:error, any()}
when params: %{alias: String.t(), forward: String.t()}

Add a new alias to a given domain

Link to this function

delete(domain_name, alias_name)

View Source
@spec delete(String.t(), String.t()) :: {:ok, map()} | {:error, any()}

Delete a given alias

Link to this function

edit(domain_name, alias_name, forwarding_email)

View Source
@spec edit(String.t(), String.t(), String.t()) :: {:ok, map()} | {:error, any()}

Update a given alias

Link to this function

get(domain_name, alias_name)

View Source
@spec get(String.t(), String.t()) :: {:ok, map()} | {:error, any()}

Get the details of a given alias

Link to this function

list(domain_name, params \\ %{})

View Source
@spec list(String.t(), params) :: {:ok, map()} | {:error, any()}
when params: %{
       optional(:q) => String.t(),
       optional(:alias) => String.t(),
       optional(:is_active) => boolean(),
       optional(:page) => integer()
     }

List aliases for a given domain