##// END OF EJS Templates
jro_apps » redmine
RSS
Merged r11748 from trunk (#13712)....
Jean-Philippe Lang -
r11519:07dc1e34ff7e
parent child
Show More
Side by Side Unified
Context file:
r11519:07dc1e34ff7e Loading diff...:
Show file before | Show file after | Hide comments
@@ -1,188 +1,198
1 1 # Redmine - project management software
2 2 # Copyright (C) 2006-2013 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 no_account_notice=1 disable new user account notification
33 default_group=foo,bar adds created user to foo and bar groups
32 34
33 35 Issue attributes control options:
34 36 project=PROJECT identifier of the target project
35 37 status=STATUS name of the target status
36 38 tracker=TRACKER name of the target tracker
37 39 category=CATEGORY name of the target category
38 40 priority=PRIORITY name of the target priority
39 41 allow_override=ATTRS allow email content to override attributes
40 42 specified by previous options
41 43 ATTRS is a comma separated list of attributes
42 44
43 45 Examples:
44 46 # No project specified. Emails MUST contain the 'Project' keyword:
45 47 rake redmine:email:read RAILS_ENV="production" < raw_email
46 48
47 49 # Fixed project and default tracker specified, but emails can override
48 50 # both tracker and priority attributes:
49 51 rake redmine:email:read RAILS_ENV="production" \\
50 52 project=foo \\
51 53 tracker=bug \\
52 54 allow_override=tracker,priority < raw_email
53 55 END_DESC
54 56
55 57 task :read => :environment do
56 58 options = { :issue => {} }
57 59 %w(project status tracker category priority).each { |a| options[:issue][a.to_sym] = ENV[a] if ENV[a] }
58 60 options[:allow_override] = ENV['allow_override'] if ENV['allow_override']
59 61 options[:unknown_user] = ENV['unknown_user'] if ENV['unknown_user']
60 62 options[:no_permission_check] = ENV['no_permission_check'] if ENV['no_permission_check']
63 options[:no_account_notice] = ENV['no_account_notice'] if ENV['no_account_notice']
64 options[:default_group] = ENV['default_group'] if ENV['default_group']
61 65
62 66 MailHandler.receive(STDIN.read, options)
63 67 end
64 68
65 69 desc <<-END_DESC
66 70 Read emails from an IMAP server.
67 71
68 72 General options:
69 73 unknown_user=ACTION how to handle emails from an unknown user
70 74 ACTION can be one of the following values:
71 75 ignore: email is ignored (default)
72 76 accept: accept as anonymous user
73 77 create: create a user account
74 78 no_permission_check=1 disable permission checking when receiving
75 79 the email
80 no_account_notice=1 disable new user account notification
81 default_group=foo,bar adds created user to foo and bar groups
76 82
77 83 Available IMAP options:
78 84 host=HOST IMAP server host (default: 127.0.0.1)
79 85 port=PORT IMAP server port (default: 143)
80 86 ssl=SSL Use SSL? (default: false)
81 87 username=USERNAME IMAP account
82 88 password=PASSWORD IMAP password
83 89 folder=FOLDER IMAP folder to read (default: INBOX)
84 90
85 91 Issue attributes control options:
86 92 project=PROJECT identifier of the target project
87 93 status=STATUS name of the target status
88 94 tracker=TRACKER name of the target tracker
89 95 category=CATEGORY name of the target category
90 96 priority=PRIORITY name of the target priority
91 97 allow_override=ATTRS allow email content to override attributes
92 98 specified by previous options
93 99 ATTRS is a comma separated list of attributes
94 100
95 101 Processed emails control options:
96 102 move_on_success=MAILBOX move emails that were successfully received
97 103 to MAILBOX instead of deleting them
98 104 move_on_failure=MAILBOX move emails that were ignored to MAILBOX
99 105
100 106 Examples:
101 107 # No project specified. Emails MUST contain the 'Project' keyword:
102 108
103 109 rake redmine:email:receive_imap RAILS_ENV="production" \\
104 110 host=imap.foo.bar username=redmine@example.net password=xxx
105 111
106 112
107 113 # Fixed project and default tracker specified, but emails can override
108 114 # both tracker and priority attributes:
109 115
110 116 rake redmine:email:receive_imap RAILS_ENV="production" \\
111 117 host=imap.foo.bar username=redmine@example.net password=xxx ssl=1 \\
112 118 project=foo \\
113 119 tracker=bug \\
114 120 allow_override=tracker,priority
115 121 END_DESC
116 122
117 123 task :receive_imap => :environment do
118 124 imap_options = {:host => ENV['host'],
119 125 :port => ENV['port'],
120 126 :ssl => ENV['ssl'],
121 127 :username => ENV['username'],
122 128 :password => ENV['password'],
123 129 :folder => ENV['folder'],
124 130 :move_on_success => ENV['move_on_success'],
125 131 :move_on_failure => ENV['move_on_failure']}
126 132
127 133 options = { :issue => {} }
128 134 %w(project status tracker category priority).each { |a| options[:issue][a.to_sym] = ENV[a] if ENV[a] }
129 135 options[:allow_override] = ENV['allow_override'] if ENV['allow_override']
130 136 options[:unknown_user] = ENV['unknown_user'] if ENV['unknown_user']
131 137 options[:no_permission_check] = ENV['no_permission_check'] if ENV['no_permission_check']
138 options[:no_account_notice] = ENV['no_account_notice'] if ENV['no_account_notice']
139 options[:default_group] = ENV['default_group'] if ENV['default_group']
132 140
133 141 Redmine::IMAP.check(imap_options, options)
134 142 end
135 143
136 144 desc <<-END_DESC
137 145 Read emails from an POP3 server.
138 146
139 147 Available POP3 options:
140 148 host=HOST POP3 server host (default: 127.0.0.1)
141 149 port=PORT POP3 server port (default: 110)
142 150 username=USERNAME POP3 account
143 151 password=PASSWORD POP3 password
144 152 apop=1 use APOP authentication (default: false)
145 153 delete_unprocessed=1 delete messages that could not be processed
146 154 successfully from the server (default
147 155 behaviour is to leave them on the server)
148 156
149 157 See redmine:email:receive_imap for more options and examples.
150 158 END_DESC
151 159
152 160 task :receive_pop3 => :environment do
153 161 pop_options = {:host => ENV['host'],
154 162 :port => ENV['port'],
155 163 :apop => ENV['apop'],
156 164 :username => ENV['username'],
157 165 :password => ENV['password'],
158 166 :delete_unprocessed => ENV['delete_unprocessed']}
159 167
160 168 options = { :issue => {} }
161 169 %w(project status tracker category priority).each { |a| options[:issue][a.to_sym] = ENV[a] if ENV[a] }
162 170 options[:allow_override] = ENV['allow_override'] if ENV['allow_override']
163 171 options[:unknown_user] = ENV['unknown_user'] if ENV['unknown_user']
164 172 options[:no_permission_check] = ENV['no_permission_check'] if ENV['no_permission_check']
173 options[:no_account_notice] = ENV['no_account_notice'] if ENV['no_account_notice']
174 options[:default_group] = ENV['default_group'] if ENV['default_group']
165 175
166 176 Redmine::POP3.check(pop_options, options)
167 177 end
168 178
169 179 desc "Send a test email to the user with the provided login name"
170 180 task :test, [:login] => :environment do |task, args|
171 181 include Redmine::I18n
172 182 abort l(:notice_email_error, "Please include the user login to test with. Example: rake redmine:email:test[login]") if args[:login].blank?
173 183
174 184 user = User.find_by_login(args[:login])
175 185 abort l(:notice_email_error, "User #{args[:login]} not found") unless user && user.logged?
176 186
177 187 ActionMailer::Base.raise_delivery_errors = true
178 188 begin
179 189 Mailer.with_synched_deliveries do
180 190 Mailer.test_email(user).deliver
181 191 end
182 192 puts l(:notice_email_sent, user.mail)
183 193 rescue Exception => e
184 194 abort l(:notice_email_error, e.message)
185 195 end
186 196 end
187 197 end
188 198 end
General Comments 0
You need to be logged in to leave comments. Login now