SelectoComponents.ExportDelivery behaviour (selecto_components v0.4.5)

Behavior for delivering generated export payloads.

Host applications own the actual delivery integration so they can plug in their mailer/provider of choice.

Link to this section Summary

Types

Normalized delivery configuration

Normalized export payload ready for delivery

Link to this section Types

Link to this type

delivery_config()

@type delivery_config() :: map()

Normalized delivery configuration

Link to this type

export_payload()

@type export_payload() :: map()

Normalized export payload ready for delivery

Link to this section Callbacks

Link to this callback

deliver_email(export_payload, delivery_config, keyword)

@callback deliver_email(export_payload(), delivery_config(), keyword()) ::
  {:ok, map()} | {:error, term()}