Class: Mailer

Inherits:
ActionMailer::Base
  • Object
show all
Includes:
ActionController::UrlWriter, Redmine::I18n
Defined in:
app/models/mailer.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Redmine::I18n

#current_language, #day_name, #find_language, #format_date, #format_time, included, #l, #l_hours, #l_or_humanize, #ll, #month_name, #set_language_if_valid, #valid_languages

Class Method Details

.controller_pathObject


458
459
460
# File 'app/models/mailer.rb', line 458

def self.controller_path
  ''
end

.default_url_optionsObject


27
28
29
30
31
# File 'app/models/mailer.rb', line 27

def self.default_url_options
  h = Setting.host_name
  h = h.to_s.gsub(%r{\/.*$}, '') unless Redmine::Utils.relative_url_root.blank?
  { :host => h, :protocol => Setting.protocol }
end

.reminders(options = {}) ⇒ Object

Sends reminders to issue assignees Available options:

  • :days => how many days in the future to remind about (defaults to 7)

  • :tracker => id of tracker for filtering issues (defaults to all trackers)

  • :project => id or identifier of project to process (defaults to all projects)

  • :users => array of user ids who should be reminded


373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'app/models/mailer.rb', line 373

def self.reminders(options={})
  days = options[:days] || 7
  project = options[:project] ? Project.find(options[:project]) : nil
  tracker = options[:tracker] ? Tracker.find(options[:tracker]) : nil
  user_ids = options[:users]

  s = ARCondition.new ["#{IssueStatus.table_name}.is_closed = ? AND #{Issue.table_name}.due_date <= ?", false, days.day.from_now.to_date]
  s << "#{Issue.table_name}.assigned_to_id IS NOT NULL"
  s << ["#{Issue.table_name}.assigned_to_id IN (?)", user_ids] if user_ids.present?
  s << "#{Project.table_name}.status = #{Project::STATUS_ACTIVE}"
  s << "#{Issue.table_name}.project_id = #{project.id}" if project
  s << "#{Issue.table_name}.tracker_id = #{tracker.id}" if tracker

  issues_by_assignee = Issue.find(:all, :include => [:status, :assigned_to, :project, :tracker],
                                        :conditions => s.conditions
                                  ).group_by(&:assigned_to)
  issues_by_assignee.each do |assignee, issues|
    deliver_reminder(assignee, issues, days) if assignee && assignee.active?
  end
end

.with_deliveries(enabled = true, &block) ⇒ Object

Activates/desactivates email deliveries during block


395
396
397
398
399
400
401
# File 'app/models/mailer.rb', line 395

def self.with_deliveries(enabled = true, &block)
  was_enabled = ActionMailer::Base.perform_deliveries
  ActionMailer::Base.perform_deliveries = !!enabled
  yield
ensure
  ActionMailer::Base.perform_deliveries = was_enabled
end

Instance Method Details

#account_activated(user) ⇒ Object

Builds a tmail object used to email the specified user that their account was activated by an administrator.

Example:

account_activated(user) => tmail object
Mailer.deliver_account_activated(user) => sends an email to the registered user

258
259
260
261
262
263
264
265
266
# File 'app/models/mailer.rb', line 258

def (user)
  redmine_headers 'Type' => "Account"
  set_language_if_valid user.language
  recipients user.mail
  subject l(:mail_subject_register, Setting.app_title)
  body :user => user,
       :login_url => url_for(:controller => 'account', :action => 'login')
  render_multipart('account_activated', body)
end

#account_activation_request(user) ⇒ Object

Builds a tmail object used to email all active administrators of an account activation request.

Example:

account_activation_request(user) => tmail object
Mailer.deliver_account_activation_request(user)=> sends an email to all active administrators

243
244
245
246
247
248
249
250
251
# File 'app/models/mailer.rb', line 243

def (user)
  # Send the email to all active administrators
  redmine_headers 'Type' => "Account"
  recipients User.active.find(:all, :conditions => {:admin => true}).collect { |u| u.mail }.compact
  subject l(:mail_subject_account_activation_request, Setting.app_title)
  body :user => user,
       :url => url_for(:controller => 'users', :action => 'index', :status => User::STATUS_REGISTERED, :sort_key => 'created_on', :sort_order => 'desc')
  render_multipart('account_activation_request', body)
end

#account_information(user, password) ⇒ Object

Builds a tmail object used to email the specified user their account information.

Example:

account_information(user, password) => tmail object
Mailer.deliver_account_information(user, password) => sends account information to the user

227
228
229
230
231
232
233
234
235
236
# File 'app/models/mailer.rb', line 227

def (user, password)
  redmine_headers 'Type' => "Account"
  set_language_if_valid user.language
  recipients user.mail
  subject l(:mail_subject_register, Setting.app_title)
  body :user => user,
       :password => password,
       :login_url => url_for(:controller => 'account', :action => 'login')
  render_multipart('account_information', body)
end

#attachments_added(attachments, recipient) ⇒ Object

Builds a tmail object used to email recipients of a project when an attachements are added.

Example:

attachments_added(attachments) => tmail object
Mailer.deliver_attachments_added(attachments) => sends an email to the project's recipients

110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# File 'app/models/mailer.rb', line 110

def attachments_added(attachments, recipient)
  container = attachments.first.container
  added_to = ''
  added_to_url = ''
  case container.class.name
  when 'Project'
    added_to_url = url_for(:controller => 'files', :action => 'index', :project_id => container)
    added_to = "#{l(:label_project)}: #{container}"
  when 'Version'
    added_to_url = url_for(:controller => 'files', :action => 'index', :project_id => container.project)
    added_to = "#{l(:label_version)}: #{container.name}"
  when 'Document'
    added_to_url = url_for(:controller => 'documents', :action => 'show', :id => container.id)
    added_to = "#{l(:label_document)}: #{container.title}"
  end
  recipients [recipient]
  redmine_headers 'Project' => container.project.identifier,
                  'Type' => "Attachment"
  subject "[#{container.project.name}] #{l(:label_attachment_new)}"
  body :attachments => attachments,
       :added_to => added_to,
       :added_to_url => added_to_url
  render_multipart('attachments_added', body)
end

#deliver!(mail = @mail) ⇒ Object

Overrides default deliver! method to prevent from sending an email with no recipient, cc or bcc


337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
# File 'app/models/mailer.rb', line 337

def deliver!(mail = @mail)
  set_language_if_valid @initial_language
  return false if (recipients.nil? || recipients.empty?) &&
                  (cc.nil? || cc.empty?) &&
                  (bcc.nil? || bcc.empty?)

  # Set Message-Id and References
  if @message_id_object
    mail.message_id = self.class.message_id_for(@message_id_object)
  end
  if @references_objects
    mail.references = @references_objects.collect {|o| self.class.message_id_for(o)}
  end

  # Log errors when raise_delivery_errors is set to false, Rails does not
  raise_errors = self.class.raise_delivery_errors
  self.class.raise_delivery_errors = true
  begin
    return super(mail)
  rescue Exception => e
    if raise_errors
      raise e
    elsif mylogger
      mylogger.error "The following error occured while sending email notification: \"#{e.message}\". Check your configuration in config/configuration.yml."
    end
  ensure
    self.class.raise_delivery_errors = raise_errors
  end
end

#document_added(document, recipient) ⇒ Object

Builds a tmail object used to email users belonging to the added document's project.

Example:

document_added(document, '[email protected]') => tmail object
Mailer.deliver_document_added(document, '[email protected]') => sends an email to the document's project recipients

95
96
97
98
99
100
101
102
103
# File 'app/models/mailer.rb', line 95

def document_added(document, recipient)
  redmine_headers 'Project' => document.project.identifier,
                  'Type' => "Document"
  recipients [recipient]
  subject "[#{document.project.name}] #{l(:label_document_new)}: #{document.title}"
  body :document => document,
       :document_url => url_for(:controller => 'documents', :action => 'show', :id => document)
  render_multipart('document_added', body)
end

#issue_add(issue, recipient) ⇒ Object

Builds a tmail object used to email a recipient of the added issue.

Example:

issue_add(issue, '[email protected]') => tmail object
Mailer.deliver_issue_add(issue, '[email protected]') => sends an email to '[email protected]'

38
39
40
41
42
43
44
45
46
47
48
49
50
# File 'app/models/mailer.rb', line 38

def issue_add(issue, recipient)
  redmine_headers 'Project' => issue.project.identifier,
                  'Issue-Id' => issue.id,
                  'Issue-Author' => issue.author.,
                  'Type' => "Issue"
  redmine_headers 'Issue-Assignee' => issue.assigned_to. if issue.assigned_to
  message_id issue
  recipients [recipient]
  subject "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] (#{issue.status.name}) #{issue.subject}"
  body :issue => issue,
       :issue_url => url_for(:controller => 'issues', :action => 'show', :id => issue)
  render_multipart('issue_add', body)
end

#issue_edit(journal, recipient) ⇒ Object

Builds a tmail object used to email recipients of the edited issue.

Example:

issue_edit(journal, '[email protected]') => tmail object
Mailer.deliver_issue_edit(journal, '[email protected]') => sends an email to issue recipients

57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'app/models/mailer.rb', line 57

def issue_edit(journal, recipient)
  issue = journal.journaled.reload
  redmine_headers 'Project' => issue.project.identifier,
                  'Issue-Id' => issue.id,
                  'Issue-Author' => issue.author.,
                  'Type' => "Issue"
  redmine_headers 'Issue-Assignee' => issue.assigned_to. if issue.assigned_to
  message_id journal
  references issue
  @author = journal.user
  recipients [recipient]
  s = "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] "
  s << "(#{issue.status.name}) " if journal.details['status_id']
  s << issue.subject
  subject s
  body :issue => issue,
       :journal => journal,
       :issue_url => url_for(:controller => 'issues', :action => 'show', :id => issue)

  render_multipart('issue_edit', body)
end

#lost_password(token) ⇒ Object


268
269
270
271
272
273
274
275
276
# File 'app/models/mailer.rb', line 268

def lost_password(token)
  redmine_headers 'Type' => "Account"
  set_language_if_valid(token.user.language)
  recipients token.user.mail
  subject l(:mail_subject_lost_password, Setting.app_title)
  body :token => token,
       :url => url_for(:controller => 'account', :action => 'lost_password', :token => token.value)
  render_multipart('lost_password', body)
end

#mail_handler_confirmation(object, user, email_subject) ⇒ Object


288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
# File 'app/models/mailer.rb', line 288

def mail_handler_confirmation(object, user, email_subject)
  recipients user.mail

  case
  when object.is_a?(Issue)
    project = object.project.name
    url = url_for(:controller => 'issues', :action => 'show', :id => object.id)
  when object.is_a?(Journal)
    project = object.project.name
    url = url_for(:controller => 'issues', :action => 'show', :id => object.issue.id)
  when object.class == Message
    project = object.project.name
    url = url_for(object.event_url)
  else
    project = ''
    url = ''
  end

  subject "[#{project}] #{l(:label_mail_handler_confirmation, :subject => email_subject)}"
  body(:object => object,
       :url => url)
  render_multipart('mail_handler_confirmation', body)
end

#mail_handler_missing_information(user, email_subject, error_message) ⇒ Object


319
320
321
322
323
324
# File 'app/models/mailer.rb', line 319

def mail_handler_missing_information(user, email_subject, error_message)
  recipients user.mail
  subject l(:label_mail_handler_failure, :subject => email_subject)
  body({:errors => error_message.to_s})
  render_multipart('mail_handler_missing_information', body)
end

#mail_handler_unauthorized_action(user, email_subject, options = {}) ⇒ Object


312
313
314
315
316
317
# File 'app/models/mailer.rb', line 312

def mail_handler_unauthorized_action(user, email_subject, options={})
  recipients options[:to] || user.mail
  subject l(:label_mail_handler_failure, :subject => email_subject)
  body({})
  render_multipart('mail_handler_unauthorized_action', body)
end

#message_posted(message, recipient) ⇒ Object

Builds a tmail object used to email the recipients of the specified message that was posted.

Example:

message_posted(message) => tmail object
Mailer.deliver_message_posted(message) => sends an email to the recipients

174
175
176
177
178
179
180
181
182
183
184
185
# File 'app/models/mailer.rb', line 174

def message_posted(message, recipient)
  redmine_headers 'Project' => message.project.identifier,
                  'Topic-Id' => (message.parent_id || message.id),
                  'Type' => "Forum"
  message_id message
  references message.parent unless message.parent.nil?
  recipients [recipient]
  subject "[#{message.board.project.name} - #{message.board.name} - msg#{message.root.id}] #{message.subject}"
  body :message => message,
       :message_url => url_for({ :controller => 'messages', :action => 'show', :board_id => message.board, :id => message.root, :r => message, :anchor => "message-#{message.id}" })
  render_multipart('message_posted', body)
end

#news_added(news, recipient) ⇒ Object

Builds a tmail object used to email recipients of a news' project when a news item is added.

Example:

news_added(news) => tmail object
Mailer.deliver_news_added(news) => sends an email to the news' project recipients

140
141
142
143
144
145
146
147
148
149
# File 'app/models/mailer.rb', line 140

def news_added(news, recipient)
  redmine_headers 'Project' => news.project.identifier,
                  'Type' => "News"
  message_id news
  recipients [recipient]
  subject "[#{news.project.name}] #{l(:label_news)}: #{news.title}"
  body :news => news,
       :news_url => url_for(:controller => 'news', :action => 'show', :id => news)
  render_multipart('news_added', body)
end

#news_comment_added(comment) ⇒ Object

Builds a tmail object used to email recipients of a news' project when a news comment is added.

Example:

news_comment_added(comment) => tmail object
Mailer.news_comment_added(comment) => sends an email to the news' project recipients

156
157
158
159
160
161
162
163
164
165
166
167
# File 'app/models/mailer.rb', line 156

def news_comment_added(comment)
  news = comment.commented
  redmine_headers 'Project' => news.project.identifier
  message_id comment
  recipients news.recipients
  cc news.watcher_recipients
  subject "Re: [#{news.project.name}] #{l(:label_news)}: #{news.title}"
  body :news => news,
       :comment => comment,
       :news_url => url_for(:controller => 'news', :action => 'show', :id => news)
  render_multipart('news_comment_added', body)
end

#register(token) ⇒ Object


278
279
280
281
282
283
284
285
286
# File 'app/models/mailer.rb', line 278

def register(token)
  redmine_headers 'Type' => "Account"
  set_language_if_valid(token.user.language)
  recipients token.user.mail
  subject l(:mail_subject_register, Setting.app_title)
  body :token => token,
       :url => url_for(:controller => 'account', :action => 'activate', :token => token.value)
  render_multipart('register', body)
end

#reminder(user, issues, days) ⇒ Object


79
80
81
82
83
84
85
86
87
88
# File 'app/models/mailer.rb', line 79

def reminder(user, issues, days)
  redmine_headers 'Type' => "Issue"
  set_language_if_valid user.language
  recipients user.mail
  subject l(:mail_subject_reminder, :count => issues.size, :days => days)
  body :issues => issues,
       :days => days,
       :issues_url => url_for(:controller => 'issues', :action => 'index', :set_filter => 1, :assigned_to_id => user.id, :sort => 'due_date:asc')
  render_multipart('reminder', body)
end

#test(user) ⇒ Object


326
327
328
329
330
331
332
333
# File 'app/models/mailer.rb', line 326

def test(user)
  redmine_headers 'Type' => "Test"
  set_language_if_valid(user.language)
  recipients user.mail
  subject 'ChiliProject test'
  body :url => url_for(:controller => 'welcome')
  render_multipart('test', body)
end

#wiki_content_added(wiki_content, recipient) ⇒ Object

Builds a tmail object used to email the recipients of a project of the specified wiki content was added.

Example:

wiki_content_added(wiki_content) => tmail object
Mailer.deliver_wiki_content_added(wiki_content) => sends an email to the project's recipients

192
193
194
195
196
197
198
199
200
201
202
# File 'app/models/mailer.rb', line 192

def wiki_content_added(wiki_content, recipient)
  redmine_headers 'Project' => wiki_content.project.identifier,
                  'Wiki-Page-Id' => wiki_content.page.id,
                  'Type' => "Wiki"
  message_id wiki_content
  recipients [recipient]
  subject "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_added, :id => wiki_content.page.pretty_title)}"
  body :wiki_content => wiki_content,
       :wiki_content_url => url_for(:controller => 'wiki', :action => 'show', :project_id => wiki_content.project, :id => wiki_content.page.title)
  render_multipart('wiki_content_added', body)
end

#wiki_content_updated(wiki_content, recipient) ⇒ Object

Builds a tmail object used to email the recipients of a project of the specified wiki content was updated.

Example:

wiki_content_updated(wiki_content) => tmail object
Mailer.deliver_wiki_content_updated(wiki_content) => sends an email to the project's recipients

209
210
211
212
213
214
215
216
217
218
219
220
# File 'app/models/mailer.rb', line 209

def wiki_content_updated(wiki_content, recipient)
  redmine_headers 'Project' => wiki_content.project.identifier,
                  'Wiki-Page-Id' => wiki_content.page.id,
                  'Type' => "Wiki"
  message_id wiki_content
  recipients [recipient]
  subject "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_updated, :id => wiki_content.page.pretty_title)}"
  body :wiki_content => wiki_content,
       :wiki_content_url => url_for(:controller => 'wiki', :action => 'show', :project_id => wiki_content.project, :id => wiki_content.page.title),
       :wiki_diff_url => url_for(:controller => 'wiki', :action => 'diff', :project_id => wiki_content.project, :id => wiki_content.page.title, :version => wiki_content.version)
  render_multipart('wiki_content_updated', body)
end