[Buildbot-commits] buildbot/buildbot/status mail.py,1.12,1.13
Brian Warner
warner at users.sourceforge.net
Mon Apr 11 19:30:33 UTC 2005
Update of /cvsroot/buildbot/buildbot/buildbot/status
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv29759/buildbot/status
Modified Files:
mail.py
Log Message:
Revision: arch at buildbot.sf.net--2004/buildbot--dev--0--patch-32
Creator: Brian Warner <warner at monolith.lothar.com>
merge epydoc work from org.apestaart at thomas/buildbot--doc--0--patch-3
* general: merge org.apestaart at thomas/buildbot--doc--0--patch-3,
adding epydoc-format docstrings to many classes. Thanks to Thomas
Vander Stichele for the patches.
* docs/epyrun, docs/gen-reference: add epydoc-generating tools
* buildbot/status/mail.py, buildbot/process/step_twisted.py: same
* buildbot/slave/bot.py, commands.py, registry.py: same
Index: mail.py
===================================================================
RCS file: /cvsroot/buildbot/buildbot/buildbot/status/mail.py,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -d -r1.12 -r1.13
--- mail.py 11 Nov 2004 00:43:48 -0000 1.12
+++ mail.py 11 Apr 2005 19:30:31 -0000 1.13
@@ -46,57 +46,9 @@
To get a simple one-message-per-build (say, for a mailing list), use
sendToInterestedUsers=False, extraRecipients=['listaddr at example.org']
- Parameters:
-
- fromaddr (required): the email address to be used in the 'From' header.
-
- sendToInterestedUsers: if True (the default), send mail to all of the
- Interested Users. If False, only send mail to
- the extraRecipients list.
-
- extraRecipients: 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.
-
- subject: 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: a string, one of the following (defaults to 'all'):
-
- 'all': send mail about all builds, passing and failing
- 'failing': only send mail about builds which fail
- 'problem': only send mail about a build which failed when the previous
- build passed
-
- builders: a list of builder names for which mail should be sent.
- Defaults to all builds.
-
- addLogs: 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.
-
- relayhost: the host to which the outbound SMTP connection should be
- made. Defaults to 'localhost'
-
- lookup: this is an object which provides IEmailLookup, which is
- responsible for mapping User names (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.
-
Each MailNotifier sends mail to a single set of recipients. To send
different kinds of mail to different recipients, use multiple
MailNotifiers.
-
"""
__implements__ = (interfaces.IStatusReceiver,
@@ -112,6 +64,63 @@
subject="buildbot %(result)s in %(builder)s",
lookup=None, extraRecipients=[],
sendToInterestedUsers=True):
+ """
+ @type fromaddr: string
+ @param fromaddr: the email address to be used in the 'From' header.
+ @type sendToInterestedUsers: boolean
+ @param sendToInterestedUsers: if True (the default), send mail to all
+ of the Interested Users. If False, only
+ send mail to the extraRecipients list.
+
+ @type extraRecipients: tuple of string
+ @param extraRecipients: 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.
+
+ @type subject: string
+ @param subject: 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.
+
+ @type mode: string (defaults to all)
+ @param mode: one of:
+ - 'all': send mail about all builds, passing and failing
+ - 'failing': only send mail about builds which fail
+ - 'problem': only send mail about a build which failed
+ when the previous build passed
+
+ @type builders: tuple of strings
+ @param builders: a list of builder names for which mail should be sent.
+ Defaults to all builds.
+
+ @type addLogs: boolean.
+ @param addLogs: 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.
+
+ @type relayhost: string
+ @param relayhost: the host to which the outbound SMTP connection
+ should be made. Defaults to 'localhost'
+
+ @type lookup: implementor of {IEmailLookup}
+ @param lookup: object which provides IEmailLookup, which is
+ responsible for mapping User names (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.
+ """
+
assert type(extraRecipients) in (list, tuple)
for r in extraRecipients:
assert type(r) is str
More information about the Commits
mailing list