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