antikythera v0.4.0 AntikytheraEal.AlertMailer.Behaviour behaviour View Source

Interface to email delivery backend for core/gear alerts.

See AntikytheraEal for common information about pluggable interfaces defined in antikythera.

Link to this section Summary

Callbacks

Sends an alert email.

Link to this section Callbacks

Specs

deliver(mail :: AntikytheraEal.AlertMailer.Mail.t()) :: :ok | {:error, term()}

Sends an alert email.

CC/BCC and HTML mail is omitted for simplicity.

This callback is called in AntikytheraCore.Alert.Handler.Email, that is, when an alert email about error(s) in either antikythera core or gear is sent.