probator.plugins.notifiers

Module contents

class probator.plugins.notifiers.BaseNotifier

Bases: probator.plugins.BasePlugin, abc.ABC

name

Human friendly name of the Plugin

notify(subsystem, recipient, subject, body_html, body_text)

Method to send a notification. A plugin may use only part of the information, but all fields are required.

Parameters:
  • subsystem (str) – Name of the subsystem originating the notification
  • recipient (str) – Recipient of the notification
  • subject (str) – Subject / title of the notification
  • body_html (str) – HTML formatted version of the message
  • body_text (str) – Text formatted version of the message
Returns:

None

notifier_type

A string used to identify the type of contact

validation()

A regular expression used to validate if a contact is correctly formatted for the notifier