Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Email notifications for Sloth CI apps

Project description

Send email notifications when builds complete or fail.

Executing actions of an app is called *build*. A build is considered *completed* if all its actions were completed. If some actions were completed and some failed, it's a *partially completed*; if all actions fail, the build *failed*.

This extension sends you emails via SMTP when your builds complete (fully or partially) or fail; just pick the desired notification level, list the recepient emails, and enter your SMTP credentials. Optionally, you can set the subject for each notifcation level.

.. warning::

This extension uses `SMTPHandler <>`__ from logging.handlers. SMTPHandler doesn't work with GMail because it creates an smtplib.SMTP object to connect to the host, whereas GMail requires smtplib.SMTP_SSL. works fine.


.. code-block:: bash

$ pip install sloth-ci.ext.build_email_notifications


.. code-block:: yaml
:caption: build_email_notifications.yml

# Use the module sloth_ci.ext.build_email_notifications.
module: build_email_notifications

# Emails to send the notifications to.

# Log level (number or valid Python logging level name).
# ERROR includes only build fails, WARNING adds partial completions,
# INFO adds completion, and DEBUG adds trigger notifications.
# Default is WARNING.
level: INFO

# The "from" address in the emails. Default is ""

# The email subject on build trigger. You can use the {listen_point} placeholder.
# Default is "{listen_point}: Build Triggered."
subject_triggered: 'Triggered build on {listen_point}!'

# The email subject on build completion.You can use the {listen_point} placeholder.
# Default is "{listen_point}: Build Completed."
subject_completed: 'Hooray! {listen_point} works!'

# The email subject on build partial completion. You can use the {listen_point} placeholder.
# Default is "{listen_point}: Build Partially Completed."
subject_partially_completed: 'Better than nothing on {listen_point}'

# The email subject on build fail. You can use the {listen_point} placeholder.
# Default is "{listen_point}: Build Failed."
subject_failed: 'Fail on {listen_point}'

# SMTP settings.
# SMTP mail host and (if not default) port.
# Mandatory parameter.
mailhost: ''

# SMTP login.
login: foo@bar.baz

# SMTP password.
password: bar

# If the SMTP server requires TLS, set this to true. Default is false.
# If necessary, you can provide a keyfile name or a keyfile and a certificate file names.
# This param is used only if the login and password params are supplied.
secure: true
# secure:
# - keyfile
# - cerfile

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sloth-ci.ext.build_email_notifications, version 1.0.8
Filename, size File type Python version Upload date Hashes
Filename, size sloth_ci.ext.build_email_notifications-1.0.8-py3-none-any.whl (6.9 kB) File type Wheel Python version 3.5 Upload date Hashes View hashes
Filename, size (145.3 kB) File type Windows Installer Python version any Upload date Hashes View hashes
Filename, size (7.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page