jro_apps/redmine Commit - r8665:967f42aa98f5

Adds a X-Redmine-Sender header to email notifications (#5643)....

Jean-Philippe Lang -

r8665:967f42aa98f5

parent child

Context file:

r8665:967f42aa98f5

Collapse all files

app/models/mailer.rb +5 0

             # Redmine - project management software
             # Copyright (C) 2006-2011  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             class Mailer < ActionMailer::Base
               layout 'mailer'
               helper :application
               helper :issues
               helper :custom_fields
               include ActionController::UrlWriter
               include Redmine::I18n
               def self.default_url_options
                 h = Setting.host_name
                 h = h.to_s.gsub(%r{\/.*$}, '') unless Redmine::Utils.relative_url_root.blank?
                 { :host => h, :protocol => Setting.protocol }
               end
               # Builds a tmail object used to email recipients of the added issue.
               #
               # Example:
               #   issue_add(issue) => tmail object
               #   Mailer.deliver_issue_add(issue) => sends an email to issue recipients
               def issue_add(issue)
                 redmine_headers 'Project' => issue.project.identifier,
                                 'Issue-Id' => issue.id,
                                 'Issue-Author' => issue.author.login
                 redmine_headers 'Issue-Assignee' => issue.assigned_to.login if issue.assigned_to
                 message_id issue
+                @author = issue.author
                 recipients issue.recipients
                 cc(issue.watcher_recipients - @recipients)
                 subject "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] (#{issue.status.name}) #{issue.subject}"
                 body :issue => issue,
                      :issue_url => url_for(:controller => 'issues', :action => 'show', :id => issue)
                 render_multipart('issue_add', body)
               end
               # Builds a tmail object used to email recipients of the edited issue.
               #
               # Example:
               #   issue_edit(journal) => tmail object
               #   Mailer.deliver_issue_edit(journal) => sends an email to issue recipients
               def issue_edit(journal)
                 issue = journal.journalized.reload
                 redmine_headers 'Project' => issue.project.identifier,
                                 '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
                 cc(issue.watcher_recipients - @recipients)
                 s = "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] "
                 s << "(#{issue.status.name}) " if journal.new_value_for('status_id')
                 s << issue.subject
                 subject s
                 body :issue => issue,
                      :journal => journal,
                      :issue_url => url_for(:controller => 'issues', :action => 'show', :id => issue, :anchor => "change-#{journal.id}")
                 render_multipart('issue_edit', body)
               end
               def reminder(user, issues, days)
                 set_language_if_valid user.language
                 recipients user.mail
                 subject l(:mail_subject_reminder, :count => issues.size, :days => days)
                 body :issues => issues,
                      :days => days,
                      :issues_url => url_for(:controller => 'issues', :action => 'index',
                                             :set_filter => 1, :assigned_to_id => user.id,
                                             :sort => 'due_date:asc')
                 render_multipart('reminder', body)
               end
               # Builds a tmail object used to email users belonging to the added document's project.
               #
               # Example:
               #   document_added(document) => tmail object
               #   Mailer.deliver_document_added(document) => sends an email to the document's project recipients
               def document_added(document)
                 redmine_headers 'Project' => document.project.identifier
                 recipients document.recipients
                 subject "[#{document.project.name}] #{l(:label_document_new)}: #{document.title}"
                 body :document => document,
                      :document_url => url_for(:controller => 'documents', :action => 'show', :id => document)
                 render_multipart('document_added', body)
               end
               # Builds a tmail object used to email recipients of a project when an attachements are added.
               #
               # Example:
               #   attachments_added(attachments) => tmail object
               #   Mailer.deliver_attachments_added(attachments) => sends an email to the project's recipients
               def attachments_added(attachments)
                 container = attachments.first.container
                 added_to = ''
                 added_to_url = ''
                 case container.class.name
                 when 'Project'
                   added_to_url = url_for(:controller => 'files', :action => 'index', :project_id => container)
                   added_to = "#{l(:label_project)}: #{container}"
                   recipients container.project.notified_users.select {|user| user.allowed_to?(:view_files, container.project)}.collect  {|u| u.mail}
                 when 'Version'
                   added_to_url = url_for(:controller => 'files', :action => 'index', :project_id => container.project)
                   added_to = "#{l(:label_version)}: #{container.name}"
                   recipients container.project.notified_users.select {|user| user.allowed_to?(:view_files, container.project)}.collect  {|u| u.mail}
                 when 'Document'
                   added_to_url = url_for(:controller => 'documents', :action => 'show', :id => container.id)
                   added_to = "#{l(:label_document)}: #{container.title}"
                   recipients container.recipients
                 end
                 redmine_headers 'Project' => container.project.identifier
                 subject "[#{container.project.name}] #{l(:label_attachment_new)}"
                 body :attachments => attachments,
                      :added_to => added_to,
                      :added_to_url => added_to_url
                 render_multipart('attachments_added', body)
               end
               # Builds a tmail object used to email recipients of a news' project when a news item is added.
               #
               # Example:
               #   news_added(news) => tmail object
               #   Mailer.deliver_news_added(news) => sends an email to the news' project recipients
               def news_added(news)
                 redmine_headers 'Project' => news.project.identifier
                 message_id news
                 recipients news.recipients
                 subject "[#{news.project.name}] #{l(:label_news)}: #{news.title}"
                 body :news => news,
                      :news_url => url_for(:controller => 'news', :action => 'show', :id => news)
                 render_multipart('news_added', body)
               end
               # Builds a tmail object used to email recipients of a news' project when a news comment is added.
               #
               # Example:
               #   news_comment_added(comment) => tmail object
               #   Mailer.news_comment_added(comment) => sends an email to the news' project recipients
               def news_comment_added(comment)
                 news = comment.commented
                 redmine_headers 'Project' => news.project.identifier
                 message_id comment
                 recipients news.recipients
                 cc news.watcher_recipients
                 subject "Re: [#{news.project.name}] #{l(:label_news)}: #{news.title}"
                 body :news => news,
                      :comment => comment,
                      :news_url => url_for(:controller => 'news', :action => 'show', :id => news)
                 render_multipart('news_comment_added', body)
               end
               # Builds a tmail object used to email the recipients of the specified message that was posted.
               #
               # Example:
               #   message_posted(message) => tmail object
               #   Mailer.deliver_message_posted(message) => sends an email to the recipients
               def message_posted(message)
                 redmine_headers 'Project' => message.project.identifier,
                                 'Topic-Id' => (message.parent_id || message.id)
                 message_id message
                 references message.parent unless message.parent.nil?
                 recipients(message.recipients)
                 cc((message.root.watcher_recipients + message.board.watcher_recipients).uniq - @recipients)
                 subject "[#{message.board.project.name} - #{message.board.name} - msg#{message.root.id}] #{message.subject}"
                 body :message => message,
                      :message_url => url_for(message.event_url)
                 render_multipart('message_posted', body)
               end
               # Builds a tmail object used to email the recipients of a project of the specified wiki content was added.
               #
               # Example:
               #   wiki_content_added(wiki_content) => tmail object
               #   Mailer.deliver_wiki_content_added(wiki_content) => sends an email to the project's recipients
               def wiki_content_added(wiki_content)
                 redmine_headers 'Project' => wiki_content.project.identifier,
                                 'Wiki-Page-Id' => wiki_content.page.id
                 message_id wiki_content
                 recipients wiki_content.recipients
                 cc(wiki_content.page.wiki.watcher_recipients - recipients)
                 subject "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_added, :id => wiki_content.page.pretty_title)}"
                 body :wiki_content => wiki_content,
                      :wiki_content_url => url_for(:controller => 'wiki', :action => 'show',
                                                   :project_id => wiki_content.project,
                                                   :id => wiki_content.page.title)
                 render_multipart('wiki_content_added', body)
               end
               # Builds a tmail object used to email the recipients of a project of the specified wiki content was updated.
               #
               # Example:
               #   wiki_content_updated(wiki_content) => tmail object
               #   Mailer.deliver_wiki_content_updated(wiki_content) => sends an email to the project's recipients
               def wiki_content_updated(wiki_content)
                 redmine_headers 'Project' => wiki_content.project.identifier,
                                 'Wiki-Page-Id' => wiki_content.page.id
                 message_id wiki_content
                 recipients wiki_content.recipients
                 cc(wiki_content.page.wiki.watcher_recipients + wiki_content.page.watcher_recipients - recipients)
                 subject "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_updated, :id => wiki_content.page.pretty_title)}"
                 body :wiki_content => wiki_content,
                      :wiki_content_url => url_for(:controller => 'wiki', :action => 'show',
                                                   :project_id => wiki_content.project,
                                                   :id => wiki_content.page.title),
                      :wiki_diff_url => url_for(:controller => 'wiki', :action => 'diff',
                                                :project_id => wiki_content.project, :id => wiki_content.page.title,
                                                :version => wiki_content.version)
                 render_multipart('wiki_content_updated', body)
               end
               # Builds a tmail object used to email the specified user their account information.
               #
               # Example:
               #   account_information(user, password) => tmail object
               #   Mailer.deliver_account_information(user, password) => sends account information to the user
               def account_information(user, password)
                 set_language_if_valid user.language
                 recipients user.mail
                 subject l(:mail_subject_register, Setting.app_title)
                 body :user => user,
                      :password => password,
                      :login_url => url_for(:controller => 'account', :action => 'login')
                 render_multipart('account_information', body)
               end
               # Builds a tmail object used to email all active administrators of an account activation request.
               #
               # Example:
               #   account_activation_request(user) => tmail object
               #   Mailer.deliver_account_activation_request(user)=> sends an email to all active administrators
               def account_activation_request(user)
                 # Send the email to all active administrators
                 recipients User.active.find(:all, :conditions => {:admin => true}).collect { |u| u.mail }.compact
                 subject l(:mail_subject_account_activation_request, Setting.app_title)
                 body :user => user,
                      :url => url_for(:controller => 'users', :action => 'index',
                                      :status => User::STATUS_REGISTERED,
                                      :sort_key => 'created_on', :sort_order => 'desc')
                 render_multipart('account_activation_request', body)
               end
               # Builds a tmail object used to email the specified user that their account was activated by an administrator.
               #
               # Example:
               #   account_activated(user) => tmail object
               #   Mailer.deliver_account_activated(user) => sends an email to the registered user
               def account_activated(user)
                 set_language_if_valid user.language
                 recipients user.mail
                 subject l(:mail_subject_register, Setting.app_title)
                 body :user => user,
                      :login_url => url_for(:controller => 'account', :action => 'login')
                 render_multipart('account_activated', body)
               end
               def lost_password(token)
                 set_language_if_valid(token.user.language)
                 recipients token.user.mail
                 subject l(:mail_subject_lost_password, Setting.app_title)
                 body :token => token,
                      :url => url_for(:controller => 'account', :action => 'lost_password', :token => token.value)
                 render_multipart('lost_password', body)
               end
               def register(token)
                 set_language_if_valid(token.user.language)
                 recipients token.user.mail
                 subject l(:mail_subject_register, Setting.app_title)
                 body :token => token,
                      :url => url_for(:controller => 'account', :action => 'activate', :token => token.value)
                 render_multipart('register', body)
               end
               def test(user)
                 set_language_if_valid(user.language)
                 recipients user.mail
                 subject 'Redmine test'
                 body :url => url_for(:controller => 'welcome')
                 render_multipart('test', body)
               end
               # Overrides default deliver! method to prevent from sending an email
               # with no recipient, cc or bcc
               def deliver!(mail = @mail)
                 set_language_if_valid @initial_language
                 return false if (recipients.nil? || recipients.empty?) &&
                                 (cc.nil? || cc.empty?) &&
                                 (bcc.nil? || bcc.empty?)
                 # 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
                 # Log errors when raise_delivery_errors is set to false, Rails does not
                 raise_errors = self.class.raise_delivery_errors
                 self.class.raise_delivery_errors = true
                 begin
                   return super(mail)
                 rescue Exception => e
                   if raise_errors
                     raise e
                   elsif mylogger
                     mylogger.error "The following error occured while sending email notification: \"#{e.message}\". Check your configuration in config/configuration.yml."
                   end
                 ensure
                   self.class.raise_delivery_errors = raise_errors
                 end
               end
               # Sends reminders to issue assignees
               # Available options:
               # * :days     => how many days in the future to remind about (defaults to 7)
               # * :tracker  => id of tracker for filtering issues (defaults to all trackers)
               # * :project  => id or identifier of project to process (defaults to all projects)
               # * :users    => array of user ids who should be reminded
               def self.reminders(options={})
                 days = options[:days] || 7
                 project = options[:project] ? Project.find(options[:project]) : nil
                 tracker = options[:tracker] ? Tracker.find(options[:tracker]) : nil
                 user_ids = options[:users]
                 scope = Issue.open.scoped(:conditions => ["#{Issue.table_name}.assigned_to_id IS NOT NULL" +
                   " AND #{Project.table_name}.status = #{Project::STATUS_ACTIVE}" +
                   " AND #{Issue.table_name}.due_date <= ?", days.day.from_now.to_date]
                 )
                 scope = scope.scoped(:conditions => {:assigned_to_id => user_ids}) if user_ids.present?
                 scope = scope.scoped(:conditions => {:project_id => project.id}) if project
                 scope = scope.scoped(:conditions => {:tracker_id => tracker.id}) if tracker
                 issues_by_assignee = scope.all(:include => [:status, :assigned_to, :project, :tracker]).group_by(&:assigned_to)
                 issues_by_assignee.each do |assignee, issues|
                   deliver_reminder(assignee, issues, days) if assignee && assignee.active?
                 end
               end
               # Activates/desactivates email deliveries during +block+
               def self.with_deliveries(enabled = true, &block)
                 was_enabled = ActionMailer::Base.perform_deliveries
                 ActionMailer::Base.perform_deliveries = !!enabled
                 yield
               ensure
                 ActionMailer::Base.perform_deliveries = was_enabled
               end
               private
               def initialize_defaults(method_name)
                 super
                 @initial_language = current_language
                 set_language_if_valid Setting.default_language
                 from Setting.mail_from
                 # Common headers
                 headers 'X-Mailer' => 'Redmine',
                         'X-Redmine-Host' => Setting.host_name,
                         'X-Redmine-Site' => Setting.app_title,
                         'X-Auto-Response-Suppress' => 'OOF',
                         'Auto-Submitted' => 'auto-generated'
               end
               # Appends a Redmine header field (name is prepended with 'X-Redmine-')
               def redmine_headers(h)
                 h.each { |k,v| headers["X-Redmine-#{k}"] = v.to_s }
               end
               # Overrides the create_mail method
               def create_mail
                 # Removes the current user from the recipients and cc
                 # if he doesn't want to receive notifications about what he does
                 @author ||= User.current
                 if @author.pref[:no_self_notified]
                   recipients.delete(@author.mail) if recipients
                   cc.delete(@author.mail) if cc
                 end
+                if @author.logged?
+                  redmine_headers 'Sender' => @author.login
+                end
                 notified_users = [recipients, cc].flatten.compact.uniq
                 # Rails would log recipients only, not cc and bcc
                 mylogger.info "Sending email notification to: #{notified_users.join(', ')}" if mylogger
                 # Blind carbon copy recipients
                 if Setting.bcc_recipients?
                   bcc(notified_users)
                   recipients []
                   cc []
                 end
                 super
               end
               # Rails 2.3 has problems rendering implicit multipart messages with
               # layouts so this method will wrap an multipart messages with
               # explicit parts.
               #
               # https://rails.lighthouseapp.com/projects/8994/tickets/2338-actionmailer-mailer-views-and-content-type
               # https://rails.lighthouseapp.com/projects/8994/tickets/1799-actionmailer-doesnt-set-template_format-when-rendering-layouts
               def render_multipart(method_name, body)
                 if Setting.plain_text_mail?
                   content_type "text/plain"
                   body render(:file => "#{method_name}.text.erb",
                               :body => body,
                               :layout => 'mailer.text.erb')
                 else
                   content_type "multipart/alternative"
                   part :content_type => "text/plain",
                        :body => render(:file => "#{method_name}.text.erb",
                                        :body => body, :layout => 'mailer.text.erb')
                   part :content_type => "text/html",
                        :body => render_message("#{method_name}.html.erb", body)
                 end
               end
               # Makes partial rendering work with Rails 1.2 (retro-compatibility)
               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
                 timestamp = object.send(object.respond_to?(:created_on) ? :created_on : :updated_on)
                 hash = "redmine.#{object.class.name.demodulize.underscore}-#{object.id}.#{timestamp.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
               def mylogger
                 Rails.logger
               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/unit/mailer_test.rb +8 0

             # Redmine - project management software
             # Copyright (C) 2006-2011  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require File.expand_path('../../test_helper', __FILE__)
             class MailerTest < ActiveSupport::TestCase
               include Redmine::I18n
               include ActionController::Assertions::SelectorAssertions
               fixtures :projects, :enabled_modules, :issues, :users, :members,
                        :member_roles, :roles, :documents, :attachments, :news,
                        :tokens, :journals, :journal_details, :changesets, :trackers,
                        :issue_statuses, :enumerations, :messages, :boards, :repositories,
                        :wikis, :wiki_pages, :wiki_contents, :wiki_content_versions,
                        :versions,
                        :comments
               def setup
                 ActionMailer::Base.deliveries.clear
                 Setting.host_name = 'mydomain.foo'
                 Setting.protocol = 'http'
                 Setting.plain_text_mail = '0'
               end
               def test_generated_links_in_emails
                 Setting.host_name = 'mydomain.foo'
                 Setting.protocol = 'https'
                 journal = Journal.find(2)
                 assert Mailer.deliver_issue_edit(journal)
                 mail = ActionMailer::Base.deliveries.last
                 assert_kind_of TMail::Mail, mail
                 assert_select_email do
                   # link to the main ticket
                   assert_select "a[href=?]",
                                 "https://mydomain.foo/issues/1#change-2",
                                 :text => "Bug #1: Can't print recipes"
                   # link to a referenced ticket
                   assert_select "a[href=?][title=?]",
                                 "https://mydomain.foo/issues/2",
                                 "Add ingredients categories (Assigned)",
                                 :text => "#2"
                   # link to a changeset
                   assert_select "a[href=?][title=?]",
                                 "https://mydomain.foo/projects/ecookbook/repository/revisions/2",
                                 "This commit fixes #1, #2 and references #1 &amp; #3",
                                 :text => "r2"
                 end
               end
               def test_generated_links_with_prefix
                 relative_url_root = Redmine::Utils.relative_url_root
                 Setting.host_name = 'mydomain.foo/rdm'
                 Setting.protocol = 'http'
                 Redmine::Utils.relative_url_root = '/rdm'
                 journal = Journal.find(2)
                 assert Mailer.deliver_issue_edit(journal)
                 mail = ActionMailer::Base.deliveries.last
                 assert_kind_of TMail::Mail, mail
                 assert_select_email do
                   # link to the main ticket
                   assert_select "a[href=?]",
                                 "http://mydomain.foo/rdm/issues/1#change-2",
                                 :text => "Bug #1: Can't print recipes"
                   # link to a referenced ticket
                   assert_select "a[href=?][title=?]",
                                 "http://mydomain.foo/rdm/issues/2",
                                 "Add ingredients categories (Assigned)",
                                 :text => "#2"
                   # link to a changeset
                   assert_select "a[href=?][title=?]",
                                 "http://mydomain.foo/rdm/projects/ecookbook/repository/revisions/2",
                                 "This commit fixes #1, #2 and references #1 &amp; #3",
                                 :text => "r2"
                 end
               ensure
                 # restore it
                 Redmine::Utils.relative_url_root = relative_url_root
               end
               def test_generated_links_with_prefix_and_no_relative_url_root
                 relative_url_root = Redmine::Utils.relative_url_root
                 Setting.host_name = 'mydomain.foo/rdm'
                 Setting.protocol = 'http'
                 Redmine::Utils.relative_url_root = nil
                 journal = Journal.find(2)
                 assert Mailer.deliver_issue_edit(journal)
                 mail = ActionMailer::Base.deliveries.last
                 assert_kind_of TMail::Mail, mail
                 assert_select_email do
                   # link to the main ticket
                   assert_select "a[href=?]",
                                 "http://mydomain.foo/rdm/issues/1#change-2",
                                 :text => "Bug #1: Can't print recipes"
                   # link to a referenced ticket
                   assert_select "a[href=?][title=?]",
                                 "http://mydomain.foo/rdm/issues/2",
                                 "Add ingredients categories (Assigned)",
                                 :text => "#2"
                   # link to a changeset
                   assert_select "a[href=?][title=?]",
                                 "http://mydomain.foo/rdm/projects/ecookbook/repository/revisions/2",
                                 "This commit fixes #1, #2 and references #1 &amp; #3",
                                 :text => "r2"
                 end
               ensure
                 # restore it
                 Redmine::Utils.relative_url_root = relative_url_root
               end
               def test_email_headers
                 issue = Issue.find(1)
                 Mailer.deliver_issue_add(issue)
                 mail = ActionMailer::Base.deliveries.last
                 assert_not_nil mail
                 assert_equal 'OOF', mail.header_string('X-Auto-Response-Suppress')
                 assert_equal 'auto-generated', mail.header_string('Auto-Submitted')
               end
+              def test_email_headers_should_include_sender
+                issue = Issue.find(1)
+                Mailer.deliver_issue_add(issue)
+                mail = ActionMailer::Base.deliveries.last
+                assert_not_nil mail
+                assert_equal issue.author.login, mail.header_string('X-Redmine-Sender')
+              end
               def test_plain_text_mail
                 Setting.plain_text_mail = 1
                 journal = Journal.find(2)
                 Mailer.deliver_issue_edit(journal)
                 mail = ActionMailer::Base.deliveries.last
                 assert_equal "text/plain", mail.content_type
                 assert_equal 0, mail.parts.size
                 assert !mail.encoded.include?('href')
               end
               def test_html_mail
                 Setting.plain_text_mail = 0
                 journal = Journal.find(2)
                 Mailer.deliver_issue_edit(journal)
                 mail = ActionMailer::Base.deliveries.last
                 assert_equal 2, mail.parts.size
                 assert mail.encoded.include?('href')
               end
               def test_from_header
                 with_settings :mail_from => 'redmine@example.net' do
                   Mailer.deliver_test(User.find(1))
                 end
                 mail = ActionMailer::Base.deliveries.last
                 assert_not_nil mail
                 assert_equal 'redmine@example.net', mail.from_addrs.first.address
               end
               def test_from_header_with_phrase
                 with_settings :mail_from => 'Redmine app <redmine@example.net>' do
                   Mailer.deliver_test(User.find(1))
                 end
                 mail = ActionMailer::Base.deliveries.last
                 assert_not_nil mail
                 assert_equal 'redmine@example.net', mail.from_addrs.first.address
                 assert_equal 'Redmine app', mail.from_addrs.first.name
               end
               def test_should_not_send_email_without_recipient
                 news = News.find(:first)
                 user = news.author
                 # Remove members except news author
                 news.project.memberships.each {|m| m.destroy unless m.user == user}
                 user.pref[:no_self_notified] = false
                 user.pref.save
                 User.current = user
                 Mailer.deliver_news_added(news.reload)
                 assert_equal 1, last_email.bcc.size
                 # nobody to notify
                 user.pref[:no_self_notified] = true
                 user.pref.save
                 User.current = user
                 ActionMailer::Base.deliveries.clear
                 Mailer.deliver_news_added(news.reload)
                 assert ActionMailer::Base.deliveries.empty?
               end
               def test_issue_add_message_id
                 issue = Issue.find(1)
                 Mailer.deliver_issue_add(issue)
                 mail = ActionMailer::Base.deliveries.last
                 assert_not_nil mail
                 assert_equal Mailer.message_id_for(issue), mail.message_id
                 assert_nil mail.references
               end
               def test_issue_edit_message_id
                 journal = Journal.find(1)
                 Mailer.deliver_issue_edit(journal)
                 mail = ActionMailer::Base.deliveries.last
                 assert_not_nil mail
                 assert_equal Mailer.message_id_for(journal), mail.message_id
                 assert_equal Mailer.message_id_for(journal.issue), mail.references.first.to_s
                 assert_select_email do
                   # link to the update
                   assert_select "a[href=?]",
                                 "http://mydomain.foo/issues/#{journal.journalized_id}#change-#{journal.id}"
                 end
               end
               def test_message_posted_message_id
                 message = Message.find(1)
                 Mailer.deliver_message_posted(message)
                 mail = ActionMailer::Base.deliveries.last
                 assert_not_nil mail
                 assert_equal Mailer.message_id_for(message), mail.message_id
                 assert_nil mail.references
                 assert_select_email do
                   # link to the message
                   assert_select "a[href=?]",
                                 "http://mydomain.foo/boards/#{message.board.id}/topics/#{message.id}",
                                 :text => message.subject
                 end
               end
               def test_reply_posted_message_id
                 message = Message.find(3)
                 Mailer.deliver_message_posted(message)
                 mail = ActionMailer::Base.deliveries.last
                 assert_not_nil mail
                 assert_equal Mailer.message_id_for(message), mail.message_id
                 assert_equal Mailer.message_id_for(message.parent), mail.references.first.to_s
                 assert_select_email do
                   # link to the reply
                   assert_select "a[href=?]",
                                 "http://mydomain.foo/boards/#{message.board.id}/topics/#{message.root.id}?r=#{message.id}#message-#{message.id}",
                                 :text => message.subject
                 end
               end
               context("#issue_add") do
                 setup do
                   ActionMailer::Base.deliveries.clear
                   Setting.bcc_recipients = '1'
                   @issue = Issue.find(1)
                 end
                 should "notify project members" do
                   assert Mailer.deliver_issue_add(@issue)
                   assert last_email.bcc.include?('dlopper@somenet.foo')
                 end
                 should "not notify project members that are not allow to view the issue" do
                   Role.find(2).remove_permission!(:view_issues)
                   assert Mailer.deliver_issue_add(@issue)
                   assert !last_email.bcc.include?('dlopper@somenet.foo')
                 end
                 should "notify issue watchers" do
                   user = User.find(9)
                   # minimal email notification options
                   user.pref[:no_self_notified] = '1'
                   user.pref.save
                   user.mail_notification = false
                   user.save
                   Watcher.create!(:watchable => @issue, :user => user)
                   assert Mailer.deliver_issue_add(@issue)
                   assert last_email.bcc.include?(user.mail)
                 end
                 should "not notify watchers not allowed to view the issue" do
                   user = User.find(9)
                   Watcher.create!(:watchable => @issue, :user => user)
                   Role.non_member.remove_permission!(:view_issues)
                   assert Mailer.deliver_issue_add(@issue)
                   assert !last_email.bcc.include?(user.mail)
                 end
               end
               # test mailer methods for each language
               def test_issue_add
                 issue = Issue.find(1)
                 valid_languages.each do |lang|
                   Setting.default_language = lang.to_s
                   assert Mailer.deliver_issue_add(issue)
                 end
               end
               def test_issue_edit
                 journal = Journal.find(1)
                 valid_languages.each do |lang|
                   Setting.default_language = lang.to_s
                   assert Mailer.deliver_issue_edit(journal)
                 end
               end
               def test_document_added
                 document = Document.find(1)
                 valid_languages.each do |lang|
                   Setting.default_language = lang.to_s
                   assert Mailer.deliver_document_added(document)
                 end
               end
               def test_attachments_added
                 attachements = [ Attachment.find_by_container_type('Document') ]
                 valid_languages.each do |lang|
                   Setting.default_language = lang.to_s
                   assert Mailer.deliver_attachments_added(attachements)
                 end
               end
               def test_version_file_added
                 attachements = [ Attachment.find_by_container_type('Version') ]
                 assert Mailer.deliver_attachments_added(attachements)
                 assert_not_nil last_email.bcc
                 assert last_email.bcc.any?
                 assert_select_email do
                   assert_select "a[href=?]", "http://mydomain.foo/projects/ecookbook/files"
                 end
               end
               def test_project_file_added
                 attachements = [ Attachment.find_by_container_type('Project') ]
                 assert Mailer.deliver_attachments_added(attachements)
                 assert_not_nil last_email.bcc
                 assert last_email.bcc.any?
                 assert_select_email do
                   assert_select "a[href=?]", "http://mydomain.foo/projects/ecookbook/files"
                 end
               end
               def test_news_added
                 news = News.find(:first)
                 valid_languages.each do |lang|
                   Setting.default_language = lang.to_s
                   assert Mailer.deliver_news_added(news)
                 end
               end
               def test_news_comment_added
                 comment = Comment.find(2)
                 valid_languages.each do |lang|
                   Setting.default_language = lang.to_s
                   assert Mailer.deliver_news_comment_added(comment)
                 end
               end
               def test_message_posted
                 message = Message.find(:first)
                 recipients = ([message.root] + message.root.children).collect {|m| m.author.mail if m.author}
                 recipients = recipients.compact.uniq
                 valid_languages.each do |lang|
                   Setting.default_language = lang.to_s
                   assert Mailer.deliver_message_posted(message)
                 end
               end
               def test_wiki_content_added
                 content = WikiContent.find(:first)
                 valid_languages.each do |lang|
                   Setting.default_language = lang.to_s
                   assert_difference 'ActionMailer::Base.deliveries.size' do
                     assert Mailer.deliver_wiki_content_added(content)
                   end
                 end
               end
               def test_wiki_content_updated
                 content = WikiContent.find(:first)
                 valid_languages.each do |lang|
                   Setting.default_language = lang.to_s
                   assert_difference 'ActionMailer::Base.deliveries.size' do
                     assert Mailer.deliver_wiki_content_updated(content)
                   end
                 end
               end
               def test_account_information
                 user = User.find(2)
                 valid_languages.each do |lang|
                   user.update_attribute :language, lang.to_s
                   user.reload
                   assert Mailer.deliver_account_information(user, 'pAsswORd')
                 end
               end
               def test_lost_password
                 token = Token.find(2)
                 valid_languages.each do |lang|
                   token.user.update_attribute :language, lang.to_s
                   token.reload
                   assert Mailer.deliver_lost_password(token)
                 end
               end
               def test_register
                 token = Token.find(1)
                 Setting.host_name = 'redmine.foo'
                 Setting.protocol = 'https'
                 valid_languages.each do |lang|
                   token.user.update_attribute :language, lang.to_s
                   token.reload
                   ActionMailer::Base.deliveries.clear
                   assert Mailer.deliver_register(token)
                   mail = ActionMailer::Base.deliveries.last
                   assert mail.body.include?("https://redmine.foo/account/activate?token=#{token.value}")
                 end
               end
               def test_test
                 user = User.find(1)
                 valid_languages.each do |lang|
                   user.update_attribute :language, lang.to_s
                   assert Mailer.deliver_test(user)
                 end
               end
               def test_reminders
                 Mailer.reminders(:days => 42)
                 assert_equal 1, ActionMailer::Base.deliveries.size
                 mail = ActionMailer::Base.deliveries.last
                 assert mail.bcc.include?('dlopper@somenet.foo')
                 assert mail.body.include?('Bug #3: Error 281 when updating a recipe')
                 assert_equal '1 issue(s) due in the next 42 days', mail.subject
               end
               def test_reminders_should_not_include_closed_issues
                 Issue.generate!(:project_id => 1, :tracker_id => 1, :status_id => 5, :subject => 'Closed issue', :assigned_to_id => 3, :due_date => 5.days.from_now)
                 ActionMailer::Base.deliveries.clear
                 Mailer.reminders(:days => 42)
                 assert_equal 1, ActionMailer::Base.deliveries.size
                 mail = ActionMailer::Base.deliveries.last
                 assert mail.bcc.include?('dlopper@somenet.foo')
                 assert !mail.body.include?('Closed issue')
               end
               def test_reminders_for_users
                 Mailer.reminders(:days => 42, :users => ['5'])
                 assert_equal 0, ActionMailer::Base.deliveries.size # No mail for dlopper
                 Mailer.reminders(:days => 42, :users => ['3'])
                 assert_equal 1, ActionMailer::Base.deliveries.size # No mail for dlopper
                 mail = ActionMailer::Base.deliveries.last
                 assert mail.bcc.include?('dlopper@somenet.foo')
                 assert mail.body.include?('Bug #3: Error 281 when updating a recipe')
               end
               def last_email
                 mail = ActionMailer::Base.deliveries.last
                 assert_not_nil mail
                 mail
               end
               def test_mailer_should_not_change_locale
                 Setting.default_language = 'en'
                 # Set current language to italian
                 set_language_if_valid 'it'
                 # Send an email to a french user
                 user = User.find(1)
                 user.language = 'fr'
                 Mailer.deliver_account_activated(user)
                 mail = ActionMailer::Base.deliveries.last
                 assert mail.body.include?('Votre compte')
                 assert_equal :it, current_language
               end
               def test_with_deliveries_off
                 Mailer.with_deliveries false do
                   Mailer.deliver_test(User.find(1))
                 end
                 assert ActionMailer::Base.deliveries.empty?
                 # should restore perform_deliveries
                 assert ActionMailer::Base.perform_deliveries
               end
               def test_tmail_to_header_field_should_not_include_blank_lines
                 mail = TMail::Mail.new
                 mail.to = ["a.user@example.com", "v.user2@example.com", "e.smith@example.com", "info@example.com", "v.pupkin@example.com",
                   "b.user@example.com", "w.user2@example.com", "f.smith@example.com", "info2@example.com", "w.pupkin@example.com"]
                 assert !mail.encoded.strip.split("\r\n").detect(&:blank?), "#{mail.encoded} malformed"
               end
               def test_layout_should_include_the_emails_header
                 with_settings :emails_header => "*Header content*" do
                   assert Mailer.deliver_test(User.find(1))
                   assert_select_email do
                     assert_select ".header" do
                       assert_select "strong", :text => "Header content"
                     end
                   end
                 end
               end
             end

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