Merge lp:~gmb/launchpad/dont-leak-email-addresses-bug-111147 into lp:launchpad

[Graham Binns]

Bug notification email will now always come from 'Person Name <$<email address hidden>>' instead of spoofing the email of the person who generated the notification.

This branch fixes bug 111147 and bug 31586 by making all bug notification emails come from $<email address hidden> instead of the email address of the Person that triggered the notification.

To compensate for the fact that people will no longer be able to filter bugmail based on the sender's email address, I've added an X-Launchpad-Sender header which contains the LP name of the Person that caused the notification to be sent.

I've made the following changes:

== lib/canonical/launchpad/mailnotification.py ==

 - I've updated the get_bugmail_from_address() function to always return "Name <$<email address hidden>>" instead of returning the Person's email address.
 - I've added a line to BugNotificationBuilder.build() to add an X-Launchpad-Sender header to notification emails.

== lib/lp/bugs/doc/bugnotification-email.txt ==

 - I've updated all tests to account for the changes I've made.

== lib/lp/bugs/doc/bugnotification-sending.txt ==

 - I've updated all tests to account for the changes I've made.

== lib/lp/bugs/scripts/bugnotification.py ==

 - I've updated the call to BugNotificationBuilder.build() to pass the Person who triggered the notification.

== lib/lp/bugs/tests/test_bugnotification.py ==

 - I've added a TestCase to cover BugNotification email headers. We'll eventually refactor our existing tests for headers as unit tests, so this seemed an ideal time to start.
 - I've added a test for the new X-Launchpad-Sender header.

Unmerged revisions

10982. By Graham Binns on 2010-06-09

Removed some lint

10981. By Graham Binns on 2010-06-09

Added a test for the X-Launchpad-Sender header.

10980. By Graham Binns on 2010-06-09

Fixed tests broken by the X-Launchpad-Sender header.

10979. By Graham Binns on 2010-06-09

Added X-Launchpad-Sender header to bugnotifications.

10978. By Graham Binns on 2010-06-09

Fixed test failures associated with the bug From address change.

10977. By Graham Binns on 2010-06-09

Bug notifications are now always sent from the bug email address.

=== modified file 'lib/canonical/launchpad/mailnotification.py'
--- lib/canonical/launchpad/mailnotification.py	2010-05-20 01:11:41 +0000
+++ lib/canonical/launchpad/mailnotification.py	2010-06-09 13:50:46 +0000
@@ -251,7 +251,7 @@
             ('X-Launchpad-Bug-Commenters', ' '.join(sorted(commenters))))
 
     def build(self, from_address, to_address, body, subject, email_date,
-              rationale=None, references=None, message_id=None):
+              sender, rationale=None, references=None, message_id=None):
         """Construct the notification.
 
         :param from_address: The From address of the notification.
@@ -260,6 +260,7 @@
         :type body: unicode
         :param subject: The Subject of the notification.
         :param email_date: The Date for the notification.
+        :param sender: The Launchpad Person sending the notification.
         :param rationale: The rationale for why the recipient is
             receiving this notification.
         :param references: A value for the References header.
@@ -292,6 +293,8 @@
         if rationale is not None:
             message.add_header('X-Launchpad-Message-Rationale', rationale)
 
+        message.add_header('X-Launchpad-Sender', sender.name)
+
         return message
 
 
@@ -368,34 +371,11 @@
 
 def get_bugmail_from_address(person, bug):
     """Returns the right From: address to use for a bug notification."""
+    bug_address = "%s@%s" % (bug.id, config.launchpad.bugs_domain)
     if person == getUtility(ILaunchpadCelebrities).janitor:
-        return format_address(
-            'Launchpad Bug Tracker',
-            "%s@%s" % (bug.id, config.launchpad.bugs_domain))
-
-    if person.preferredemail is not None:
-        return format_address(person.displayname, person.preferredemail.email)
-
-    # XXX: Bjorn Tillenius 2006-04-05:
-    # The person doesn't have a preferred email set, but he
-    # added a comment (either via the email UI, or because he was
-    # imported as a deaf reporter). It shouldn't be possible to use the
-    # email UI if you don't have a preferred email set, but work around
-    # it for now by trying hard to find the right email address to use.
-    email_addresses = shortlist(
-        getUtility(IEmailAddressSet).getByPerson(person))
-    if not email_addresses:
-        # XXX: Bjorn Tillenius 2006-05-21 bug=33427:
-        # A user should always have at least one email address,
-        # but due to bug #33427, this isn't always the case.
-        return format_address(person.displayname,
-            "%s@%s" % (bug.id, config.launchpad.bugs_domain))
-
-    # At this point we have no validated emails to use: if any of the
-    # person's emails had been validated the preferredemail would be
-    # set. Since we have no idea of which email address is best to use,
-    # we choose the first one.
-    return format_address(person.displayname, email_addresses[0].email)
+        return format_address('Launchpad Bug Tracker', bug_address)
+    else:
+        return format_address(person.displayname, bug_address)
 
 
 def get_bugmail_replyto_address(bug):

=== modified file 'lib/lp/bugs/doc/bugnotification-email.txt'
--- lib/lp/bugs/doc/bugnotification-email.txt	2010-04-14 12:55:44 +0000
+++ lib/lp/bugs/doc/bugnotification-email.txt	2010-06-09 13:50:46 +0000
@@ -31,7 +31,7 @@
 
     >>> from zope.component import getUtility
     >>> from canonical.launchpad.interfaces import (
-    ...     IBugDelta, IBugSet, IEmailAddressSet, IPersonSet)
+    ...     IBugDelta, IBugSet, IPersonSet)
     >>> from lp.bugs.adapters.bugdelta import BugDelta
 
 = Filing a bug =
@@ -432,41 +432,16 @@
     >>> get_bugmail_replyto_address(bug_four)
     u'Bug 4 <[e-mail]>'
 
-The From address generator handles a few special cases. The trivial case
-is, well, trivial. Stuart has four email addresses:
+The From address generator uses the Person's full name but the bug's
+email address. This avoids private addresses being leaked.
 
     >>> stub = getUtility(IPersonSet).getByName("stub")
-    >>> [(email.email, email.status.name) for email
-    ...  in getUtility(IEmailAddressSet).getByPerson(stub)]
-    [(u'[e-mail]', 'PREFERRED'),
-     (u'[e-mail]', 'VALIDATED'),
-     (u'[e-mail]', 'NEW'),
-     (u'[e-mail]', 'OLD')]
-
-But we use his preferred one:
-
     >>> get_bugmail_from_address(stub, bug_four)
-    'Stuart Bishop <[e-mail]>'
-
-Now, mpo doesn't have a validated email address, but we pick out the
-first address we find:
-
-    >>> mpo = getUtility(IPersonSet).getByName("mpo")
-    >>> get_bugmail_from_address(mpo, bug_four)
-    '=?utf-8?b?TWF0dGkgUMO2bGzDpA==?= <[e-mail]>'
-
-(As you can see in the above example, get_bugmail_from_address() takes
-care of encoding the person's displayname correctly.)
-
-The team janitor doesn't have an email address at all!
-
-    >>> janitor = getUtility(IPersonSet).getByName("team-membership-janitor")
-    >>> get_bugmail_from_address(janitor, bug_four)
-    'Team Membership Janitor <[e-mail]>'
+    'Stuart Bishop <[e-mail]>'
 
 The Launchpad Janitor celebrity isn't a real user, and shouldn't be
-sending mail. Notifications from the janitor are sent with the address
-of the bug itself.
+sending mail. Notifications from the janitor are sent as though from the
+bug tracker itself.
 
     >>> from canonical.launchpad.interfaces import ILaunchpadCelebrities
     >>> lp_janitor = getUtility(ILaunchpadCelebrities).janitor
@@ -498,8 +473,9 @@
 
 The build() method of a builder accepts a number of parameters and
 returns an instance of email.MIMEText. The most basic invokation of
-this method requires a from address, a to address, a body, a subject
-and a sending date for the mail.
+this method requires a from address, a to address, a body, a subject,
+a sending date for the mail and the Person object representing the
+sender.
 
     >>> from datetime import datetime
     >>> import pytz
@@ -510,7 +486,7 @@
 
     >>> notification_email = bug_four_notification_builder.build(
     ...     from_address, '[e-mail]',
-    ...     "A test body.", "A test subject.", sending_date)
+    ...     "A test body.", "A test subject.", sending_date, lp_janitor)
 
 The fields of the generated notification email will be set according
 to the parameters that were used to instantiate BugNotificationBuilder
@@ -536,7 +512,7 @@
 
     >>> notification_email = bug_four_notification_builder.build(
     ...     from_address, '[e-mail]',
-    ...     "A test body.", "A test subject.", sending_date,
+    ...     "A test body.", "A test subject.", sending_date, lp_janitor,
     ...     rationale='Because-I-said-so',
     ...     references=['<[e-mail]>'],
     ...     message_id='<[e-mail]>')
@@ -562,7 +538,8 @@
 
     >>> notification_email = bug_four_notification_builder.build(
     ...     from_address, '[e-mail]',
-    ...     "A test body.", "Yet another message", sending_date)
+    ...     "A test body.", "Yet another message", sending_date,
+    ...     lp_janitor)
 
     >>> print notification_email['Subject']
     [Bug 4] Yet another message
@@ -572,7 +549,7 @@
 
     >>> notification_email = bug_four_notification_builder.build(
     ...     from_address, '[e-mail]',
-    ...     "A test body.", None, sending_date)
+    ...     "A test body.", None, sending_date, lp_janitor)
 
     >>> print notification_email['Subject']
     [Bug 4]

=== modified file 'lib/lp/bugs/doc/bugnotification-sending.txt'
--- lib/lp/bugs/doc/bugnotification-sending.txt	2010-06-03 12:32:45 +0000
+++ lib/lp/bugs/doc/bugnotification-sending.txt	2010-06-09 13:50:46 +0000
@@ -60,7 +60,7 @@
     ...     for message in messages:
     ...         print_notification(message)
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 1] subject
     X-Launchpad-Message-Rationale: Subscriber (mozilla-firefox in ubuntu)
     <BLANKLINE>
@@ -74,7 +74,7 @@
     <BLANKLINE>
     ----------------------------------------------------------------------
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 1] subject
     X-Launchpad-Message-Rationale: Assignee
     <BLANKLINE>
@@ -87,7 +87,7 @@
     <BLANKLINE>
     ----------------------------------------------------------------------
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 1] subject
     X-Launchpad-Message-Rationale: Registrant (Ubuntu) @ubuntu-team
     <BLANKLINE>
@@ -101,7 +101,7 @@
     <BLANKLINE>
     ----------------------------------------------------------------------
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 1] subject
     X-Launchpad-Message-Rationale: Subscriber
     <BLANKLINE>
@@ -172,7 +172,7 @@
     To: [e-mail]
     ...
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: Re: [Bug 1] subject
     X-Launchpad-Message-Rationale: Registrant (Ubuntu) @ubuntu-team
     <BLANKLINE>
@@ -212,7 +212,7 @@
     To: [e-mail]
     ...
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 1] Re: Firefox does not support SVG
     X-Launchpad-Message-Rationale: Registrant (Ubuntu) @ubuntu-team
     <BLANKLINE>
@@ -260,7 +260,7 @@
     To: [e-mail]
     ...
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 1] Re: Firefox does not support SVG
     X-Launchpad-Message-Rationale: Registrant (Ubuntu) @ubuntu-team
     <BLANKLINE>
@@ -303,7 +303,7 @@
     To: [e-mail]
     ...
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 1] Re: Firefox does not support SVG
     X-Launchpad-Message-Rationale: Registrant (Ubuntu) @ubuntu-team
     <BLANKLINE>
@@ -331,7 +331,7 @@
     To: [e-mail]
     ...
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 1] subject
     X-Launchpad-Message-Rationale: Registrant (Ubuntu) @ubuntu-team
     <BLANKLINE>
@@ -377,7 +377,7 @@
     To: [e-mail]
     ...
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 1] subject
     X-Launchpad-Message-Rationale: Registrant (Ubuntu) @ubuntu-team
     <BLANKLINE>
@@ -397,7 +397,7 @@
     To: [e-mail]
     ...
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 1] subject
     X-Launchpad-Message-Rationale: Registrant (Ubuntu) @ubuntu-team
     <BLANKLINE>
@@ -417,7 +417,7 @@
     To: [e-mail]
     ...
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 1] subject
     X-Launchpad-Message-Rationale: Registrant (Ubuntu) @ubuntu-team
     <BLANKLINE>
@@ -465,7 +465,7 @@
     To: [e-mail]
     ...
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 1] subject
     X-Launchpad-Message-Rationale: Registrant (Ubuntu) @ubuntu-team
     <BLANKLINE>
@@ -485,7 +485,7 @@
     To: [e-mail]
     ...
     To: [e-mail]
-    From: Foo Bar <[e-mail]>
+    From: Foo Bar <[e-mail]>
     Subject: [Bug 1] Re: Firefox does not support SVG
     X-Launchpad-Message-Rationale: Registrant (Ubuntu) @ubuntu-team
     <BLANKLINE>
@@ -505,7 +505,7 @@
     To: [e-mail]
     ...
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 1] Re: Firefox does not support SVG
     X-Launchpad-Message-Rationale: Registrant (Ubuntu) @ubuntu-team
     <BLANKLINE>
@@ -603,72 +603,72 @@
     ...         print_notification_headers(message)
     ...         print
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 2] Re: Blackhole Trash folder
     X-Launchpad-Message-Rationale: Registrant (Debian)
     <BLANKLINE>
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 2] Re: Blackhole Trash folder
     X-Launchpad-Message-Rationale: Registrant (Tomcat) @ubuntu-team
     <BLANKLINE>
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 2] Re: Blackhole Trash folder
     X-Launchpad-Message-Rationale: Assignee
     <BLANKLINE>
     To: [e-mail]
-    From: Foo Bar <[e-mail]>
+    From: Foo Bar <[e-mail]>
     Subject: [Bug 2] Re: Blackhole Trash folder
     X-Launchpad-Message-Rationale: Registrant (Debian)
     <BLANKLINE>
     To: [e-mail]
-    From: Foo Bar <[e-mail]>
+    From: Foo Bar <[e-mail]>
     Subject: [Bug 2] Re: Blackhole Trash folder
     X-Launchpad-Message-Rationale: Registrant (Tomcat) @ubuntu-team
     <BLANKLINE>
     To: [e-mail]
-    From: Foo Bar <[e-mail]>
+    From: Foo Bar <[e-mail]>
     Subject: [Bug 2] Re: Blackhole Trash folder
     X-Launchpad-Message-Rationale: Assignee
     <BLANKLINE>
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 1] Re: Firefox does not support SVG
     X-Launchpad-Message-Rationale: Subscriber (mozilla-firefox in ubuntu)
     <BLANKLINE>
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 1] Re: Firefox does not support SVG
     X-Launchpad-Message-Rationale: Assignee
     <BLANKLINE>
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 1] Re: Firefox does not support SVG
     X-Launchpad-Message-Rationale: Registrant (Ubuntu) @ubuntu-team
     <BLANKLINE>
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 1] Re: Firefox does not support SVG
     X-Launchpad-Message-Rationale: Subscriber
     <BLANKLINE>
     To: [e-mail]
-    From: Foo Bar <[e-mail]>
+    From: Foo Bar <[e-mail]>
     Subject: [Bug 1] Re: Firefox does not support SVG
     X-Launchpad-Message-Rationale: Subscriber (mozilla-firefox in ubuntu)
     <BLANKLINE>
     To: [e-mail]
-    From: Foo Bar <[e-mail]>
+    From: Foo Bar <[e-mail]>
     Subject: [Bug 1] Re: Firefox does not support SVG
     X-Launchpad-Message-Rationale: Assignee
     <BLANKLINE>
     To: [e-mail]
-    From: Foo Bar <[e-mail]>
+    From: Foo Bar <[e-mail]>
     Subject: [Bug 1] Re: Firefox does not support SVG
     X-Launchpad-Message-Rationale: Registrant (Ubuntu) @ubuntu-team
     <BLANKLINE>
     To: [e-mail]
-    From: Foo Bar <[e-mail]>
+    From: Foo Bar <[e-mail]>
     Subject: [Bug 1] Re: Firefox does not support SVG
     X-Launchpad-Message-Rationale: Subscriber
     <BLANKLINE>
@@ -729,7 +729,8 @@
     >>> flush_notifications()
 
 
-== Duplicates ==
+Duplicates
+----------
 
 We will need some helper functions.
 
@@ -779,7 +780,7 @@
     ...     for message in messages:
     ...         print_notification(message)
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 16] subject
     X-Launchpad-Message-Rationale: Registrant (Ubuntu) @ubuntu-team
     <BLANKLINE>
@@ -796,7 +797,7 @@
     <BLANKLINE>
     ----------------------------------------------------------------------
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 16] subject
     X-Launchpad-Message-Rationale: Subscriber
     <BLANKLINE>
@@ -816,7 +817,8 @@
     >>> flush_notifications()
 
 
-== Security Vulnerabilities ==
+Security Vulnerabilities
+------------------------
 
 When a new security related bug is filed, a small notification is
 inserted at the top of the message body.
@@ -844,7 +846,7 @@
     ...     for message in messages:
     ...         print_notification(message)
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug ...] [NEW] Zero-day on Frobulator
     X-Launchpad-Message-Rationale: Subscriber @ubuntu-team
     <BLANKLINE>
@@ -868,7 +870,7 @@
     ...     for message in messages:
     ...         print_notification(message)
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug ...] subject
     X-Launchpad-Message-Rationale: Subscriber @ubuntu-team
     <BLANKLINE>
@@ -879,7 +881,8 @@
     >>> flush_notifications()
 
 
-== The cronscript ==
+The cronscript
+--------------
 
 There's a cronsript which does the sending of the email. Let's add a
 few notifications to show that it works.
@@ -937,7 +940,7 @@
     ...
     INFO    Notifying [e-mail] about bug 2.
     ...
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     To: [e-mail]
     Reply-To: Bug 2 <[e-mail]>
     ...
@@ -947,7 +950,7 @@
     ...
     INFO    Notifying [e-mail] about bug 1.
     ...
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     To: [e-mail]
     Reply-To: Bug 1 <[e-mail]>
     ...
@@ -965,13 +968,14 @@
     ...
     INFO    Notifying [e-mail] about bug 1.
     ...
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     To: [e-mail]
     Reply-To: Bug 1 <[e-mail]>
     ...
     References: sdsdfsfd
     ...
     X-Launchpad-Message-Rationale: Subscriber (mozilla-firefox in ubuntu)
+    X-Launchpad-Sender: name12
     Errors-To: [e-mail]
     Return-Path: [e-mail]
     Precedence: bulk
@@ -1000,7 +1004,8 @@
     >>> flush_notifications()
 
 
-== The X-Launchpad-Bug header ==
+The X-Launchpad-Bug header
+--------------------------
 
 When a notification is sent out about a bug, the X-Launchpad-Bug header is
 filled with data about that bug:
@@ -1038,7 +1043,8 @@
     False
 
 
-== The X-Launchpad-Bug-Tags header ==
+The X-Launchpad-Bug-Tags header
+-------------------------------
 
 First, a helper function that triggers notifications by adding a
 comment to a given bug, another that returns a sorted list of new
@@ -1103,7 +1109,8 @@
     ...     message.get_all('X-Launchpad-Bug-Tags')
 
 
-== The X-Launchpad-Bug-Private header ==
+The X-Launchpad-Bug-Private header
+----------------------------------
 
 When a notification is sent out about a bug, the
 X-Launchpad-Bug-Private header shows if the bug is marked as
@@ -1128,7 +1135,8 @@
     [e-mail] ['yes']
 
 
-== The X-Launchpad-Bug-Security-Vulnerability header ==
+The X-Launchpad-Bug-Security-Vulnerability header
+-------------------------------------------------
 
 When a notification is sent out about a bug, the
 X-Launchpad-Bug-Security-Vulnerability header records if the bug is a
@@ -1156,7 +1164,8 @@
     [e-mail] ['yes']
 
 
-== The X-Launchpad-Bug-Commenters header ==
+The X-Launchpad-Bug-Commenters header
+-------------------------------------
 
 The X-Launchpad-Bug-Recipient-Commented header lists all user IDs of
 people who have ever commented on the bug. It's a space-separated
@@ -1187,7 +1196,8 @@
     name12 name16
 
 
-== Verbose bug notifications ==
+Verbose bug notifications
+-------------------------
 
 It is possible for users to have all the bug notifications which they
 receive include the bug description and status. This helps in those
@@ -1301,7 +1311,7 @@
 
     >>> print_notification(collated_messages['[e-mail]'][0])
     To: [e-mail]
-    From: Verbose Person <[e-mail]>
+    From: Verbose Person <[e-mail]>
     Subject: [Bug ...] subject
     X-Launchpad-Message-Rationale: Subscriber
     <BLANKLINE>
@@ -1320,7 +1330,7 @@
 
     >>> print_notification(collated_messages['[e-mail]'][0])
     To: [e-mail]
-    From: Verbose Person <[e-mail]>
+    From: Verbose Person <[e-mail]>
     Subject: [Bug ...] subject
     X-Launchpad-Message-Rationale: Subscriber @verboseteam
     <BLANKLINE>
@@ -1338,7 +1348,7 @@
 
     >>> print_notification(collated_messages['[e-mail]'][0])
     To: [e-mail]
-    From: Verbose Person <[e-mail]>
+    From: Verbose Person <[e-mail]>
     Subject: [Bug ...] subject
     X-Launchpad-Message-Rationale: Subscriber
     <BLANKLINE>
@@ -1364,7 +1374,7 @@
 
     >>> print_notification(collated_messages['[e-mail]'][0])
     To: [e-mail]
-    From: Verbose Person <[e-mail]>
+    From: Verbose Person <[e-mail]>
     Subject: [Bug ...] subject
     X-Launchpad-Message-Rationale: Subscriber @conciseteam
     <BLANKLINE>
@@ -1383,7 +1393,8 @@
     <BLANKLINE>
     ----------------------------------------------------------------------
 
-== Notification Recipients ==
+Notification Recipients
+-----------------------
 
 Bug notifications are sent to direct subscribers of a bug as well as to
 structural subscribers. Structural subcribers can select the
@@ -1437,7 +1448,7 @@
     <BLANKLINE>
     ----------------------------------------------------------------------
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 1] subject
     X-Launchpad-Message-Rationale: Subscriber (Mozilla Firefox)
     <BLANKLINE>
@@ -1489,7 +1500,7 @@
     <BLANKLINE>
     ----------------------------------------------------------------------
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 1] subject
     X-Launchpad-Message-Rationale: Subscriber @shipit-admins
     <BLANKLINE>
@@ -1551,7 +1562,7 @@
     <BLANKLINE>
     ----------------------------------------------------------------------
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 1] subject
     X-Launchpad-Message-Rationale: Subscriber (Mozilla Firefox)
     <BLANKLINE>
@@ -1603,7 +1614,7 @@
     <BLANKLINE>
     ----------------------------------------------------------------------
     To: [e-mail]
-    From: Sample Person <[e-mail]>
+    From: Sample Person <[e-mail]>
     Subject: [Bug 1] Re: Firefox does not support SVG
     X-Launchpad-Message-Rationale: Subscriber @shipit-admins
     <BLANKLINE>

=== modified file 'lib/lp/bugs/scripts/bugnotification.py'
--- lib/lp/bugs/scripts/bugnotification.py	2009-11-17 17:33:28 +0000
+++ lib/lp/bugs/scripts/bugnotification.py	2010-06-09 13:50:46 +0000
@@ -155,7 +155,7 @@
 
         body = get_email_template(email_template) % body_data
         msg = bug_notification_builder.build(
-            from_address, address, body, subject, email_date,
+            from_address, address, body, subject, email_date, person,
             rationale, references, msgid)
         messages.append(msg)
 

=== modified file 'lib/lp/bugs/tests/test_bugnotification.py'
--- lib/lp/bugs/tests/test_bugnotification.py	2010-06-03 13:53:29 +0000
+++ lib/lp/bugs/tests/test_bugnotification.py	2010-06-09 13:50:46 +0000
@@ -16,6 +16,8 @@
 from canonical.config import config
 from canonical.launchpad.database.message import MessageSet
 from canonical.launchpad.ftests import login
+from canonical.launchpad.mailnotification import (
+    BugNotificationBuilder, get_bugmail_from_address)
 from lp.bugs.interfaces.bugtask import BugTaskStatus, IUpstreamBugTask
 from lp.bugs.model.bugnotification import BugNotification, BugNotificationSet
 from lp.testing import TestCaseWithFactory
@@ -200,6 +202,54 @@
         self.assertEqual(self.dupe_subscribers, recipients)
 
 
+class TestBugNotificationEmailHeaders(TestCaseWithFactory):
+    """Tests for X-Launchpad bugnotification headers."""
+
+    layer = DatabaseFunctionalLayer
+
+    def setUp(self):
+        super(TestBugNotificationEmailHeaders, self).setUp(
+            user='[e-mail]')
+        self.bug = self.factory.makeBug()
+
+    def _buildBugNotificationEmail(self, bug_notification, rationale=None,
+                                   references=None, message_id=None):
+        """Build a notification email based on a BugNotification instance."""
+        from_address = get_bugmail_from_address(
+            bug_notification.message.owner, bug_notification.bug)
+        to_address = '[e-mail]'
+        body = bug_notification.message.text_contents
+        subject = bug_notification.message.subject
+        email_date = bug_notification.message.datecreated
+        sender = bug_notification.message.owner
+
+        builder = BugNotificationBuilder(bug_notification.bug)
+        return builder.build(
+            from_address, to_address, body, subject, email_date, sender,
+            rationale, references, message_id)
+
+    def test_x_launchpad_sender(self):
+        # Bug notifications include a header, X-Launchpad-Sender, which
+        # is set to the name of the Person who triggered the
+        # notification.
+        self.bug.newMessage(
+            self.bug.owner, subject='subject', content='content')
+
+        latest_notification = BugNotification.selectFirst(orderBy='-id')
+        notification_email = self._buildBugNotificationEmail(
+            latest_notification)
+
+        self.assertTrue(
+            'X-Launchpad-Sender' in notification_email,
+            "Notification email does not include an X-Launchpad-Sender "
+            "header")
+        self.assertEqual(
+            self.bug.owner.name, notification_email['X-Launchpad-Sender'],
+            "X-Launchpad-Sender does not match expected value. Expected "
+            "'%s', found '%s'" %
+            (self.bug.owner.name, notification_email['X-Launchpad-Sender']))
+
+
 def test_suite():
     """Return the test suite for the tests in this module."""
     return unittest.TestLoader().loadTestsFromName(__name__)