View Source Papelillo.MailingListBehaviour behaviour (Papelillo v0.2.2)

Behaviour for mailing list providers integration

Link to this section Summary

Link to this section Types

@type actual_address() :: String.t()
@type address() :: String.t()
@type config() :: Keyword.t()
@type description() :: String.t()
@type list_name() :: String.t()
@type member() :: String.t()
@type name() :: String.t()

Link to this section Callbacks

Link to this callback

create(name, description, address, config)

View Source
@callback create(name(), description(), address(), config()) ::
  {:ok, any()} | {:error, any()}
@callback delete(address(), config()) :: {:ok, any()} | {:error, any()}
Link to this callback

subscribe(list_name, member, config)

View Source
@callback subscribe(list_name(), member(), config()) :: {:ok, any()} | {:error, any()}
Link to this callback

unsubscribe(list_name, member, config)

View Source
@callback unsubscribe(list_name(), member(), config()) :: {:ok, any()} | {:error, any()}
Link to this callback

update(name, description, address, actual_address, config)

View Source
@callback update(name(), description(), address(), actual_address(), config()) ::
  {:ok, any()} | {:error, any()}