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