@@ -1,186 +1,188 | |||
|
1 | 1 | # Redmine - project management software |
|
2 | 2 | # Copyright (C) 2006-2011 Jean-Philippe Lang |
|
3 | 3 | # |
|
4 | 4 | # This program is free software; you can redistribute it and/or |
|
5 | 5 | # modify it under the terms of the GNU General Public License |
|
6 | 6 | # as published by the Free Software Foundation; either version 2 |
|
7 | 7 | # of the License, or (at your option) any later version. |
|
8 | 8 | # |
|
9 | 9 | # This program is distributed in the hope that it will be useful, |
|
10 | 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
11 | 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
12 | 12 | # GNU General Public License for more details. |
|
13 | 13 | # |
|
14 | 14 | # You should have received a copy of the GNU General Public License |
|
15 | 15 | # along with this program; if not, write to the Free Software |
|
16 | 16 | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
|
17 | 17 | |
|
18 | 18 | namespace :redmine do |
|
19 | 19 | namespace :email do |
|
20 | 20 | |
|
21 | 21 | desc <<-END_DESC |
|
22 | 22 | Read an email from standard input. |
|
23 | 23 | |
|
24 | 24 | General options: |
|
25 | 25 | unknown_user=ACTION how to handle emails from an unknown user |
|
26 | 26 | ACTION can be one of the following values: |
|
27 | 27 | ignore: email is ignored (default) |
|
28 | 28 | accept: accept as anonymous user |
|
29 | 29 | create: create a user account |
|
30 | 30 | no_permission_check=1 disable permission checking when receiving |
|
31 | 31 | the email |
|
32 | 32 | |
|
33 | 33 | Issue attributes control options: |
|
34 | 34 | project=PROJECT identifier of the target project |
|
35 | 35 | status=STATUS name of the target status |
|
36 | 36 | tracker=TRACKER name of the target tracker |
|
37 | 37 | category=CATEGORY name of the target category |
|
38 | 38 | priority=PRIORITY name of the target priority |
|
39 | 39 | allow_override=ATTRS allow email content to override attributes |
|
40 | 40 | specified by previous options |
|
41 | 41 | ATTRS is a comma separated list of attributes |
|
42 | 42 | |
|
43 | 43 | Examples: |
|
44 | 44 | # No project specified. Emails MUST contain the 'Project' keyword: |
|
45 | 45 | rake redmine:email:read RAILS_ENV="production" < raw_email |
|
46 | 46 | |
|
47 | 47 | # Fixed project and default tracker specified, but emails can override |
|
48 | 48 | # both tracker and priority attributes: |
|
49 | 49 | rake redmine:email:read RAILS_ENV="production" \\ |
|
50 | 50 | project=foo \\ |
|
51 | 51 | tracker=bug \\ |
|
52 | 52 | allow_override=tracker,priority < raw_email |
|
53 | 53 | END_DESC |
|
54 | 54 | |
|
55 | 55 | task :read => :environment do |
|
56 | 56 | options = { :issue => {} } |
|
57 | 57 | %w(project status tracker category priority).each { |a| options[:issue][a.to_sym] = ENV[a] if ENV[a] } |
|
58 | 58 | options[:allow_override] = ENV['allow_override'] if ENV['allow_override'] |
|
59 | 59 | options[:unknown_user] = ENV['unknown_user'] if ENV['unknown_user'] |
|
60 | 60 | options[:no_permission_check] = ENV['no_permission_check'] if ENV['no_permission_check'] |
|
61 | 61 | |
|
62 | 62 | MailHandler.receive(STDIN.read, options) |
|
63 | 63 | end |
|
64 | 64 | |
|
65 | 65 | desc <<-END_DESC |
|
66 | 66 | Read emails from an IMAP server. |
|
67 | 67 | |
|
68 | 68 | General options: |
|
69 | 69 | unknown_user=ACTION how to handle emails from an unknown user |
|
70 | 70 | ACTION can be one of the following values: |
|
71 | 71 | ignore: email is ignored (default) |
|
72 | 72 | accept: accept as anonymous user |
|
73 | 73 | create: create a user account |
|
74 | 74 | no_permission_check=1 disable permission checking when receiving |
|
75 | 75 | the email |
|
76 | 76 | |
|
77 | 77 | Available IMAP options: |
|
78 | 78 | host=HOST IMAP server host (default: 127.0.0.1) |
|
79 | 79 | port=PORT IMAP server port (default: 143) |
|
80 | 80 | ssl=SSL Use SSL? (default: false) |
|
81 | 81 | username=USERNAME IMAP account |
|
82 | 82 | password=PASSWORD IMAP password |
|
83 | 83 | folder=FOLDER IMAP folder to read (default: INBOX) |
|
84 | 84 | |
|
85 | 85 | Issue attributes control options: |
|
86 | 86 | project=PROJECT identifier of the target project |
|
87 | 87 | status=STATUS name of the target status |
|
88 | 88 | tracker=TRACKER name of the target tracker |
|
89 | 89 | category=CATEGORY name of the target category |
|
90 | 90 | priority=PRIORITY name of the target priority |
|
91 | 91 | allow_override=ATTRS allow email content to override attributes |
|
92 | 92 | specified by previous options |
|
93 | 93 | ATTRS is a comma separated list of attributes |
|
94 | 94 | |
|
95 | 95 | Processed emails control options: |
|
96 | 96 | move_on_success=MAILBOX move emails that were successfully received |
|
97 | 97 | to MAILBOX instead of deleting them |
|
98 | 98 | move_on_failure=MAILBOX move emails that were ignored to MAILBOX |
|
99 | 99 | |
|
100 | 100 | Examples: |
|
101 | 101 | # No project specified. Emails MUST contain the 'Project' keyword: |
|
102 | 102 | |
|
103 | 103 | rake redmine:email:receive_imap RAILS_ENV="production" \\ |
|
104 | 104 | host=imap.foo.bar username=redmine@example.net password=xxx |
|
105 | 105 | |
|
106 | 106 | |
|
107 | 107 | # Fixed project and default tracker specified, but emails can override |
|
108 | 108 | # both tracker and priority attributes: |
|
109 | 109 | |
|
110 | 110 | rake redmine:email:receive_imap RAILS_ENV="production" \\ |
|
111 | 111 | host=imap.foo.bar username=redmine@example.net password=xxx ssl=1 \\ |
|
112 | 112 | project=foo \\ |
|
113 | 113 | tracker=bug \\ |
|
114 | 114 | allow_override=tracker,priority |
|
115 | 115 | END_DESC |
|
116 | 116 | |
|
117 | 117 | task :receive_imap => :environment do |
|
118 | 118 | imap_options = {:host => ENV['host'], |
|
119 | 119 | :port => ENV['port'], |
|
120 | 120 | :ssl => ENV['ssl'], |
|
121 | 121 | :username => ENV['username'], |
|
122 | 122 | :password => ENV['password'], |
|
123 | 123 | :folder => ENV['folder'], |
|
124 | 124 | :move_on_success => ENV['move_on_success'], |
|
125 | 125 | :move_on_failure => ENV['move_on_failure']} |
|
126 | 126 | |
|
127 | 127 | options = { :issue => {} } |
|
128 | 128 | %w(project status tracker category priority).each { |a| options[:issue][a.to_sym] = ENV[a] if ENV[a] } |
|
129 | 129 | options[:allow_override] = ENV['allow_override'] if ENV['allow_override'] |
|
130 | 130 | options[:unknown_user] = ENV['unknown_user'] if ENV['unknown_user'] |
|
131 | 131 | options[:no_permission_check] = ENV['no_permission_check'] if ENV['no_permission_check'] |
|
132 | 132 | |
|
133 | 133 | Redmine::IMAP.check(imap_options, options) |
|
134 | 134 | end |
|
135 | 135 | |
|
136 | 136 | desc <<-END_DESC |
|
137 | 137 | Read emails from an POP3 server. |
|
138 | 138 | |
|
139 | 139 | Available POP3 options: |
|
140 | 140 | host=HOST POP3 server host (default: 127.0.0.1) |
|
141 | 141 | port=PORT POP3 server port (default: 110) |
|
142 | 142 | username=USERNAME POP3 account |
|
143 | 143 | password=PASSWORD POP3 password |
|
144 | 144 | apop=1 use APOP authentication (default: false) |
|
145 | 145 | delete_unprocessed=1 delete messages that could not be processed |
|
146 | 146 | successfully from the server (default |
|
147 | 147 | behaviour is to leave them on the server) |
|
148 | 148 | |
|
149 | 149 | See redmine:email:receive_imap for more options and examples. |
|
150 | 150 | END_DESC |
|
151 | 151 | |
|
152 | 152 | task :receive_pop3 => :environment do |
|
153 | 153 | pop_options = {:host => ENV['host'], |
|
154 | 154 | :port => ENV['port'], |
|
155 | 155 | :apop => ENV['apop'], |
|
156 | 156 | :username => ENV['username'], |
|
157 | 157 | :password => ENV['password'], |
|
158 | 158 | :delete_unprocessed => ENV['delete_unprocessed']} |
|
159 | 159 | |
|
160 | 160 | options = { :issue => {} } |
|
161 | 161 | %w(project status tracker category priority).each { |a| options[:issue][a.to_sym] = ENV[a] if ENV[a] } |
|
162 | 162 | options[:allow_override] = ENV['allow_override'] if ENV['allow_override'] |
|
163 | 163 | options[:unknown_user] = ENV['unknown_user'] if ENV['unknown_user'] |
|
164 | 164 | options[:no_permission_check] = ENV['no_permission_check'] if ENV['no_permission_check'] |
|
165 | 165 | |
|
166 | 166 | Redmine::POP3.check(pop_options, options) |
|
167 | 167 | end |
|
168 | 168 | |
|
169 | 169 | desc "Send a test email to the user with the provided login name" |
|
170 | 170 | task :test, [:login] => :environment do |task, args| |
|
171 | 171 | include Redmine::I18n |
|
172 | 172 | abort l(:notice_email_error, "Please include the user login to test with. Example: rake redmine:email:test[login]") if args[:login].blank? |
|
173 | 173 | |
|
174 | 174 | user = User.find_by_login(args[:login]) |
|
175 | 175 | abort l(:notice_email_error, "User #{args[:login]} not found") unless user && user.logged? |
|
176 | 176 | |
|
177 | 177 | ActionMailer::Base.raise_delivery_errors = true |
|
178 | 178 | begin |
|
179 |
Mailer.deliver |
|
|
179 | Mailer.with_synched_deliveries do | |
|
180 | Mailer.deliver_test_email(user) | |
|
181 | end | |
|
180 | 182 | puts l(:notice_email_sent, user.mail) |
|
181 | 183 | rescue Exception => e |
|
182 | 184 | abort l(:notice_email_error, e.message) |
|
183 | 185 | end |
|
184 | 186 | end |
|
185 | 187 | end |
|
186 | 188 | end |
General Comments 0
You need to be logged in to leave comments.
Login now