notifiers

README

Notifiers service

Notifiers service provides a service for sending notifications using Notifiers. Notifiers service can be configured to use different types of Notifiers to send different types of notifications such as SMS messages, emails, or push notifications. Service is extensible so that new implementations of Notifiers can be easily added. Notifiers are not standalone services but rather dependencies used by Notifiers service for sending notifications over specific protocols.

Configuration

The channel profile should include a list of contact emails. These emails are the recipients of the messages sent by the service. Configuration of the service is achieved through environment variables. The environment variables needed for service configuration depend on the underlying Notifier. An example of the service configuration for SMTP Notifier can be found in SMTP Notifier documentation. Note that any unset variables will be replaced with their default values.

Usage

Subscriptions service will start consuming messages and sending notifications when a message is received.

Documentation

Overview

Package notifiers contain the domain concept definitions needed to support Mainflux notifications functionality.

Index

• Variables
• type Notifier
• type Service
  • func New(auth mainflux.AuthServiceClient, idp mainflux.IDProvider, notifier Notifier, ...) Service

Variables

var ErrNotify = errors.New("failed to send notification")

ErrNotify wraps sending notification errors,

Types

type Notifier

type Notifier interface {
	// Notify method is used to send notification for the
	// received message to the provided list of receivers.
	Notify(from string, to []string, msg messaging.Message) error
}

Notifier represents an API for sending notification.

type Service

type Service interface {
	consumers.Consumer
}

Service reprents a notification service.

func New

func New(auth mainflux.AuthServiceClient, idp mainflux.IDProvider, notifier Notifier, from string) Service

New instantiates the subscriptions service implementation.