6.3.3. Notification

Send E-Mails about start and end of analysis

This rule is used to configure email notifications for events during the analysis run.

This is mainly useful if the analysis is not triggered from some Continuous Integration system which does email notifications on its own, otherwise it is most likely not necessary.

6.3.3.1. Options

mailserver_options

Configuration of the mail server.

 

mailserver_options.password : bauhaus.analysis.config.PasswordString | None = None

The SMTP authentication password to use.

 

mailserver_options.port : int = 25

The port of the SMTP server.

 

mailserver_options.sender : str = 'do-not-reply@eaceaa726a99'

The sender email address of notification mails.

 

mailserver_options.server : str = 'eaceaa726a99'

The SMTP server to use.

 

mailserver_options.use_ssl : bool = False

If the SMTP server supports STARTTLS it is used automatically. Set use_ssl to true only if the server expects a SSL connection from the beginning.

 

mailserver_options.username : str | None = None

The SMTP authentication username to use.

 

notify_of_build_start

notify_of_build_start : bool = True

If set to false, only notification emails at the end (successful or unsuccessful) of an analysis run are sent.

 

notify_of_failure_only

notify_of_failure_only : bool = False

If set to true, only notification emails for build errors are sent.

 

recipient

recipient : str | None = None

The recipient email address of notifications.