Done with the first pass instrumenting all mail points. There is one spot in the ipr code that's complicated and will require some refactor before instrumenting. There are a few places to add explicit messages (templates and all) to replace the simple use of email_ad. The next pass will be to make sure every spot that sends mail is covered by a test, and that the tests look at the headers sensibly. That will be followed by a moderately heavy refactor of MailToken and the gather_address utilities. Then pages showing the expansions of a token for a given document/group. Long way to go, but this is working well, and I think it will make things much easier later.

 - Legacy-Id: 10030

Author: rjsparks

ietf/mailtoken/migrations/0002_auto_20150809_1314.py

@@ -25,9 +25,13 @@ def make_recipients(apps):
        desc='The Secretariat',
        template='<iesg-secretary@ietf.org>')
 
+    rc(slug='ietf_secretariat',
+       desc='The Secretariat',
+       template='<ietf-secretariat-reply@ietf.org>')
+
     rc(slug='doc_authors',
        desc="The document's authors",
-       template='{% if doc.type_id == "draft" %}{{doc.name}}@ietf.org{% endif %}')
+       template='{% if doc.type_id == "draft" %}<{{doc.name}}@ietf.org>{% endif %}')
 
     rc(slug='doc_notify',
        desc="The addresses in the document's notify field",
@@ -55,11 +59,11 @@ def make_recipients(apps):
 
     rc(slug='doc_shepherd',
        desc="The document's shepherd",
-       template='{% if doc.shepherd %}{{doc.shepherd.address}}{% endif %}' )
+       template='{% if doc.shepherd %}<{{doc.shepherd.address}}>{% endif %}' )
 
     rc(slug='doc_ad',
        desc="The document's responsible Area Director",
-       template='{% if doc.ad %}{{doc.ad.email_address}}{% endif %}' )
+       template='{% if doc.ad %}<{{doc.ad.email_address}}>{% endif %}' )
 
     rc(slug='doc_group_mail_list',
        desc="The list address of the document's group",
@@ -99,7 +103,7 @@ def make_recipients(apps):
 
     rc(slug='group_mail_list',
        desc="The group's mailing list",
-       template='{{ group.list_email }}')
+       template='<{{ group.list_email }}>')
 
     rc(slug='group_steering_group',
        desc="The group's steering group (IESG or IRSG)",
@@ -119,7 +123,7 @@ def make_recipients(apps):
 
     rc(slug='internet_draft_requests',
        desc="The internet drafts ticketing system",
-       template='internet-drafts@ietf.org')
+       template='<internet-drafts@ietf.org>')
 
     rc(slug='submission_submitter',
        desc="The person that submitted a draft",
@@ -159,15 +163,15 @@ def make_recipients(apps):
 
     rc(slug='session_requests',
        desc="The session request ticketing system",
-       template='session-request@ietf.org')
+       template='<session-request@ietf.org>')
 
     rc(slug='logged_in_person',
        desc="The person currently logged into the datatracker who initiated a given action",
-       template='{% if person and person.email_address %}{{ person.email_address }}{% endif %}')
+       template='{% if person and person.email_address %}<{{ person.email_address }}>{% endif %}')
 
     rc(slug='ipr_requests',
        desc="The ipr disclosure handling system",
-       template='ietf-ipr@ietf.org')
+       template='<ietf-ipr@ietf.org>')
 
     rc(slug='ipr_submitter',
        desc="The submitter of an IPR disclosure",
@@ -209,12 +213,28 @@ def make_recipients(apps):
 
     rc(slug='liaison_statements_list',
        desc="The IETF liaison statement ticketing system",
-       template='statements@ietf.org')
+       template='<statements@ietf.org>')
 
     rc(slug='liaison_manager',
        desc="The assigned liaison manager for an external group ",
        template=None)
 
+    rc(slug='nominator',
+       desc="The person that submitted a nomination to nomcom",
+       template='{{nominator}}')
+
+    rc(slug='nominee',
+       desc="The person nominated for a position",
+       template='{{nominee}}')
+
+    rc(slug='nomcom_chair',
+       desc="The chair of a given nomcom",
+       template='{{nomcom.group.get_chair.email.address}}')
+
+    rc(slug='commenter',
+       desc="The person providing a comment to nomcom",
+       template='{{commenter}}')
+
 def make_mailtokens(apps):
 
     Recipient=apps.get_model('mailtoken','Recipient')
@@ -743,6 +763,48 @@ def mt_factory(slug,desc,recipient_slugs):
                recipient_slugs=['liaison_manager',
                                ])
 
+    mt_factory(slug='nomination_received',
+               desc="Recipients for a message noting a new nomination has been received",
+               recipient_slugs=['nomcom_chair',
+                               ])
+
+    mt_factory(slug='nomination_receipt_requested',
+               desc="Recipients for a message confirming a nomination was made",
+               recipient_slugs=['nominator', 
+                               ])
+
+    mt_factory(slug='nomcom_comment_receipt_requested',
+               desc="Recipients for a message confirming a comment was made",
+               recipient_slugs=['commenter', 
+                               ])
+
+    mt_factory(slug='nomination_created_person',
+               desc="Recipients for a message noting that a nomination caused a "
+                     "new Person record to be created in the datatracker",
+               recipient_slugs=['ietf_secretariat',
+                                'nomcom_chair',
+                               ])
+    mt_factory(slug='nomination_new_nominee',
+               desc="Recipients the first time a person is nominated for a position, "
+                     "asking them to accept or decline the nomination",
+               recipient_slugs=['nominee',
+                               ])
+
+    mt_factory(slug='nomination_accept_reminder',
+               desc="Recipeints of message reminding a nominee to accept or decline a nomination",
+               recipient_slugs=['nominee',
+                               ])
+
+    mt_factory(slug='nomcom_questionnaire',
+               desc="Recipients for the questionairre that nominees should complete",
+               recipient_slugs=['nominee',
+                               ])
+
+    mt_factory(slug='nomcom_questionnaire_reminder',
+               desc="Recipients for a message reminding a nominee to return a completed questionairre response",
+               recipient_slugs=['nominee',
+                               ])
+
 def forward(apps, schema_editor):
 
     make_recipients(apps)

ietf/name/fixtures/names.json

@@ -4327,6 +4327,14 @@
  "model": "doc.ballottype",
  "pk": 3
 },
+{
+ "fields": {
+  "template": "{{commenter}}",
+  "desc": "The person providing a comment to nomcom"
+ },
+ "model": "mailtoken.recipient",
+ "pk": "commenter"
+},
 {
  "fields": {
   "template": null,
@@ -4345,7 +4353,7 @@
 },
 {
  "fields": {
-  "template": "{% if doc.ad %}{{doc.ad.email_address}}{% endif %}",
+  "template": "{% if doc.ad %}<{{doc.ad.email_address}}>{% endif %}",
   "desc": "The document's responsible Area Director"
  },
  "model": "mailtoken.recipient",
@@ -4377,7 +4385,7 @@
 },
 {
  "fields": {
-  "template": "{% if doc.type_id == \"draft\" %}{{doc.name}}@ietf.org{% endif %}",
+  "template": "{% if doc.type_id == \"draft\" %}<{{doc.name}}@ietf.org>{% endif %}",
   "desc": "The document's authors"
  },
  "model": "mailtoken.recipient",
@@ -4449,7 +4457,7 @@
 },
 {
  "fields": {
-  "template": "{% if doc.shepherd %}{{doc.shepherd.address}}{% endif %}",
+  "template": "{% if doc.shepherd %}<{{doc.shepherd.address}}>{% endif %}",
   "desc": "The document's shepherd"
  },
  "model": "mailtoken.recipient",
@@ -4481,7 +4489,7 @@
 },
 {
  "fields": {
-  "template": "{{ group.list_email }}",
+  "template": "<{{ group.list_email }}>",
   "desc": "The group's mailing list"
  },
  "model": "mailtoken.recipient",
@@ -4561,7 +4569,15 @@
 },
 {
  "fields": {
-  "template": "internet-drafts@ietf.org",
+  "template": "<ietf-secretariat-reply@ietf.org>",
+  "desc": "The Secretariat"
+ },
+ "model": "mailtoken.recipient",
+ "pk": "ietf_secretariat"
+},
+{
+ "fields": {
+  "template": "<internet-drafts@ietf.org>",
   "desc": "The internet drafts ticketing system"
  },
  "model": "mailtoken.recipient",
@@ -4577,7 +4593,7 @@
 },
 {
  "fields": {
-  "template": "ietf-ipr@ietf.org",
+  "template": "<ietf-ipr@ietf.org>",
   "desc": "The ipr disclosure handling system"
  },
  "model": "mailtoken.recipient",
@@ -4633,7 +4649,7 @@
 },
 {
  "fields": {
-  "template": "statements@ietf.org",
+  "template": "<statements@ietf.org>",
   "desc": "The IETF liaison statement ticketing system"
  },
  "model": "mailtoken.recipient",
@@ -4657,12 +4673,36 @@
 },
 {
  "fields": {
-  "template": "{% if person and person.email_address %}{{ person.email_address }}{% endif %}",
+  "template": "{% if person and person.email_address %}<{{ person.email_address }}>{% endif %}",
   "desc": "The person currently logged into the datatracker who initiated a given action"
  },
  "model": "mailtoken.recipient",
  "pk": "logged_in_person"
 },
+{
+ "fields": {
+  "template": "{{nomcom.group.get_chair.email.address}}",
+  "desc": "The chair of a given nomcom"
+ },
+ "model": "mailtoken.recipient",
+ "pk": "nomcom_chair"
+},
+{
+ "fields": {
+  "template": "{{nominator}}",
+  "desc": "The person that submitted a nomination to nomcom"
+ },
+ "model": "mailtoken.recipient",
+ "pk": "nominator"
+},
+{
+ "fields": {
+  "template": "{{nominee}}",
+  "desc": "The person nominated for a position"
+ },
+ "model": "mailtoken.recipient",
+ "pk": "nominee"
+},
 {
  "fields": {
   "template": "<rfc-editor@rfc-editor.org>",
@@ -4681,7 +4721,7 @@
 },
 {
  "fields": {
-  "template": "session-request@ietf.org",
+  "template": "<session-request@ietf.org>",
   "desc": "The session request ticketing system"
  },
  "model": "mailtoken.recipient",
@@ -5415,6 +5455,87 @@
  "model": "mailtoken.mailtoken",
  "pk": "milestone_review_reminder_cc"
 },
+{
+ "fields": {
+  "recipients": [
+   "commenter"
+  ],
+  "desc": "Recipients for a message confirming a comment was made"
+ },
+ "model": "mailtoken.mailtoken",
+ "pk": "nomcom_comment_receipt_requested"
+},
+{
+ "fields": {
+  "recipients": [
+   "nominee"
+  ],
+  "desc": "Recipients for the questionairre that nominees should complete"
+ },
+ "model": "mailtoken.mailtoken",
+ "pk": "nomcom_questionnaire"
+},
+{
+ "fields": {
+  "recipients": [
+   "nominee"
+  ],
+  "desc": "Recipients for a message reminding a nominee to return a completed questionairre response"
+ },
+ "model": "mailtoken.mailtoken",
+ "pk": "nomcom_questionnaire_reminder"
+},
+{
+ "fields": {
+  "recipients": [
+   "nominee"
+  ],
+  "desc": "Recipeints of message reminding a nominee to accept or decline a nomination"
+ },
+ "model": "mailtoken.mailtoken",
+ "pk": "nomination_accept_reminder"
+},
+{
+ "fields": {
+  "recipients": [
+   "ietf_secretariat",
+   "nomcom_chair"
+  ],
+  "desc": "Recipients for a message noting that a nomination caused a new Person record to be created in the datatracker"
+ },
+ "model": "mailtoken.mailtoken",
+ "pk": "nomination_created_person"
+},
+{
+ "fields": {
+  "recipients": [
+   "nominee"
+  ],
+  "desc": "Recipients the first time a person is nominated for a position, asking them to accept or decline the nomination"
+ },
+ "model": "mailtoken.mailtoken",
+ "pk": "nomination_new_nominee"
+},
+{
+ "fields": {
+  "recipients": [
+   "nominator"
+  ],
+  "desc": "Recipients for a message confirming a nomination was made"
+ },
+ "model": "mailtoken.mailtoken",
+ "pk": "nomination_receipt_requested"
+},
+{
+ "fields": {
+  "recipients": [
+   "nomcom_chair"
+  ],
+  "desc": "Recipients for a message noting a new nomination has been received"
+ },
+ "model": "mailtoken.mailtoken",
+ "pk": "nomination_received"
+},
 {
  "fields": {
   "recipients": [

ietf/nomcom/forms.py

@@ -20,6 +20,7 @@
 from ietf.person.fields import SearchableEmailField
 from ietf.utils.fields import MultiEmailField
 from ietf.utils.mail import send_mail
+from ietf.mailtoken.utils import gather_address_list
 
 
 ROLODEX_URL = getattr(settings, 'ROLODEX_URL', None)
@@ -407,7 +408,7 @@ def save(self, commit=True):
             if author:
                 subject = 'Nomination receipt'
                 from_email = settings.NOMCOM_FROM_EMAIL
-                to_email = author.address
+                to_email = gather_address_list('nomination_receipt_requested',nominator=author.address)
                 context = {'nominee': nominee.email.person.name,
                           'comments': comments,
                           'position': position.name}
@@ -525,7 +526,7 @@ def save(self, commit=True):
             if author:
                 subject = "NomCom comment confirmation"
                 from_email = settings.NOMCOM_FROM_EMAIL
-                to_email = author.address
+                to_email = gather_address_list('nomcom_comment_receipt_requested',commenter=author.address)
                 context = {'nominee': self.nominee.email.person.name,
                            'comments': comments,
                            'position': self.position.name}