email.rake
114 lines
| 4.7 KiB
| text/x-ruby
|
RubyLexer
Jean-Philippe Lang
|
r2218 | # Redmine - project management software | ||
|
Jean-Philippe Lang
|
r1554 | # Copyright (C) 2006-2008 Jean-Philippe Lang | ||
| # | ||||
| # This program is free software; you can redistribute it and/or | ||||
| # modify it under the terms of the GNU General Public License | ||||
| # as published by the Free Software Foundation; either version 2 | ||||
| # of the License, or (at your option) any later version. | ||||
| # | ||||
| # This program is distributed in the hope that it will be useful, | ||||
| # but WITHOUT ANY WARRANTY; without even the implied warranty of | ||||
| # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||||
| # GNU General Public License for more details. | ||||
| # | ||||
| # You should have received a copy of the GNU General Public License | ||||
| # along with this program; if not, write to the Free Software | ||||
| # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. | ||||
|
Jean-Philippe Lang
|
r1555 | namespace :redmine do | ||
| namespace :email do | ||||
| desc <<-END_DESC | ||||
|
Jean-Philippe Lang
|
r1554 | Read an email from standard input. | ||
|
Jean-Philippe Lang
|
r1629 | Issue attributes control options: | ||
| project=PROJECT identifier of the target project | ||||
|
Jean-Philippe Lang
|
r2073 | status=STATUS name of the target status | ||
|
Jean-Philippe Lang
|
r1629 | tracker=TRACKER name of the target tracker | ||
| category=CATEGORY name of the target category | ||||
| priority=PRIORITY name of the target priority | ||||
| allow_override=ATTRS allow email content to override attributes | ||||
| specified by previous options | ||||
| ATTRS is a comma separated list of attributes | ||||
| Examples: | ||||
| # No project specified. Emails MUST contain the 'Project' keyword: | ||||
| rake redmine:email:read RAILS_ENV="production" < raw_email | ||||
| # Fixed project and default tracker specified, but emails can override | ||||
| # both tracker and priority attributes: | ||||
| rake redmine:email:read RAILS_ENV="production" \\ | ||||
| project=foo \\ | ||||
| tracker=bug \\ | ||||
| allow_override=tracker,priority < raw_email | ||||
|
Jean-Philippe Lang
|
r1554 | END_DESC | ||
|
Jean-Philippe Lang
|
r1629 | task :read => :environment do | ||
| options = { :issue => {} } | ||||
|
Jean-Philippe Lang
|
r2073 | %w(project status tracker category priority).each { |a| options[:issue][a.to_sym] = ENV[a] if ENV[a] } | ||
|
Jean-Philippe Lang
|
r1629 | options[:allow_override] = ENV['allow_override'] if ENV['allow_override'] | ||
|
Jean-Philippe Lang
|
r1554 | |||
| MailHandler.receive(STDIN.read, options) | ||||
| end | ||||
|
Jean-Philippe Lang
|
r1555 | |||
| desc <<-END_DESC | ||||
| Read emails from an IMAP server. | ||||
| Available IMAP options: | ||||
|
Jean-Philippe Lang
|
r1629 | host=HOST IMAP server host (default: 127.0.0.1) | ||
| port=PORT IMAP server port (default: 143) | ||||
| ssl=SSL Use SSL? (default: false) | ||||
| username=USERNAME IMAP account | ||||
| password=PASSWORD IMAP password | ||||
| folder=FOLDER IMAP folder to read (default: INBOX) | ||||
| Issue attributes control options: | ||||
| project=PROJECT identifier of the target project | ||||
|
Jean-Philippe Lang
|
r2073 | status=STATUS name of the target status | ||
|
Jean-Philippe Lang
|
r1629 | tracker=TRACKER name of the target tracker | ||
| category=CATEGORY name of the target category | ||||
| priority=PRIORITY name of the target priority | ||||
| allow_override=ATTRS allow email content to override attributes | ||||
| specified by previous options | ||||
| ATTRS is a comma separated list of attributes | ||||
|
Jean-Philippe Lang
|
r2218 | |||
| Processed emails control options: | ||||
| move_on_success=MAILBOX move emails that were successfully received | ||||
| to MAILBOX instead of deleting them | ||||
| move_on_failure=MAILBOX move emails that were ignored to MAILBOX | ||||
|
Jean-Philippe Lang
|
r1629 | |||
| Examples: | ||||
| # No project specified. Emails MUST contain the 'Project' keyword: | ||||
| rake redmine:email:receive_iamp RAILS_ENV="production" \\ | ||||
|
Jean-Philippe Lang
|
r1763 | host=imap.foo.bar username=redmine@example.net password=xxx | ||
|
Jean-Philippe Lang
|
r1629 | |||
| # Fixed project and default tracker specified, but emails can override | ||||
| # both tracker and priority attributes: | ||||
|
Jean-Philippe Lang
|
r1555 | |||
|
Jean-Philippe Lang
|
r1629 | rake redmine:email:receive_iamp RAILS_ENV="production" \\ | ||
|
Jean-Philippe Lang
|
r1763 | host=imap.foo.bar username=redmine@example.net password=xxx ssl=1 \\ | ||
|
Jean-Philippe Lang
|
r1629 | project=foo \\ | ||
| tracker=bug \\ | ||||
| allow_override=tracker,priority | ||||
|
Jean-Philippe Lang
|
r1555 | END_DESC | ||
| task :receive_imap => :environment do | ||||
| imap_options = {:host => ENV['host'], | ||||
| :port => ENV['port'], | ||||
| :ssl => ENV['ssl'], | ||||
| :username => ENV['username'], | ||||
| :password => ENV['password'], | ||||
|
Jean-Philippe Lang
|
r2218 | :folder => ENV['folder'], | ||
| :move_on_success => ENV['move_on_success'], | ||||
| :move_on_failure => ENV['move_on_failure']} | ||||
|
Jean-Philippe Lang
|
r1555 | |||
|
Jean-Philippe Lang
|
r1629 | options = { :issue => {} } | ||
|
Jean-Philippe Lang
|
r2073 | %w(project status tracker category priority).each { |a| options[:issue][a.to_sym] = ENV[a] if ENV[a] } | ||
|
Jean-Philippe Lang
|
r1629 | options[:allow_override] = ENV['allow_override'] if ENV['allow_override'] | ||
|
Jean-Philippe Lang
|
r1555 | |||
| Redmine::IMAP.check(imap_options, options) | ||||
| end | ||||
|
Jean-Philippe Lang
|
r1554 | end | ||
| end | ||||