Chris@1494: # Redmine - project management software Chris@1494: # Copyright (C) 2006-2014 Jean-Philippe Lang Chris@1494: # Chris@1494: # This program is free software; you can redistribute it and/or Chris@1494: # modify it under the terms of the GNU General Public License Chris@1494: # as published by the Free Software Foundation; either version 2 Chris@1494: # of the License, or (at your option) any later version. Chris@1494: # Chris@1494: # This program is distributed in the hope that it will be useful, Chris@1494: # but WITHOUT ANY WARRANTY; without even the implied warranty of Chris@1494: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Chris@1494: # GNU General Public License for more details. Chris@1494: # Chris@1494: # You should have received a copy of the GNU General Public License Chris@1494: # along with this program; if not, write to the Free Software Chris@1494: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Chris@1494: Chris@1494: namespace :redmine do Chris@1494: namespace :email do Chris@1494: Chris@1494: desc <<-END_DESC Chris@1494: Read an email from standard input. Chris@1494: Chris@1494: General options: Chris@1494: unknown_user=ACTION how to handle emails from an unknown user Chris@1494: ACTION can be one of the following values: Chris@1494: ignore: email is ignored (default) Chris@1494: accept: accept as anonymous user Chris@1494: create: create a user account Chris@1494: no_permission_check=1 disable permission checking when receiving Chris@1494: the email Chris@1494: no_account_notice=1 disable new user account notification Chris@1494: default_group=foo,bar adds created user to foo and bar groups Chris@1494: Chris@1494: Issue attributes control options: Chris@1494: project=PROJECT identifier of the target project Chris@1494: status=STATUS name of the target status Chris@1494: tracker=TRACKER name of the target tracker Chris@1494: category=CATEGORY name of the target category Chris@1494: priority=PRIORITY name of the target priority Chris@1494: allow_override=ATTRS allow email content to override attributes Chris@1494: specified by previous options Chris@1494: ATTRS is a comma separated list of attributes Chris@1494: Chris@1494: Examples: Chris@1494: # No project specified. Emails MUST contain the 'Project' keyword: Chris@1494: rake redmine:email:read RAILS_ENV="production" < raw_email Chris@1494: Chris@1494: # Fixed project and default tracker specified, but emails can override Chris@1494: # both tracker and priority attributes: Chris@1494: rake redmine:email:read RAILS_ENV="production" \\ Chris@1494: project=foo \\ Chris@1494: tracker=bug \\ Chris@1494: allow_override=tracker,priority < raw_email Chris@1494: END_DESC Chris@1494: Chris@1494: task :read => :environment do Chris@1494: MailHandler.receive(STDIN.read, MailHandler.extract_options_from_env(ENV)) Chris@1494: end Chris@1494: Chris@1494: desc <<-END_DESC Chris@1494: Read emails from an IMAP server. Chris@1494: Chris@1494: General options: Chris@1494: unknown_user=ACTION how to handle emails from an unknown user Chris@1494: ACTION can be one of the following values: Chris@1494: ignore: email is ignored (default) Chris@1494: accept: accept as anonymous user Chris@1494: create: create a user account Chris@1494: no_permission_check=1 disable permission checking when receiving Chris@1494: the email Chris@1494: no_account_notice=1 disable new user account notification Chris@1494: default_group=foo,bar adds created user to foo and bar groups Chris@1494: Chris@1494: Available IMAP options: Chris@1494: host=HOST IMAP server host (default: 127.0.0.1) Chris@1494: port=PORT IMAP server port (default: 143) Chris@1494: ssl=SSL Use SSL? (default: false) Chris@1494: username=USERNAME IMAP account Chris@1494: password=PASSWORD IMAP password Chris@1494: folder=FOLDER IMAP folder to read (default: INBOX) Chris@1494: Chris@1494: Issue attributes control options: Chris@1494: project=PROJECT identifier of the target project Chris@1494: status=STATUS name of the target status Chris@1494: tracker=TRACKER name of the target tracker Chris@1494: category=CATEGORY name of the target category Chris@1494: priority=PRIORITY name of the target priority Chris@1494: allow_override=ATTRS allow email content to override attributes Chris@1494: specified by previous options Chris@1494: ATTRS is a comma separated list of attributes Chris@1494: Chris@1494: Processed emails control options: Chris@1494: move_on_success=MAILBOX move emails that were successfully received Chris@1494: to MAILBOX instead of deleting them Chris@1494: move_on_failure=MAILBOX move emails that were ignored to MAILBOX Chris@1494: Chris@1494: Examples: Chris@1494: # No project specified. Emails MUST contain the 'Project' keyword: Chris@1494: Chris@1494: rake redmine:email:receive_imap RAILS_ENV="production" \\ Chris@1494: host=imap.foo.bar username=redmine@example.net password=xxx Chris@1494: Chris@1494: Chris@1494: # Fixed project and default tracker specified, but emails can override Chris@1494: # both tracker and priority attributes: Chris@1494: Chris@1494: rake redmine:email:receive_imap RAILS_ENV="production" \\ Chris@1494: host=imap.foo.bar username=redmine@example.net password=xxx ssl=1 \\ Chris@1494: project=foo \\ Chris@1494: tracker=bug \\ Chris@1494: allow_override=tracker,priority Chris@1494: END_DESC Chris@1494: Chris@1494: task :receive_imap => :environment do Chris@1494: imap_options = {:host => ENV['host'], Chris@1494: :port => ENV['port'], Chris@1494: :ssl => ENV['ssl'], Chris@1494: :username => ENV['username'], Chris@1494: :password => ENV['password'], Chris@1494: :folder => ENV['folder'], Chris@1494: :move_on_success => ENV['move_on_success'], Chris@1494: :move_on_failure => ENV['move_on_failure']} Chris@1494: Chris@1494: Redmine::IMAP.check(imap_options, MailHandler.extract_options_from_env(ENV)) Chris@1494: end Chris@1494: Chris@1494: desc <<-END_DESC Chris@1494: Read emails from an POP3 server. Chris@1494: Chris@1494: Available POP3 options: Chris@1494: host=HOST POP3 server host (default: 127.0.0.1) Chris@1494: port=PORT POP3 server port (default: 110) Chris@1494: username=USERNAME POP3 account Chris@1494: password=PASSWORD POP3 password Chris@1494: apop=1 use APOP authentication (default: false) Chris@1494: delete_unprocessed=1 delete messages that could not be processed Chris@1494: successfully from the server (default Chris@1494: behaviour is to leave them on the server) Chris@1494: Chris@1494: See redmine:email:receive_imap for more options and examples. Chris@1494: END_DESC Chris@1494: Chris@1494: task :receive_pop3 => :environment do Chris@1494: pop_options = {:host => ENV['host'], Chris@1494: :port => ENV['port'], Chris@1494: :apop => ENV['apop'], Chris@1494: :username => ENV['username'], Chris@1494: :password => ENV['password'], Chris@1494: :delete_unprocessed => ENV['delete_unprocessed']} Chris@1494: Chris@1494: Redmine::POP3.check(pop_options, MailHandler.extract_options_from_env(ENV)) Chris@1494: end Chris@1494: Chris@1494: desc "Send a test email to the user with the provided login name" Chris@1494: task :test, [:login] => :environment do |task, args| Chris@1494: include Redmine::I18n Chris@1494: abort l(:notice_email_error, "Please include the user login to test with. Example: rake redmine:email:test[login]") if args[:login].blank? Chris@1494: Chris@1494: user = User.find_by_login(args[:login]) Chris@1494: abort l(:notice_email_error, "User #{args[:login]} not found") unless user && user.logged? Chris@1494: Chris@1494: ActionMailer::Base.raise_delivery_errors = true Chris@1494: begin Chris@1494: Mailer.with_synched_deliveries do Chris@1494: Mailer.test_email(user).deliver Chris@1494: end Chris@1494: puts l(:notice_email_sent, user.mail) Chris@1494: rescue Exception => e Chris@1494: abort l(:notice_email_error, e.message) Chris@1494: end Chris@1494: end Chris@1494: end Chris@1494: end