##// END OF EJS Templates
Fixed that reminders are sent for closed issues (#10006)....
Jean-Philippe Lang -
r8570:94b621a99fd5
parent child
Show More
@@ -1,472 +1,472
1 1 # Redmine - project management software
2 2 # Copyright (C) 2006-2011 Jean-Philippe Lang
3 3 #
4 4 # This program is free software; you can redistribute it and/or
5 5 # modify it under the terms of the GNU General Public License
6 6 # as published by the Free Software Foundation; either version 2
7 7 # of the License, or (at your option) any later version.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU General Public License
15 15 # along with this program; if not, write to the Free Software
16 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 17
18 18 class Mailer < ActionMailer::Base
19 19 layout 'mailer'
20 20 helper :application
21 21 helper :issues
22 22 helper :custom_fields
23 23
24 24 include ActionController::UrlWriter
25 25 include Redmine::I18n
26 26
27 27 def self.default_url_options
28 28 h = Setting.host_name
29 29 h = h.to_s.gsub(%r{\/.*$}, '') unless Redmine::Utils.relative_url_root.blank?
30 30 { :host => h, :protocol => Setting.protocol }
31 31 end
32 32
33 33 # Builds a tmail object used to email recipients of the added issue.
34 34 #
35 35 # Example:
36 36 # issue_add(issue) => tmail object
37 37 # Mailer.deliver_issue_add(issue) => sends an email to issue recipients
38 38 def issue_add(issue)
39 39 redmine_headers 'Project' => issue.project.identifier,
40 40 'Issue-Id' => issue.id,
41 41 'Issue-Author' => issue.author.login
42 42 redmine_headers 'Issue-Assignee' => issue.assigned_to.login if issue.assigned_to
43 43 message_id issue
44 44 recipients issue.recipients
45 45 cc(issue.watcher_recipients - @recipients)
46 46 subject "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] (#{issue.status.name}) #{issue.subject}"
47 47 body :issue => issue,
48 48 :issue_url => url_for(:controller => 'issues', :action => 'show', :id => issue)
49 49 render_multipart('issue_add', body)
50 50 end
51 51
52 52 # Builds a tmail object used to email recipients of the edited issue.
53 53 #
54 54 # Example:
55 55 # issue_edit(journal) => tmail object
56 56 # Mailer.deliver_issue_edit(journal) => sends an email to issue recipients
57 57 def issue_edit(journal)
58 58 issue = journal.journalized.reload
59 59 redmine_headers 'Project' => issue.project.identifier,
60 60 'Issue-Id' => issue.id,
61 61 'Issue-Author' => issue.author.login
62 62 redmine_headers 'Issue-Assignee' => issue.assigned_to.login if issue.assigned_to
63 63 message_id journal
64 64 references issue
65 65 @author = journal.user
66 66 recipients issue.recipients
67 67 # Watchers in cc
68 68 cc(issue.watcher_recipients - @recipients)
69 69 s = "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] "
70 70 s << "(#{issue.status.name}) " if journal.new_value_for('status_id')
71 71 s << issue.subject
72 72 subject s
73 73 body :issue => issue,
74 74 :journal => journal,
75 75 :issue_url => url_for(:controller => 'issues', :action => 'show', :id => issue, :anchor => "change-#{journal.id}")
76 76
77 77 render_multipart('issue_edit', body)
78 78 end
79 79
80 80 def reminder(user, issues, days)
81 81 set_language_if_valid user.language
82 82 recipients user.mail
83 83 subject l(:mail_subject_reminder, :count => issues.size, :days => days)
84 84 body :issues => issues,
85 85 :days => days,
86 86 :issues_url => url_for(:controller => 'issues', :action => 'index',
87 87 :set_filter => 1, :assigned_to_id => user.id,
88 88 :sort => 'due_date:asc')
89 89 render_multipart('reminder', body)
90 90 end
91 91
92 92 # Builds a tmail object used to email users belonging to the added document's project.
93 93 #
94 94 # Example:
95 95 # document_added(document) => tmail object
96 96 # Mailer.deliver_document_added(document) => sends an email to the document's project recipients
97 97 def document_added(document)
98 98 redmine_headers 'Project' => document.project.identifier
99 99 recipients document.recipients
100 100 subject "[#{document.project.name}] #{l(:label_document_new)}: #{document.title}"
101 101 body :document => document,
102 102 :document_url => url_for(:controller => 'documents', :action => 'show', :id => document)
103 103 render_multipart('document_added', body)
104 104 end
105 105
106 106 # Builds a tmail object used to email recipients of a project when an attachements are added.
107 107 #
108 108 # Example:
109 109 # attachments_added(attachments) => tmail object
110 110 # Mailer.deliver_attachments_added(attachments) => sends an email to the project's recipients
111 111 def attachments_added(attachments)
112 112 container = attachments.first.container
113 113 added_to = ''
114 114 added_to_url = ''
115 115 case container.class.name
116 116 when 'Project'
117 117 added_to_url = url_for(:controller => 'files', :action => 'index', :project_id => container)
118 118 added_to = "#{l(:label_project)}: #{container}"
119 119 recipients container.project.notified_users.select {|user| user.allowed_to?(:view_files, container.project)}.collect {|u| u.mail}
120 120 when 'Version'
121 121 added_to_url = url_for(:controller => 'files', :action => 'index', :project_id => container.project)
122 122 added_to = "#{l(:label_version)}: #{container.name}"
123 123 recipients container.project.notified_users.select {|user| user.allowed_to?(:view_files, container.project)}.collect {|u| u.mail}
124 124 when 'Document'
125 125 added_to_url = url_for(:controller => 'documents', :action => 'show', :id => container.id)
126 126 added_to = "#{l(:label_document)}: #{container.title}"
127 127 recipients container.recipients
128 128 end
129 129 redmine_headers 'Project' => container.project.identifier
130 130 subject "[#{container.project.name}] #{l(:label_attachment_new)}"
131 131 body :attachments => attachments,
132 132 :added_to => added_to,
133 133 :added_to_url => added_to_url
134 134 render_multipart('attachments_added', body)
135 135 end
136 136
137 137 # Builds a tmail object used to email recipients of a news' project when a news item is added.
138 138 #
139 139 # Example:
140 140 # news_added(news) => tmail object
141 141 # Mailer.deliver_news_added(news) => sends an email to the news' project recipients
142 142 def news_added(news)
143 143 redmine_headers 'Project' => news.project.identifier
144 144 message_id news
145 145 recipients news.recipients
146 146 subject "[#{news.project.name}] #{l(:label_news)}: #{news.title}"
147 147 body :news => news,
148 148 :news_url => url_for(:controller => 'news', :action => 'show', :id => news)
149 149 render_multipart('news_added', body)
150 150 end
151 151
152 152 # Builds a tmail object used to email recipients of a news' project when a news comment is added.
153 153 #
154 154 # Example:
155 155 # news_comment_added(comment) => tmail object
156 156 # Mailer.news_comment_added(comment) => sends an email to the news' project recipients
157 157 def news_comment_added(comment)
158 158 news = comment.commented
159 159 redmine_headers 'Project' => news.project.identifier
160 160 message_id comment
161 161 recipients news.recipients
162 162 cc news.watcher_recipients
163 163 subject "Re: [#{news.project.name}] #{l(:label_news)}: #{news.title}"
164 164 body :news => news,
165 165 :comment => comment,
166 166 :news_url => url_for(:controller => 'news', :action => 'show', :id => news)
167 167 render_multipart('news_comment_added', body)
168 168 end
169 169
170 170 # Builds a tmail object used to email the recipients of the specified message that was posted.
171 171 #
172 172 # Example:
173 173 # message_posted(message) => tmail object
174 174 # Mailer.deliver_message_posted(message) => sends an email to the recipients
175 175 def message_posted(message)
176 176 redmine_headers 'Project' => message.project.identifier,
177 177 'Topic-Id' => (message.parent_id || message.id)
178 178 message_id message
179 179 references message.parent unless message.parent.nil?
180 180 recipients(message.recipients)
181 181 cc((message.root.watcher_recipients + message.board.watcher_recipients).uniq - @recipients)
182 182 subject "[#{message.board.project.name} - #{message.board.name} - msg#{message.root.id}] #{message.subject}"
183 183 body :message => message,
184 184 :message_url => url_for(message.event_url)
185 185 render_multipart('message_posted', body)
186 186 end
187 187
188 188 # Builds a tmail object used to email the recipients of a project of the specified wiki content was added.
189 189 #
190 190 # Example:
191 191 # wiki_content_added(wiki_content) => tmail object
192 192 # Mailer.deliver_wiki_content_added(wiki_content) => sends an email to the project's recipients
193 193 def wiki_content_added(wiki_content)
194 194 redmine_headers 'Project' => wiki_content.project.identifier,
195 195 'Wiki-Page-Id' => wiki_content.page.id
196 196 message_id wiki_content
197 197 recipients wiki_content.recipients
198 198 cc(wiki_content.page.wiki.watcher_recipients - recipients)
199 199 subject "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_added, :id => wiki_content.page.pretty_title)}"
200 200 body :wiki_content => wiki_content,
201 201 :wiki_content_url => url_for(:controller => 'wiki', :action => 'show',
202 202 :project_id => wiki_content.project,
203 203 :id => wiki_content.page.title)
204 204 render_multipart('wiki_content_added', body)
205 205 end
206 206
207 207 # Builds a tmail object used to email the recipients of a project of the specified wiki content was updated.
208 208 #
209 209 # Example:
210 210 # wiki_content_updated(wiki_content) => tmail object
211 211 # Mailer.deliver_wiki_content_updated(wiki_content) => sends an email to the project's recipients
212 212 def wiki_content_updated(wiki_content)
213 213 redmine_headers 'Project' => wiki_content.project.identifier,
214 214 'Wiki-Page-Id' => wiki_content.page.id
215 215 message_id wiki_content
216 216 recipients wiki_content.recipients
217 217 cc(wiki_content.page.wiki.watcher_recipients + wiki_content.page.watcher_recipients - recipients)
218 218 subject "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_updated, :id => wiki_content.page.pretty_title)}"
219 219 body :wiki_content => wiki_content,
220 220 :wiki_content_url => url_for(:controller => 'wiki', :action => 'show',
221 221 :project_id => wiki_content.project,
222 222 :id => wiki_content.page.title),
223 223 :wiki_diff_url => url_for(:controller => 'wiki', :action => 'diff',
224 224 :project_id => wiki_content.project, :id => wiki_content.page.title,
225 225 :version => wiki_content.version)
226 226 render_multipart('wiki_content_updated', body)
227 227 end
228 228
229 229 # Builds a tmail object used to email the specified user their account information.
230 230 #
231 231 # Example:
232 232 # account_information(user, password) => tmail object
233 233 # Mailer.deliver_account_information(user, password) => sends account information to the user
234 234 def account_information(user, password)
235 235 set_language_if_valid user.language
236 236 recipients user.mail
237 237 subject l(:mail_subject_register, Setting.app_title)
238 238 body :user => user,
239 239 :password => password,
240 240 :login_url => url_for(:controller => 'account', :action => 'login')
241 241 render_multipart('account_information', body)
242 242 end
243 243
244 244 # Builds a tmail object used to email all active administrators of an account activation request.
245 245 #
246 246 # Example:
247 247 # account_activation_request(user) => tmail object
248 248 # Mailer.deliver_account_activation_request(user)=> sends an email to all active administrators
249 249 def account_activation_request(user)
250 250 # Send the email to all active administrators
251 251 recipients User.active.find(:all, :conditions => {:admin => true}).collect { |u| u.mail }.compact
252 252 subject l(:mail_subject_account_activation_request, Setting.app_title)
253 253 body :user => user,
254 254 :url => url_for(:controller => 'users', :action => 'index',
255 255 :status => User::STATUS_REGISTERED,
256 256 :sort_key => 'created_on', :sort_order => 'desc')
257 257 render_multipart('account_activation_request', body)
258 258 end
259 259
260 260 # Builds a tmail object used to email the specified user that their account was activated by an administrator.
261 261 #
262 262 # Example:
263 263 # account_activated(user) => tmail object
264 264 # Mailer.deliver_account_activated(user) => sends an email to the registered user
265 265 def account_activated(user)
266 266 set_language_if_valid user.language
267 267 recipients user.mail
268 268 subject l(:mail_subject_register, Setting.app_title)
269 269 body :user => user,
270 270 :login_url => url_for(:controller => 'account', :action => 'login')
271 271 render_multipart('account_activated', body)
272 272 end
273 273
274 274 def lost_password(token)
275 275 set_language_if_valid(token.user.language)
276 276 recipients token.user.mail
277 277 subject l(:mail_subject_lost_password, Setting.app_title)
278 278 body :token => token,
279 279 :url => url_for(:controller => 'account', :action => 'lost_password', :token => token.value)
280 280 render_multipart('lost_password', body)
281 281 end
282 282
283 283 def register(token)
284 284 set_language_if_valid(token.user.language)
285 285 recipients token.user.mail
286 286 subject l(:mail_subject_register, Setting.app_title)
287 287 body :token => token,
288 288 :url => url_for(:controller => 'account', :action => 'activate', :token => token.value)
289 289 render_multipart('register', body)
290 290 end
291 291
292 292 def test(user)
293 293 set_language_if_valid(user.language)
294 294 recipients user.mail
295 295 subject 'Redmine test'
296 296 body :url => url_for(:controller => 'welcome')
297 297 render_multipart('test', body)
298 298 end
299 299
300 300 # Overrides default deliver! method to prevent from sending an email
301 301 # with no recipient, cc or bcc
302 302 def deliver!(mail = @mail)
303 303 set_language_if_valid @initial_language
304 304 return false if (recipients.nil? || recipients.empty?) &&
305 305 (cc.nil? || cc.empty?) &&
306 306 (bcc.nil? || bcc.empty?)
307 307
308 308 # Set Message-Id and References
309 309 if @message_id_object
310 310 mail.message_id = self.class.message_id_for(@message_id_object)
311 311 end
312 312 if @references_objects
313 313 mail.references = @references_objects.collect {|o| self.class.message_id_for(o)}
314 314 end
315 315
316 316 # Log errors when raise_delivery_errors is set to false, Rails does not
317 317 raise_errors = self.class.raise_delivery_errors
318 318 self.class.raise_delivery_errors = true
319 319 begin
320 320 return super(mail)
321 321 rescue Exception => e
322 322 if raise_errors
323 323 raise e
324 324 elsif mylogger
325 325 mylogger.error "The following error occured while sending email notification: \"#{e.message}\". Check your configuration in config/configuration.yml."
326 326 end
327 327 ensure
328 328 self.class.raise_delivery_errors = raise_errors
329 329 end
330 330 end
331 331
332 332 # Sends reminders to issue assignees
333 333 # Available options:
334 334 # * :days => how many days in the future to remind about (defaults to 7)
335 335 # * :tracker => id of tracker for filtering issues (defaults to all trackers)
336 336 # * :project => id or identifier of project to process (defaults to all projects)
337 337 # * :users => array of user ids who should be reminded
338 338 def self.reminders(options={})
339 339 days = options[:days] || 7
340 340 project = options[:project] ? Project.find(options[:project]) : nil
341 341 tracker = options[:tracker] ? Tracker.find(options[:tracker]) : nil
342 342 user_ids = options[:users]
343 343
344 scope = Issue.scoped(:conditions => ["#{Issue.table_name}.assigned_to_id IS NOT NULL" +
344 scope = Issue.open.scoped(:conditions => ["#{Issue.table_name}.assigned_to_id IS NOT NULL" +
345 345 " AND #{Project.table_name}.status = #{Project::STATUS_ACTIVE}" +
346 346 " AND #{Issue.table_name}.due_date <= ?", days.day.from_now.to_date]
347 347 )
348 348 scope = scope.scoped(:conditions => {:assigned_to_id => user_ids}) if user_ids.present?
349 349 scope = scope.scoped(:conditions => {:project_id => project.id}) if project
350 350 scope = scope.scoped(:conditions => {:tracker_id => tracker.id}) if tracker
351 351
352 352 issues_by_assignee = scope.all(:include => [:status, :assigned_to, :project, :tracker]).group_by(&:assigned_to)
353 353 issues_by_assignee.each do |assignee, issues|
354 354 deliver_reminder(assignee, issues, days) if assignee && assignee.active?
355 355 end
356 356 end
357 357
358 358 # Activates/desactivates email deliveries during +block+
359 359 def self.with_deliveries(enabled = true, &block)
360 360 was_enabled = ActionMailer::Base.perform_deliveries
361 361 ActionMailer::Base.perform_deliveries = !!enabled
362 362 yield
363 363 ensure
364 364 ActionMailer::Base.perform_deliveries = was_enabled
365 365 end
366 366
367 367 private
368 368 def initialize_defaults(method_name)
369 369 super
370 370 @initial_language = current_language
371 371 set_language_if_valid Setting.default_language
372 372 from Setting.mail_from
373 373
374 374 # Common headers
375 375 headers 'X-Mailer' => 'Redmine',
376 376 'X-Redmine-Host' => Setting.host_name,
377 377 'X-Redmine-Site' => Setting.app_title,
378 378 'X-Auto-Response-Suppress' => 'OOF',
379 379 'Auto-Submitted' => 'auto-generated'
380 380 end
381 381
382 382 # Appends a Redmine header field (name is prepended with 'X-Redmine-')
383 383 def redmine_headers(h)
384 384 h.each { |k,v| headers["X-Redmine-#{k}"] = v.to_s }
385 385 end
386 386
387 387 # Overrides the create_mail method
388 388 def create_mail
389 389 # Removes the current user from the recipients and cc
390 390 # if he doesn't want to receive notifications about what he does
391 391 @author ||= User.current
392 392 if @author.pref[:no_self_notified]
393 393 recipients.delete(@author.mail) if recipients
394 394 cc.delete(@author.mail) if cc
395 395 end
396 396
397 397 notified_users = [recipients, cc].flatten.compact.uniq
398 398 # Rails would log recipients only, not cc and bcc
399 399 mylogger.info "Sending email notification to: #{notified_users.join(', ')}" if mylogger
400 400
401 401 # Blind carbon copy recipients
402 402 if Setting.bcc_recipients?
403 403 bcc(notified_users)
404 404 recipients []
405 405 cc []
406 406 end
407 407 super
408 408 end
409 409
410 410 # Rails 2.3 has problems rendering implicit multipart messages with
411 411 # layouts so this method will wrap an multipart messages with
412 412 # explicit parts.
413 413 #
414 414 # https://rails.lighthouseapp.com/projects/8994/tickets/2338-actionmailer-mailer-views-and-content-type
415 415 # https://rails.lighthouseapp.com/projects/8994/tickets/1799-actionmailer-doesnt-set-template_format-when-rendering-layouts
416 416
417 417 def render_multipart(method_name, body)
418 418 if Setting.plain_text_mail?
419 419 content_type "text/plain"
420 420 body render(:file => "#{method_name}.text.erb",
421 421 :body => body,
422 422 :layout => 'mailer.text.erb')
423 423 else
424 424 content_type "multipart/alternative"
425 425 part :content_type => "text/plain",
426 426 :body => render(:file => "#{method_name}.text.erb",
427 427 :body => body, :layout => 'mailer.text.erb')
428 428 part :content_type => "text/html",
429 429 :body => render_message("#{method_name}.html.erb", body)
430 430 end
431 431 end
432 432
433 433 # Makes partial rendering work with Rails 1.2 (retro-compatibility)
434 434 def self.controller_path
435 435 ''
436 436 end unless respond_to?('controller_path')
437 437
438 438 # Returns a predictable Message-Id for the given object
439 439 def self.message_id_for(object)
440 440 # id + timestamp should reduce the odds of a collision
441 441 # as far as we don't send multiple emails for the same object
442 442 timestamp = object.send(object.respond_to?(:created_on) ? :created_on : :updated_on)
443 443 hash = "redmine.#{object.class.name.demodulize.underscore}-#{object.id}.#{timestamp.strftime("%Y%m%d%H%M%S")}"
444 444 host = Setting.mail_from.to_s.gsub(%r{^.*@}, '')
445 445 host = "#{::Socket.gethostname}.redmine" if host.empty?
446 446 "<#{hash}@#{host}>"
447 447 end
448 448
449 449 private
450 450
451 451 def message_id(object)
452 452 @message_id_object = object
453 453 end
454 454
455 455 def references(object)
456 456 @references_objects ||= []
457 457 @references_objects << object
458 458 end
459 459
460 460 def mylogger
461 461 Rails.logger
462 462 end
463 463 end
464 464
465 465 # Patch TMail so that message_id is not overwritten
466 466 module TMail
467 467 class Mail
468 468 def add_message_id( fqdn = nil )
469 469 self.message_id ||= ::TMail::new_message_id(fqdn)
470 470 end
471 471 end
472 472 end
@@ -1,499 +1,510
1 1 # Redmine - project management software
2 2 # Copyright (C) 2006-2011 Jean-Philippe Lang
3 3 #
4 4 # This program is free software; you can redistribute it and/or
5 5 # modify it under the terms of the GNU General Public License
6 6 # as published by the Free Software Foundation; either version 2
7 7 # of the License, or (at your option) any later version.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU General Public License
15 15 # along with this program; if not, write to the Free Software
16 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 17
18 18 require File.expand_path('../../test_helper', __FILE__)
19 19
20 20 class MailerTest < ActiveSupport::TestCase
21 21 include Redmine::I18n
22 22 include ActionController::Assertions::SelectorAssertions
23 23 fixtures :projects, :enabled_modules, :issues, :users, :members,
24 24 :member_roles, :roles, :documents, :attachments, :news,
25 25 :tokens, :journals, :journal_details, :changesets, :trackers,
26 26 :issue_statuses, :enumerations, :messages, :boards, :repositories,
27 27 :wikis, :wiki_pages, :wiki_contents, :wiki_content_versions,
28 28 :versions,
29 29 :comments
30 30
31 31 def setup
32 32 ActionMailer::Base.deliveries.clear
33 33 Setting.host_name = 'mydomain.foo'
34 34 Setting.protocol = 'http'
35 35 Setting.plain_text_mail = '0'
36 36 end
37 37
38 38 def test_generated_links_in_emails
39 39 Setting.host_name = 'mydomain.foo'
40 40 Setting.protocol = 'https'
41 41
42 42 journal = Journal.find(2)
43 43 assert Mailer.deliver_issue_edit(journal)
44 44
45 45 mail = ActionMailer::Base.deliveries.last
46 46 assert_kind_of TMail::Mail, mail
47 47
48 48 assert_select_email do
49 49 # link to the main ticket
50 50 assert_select "a[href=?]",
51 51 "https://mydomain.foo/issues/1#change-2",
52 52 :text => "Bug #1: Can't print recipes"
53 53 # link to a referenced ticket
54 54 assert_select "a[href=?][title=?]",
55 55 "https://mydomain.foo/issues/2",
56 56 "Add ingredients categories (Assigned)",
57 57 :text => "#2"
58 58 # link to a changeset
59 59 assert_select "a[href=?][title=?]",
60 60 "https://mydomain.foo/projects/ecookbook/repository/revisions/2",
61 61 "This commit fixes #1, #2 and references #1 &amp; #3",
62 62 :text => "r2"
63 63 end
64 64 end
65 65
66 66 def test_generated_links_with_prefix
67 67 relative_url_root = Redmine::Utils.relative_url_root
68 68 Setting.host_name = 'mydomain.foo/rdm'
69 69 Setting.protocol = 'http'
70 70 Redmine::Utils.relative_url_root = '/rdm'
71 71
72 72 journal = Journal.find(2)
73 73 assert Mailer.deliver_issue_edit(journal)
74 74
75 75 mail = ActionMailer::Base.deliveries.last
76 76 assert_kind_of TMail::Mail, mail
77 77
78 78 assert_select_email do
79 79 # link to the main ticket
80 80 assert_select "a[href=?]",
81 81 "http://mydomain.foo/rdm/issues/1#change-2",
82 82 :text => "Bug #1: Can't print recipes"
83 83 # link to a referenced ticket
84 84 assert_select "a[href=?][title=?]",
85 85 "http://mydomain.foo/rdm/issues/2",
86 86 "Add ingredients categories (Assigned)",
87 87 :text => "#2"
88 88 # link to a changeset
89 89 assert_select "a[href=?][title=?]",
90 90 "http://mydomain.foo/rdm/projects/ecookbook/repository/revisions/2",
91 91 "This commit fixes #1, #2 and references #1 &amp; #3",
92 92 :text => "r2"
93 93 end
94 94 ensure
95 95 # restore it
96 96 Redmine::Utils.relative_url_root = relative_url_root
97 97 end
98 98
99 99 def test_generated_links_with_prefix_and_no_relative_url_root
100 100 relative_url_root = Redmine::Utils.relative_url_root
101 101 Setting.host_name = 'mydomain.foo/rdm'
102 102 Setting.protocol = 'http'
103 103 Redmine::Utils.relative_url_root = nil
104 104
105 105 journal = Journal.find(2)
106 106 assert Mailer.deliver_issue_edit(journal)
107 107
108 108 mail = ActionMailer::Base.deliveries.last
109 109 assert_kind_of TMail::Mail, mail
110 110
111 111 assert_select_email do
112 112 # link to the main ticket
113 113 assert_select "a[href=?]",
114 114 "http://mydomain.foo/rdm/issues/1#change-2",
115 115 :text => "Bug #1: Can't print recipes"
116 116 # link to a referenced ticket
117 117 assert_select "a[href=?][title=?]",
118 118 "http://mydomain.foo/rdm/issues/2",
119 119 "Add ingredients categories (Assigned)",
120 120 :text => "#2"
121 121 # link to a changeset
122 122 assert_select "a[href=?][title=?]",
123 123 "http://mydomain.foo/rdm/projects/ecookbook/repository/revisions/2",
124 124 "This commit fixes #1, #2 and references #1 &amp; #3",
125 125 :text => "r2"
126 126 end
127 127 ensure
128 128 # restore it
129 129 Redmine::Utils.relative_url_root = relative_url_root
130 130 end
131 131
132 132 def test_email_headers
133 133 issue = Issue.find(1)
134 134 Mailer.deliver_issue_add(issue)
135 135 mail = ActionMailer::Base.deliveries.last
136 136 assert_not_nil mail
137 137 assert_equal 'OOF', mail.header_string('X-Auto-Response-Suppress')
138 138 assert_equal 'auto-generated', mail.header_string('Auto-Submitted')
139 139 end
140 140
141 141 def test_plain_text_mail
142 142 Setting.plain_text_mail = 1
143 143 journal = Journal.find(2)
144 144 Mailer.deliver_issue_edit(journal)
145 145 mail = ActionMailer::Base.deliveries.last
146 146 assert_equal "text/plain", mail.content_type
147 147 assert_equal 0, mail.parts.size
148 148 assert !mail.encoded.include?('href')
149 149 end
150 150
151 151 def test_html_mail
152 152 Setting.plain_text_mail = 0
153 153 journal = Journal.find(2)
154 154 Mailer.deliver_issue_edit(journal)
155 155 mail = ActionMailer::Base.deliveries.last
156 156 assert_equal 2, mail.parts.size
157 157 assert mail.encoded.include?('href')
158 158 end
159 159
160 160 def test_from_header
161 161 with_settings :mail_from => 'redmine@example.net' do
162 162 Mailer.deliver_test(User.find(1))
163 163 end
164 164 mail = ActionMailer::Base.deliveries.last
165 165 assert_not_nil mail
166 166 assert_equal 'redmine@example.net', mail.from_addrs.first.address
167 167 end
168 168
169 169 def test_from_header_with_phrase
170 170 with_settings :mail_from => 'Redmine app <redmine@example.net>' do
171 171 Mailer.deliver_test(User.find(1))
172 172 end
173 173 mail = ActionMailer::Base.deliveries.last
174 174 assert_not_nil mail
175 175 assert_equal 'redmine@example.net', mail.from_addrs.first.address
176 176 assert_equal 'Redmine app', mail.from_addrs.first.name
177 177 end
178 178
179 179 def test_should_not_send_email_without_recipient
180 180 news = News.find(:first)
181 181 user = news.author
182 182 # Remove members except news author
183 183 news.project.memberships.each {|m| m.destroy unless m.user == user}
184 184
185 185 user.pref[:no_self_notified] = false
186 186 user.pref.save
187 187 User.current = user
188 188 Mailer.deliver_news_added(news.reload)
189 189 assert_equal 1, last_email.bcc.size
190 190
191 191 # nobody to notify
192 192 user.pref[:no_self_notified] = true
193 193 user.pref.save
194 194 User.current = user
195 195 ActionMailer::Base.deliveries.clear
196 196 Mailer.deliver_news_added(news.reload)
197 197 assert ActionMailer::Base.deliveries.empty?
198 198 end
199 199
200 200 def test_issue_add_message_id
201 201 issue = Issue.find(1)
202 202 Mailer.deliver_issue_add(issue)
203 203 mail = ActionMailer::Base.deliveries.last
204 204 assert_not_nil mail
205 205 assert_equal Mailer.message_id_for(issue), mail.message_id
206 206 assert_nil mail.references
207 207 end
208 208
209 209 def test_issue_edit_message_id
210 210 journal = Journal.find(1)
211 211 Mailer.deliver_issue_edit(journal)
212 212 mail = ActionMailer::Base.deliveries.last
213 213 assert_not_nil mail
214 214 assert_equal Mailer.message_id_for(journal), mail.message_id
215 215 assert_equal Mailer.message_id_for(journal.issue), mail.references.first.to_s
216 216 assert_select_email do
217 217 # link to the update
218 218 assert_select "a[href=?]",
219 219 "http://mydomain.foo/issues/#{journal.journalized_id}#change-#{journal.id}"
220 220 end
221 221 end
222 222
223 223 def test_message_posted_message_id
224 224 message = Message.find(1)
225 225 Mailer.deliver_message_posted(message)
226 226 mail = ActionMailer::Base.deliveries.last
227 227 assert_not_nil mail
228 228 assert_equal Mailer.message_id_for(message), mail.message_id
229 229 assert_nil mail.references
230 230 assert_select_email do
231 231 # link to the message
232 232 assert_select "a[href=?]",
233 233 "http://mydomain.foo/boards/#{message.board.id}/topics/#{message.id}",
234 234 :text => message.subject
235 235 end
236 236 end
237 237
238 238 def test_reply_posted_message_id
239 239 message = Message.find(3)
240 240 Mailer.deliver_message_posted(message)
241 241 mail = ActionMailer::Base.deliveries.last
242 242 assert_not_nil mail
243 243 assert_equal Mailer.message_id_for(message), mail.message_id
244 244 assert_equal Mailer.message_id_for(message.parent), mail.references.first.to_s
245 245 assert_select_email do
246 246 # link to the reply
247 247 assert_select "a[href=?]",
248 248 "http://mydomain.foo/boards/#{message.board.id}/topics/#{message.root.id}?r=#{message.id}#message-#{message.id}",
249 249 :text => message.subject
250 250 end
251 251 end
252 252
253 253 context("#issue_add") do
254 254 setup do
255 255 ActionMailer::Base.deliveries.clear
256 256 Setting.bcc_recipients = '1'
257 257 @issue = Issue.find(1)
258 258 end
259 259
260 260 should "notify project members" do
261 261 assert Mailer.deliver_issue_add(@issue)
262 262 assert last_email.bcc.include?('dlopper@somenet.foo')
263 263 end
264 264
265 265 should "not notify project members that are not allow to view the issue" do
266 266 Role.find(2).remove_permission!(:view_issues)
267 267 assert Mailer.deliver_issue_add(@issue)
268 268 assert !last_email.bcc.include?('dlopper@somenet.foo')
269 269 end
270 270
271 271 should "notify issue watchers" do
272 272 user = User.find(9)
273 273 # minimal email notification options
274 274 user.pref[:no_self_notified] = '1'
275 275 user.pref.save
276 276 user.mail_notification = false
277 277 user.save
278 278
279 279 Watcher.create!(:watchable => @issue, :user => user)
280 280 assert Mailer.deliver_issue_add(@issue)
281 281 assert last_email.bcc.include?(user.mail)
282 282 end
283 283
284 284 should "not notify watchers not allowed to view the issue" do
285 285 user = User.find(9)
286 286 Watcher.create!(:watchable => @issue, :user => user)
287 287 Role.non_member.remove_permission!(:view_issues)
288 288 assert Mailer.deliver_issue_add(@issue)
289 289 assert !last_email.bcc.include?(user.mail)
290 290 end
291 291 end
292 292
293 293 # test mailer methods for each language
294 294 def test_issue_add
295 295 issue = Issue.find(1)
296 296 valid_languages.each do |lang|
297 297 Setting.default_language = lang.to_s
298 298 assert Mailer.deliver_issue_add(issue)
299 299 end
300 300 end
301 301
302 302 def test_issue_edit
303 303 journal = Journal.find(1)
304 304 valid_languages.each do |lang|
305 305 Setting.default_language = lang.to_s
306 306 assert Mailer.deliver_issue_edit(journal)
307 307 end
308 308 end
309 309
310 310 def test_document_added
311 311 document = Document.find(1)
312 312 valid_languages.each do |lang|
313 313 Setting.default_language = lang.to_s
314 314 assert Mailer.deliver_document_added(document)
315 315 end
316 316 end
317 317
318 318 def test_attachments_added
319 319 attachements = [ Attachment.find_by_container_type('Document') ]
320 320 valid_languages.each do |lang|
321 321 Setting.default_language = lang.to_s
322 322 assert Mailer.deliver_attachments_added(attachements)
323 323 end
324 324 end
325 325
326 326 def test_version_file_added
327 327 attachements = [ Attachment.find_by_container_type('Version') ]
328 328 assert Mailer.deliver_attachments_added(attachements)
329 329 assert_not_nil last_email.bcc
330 330 assert last_email.bcc.any?
331 331 assert_select_email do
332 332 assert_select "a[href=?]", "http://mydomain.foo/projects/ecookbook/files"
333 333 end
334 334 end
335 335
336 336 def test_project_file_added
337 337 attachements = [ Attachment.find_by_container_type('Project') ]
338 338 assert Mailer.deliver_attachments_added(attachements)
339 339 assert_not_nil last_email.bcc
340 340 assert last_email.bcc.any?
341 341 assert_select_email do
342 342 assert_select "a[href=?]", "http://mydomain.foo/projects/ecookbook/files"
343 343 end
344 344 end
345 345
346 346 def test_news_added
347 347 news = News.find(:first)
348 348 valid_languages.each do |lang|
349 349 Setting.default_language = lang.to_s
350 350 assert Mailer.deliver_news_added(news)
351 351 end
352 352 end
353 353
354 354 def test_news_comment_added
355 355 comment = Comment.find(2)
356 356 valid_languages.each do |lang|
357 357 Setting.default_language = lang.to_s
358 358 assert Mailer.deliver_news_comment_added(comment)
359 359 end
360 360 end
361 361
362 362 def test_message_posted
363 363 message = Message.find(:first)
364 364 recipients = ([message.root] + message.root.children).collect {|m| m.author.mail if m.author}
365 365 recipients = recipients.compact.uniq
366 366 valid_languages.each do |lang|
367 367 Setting.default_language = lang.to_s
368 368 assert Mailer.deliver_message_posted(message)
369 369 end
370 370 end
371 371
372 372 def test_wiki_content_added
373 373 content = WikiContent.find(:first)
374 374 valid_languages.each do |lang|
375 375 Setting.default_language = lang.to_s
376 376 assert_difference 'ActionMailer::Base.deliveries.size' do
377 377 assert Mailer.deliver_wiki_content_added(content)
378 378 end
379 379 end
380 380 end
381 381
382 382 def test_wiki_content_updated
383 383 content = WikiContent.find(:first)
384 384 valid_languages.each do |lang|
385 385 Setting.default_language = lang.to_s
386 386 assert_difference 'ActionMailer::Base.deliveries.size' do
387 387 assert Mailer.deliver_wiki_content_updated(content)
388 388 end
389 389 end
390 390 end
391 391
392 392 def test_account_information
393 393 user = User.find(2)
394 394 valid_languages.each do |lang|
395 395 user.update_attribute :language, lang.to_s
396 396 user.reload
397 397 assert Mailer.deliver_account_information(user, 'pAsswORd')
398 398 end
399 399 end
400 400
401 401 def test_lost_password
402 402 token = Token.find(2)
403 403 valid_languages.each do |lang|
404 404 token.user.update_attribute :language, lang.to_s
405 405 token.reload
406 406 assert Mailer.deliver_lost_password(token)
407 407 end
408 408 end
409 409
410 410 def test_register
411 411 token = Token.find(1)
412 412 Setting.host_name = 'redmine.foo'
413 413 Setting.protocol = 'https'
414 414
415 415 valid_languages.each do |lang|
416 416 token.user.update_attribute :language, lang.to_s
417 417 token.reload
418 418 ActionMailer::Base.deliveries.clear
419 419 assert Mailer.deliver_register(token)
420 420 mail = ActionMailer::Base.deliveries.last
421 421 assert mail.body.include?("https://redmine.foo/account/activate?token=#{token.value}")
422 422 end
423 423 end
424 424
425 425 def test_test
426 426 user = User.find(1)
427 427 valid_languages.each do |lang|
428 428 user.update_attribute :language, lang.to_s
429 429 assert Mailer.deliver_test(user)
430 430 end
431 431 end
432 432
433 433 def test_reminders
434 434 Mailer.reminders(:days => 42)
435 435 assert_equal 1, ActionMailer::Base.deliveries.size
436 436 mail = ActionMailer::Base.deliveries.last
437 437 assert mail.bcc.include?('dlopper@somenet.foo')
438 438 assert mail.body.include?('Bug #3: Error 281 when updating a recipe')
439 439 assert_equal '1 issue(s) due in the next 42 days', mail.subject
440 440 end
441 441
442 def test_reminders_should_not_include_closed_issues
443 Issue.generate!(:project_id => 1, :tracker_id => 1, :status_id => 5, :subject => 'Closed issue', :assigned_to_id => 3, :due_date => 5.days.from_now)
444 ActionMailer::Base.deliveries.clear
445
446 Mailer.reminders(:days => 42)
447 assert_equal 1, ActionMailer::Base.deliveries.size
448 mail = ActionMailer::Base.deliveries.last
449 assert mail.bcc.include?('dlopper@somenet.foo')
450 assert !mail.body.include?('Closed issue')
451 end
452
442 453 def test_reminders_for_users
443 454 Mailer.reminders(:days => 42, :users => ['5'])
444 455 assert_equal 0, ActionMailer::Base.deliveries.size # No mail for dlopper
445 456 Mailer.reminders(:days => 42, :users => ['3'])
446 457 assert_equal 1, ActionMailer::Base.deliveries.size # No mail for dlopper
447 458 mail = ActionMailer::Base.deliveries.last
448 459 assert mail.bcc.include?('dlopper@somenet.foo')
449 460 assert mail.body.include?('Bug #3: Error 281 when updating a recipe')
450 461 end
451 462
452 463 def last_email
453 464 mail = ActionMailer::Base.deliveries.last
454 465 assert_not_nil mail
455 466 mail
456 467 end
457 468
458 469 def test_mailer_should_not_change_locale
459 470 Setting.default_language = 'en'
460 471 # Set current language to italian
461 472 set_language_if_valid 'it'
462 473 # Send an email to a french user
463 474 user = User.find(1)
464 475 user.language = 'fr'
465 476 Mailer.deliver_account_activated(user)
466 477 mail = ActionMailer::Base.deliveries.last
467 478 assert mail.body.include?('Votre compte')
468 479
469 480 assert_equal :it, current_language
470 481 end
471 482
472 483 def test_with_deliveries_off
473 484 Mailer.with_deliveries false do
474 485 Mailer.deliver_test(User.find(1))
475 486 end
476 487 assert ActionMailer::Base.deliveries.empty?
477 488 # should restore perform_deliveries
478 489 assert ActionMailer::Base.perform_deliveries
479 490 end
480 491
481 492 def test_tmail_to_header_field_should_not_include_blank_lines
482 493 mail = TMail::Mail.new
483 494 mail.to = ["a.user@example.com", "v.user2@example.com", "e.smith@example.com", "info@example.com", "v.pupkin@example.com",
484 495 "b.user@example.com", "w.user2@example.com", "f.smith@example.com", "info2@example.com", "w.pupkin@example.com"]
485 496
486 497 assert !mail.encoded.strip.split("\r\n").detect(&:blank?), "#{mail.encoded} malformed"
487 498 end
488 499
489 500 def test_layout_should_include_the_emails_header
490 501 with_settings :emails_header => "*Header content*" do
491 502 assert Mailer.deliver_test(User.find(1))
492 503 assert_select_email do
493 504 assert_select ".header" do
494 505 assert_select "strong", :text => "Header content"
495 506 end
496 507 end
497 508 end
498 509 end
499 510 end
General Comments 0
You need to be logged in to leave comments. Login now