jro_apps/redmine Commit - r2279:1d783106a34b

Adds Message-Id and References headers to email notifications so that issues and messages threads can be displayed by email clients (#1401)....

Jean-Philippe Lang -

r2279:1d783106a34b

parent child

Context file:

r2279:1d783106a34b

Collapse all files

app/models/mailer.rb +45 -1

                                 'Issue-Id' => issue.id,
                                 'Issue-Author' => issue.author.login
                 redmine_headers 'Issue-Assignee' => issue.assigned_to.login if issue.assigned_to
+                message_id issue
                 recipients issue.recipients
                 cc(issue.watcher_recipients - @recipients)
                 subject "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] (#{issue.status.name}) #{issue.subject}"
                                 'Issue-Id' => issue.id,
                                 'Issue-Author' => issue.author.login
                 redmine_headers 'Issue-Assignee' => issue.assigned_to.login if issue.assigned_to
+                message_id journal
+                references issue
                 @author = journal.user
                 recipients issue.recipients
                 # Watchers in cc
               def news_added(news)
                 redmine_headers 'Project' => news.project.identifier
+                message_id news
                 recipients news.project.recipients
                 subject "[#{news.project.name}] #{l(:label_news)}: #{news.title}"
                 body :news => news,
               def message_posted(message, recipients)
                 redmine_headers 'Project' => message.project.identifier,
                                 'Topic-Id' => (message.parent_id || message.id)
+                message_id message
+                references message.parent unless message.parent.nil?
                 recipients(recipients)
                 subject "[#{message.board.project.name} - #{message.board.name}] #{message.subject}"
                 body :message => message,
                 return false if (recipients.nil? || recipients.empty?) &&
                                 (cc.nil? || cc.empty?) &&
                                 (bcc.nil? || bcc.empty?)
-                super
+                # Set Message-Id and References
+                if @message_id_object
+                  mail.message_id = self.class.message_id_for(@message_id_object)
+                end
+                if @references_objects
+                  mail.references = @references_objects.collect {|o| self.class.message_id_for(o)}
+                end
+                super(mail)
               end
               # Sends reminders to issue assignees
               def self.controller_path
                 ''
               end unless respond_to?('controller_path')
+              # Returns a predictable Message-Id for the given object
+              def self.message_id_for(object)
+                # id + timestamp should reduce the odds of a collision
+                # as far as we don't send multiple emails for the same object
+                hash = "redmine.#{object.class.name.demodulize.underscore}-#{object.id}.#{object.created_on.strftime("%Y%m%d%H%M%S")}"
+                host = Setting.mail_from.to_s.gsub(%r{^.*@}, '')
+                host = "#{::Socket.gethostname}.redmine" if host.empty?
+                "<#{hash}@#{host}>"
+              end
+              private
+              def message_id(object)
+                @message_id_object = object
+              end
+              def references(object)
+                @references_objects ||= []
+                @references_objects << object
+              end
+            end
+            # Patch TMail so that message_id is not overwritten
+            module TMail
+              class Mail
+                def add_message_id( fqdn = nil )
+                  self.message_id ||= ::TMail::new_message_id(fqdn)
+                end
+              end
             end

test/fixtures/messages.yml +1 -1

               replies_count: 0
               last_reply_id:
               content: "An other reply"
-              author_id:
+              author_id: 2
               parent_id: 1
               board_id: 1
             messages_004:

test/unit/mailer_test.rb +39 -1

@@ -95,7 +95,45 class MailerTest < Test::Unit::TestCase
95	assert !mail.body.include?('<a href="https://mydomain.foo/issues/show/1">Bug #1: Can\'t print recipes</a>')	95	assert !mail.body.include?('<a href="https://mydomain.foo/issues/show/1">Bug #1: Can\'t print recipes</a>')
96	end	96	end
97		97
98		98	def test_issue_add_message_id
		99	ActionMailer::Base.deliveries.clear
		100	issue = Issue.find(1)
		101	Mailer.deliver_issue_add(issue)
		102	mail = ActionMailer::Base.deliveries.last
		103	assert_not_nil mail
		104	assert_equal Mailer.message_id_for(issue), mail.message_id
		105	assert_nil mail.references
		106	end
		107
		108	def test_issue_edit_message_id
		109	ActionMailer::Base.deliveries.clear
		110	journal = Journal.find(1)
		111	Mailer.deliver_issue_edit(journal)
		112	mail = ActionMailer::Base.deliveries.last
		113	assert_not_nil mail
		114	assert_equal Mailer.message_id_for(journal), mail.message_id
		115	assert_equal Mailer.message_id_for(journal.issue), mail.references.to_s
		116	end
		117
		118	def test_message_posted_message_id
		119	ActionMailer::Base.deliveries.clear
		120	message = Message.find(1)
		121	Mailer.deliver_message_posted(message, message.author.mail)
		122	mail = ActionMailer::Base.deliveries.last
		123	assert_not_nil mail
		124	assert_equal Mailer.message_id_for(message), mail.message_id
		125	assert_nil mail.references
		126	end
		127
		128	def test_reply_posted_message_id
		129	ActionMailer::Base.deliveries.clear
		130	message = Message.find(3)
		131	Mailer.deliver_message_posted(message, message.author.mail)
		132	mail = ActionMailer::Base.deliveries.last
		133	assert_not_nil mail
		134	assert_equal Mailer.message_id_for(message), mail.message_id
		135	assert_equal Mailer.message_id_for(message.parent), mail.references.to_s
		136	end
99		137
100	# test mailer methods for each language	138	# test mailer methods for each language
101	def test_issue_add	139	def test_issue_add

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages