View Source ImprovMX.Domains (ImprovMX v0.1.2)

Summary

Functions

add(name, params \\ %{})

Adding a new domain

check(name)

Check if the MX entries are valid for a domain

delete(name)

Edit a domain by modifying the notification email or the whitelabel entries

edit(name, params \\ %{})

Edit a domain by modifying the notification email or the whitelabel entries

get(name)

Get the details of a domain

list(params \\ %{})

Retrieve a list of all your domains

Functions

add(name, params \\ %{})

@spec add(String.t(), params) :: {:ok, map()} | {:error, any()}
when params: %{
       optional(:notification_email) => String.t(),
       optional(:whitelabel) => String.t()
     }

Adding a new domain

check(name)

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

Check if the MX entries are valid for a domain

delete(name)

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

Edit a domain by modifying the notification email or the whitelabel entries

edit(name, params \\ %{})

@spec edit(String.t(), params) :: {:ok, map()} | {:error, any()}
when params: %{
       optional(:notification_email) => String.t(),
       optional(:whitelabel) => String.t()
     }

Edit a domain by modifying the notification email or the whitelabel entries

get(name)

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

Get the details of a domain

list(params \\ %{})

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

Retrieve a list of all your domains