##// END OF EJS Templates
jro_apps » redmine
RSS
Log info when sending an email notification....
Jean-Philippe Lang -
r3241:a0364deb6a11
parent child
Show More
Side by Side Unified
Context file:
r3241:a0364deb6a11 Loading diff...:
Show file before | Show file after | Hide comments
@@ -1,405 +1,414
1 1 # redMine - project management software
2 2 # Copyright (C) 2006-2007 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)
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, issues.size)
84 84 body :issues => issues,
85 85 :days => days,
86 86 :issues_url => url_for(:controller => 'issues', :action => 'index', :set_filter => 1, :assigned_to_id => user.id, :sort_key => 'due_date', :sort_order => 'asc')
87 87 render_multipart('reminder', body)
88 88 end
89 89
90 90 # Builds a tmail object used to email users belonging to the added document's project.
91 91 #
92 92 # Example:
93 93 # document_added(document) => tmail object
94 94 # Mailer.deliver_document_added(document) => sends an email to the document's project recipients
95 95 def document_added(document)
96 96 redmine_headers 'Project' => document.project.identifier
97 97 recipients document.recipients
98 98 subject "[#{document.project.name}] #{l(:label_document_new)}: #{document.title}"
99 99 body :document => document,
100 100 :document_url => url_for(:controller => 'documents', :action => 'show', :id => document)
101 101 render_multipart('document_added', body)
102 102 end
103 103
104 104 # Builds a tmail object used to email recipients of a project when an attachements are added.
105 105 #
106 106 # Example:
107 107 # attachments_added(attachments) => tmail object
108 108 # Mailer.deliver_attachments_added(attachments) => sends an email to the project's recipients
109 109 def attachments_added(attachments)
110 110 container = attachments.first.container
111 111 added_to = ''
112 112 added_to_url = ''
113 113 case container.class.name
114 114 when 'Project'
115 115 added_to_url = url_for(:controller => 'projects', :action => 'list_files', :id => container)
116 116 added_to = "#{l(:label_project)}: #{container}"
117 117 recipients container.project.notified_users.select {|user| user.allowed_to?(:view_files, container.project)}
118 118 when 'Version'
119 119 added_to_url = url_for(:controller => 'projects', :action => 'list_files', :id => container.project_id)
120 120 added_to = "#{l(:label_version)}: #{container.name}"
121 121 recipients container.project.notified_users.select {|user| user.allowed_to?(:view_files, container.project)}
122 122 when 'Document'
123 123 added_to_url = url_for(:controller => 'documents', :action => 'show', :id => container.id)
124 124 added_to = "#{l(:label_document)}: #{container.title}"
125 125 recipients container.recipients
126 126 end
127 127 redmine_headers 'Project' => container.project.identifier
128 128 subject "[#{container.project.name}] #{l(:label_attachment_new)}"
129 129 body :attachments => attachments,
130 130 :added_to => added_to,
131 131 :added_to_url => added_to_url
132 132 render_multipart('attachments_added', body)
133 133 end
134 134
135 135 # Builds a tmail object used to email recipients of a news' project when a news item is added.
136 136 #
137 137 # Example:
138 138 # news_added(news) => tmail object
139 139 # Mailer.deliver_news_added(news) => sends an email to the news' project recipients
140 140 def news_added(news)
141 141 redmine_headers 'Project' => news.project.identifier
142 142 message_id news
143 143 recipients news.recipients
144 144 subject "[#{news.project.name}] #{l(:label_news)}: #{news.title}"
145 145 body :news => news,
146 146 :news_url => url_for(:controller => 'news', :action => 'show', :id => news)
147 147 render_multipart('news_added', body)
148 148 end
149 149
150 150 # Builds a tmail object used to email the recipients of the specified message that was posted.
151 151 #
152 152 # Example:
153 153 # message_posted(message) => tmail object
154 154 # Mailer.deliver_message_posted(message) => sends an email to the recipients
155 155 def message_posted(message)
156 156 redmine_headers 'Project' => message.project.identifier,
157 157 'Topic-Id' => (message.parent_id || message.id)
158 158 message_id message
159 159 references message.parent unless message.parent.nil?
160 160 recipients(message.recipients)
161 161 cc((message.root.watcher_recipients + message.board.watcher_recipients).uniq - @recipients)
162 162 subject "[#{message.board.project.name} - #{message.board.name} - msg#{message.root.id}] #{message.subject}"
163 163 body :message => message,
164 164 :message_url => url_for(:controller => 'messages', :action => 'show', :board_id => message.board_id, :id => message.root)
165 165 render_multipart('message_posted', body)
166 166 end
167 167
168 168 # Builds a tmail object used to email the recipients of a project of the specified wiki content was added.
169 169 #
170 170 # Example:
171 171 # wiki_content_added(wiki_content) => tmail object
172 172 # Mailer.deliver_wiki_content_added(wiki_content) => sends an email to the project's recipients
173 173 def wiki_content_added(wiki_content)
174 174 redmine_headers 'Project' => wiki_content.project.identifier,
175 175 'Wiki-Page-Id' => wiki_content.page.id
176 176 message_id wiki_content
177 177 recipients wiki_content.recipients
178 178 cc(wiki_content.page.wiki.watcher_recipients - recipients)
179 179 subject "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_added, :page => wiki_content.page.pretty_title)}"
180 180 body :wiki_content => wiki_content,
181 181 :wiki_content_url => url_for(:controller => 'wiki', :action => 'index', :id => wiki_content.project, :page => wiki_content.page.title)
182 182 render_multipart('wiki_content_added', body)
183 183 end
184 184
185 185 # Builds a tmail object used to email the recipients of a project of the specified wiki content was updated.
186 186 #
187 187 # Example:
188 188 # wiki_content_updated(wiki_content) => tmail object
189 189 # Mailer.deliver_wiki_content_updated(wiki_content) => sends an email to the project's recipients
190 190 def wiki_content_updated(wiki_content)
191 191 redmine_headers 'Project' => wiki_content.project.identifier,
192 192 'Wiki-Page-Id' => wiki_content.page.id
193 193 message_id wiki_content
194 194 recipients wiki_content.recipients
195 195 cc(wiki_content.page.wiki.watcher_recipients + wiki_content.page.watcher_recipients - recipients)
196 196 subject "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_updated, :page => wiki_content.page.pretty_title)}"
197 197 body :wiki_content => wiki_content,
198 198 :wiki_content_url => url_for(:controller => 'wiki', :action => 'index', :id => wiki_content.project, :page => wiki_content.page.title),
199 199 :wiki_diff_url => url_for(:controller => 'wiki', :action => 'diff', :id => wiki_content.project, :page => wiki_content.page.title, :version => wiki_content.version)
200 200 render_multipart('wiki_content_updated', body)
201 201 end
202 202
203 203 # Builds a tmail object used to email the specified user their account information.
204 204 #
205 205 # Example:
206 206 # account_information(user, password) => tmail object
207 207 # Mailer.deliver_account_information(user, password) => sends account information to the user
208 208 def account_information(user, password)
209 209 set_language_if_valid user.language
210 210 recipients user.mail
211 211 subject l(:mail_subject_register, Setting.app_title)
212 212 body :user => user,
213 213 :password => password,
214 214 :login_url => url_for(:controller => 'account', :action => 'login')
215 215 render_multipart('account_information', body)
216 216 end
217 217
218 218 # Builds a tmail object used to email all active administrators of an account activation request.
219 219 #
220 220 # Example:
221 221 # account_activation_request(user) => tmail object
222 222 # Mailer.deliver_account_activation_request(user)=> sends an email to all active administrators
223 223 def account_activation_request(user)
224 224 # Send the email to all active administrators
225 225 recipients User.active.find(:all, :conditions => {:admin => true}).collect { |u| u.mail }.compact
226 226 subject l(:mail_subject_account_activation_request, Setting.app_title)
227 227 body :user => user,
228 228 :url => url_for(:controller => 'users', :action => 'index', :status => User::STATUS_REGISTERED, :sort_key => 'created_on', :sort_order => 'desc')
229 229 render_multipart('account_activation_request', body)
230 230 end
231 231
232 232 # Builds a tmail object used to email the specified user that their account was activated by an administrator.
233 233 #
234 234 # Example:
235 235 # account_activated(user) => tmail object
236 236 # Mailer.deliver_account_activated(user) => sends an email to the registered user
237 237 def account_activated(user)
238 238 set_language_if_valid user.language
239 239 recipients user.mail
240 240 subject l(:mail_subject_register, Setting.app_title)
241 241 body :user => user,
242 242 :login_url => url_for(:controller => 'account', :action => 'login')
243 243 render_multipart('account_activated', body)
244 244 end
245 245
246 246 def lost_password(token)
247 247 set_language_if_valid(token.user.language)
248 248 recipients token.user.mail
249 249 subject l(:mail_subject_lost_password, Setting.app_title)
250 250 body :token => token,
251 251 :url => url_for(:controller => 'account', :action => 'lost_password', :token => token.value)
252 252 render_multipart('lost_password', body)
253 253 end
254 254
255 255 def register(token)
256 256 set_language_if_valid(token.user.language)
257 257 recipients token.user.mail
258 258 subject l(:mail_subject_register, Setting.app_title)
259 259 body :token => token,
260 260 :url => url_for(:controller => 'account', :action => 'activate', :token => token.value)
261 261 render_multipart('register', body)
262 262 end
263 263
264 264 def test(user)
265 265 set_language_if_valid(user.language)
266 266 recipients user.mail
267 267 subject 'Redmine test'
268 268 body :url => url_for(:controller => 'welcome')
269 269 render_multipart('test', body)
270 270 end
271 271
272 272 # Overrides default deliver! method to prevent from sending an email
273 273 # with no recipient, cc or bcc
274 274 def deliver!(mail = @mail)
275 275 set_language_if_valid @initial_language
276 276 return false if (recipients.nil? || recipients.empty?) &&
277 277 (cc.nil? || cc.empty?) &&
278 278 (bcc.nil? || bcc.empty?)
279 279
280 280 # Set Message-Id and References
281 281 if @message_id_object
282 282 mail.message_id = self.class.message_id_for(@message_id_object)
283 283 end
284 284 if @references_objects
285 285 mail.references = @references_objects.collect {|o| self.class.message_id_for(o)}
286 286 end
287 287 super(mail)
288 288 end
289 289
290 290 # Sends reminders to issue assignees
291 291 # Available options:
292 292 # * :days => how many days in the future to remind about (defaults to 7)
293 293 # * :tracker => id of tracker for filtering issues (defaults to all trackers)
294 294 # * :project => id or identifier of project to process (defaults to all projects)
295 295 def self.reminders(options={})
296 296 days = options[:days] || 7
297 297 project = options[:project] ? Project.find(options[:project]) : nil
298 298 tracker = options[:tracker] ? Tracker.find(options[:tracker]) : nil
299 299
300 300 s = ARCondition.new ["#{IssueStatus.table_name}.is_closed = ? AND #{Issue.table_name}.due_date <= ?", false, days.day.from_now.to_date]
301 301 s << "#{Issue.table_name}.assigned_to_id IS NOT NULL"
302 302 s << "#{Project.table_name}.status = #{Project::STATUS_ACTIVE}"
303 303 s << "#{Issue.table_name}.project_id = #{project.id}" if project
304 304 s << "#{Issue.table_name}.tracker_id = #{tracker.id}" if tracker
305 305
306 306 issues_by_assignee = Issue.find(:all, :include => [:status, :assigned_to, :project, :tracker],
307 307 :conditions => s.conditions
308 308 ).group_by(&:assigned_to)
309 309 issues_by_assignee.each do |assignee, issues|
310 310 deliver_reminder(assignee, issues, days) unless assignee.nil?
311 311 end
312 312 end
313 313
314 314 private
315 315 def initialize_defaults(method_name)
316 316 super
317 317 @initial_language = current_language
318 318 set_language_if_valid Setting.default_language
319 319 from Setting.mail_from
320 320
321 321 # Common headers
322 322 headers 'X-Mailer' => 'Redmine',
323 323 'X-Redmine-Host' => Setting.host_name,
324 324 'X-Redmine-Site' => Setting.app_title,
325 325 'Precedence' => 'bulk',
326 326 'Auto-Submitted' => 'auto-generated'
327 327 end
328 328
329 329 # Appends a Redmine header field (name is prepended with 'X-Redmine-')
330 330 def redmine_headers(h)
331 331 h.each { |k,v| headers["X-Redmine-#{k}"] = v }
332 332 end
333 333
334 334 # Overrides the create_mail method
335 335 def create_mail
336 336 # Removes the current user from the recipients and cc
337 337 # if he doesn't want to receive notifications about what he does
338 338 @author ||= User.current
339 339 if @author.pref[:no_self_notified]
340 340 recipients.delete(@author.mail) if recipients
341 341 cc.delete(@author.mail) if cc
342 342 end
343
344 notified_users = [recipients, cc].flatten.compact.uniq
345 # Rails would log recipients only, not cc and bcc
346 mylogger.info "Sending email notification to: #{notified_users.join(', ')}" if mylogger
347
343 348 # Blind carbon copy recipients
344 349 if Setting.bcc_recipients?
345 bcc([recipients, cc].flatten.compact.uniq)
350 bcc(notified_users)
346 351 recipients []
347 352 cc []
348 353 end
349 354 super
350 355 end
351 356
352 357 # Rails 2.3 has problems rendering implicit multipart messages with
353 358 # layouts so this method will wrap an multipart messages with
354 359 # explicit parts.
355 360 #
356 361 # https://rails.lighthouseapp.com/projects/8994/tickets/2338-actionmailer-mailer-views-and-content-type
357 362 # https://rails.lighthouseapp.com/projects/8994/tickets/1799-actionmailer-doesnt-set-template_format-when-rendering-layouts
358 363
359 364 def render_multipart(method_name, body)
360 365 if Setting.plain_text_mail?
361 366 content_type "text/plain"
362 367 body render(:file => "#{method_name}.text.plain.rhtml", :body => body, :layout => 'mailer.text.plain.erb')
363 368 else
364 369 content_type "multipart/alternative"
365 370 part :content_type => "text/plain", :body => render(:file => "#{method_name}.text.plain.rhtml", :body => body, :layout => 'mailer.text.plain.erb')
366 371 part :content_type => "text/html", :body => render_message("#{method_name}.text.html.rhtml", body)
367 372 end
368 373 end
369 374
370 375 # Makes partial rendering work with Rails 1.2 (retro-compatibility)
371 376 def self.controller_path
372 377 ''
373 378 end unless respond_to?('controller_path')
374 379
375 380 # Returns a predictable Message-Id for the given object
376 381 def self.message_id_for(object)
377 382 # id + timestamp should reduce the odds of a collision
378 383 # as far as we don't send multiple emails for the same object
379 384 timestamp = object.send(object.respond_to?(:created_on) ? :created_on : :updated_on)
380 385 hash = "redmine.#{object.class.name.demodulize.underscore}-#{object.id}.#{timestamp.strftime("%Y%m%d%H%M%S")}"
381 386 host = Setting.mail_from.to_s.gsub(%r{^.*@}, '')
382 387 host = "#{::Socket.gethostname}.redmine" if host.empty?
383 388 "<#{hash}@#{host}>"
384 389 end
385 390
386 391 private
387 392
388 393 def message_id(object)
389 394 @message_id_object = object
390 395 end
391 396
392 397 def references(object)
393 398 @references_objects ||= []
394 399 @references_objects << object
395 400 end
401
402 def mylogger
403 RAILS_DEFAULT_LOGGER
404 end
396 405 end
397 406
398 407 # Patch TMail so that message_id is not overwritten
399 408 module TMail
400 409 class Mail
401 410 def add_message_id( fqdn = nil )
402 411 self.message_id ||= ::TMail::new_message_id(fqdn)
403 412 end
404 413 end
405 414 end
General Comments 0
You need to be logged in to leave comments. Login now