buildbot.status.mail.MailNotifier

This is a status notifier which sends email to a list of recipients upon the completion of each build. It can be configured to only send out mail for certain builds, and only send messages when the build fails, or when it transitions from success to failure. It can also be configured to include various build logs in each message.

By default, the message will be sent to the Interested Users list, which includes all developers who made changes in the build. You can add additional recipients with the extraRecipients argument.

To get a simple one-message-per-build (say, for a mailing list), use sendToInterestedUsers=False, extraRecipients=['listaddr@example.org']

Each MailNotifier sends mail to a single set of recipients. To send different kinds of mail to different recipients, use multiple MailNotifiers.

init(self, fromaddr, mode=`'all'`, categories=None, builders=None, addLogs=False, relayhost=`'localhost'`, subject=`'buildbot %(result)s in %(projectName)s on %(builder)s'`, lookup=None, extraRecipients=`[]`, sendToInterestedUsers=True, customMesg=None, messageFormatter=<function defaultMessage at 0x283e1b8>, extraHeaders=None, addPatch=True, useTls=False, smtpUser=None, smtpPassword=None, smtpPort=25)
(Constructor)

source code

Parameters:

fromaddr (string) - the email address to be used in the 'From' header.
sendToInterestedUsers (boolean) - if True (the default), send mail to all of the Interested Users. If False, only send mail to the extraRecipients list.
extraRecipients (tuple of string) - a list of email addresses to which messages should be sent (in addition to the InterestedUsers list, which includes any developers who made Changes that went into this build). It is a good idea to create a small mailing list and deliver to that, then let subscribers come and go as they please. The addresses in this list are used literally (they are not processed by lookup).
subject (string) - a string to be used as the subject line of the message. %(builder)s will be replaced with the name of the builder which provoked the message.
mode (string (defaults to all)) - one of:
- 'all': send mail about all builds, passing and failing
- 'failing': only send mail about builds which fail
- 'passing': only send mail about builds which succeed
- 'problem': only send mail about a build which failed when the previous build passed
- 'change': only send mail about builds who change status
builders (list of strings) - a list of builder names for which mail should be sent. Defaults to None (send mail for all builds). Use either builders or categories, but not both.
categories (list of strings) - a list of category names to serve status information for. Defaults to None (all categories). Use either builders or categories, but not both.
addLogs (boolean) - if True, include all build logs as attachments to the messages. These can be quite large. This can also be set to a list of log names, to send a subset of the logs. Defaults to False.
addPatch (boolean) - if True, include the patch when the source stamp includes one.
relayhost (string) - the host to which the outbound SMTP connection should be made. Defaults to 'localhost'
lookup (implementor of {IEmailLookup}) - object which provides IEmailLookup, which is responsible for mapping User names for Interested Users (which come from the VC system) into valid email addresses. If not provided, the notifier will only be able to send mail to the addresses in the extraRecipients list. Most of the time you can use a simple Domain instance. As a shortcut, you can pass as string: this will be treated as if you had provided Domain(str). For example, lookup='twistedmatrix.com' will allow mail to be sent to all developers whose SVN usernames match their twistedmatrix.com account names.
customMesg (func) - (this function is deprecated)
messageFormatter (func) - function taking (mode, name, build, result, master_status) and returning a dictionary containing two required keys "body" and "type", with a third optional key, "subject". The "body" key gives a string that contains the complete text of the message. The "type" key is the message type ('plain' or 'html'). The 'html' type should be used when generating an HTML message. The optional "subject" key gives the subject for the email.
extraHeaders (dict) - A dict of extra headers to add to the mail. It's best to avoid putting 'To', 'From', 'Date', 'Subject', or 'CC' in here. Both the names and values may be WithProperties instances.
useTls (boolean) - Send emails using TLS and authenticate with the smtp host. Defaults to False.
smtpUser (string) - The user that will attempt to authenticate with the relayhost when useTls is True.
smtpPassword (string) - The password that smtpUser will use when authenticating with relayhost.
smtpPort (int) - The port that will be used when connecting to the relayhost. Defaults to 25.

Overrides: twisted.application.service.MultiService.__init__

compare_attrs

Value:

['extraRecipients',
 'lookup',
 'fromaddr',
 'mode',
 'categories',
 'builders',
 'addLogs',
 'relayhost',
...

Class Variables
	compare_attrs = `['extraRecipients', 'lookup', 'fromaddr', 'mod...`
	__implemented__ = `<implementedBy buildbot.status.mail.MailNoti...`
	__provides__ = `<zope.interface.declarations.ClassProvides obje...`
Inherited from `twisted.application.service.Service`: `name`, `parent`, `running`

Class MailNotifier

setServiceParent(self, parent)

disownServiceParent(self)

builderAdded(self, name, builder)

builderRemoved(self, name)

builderChangedState(self, name, state)

buildStarted(self, name, build)

buildFinished(self, name, build, results)

compare_attrs

implemented

provides

Class MailNotifier

setServiceParent(self, parent)

disownServiceParent(self)

builderAdded(self, name, builder)

builderRemoved(self, name)

builderChangedState(self, name, state)

buildStarted(self, name, build)

buildFinished(self, name, build, results)

compare_attrs

__implemented__

__provides__

implemented

provides