Documentation
¶
Index ¶
- func AsParagraph(text string, style string) string
- func DialServer(server, username, password string) (*smtp.Client, error)
- func SendNotification[T EmailNotificationMessage](conf *NotificationConf, location *time.Location, msg T) error
- type EmailNotificationMessage
- type FormattedNotification
- type Notification
- type NotificationConf
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AsParagraph ¶ added in v0.5.4
AsParagraph escapes `text` and wraps it into <p> and </p>
func DialServer ¶
DialServer dials a SMTP server using provided arguments. The 'server' argument should also contain a port number (e.g. 'localhost:25'). Anything other than port 25 is considered to be a connection with authentication over TLS.
func SendNotification ¶
func SendNotification[T EmailNotificationMessage](conf *NotificationConf, location *time.Location, msg T) error
SendNotification sends a general e-mail notification. Based on configuration, it is able to use SMTP servers requiring TLS and authentication (see Dial()).
Types ¶
type EmailNotificationMessage ¶ added in v0.5.4
type EmailNotificationMessage interface {
Notification | FormattedNotification
}
type FormattedNotification ¶ added in v0.5.4
FormattedNotification allows sending raw html message (i.e. nothing is HTMP escaped)
type Notification ¶ added in v0.0.5
Notification represents a general notification e-mail subject and body. The contents of `Paragraphs` is always escaped by the notification function. (for raw HTML formatted notifications, use `FormattedNotification`)
type NotificationConf ¶
type NotificationConf struct {
Sender string `json:"sender"`
Recipients []string `json:"recipients"`
SMTPServer string `json:"smtpServer"`
SMTPUsername string `json:"smtpUsername"`
SMTPPassword string `json:"smtpPassword"`
// Signature defines multi-language signature for notification e-mails
Signature map[string]string `json:"signature"`
}
NotificationConf configures e-mail-based notification
func (NotificationConf) WithRecipients ¶ added in v0.0.6
func (nc NotificationConf) WithRecipients(r ...string) NotificationConf
WithRecipients creates a new NotificationConf instance with recipients overwritten by the provided ones
Source Files