Class: Vmail::ImapClient
Constant Summary
ShowingHeaders::FLAGMAP
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
#convert_to_message_ids, #copy_to, #flag, #move_to
#cached_full_message?, #current_mail, #current_message, #fetch_and_cache, #format_parts_info, #show_message
#extract_address, #fetch_and_cache_headers, #format_flags, #format_header_for_list, #get_message_headers, #with_more_message_line
Methods included from Searching
#search, #search_query?
#quote_addresses
Methods included from Helpers
#divider, #number_to_human_size, #retry_if_needed
Constructor Details
#initialize(config) ⇒ ImapClient
Returns a new instance of ImapClient.
28
29
30
31
32
33
34
35
36
37
38
39
|
# File 'lib/vmail/imap_client.rb', line 28
def initialize(config)
@username, @password = config['username'], config['password']
@name = config['name']
@signature = config['signature']
@always_cc = config['always_cc']
@mailbox = nil
@logger = Logger.new(config['logfile'] || STDERR)
@logger.level = Logger::DEBUG
@imap_server = config['server'] || 'imap.gmail.com'
@imap_port = config['port'] || 993
current_message = nil
end
|
Instance Attribute Details
#max_seqno ⇒ Object
26
27
28
|
# File 'lib/vmail/imap_client.rb', line 26
def max_seqno
@max_seqno
end
|
Class Method Details
.daemon(config) ⇒ Object
470
471
472
473
474
475
476
477
|
# File 'lib/vmail/imap_client.rb', line 470
def self.daemon(config)
$gmail = self.start(config)
use_uri = config['drb_uri'] || nil DRb.start_service(use_uri, $gmail)
uri = DRb.uri
puts "Starting gmail service at #{uri}"
uri
end
|
.start(config) ⇒ Object
464
465
466
467
468
|
# File 'lib/vmail/imap_client.rb', line 464
def self.start(config)
imap_client = Vmail::ImapClient.new config
imap_client.open
imap_client
end
|
Instance Method Details
#append_to_file(uid_set, file) ⇒ Object
255
256
257
258
259
260
261
262
263
264
265
|
# File 'lib/vmail/imap_client.rb', line 255
def append_to_file(uid_set, file)
uid_set = uid_set.split(',').map(&:to_i)
log "Append to file uid set #{uid_set.inspect} to file: #{file}"
uid_set.each do |uid|
message = show_message(uid)
File.open(file, 'a') {|f| f.puts(divider('=') + "\n" + message + "\n\n")}
subject = (message[/^subject:(.*)/,1] || '').strip
log "Appended message '#{subject}'"
end
"Printed #{uid_set.size} message#{uid_set.size == 1 ? '' : 's'} to #{file.strip}"
end
|
#clear_cached_message ⇒ Object
TODO no need for this if all shown messages are stored in SQLITE3 and keyed by UID.
92
93
94
95
96
|
# File 'lib/vmail/imap_client.rb', line 92
def clear_cached_message
return unless STDIN.tty?
log "Clearing cached message"
current_message = nil
end
|
#close ⇒ Object
56
57
58
59
60
61
62
63
|
# File 'lib/vmail/imap_client.rb', line 56
def close
log "Closing connection"
Timeout::timeout(10) do
@imap.close rescue Net::IMAP::BadResponseError
@imap.disconnect rescue IOError
end
rescue Timeout::Error
end
|
#create_if_necessary(mailbox) ⇒ Object
244
245
246
247
248
249
250
251
252
253
|
# File 'lib/vmail/imap_client.rb', line 244
def create_if_necessary(mailbox)
current_mailboxes = mailboxes.map {|m| mailbox_aliases[m] || m}
if !current_mailboxes.include?(mailbox)
log "Current mailboxes: #{current_mailboxes.inspect}"
log "Creating mailbox #{mailbox}"
log @imap.create(mailbox)
@mailboxes = nil list_mailboxes
end
end
|
#decrement_max_seqno(num) ⇒ Object
180
181
182
183
184
|
# File 'lib/vmail/imap_client.rb', line 180
def decrement_max_seqno(num)
return unless STDIN.tty?
log "Decremented max seqno from #{self.max_seqno} to #{self.max_seqno - num}"
self.max_seqno -= num
end
|
#deliver(text) ⇒ Object
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
|
# File 'lib/vmail/imap_client.rb', line 324
def deliver(text)
require 'net/smtp'
mail = new_mail_from_input(text)
mail.delivery_method(*smtp_settings)
res = mail.deliver!
log res.inspect
log "\n"
msg = if res.is_a?(Mail::Message)
"Message '#{mail.subject}' sent"
else
"Failed to deliver message '#{mail.subject}'!"
end
log msg
msg
end
|
276
277
278
279
280
281
282
283
284
285
|
# File 'lib/vmail/imap_client.rb', line 276
def (hash)
lines = []
hash.each_pair do |key, value|
if value.is_a?(Array)
value = value.join(", ")
end
lines << "#{key.gsub("_", '-')}: #{value}"
end
lines.join("\n")
end
|
313
314
315
316
317
318
319
320
321
322
|
# File 'lib/vmail/imap_client.rb', line 313
def format_sent_message(mail)
formatter = Vmail::MessageFormatter.new(mail)
message_text = <<-EOF
Sent Message #{self.format_parts_info(formatter.list_parts)}
#{(formatter.)}
#{formatter.plaintext_part}
EOF
end
|
#forward_template ⇒ Object
299
300
301
302
303
304
305
306
307
308
309
310
311
|
# File 'lib/vmail/imap_client.rb', line 299
def forward_template
original_body = current_message.plaintext.split(/\n-{20,}\n/, 2)[1]
formatter = Vmail::MessageFormatter.new(current_mail)
= formatter.
subject = ['subject']
if subject !~ /Fwd: /
subject = "Fwd: #{subject}"
end
new_message_template(subject, false) +
"\n---------- Forwarded message ----------\n" +
original_body + signature
end
|
#get_highest_message_id ⇒ Object
98
99
100
101
102
103
104
105
106
107
108
|
# File 'lib/vmail/imap_client.rb', line 98
def get_highest_message_id
res = @imap.fetch([1,"*"], ["ENVELOPE"])
if res
@num_messages = res[-1].seqno
log "Highest seqno: #@num_messages"
else
@num_messages = 1
log "NO HIGHEST ID: setting @num_messages to 1"
end
end
|
#get_mailbox_status ⇒ Object
111
112
113
114
115
|
# File 'lib/vmail/imap_client.rb', line 111
def get_mailbox_status
return
@status = @imap.status(@mailbox, ["MESSAGES", "RECENT", "UNSEEN"])
log "Mailbox status: #{@status.inspect}"
end
|
#handle_error(error) ⇒ Object
440
441
442
|
# File 'lib/vmail/imap_client.rb', line 440
def handle_error(error)
log error
end
|
#list_mailboxes ⇒ Object
138
139
140
141
142
143
144
145
146
147
148
|
# File 'lib/vmail/imap_client.rb', line 138
def list_mailboxes
log 'loading mailboxes...'
@mailboxes ||= (@imap.list("", "*") || []).
select {|struct| struct.attr.none? {|a| a == :Noselect} }.
map {|struct| struct.name}.uniq
@mailboxes.delete("INBOX")
@mailboxes.unshift("INBOX")
log "Loaded mailboxes: #{@mailboxes.inspect}"
@mailboxes = @mailboxes.map {|name| mailbox_aliases.invert[name] || name}
@mailboxes.join("\n")
end
|
#log(string) ⇒ Object
436
437
438
|
# File 'lib/vmail/imap_client.rb', line 436
def log(string)
@logger.debug string
end
|
#mailbox_aliases ⇒ Object
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
# File 'lib/vmail/imap_client.rb', line 151
def mailbox_aliases
return @mailbox_aliases if @mailbox_aliases
aliases = {"sent" => "Sent Mail",
"all" => "All Mail",
"starred" => "Starred",
"important" => "Important",
"drafts" => "Drafts",
"spam" => "Spam",
"trash" => "Trash"}
@mailbox_aliases = {}
aliases.each do |shortname, fullname|
[ "[Gmail]", "[Google Mail" ].each do |prefix|
if self.mailboxes.include?( "#{prefix}/#{fullname}" )
@mailbox_aliases[shortname] = "#{prefix}/#{fullname}"
end
end
end
log "Setting aliases to #{@mailbox_aliases.inspect}"
@mailbox_aliases
end
|
#mailboxes ⇒ Object
called internally, not by vim client
173
174
175
176
177
178
|
# File 'lib/vmail/imap_client.rb', line 173
def mailboxes
if @mailboxes.nil?
list_mailboxes
end
@mailboxes
end
|
#more_messages ⇒ Object
gets 100 messages prior to id
223
224
225
226
227
228
229
230
231
232
|
# File 'lib/vmail/imap_client.rb', line 223
def more_messages
log "Getting more_messages"
x = [(@start_index - @limit), 0].max
y = [@start_index - 1, 0].max
@start_index = x
fetch_ids = search_query? ? @ids[x..y] : (x..y).to_a
message_ids = fetch_and_cache_headers(fetch_ids)
res = message_ids
with_more_message_line(res)
end
|
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
|
# File 'lib/vmail/imap_client.rb', line 342
def new_mail_from_input(text)
require 'mail'
mail = Mail.new
, raw_body = *text.split(/\n\s*\n/, 2)
= {}
.split("\n").each do |line|
key, value = *line.split(/:\s*/, 2)
log [key, value].join(':')
if %w(from to cc bcc).include?(key)
value = quote_addresses(value)
end
[key] = value
end
log "Delivering message with headers: #{.to_yaml}"
mail.from = ['from'] || @username
mail.to = ['to'] mail.cc = ['cc'] mail.bcc = ['bcc'] mail.subject = ['subject']
mail.from ||= @username
if (attachments = raw_body.split(/\n\s*\n/, 2)[0]) =~ /^attach(ment|ments)*:/
files = YAML::load(attachments).values.flatten
log "Attach: #{files}"
files.each do |file|
if File.directory?(file)
Dir.glob("#{file}/*").each {|f| mail.add_file(f) if File.size?(f)}
else
mail.add_file(file) if File.size?(file)
end
end
mail.text_part do
body raw_body.split(/\n\s*\n/, 2)[1]
end
else
mail.text_part do
body raw_body
end
end
mail
end
|
#new_message_template(subject = nil, append_signature = true) ⇒ Object
267
268
269
270
271
272
273
274
|
# File 'lib/vmail/imap_client.rb', line 267
def new_message_template(subject = nil, append_signature = true)
= {'from' => "#{@name} <#{@username}>",
'to' => nil,
'subject' => subject,
'cc' => @always_cc
}
() + (append_signature ? ("\n\n" + signature) : "\n\n")
end
|
#open ⇒ Object
42
43
44
45
46
|
# File 'lib/vmail/imap_client.rb', line 42
def open
@imap = Net::IMAP.new(@imap_server, @imap_port, true, nil, false)
log @imap.login(@username, @password)
list_mailboxes end
|
#open_html_part ⇒ Object
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
|
# File 'lib/vmail/imap_client.rb', line 403
def open_html_part
log "Open_html_part"
log current_mail.parts.inspect
multipart = current_mail.parts.detect {|part| part.multipart?}
html_part = if multipart
multipart.parts.detect {|part| part.["Content-Type"].to_s =~ /text\/html/}
elsif ! current_mail.parts.empty?
current_mail.parts.detect {|part| part.["Content-Type"].to_s =~ /text\/html/}
else
current_mail.body
end
return if html_part.nil?
outfile = 'part.html'
File.open(outfile, 'w') {|f| f.puts(html_part.decoded)}
return outfile
end
|
#prime_connection ⇒ Object
124
125
126
127
128
129
130
131
132
133
134
135
136
|
# File 'lib/vmail/imap_client.rb', line 124
def prime_connection
return if @ids.nil? || @ids.empty?
reconnect_if_necessary(4) do
log "Priming connection"
res = @imap.fetch(@ids[-1], ["ENVELOPE"])
if res.nil?
log "Priming connection didn't work, connection seems broken, but still going ahead..."
end
end
end
|
#reconnect_if_necessary(timeout = 60, &block) ⇒ Object
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
|
# File 'lib/vmail/imap_client.rb', line 444
def reconnect_if_necessary(timeout = 60, &block)
Timeout::timeout(timeout) do
block.call
end
rescue IOError, Errno::EADDRNOTAVAIL, Errno::ECONNRESET, Timeout::Error
log "Error: #{$!}"
log "Attempting to reconnect"
close
log(revive_connection)
reconnect_if_necessary do
block.call
end
rescue
log "Error: #{$!}"
raise
end
|
#reload_mailbox ⇒ Object
85
86
87
88
|
# File 'lib/vmail/imap_client.rb', line 85
def reload_mailbox
return unless STDIN.tty?
select_mailbox(@mailbox, true)
end
|
#reply_template(replyall = false) ⇒ Object
287
288
289
290
291
292
|
# File 'lib/vmail/imap_client.rb', line 287
def reply_template(replyall=false)
log "Sending reply template"
= Vmail::ReplyTemplate.new(current_message.rfc822, @username, @name, replyall, @always_cc).
body = .delete(:body)
() + "\n\n\n" + body + signature
end
|
#revive_connection ⇒ Object
117
118
119
120
121
122
|
# File 'lib/vmail/imap_client.rb', line 117
def revive_connection
log "Reviving connection"
open
log "Reselecting mailbox #@mailbox"
@imap.select(@mailbox)
end
|
#save_attachments(dir) ⇒ Object
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
|
# File 'lib/vmail/imap_client.rb', line 386
def save_attachments(dir)
log "Save_attachments #{dir}"
if !current_mail
log "Missing a current message"
end
return unless dir && current_mail
attachments = current_mail.attachments
`mkdir -p #{dir}`
saved = attachments.map do |x|
path = File.join(dir, x.filename)
log "Saving #{path}"
File.open(path, 'wb') {|f| f.puts x.decoded}
path
end
"Saved:\n" + saved.map {|x| "- #{x}"}.join("\n")
end
|
#select_mailbox(mailbox, force = false) ⇒ Object
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
# File 'lib/vmail/imap_client.rb', line 65
def select_mailbox(mailbox, force=false)
if mailbox_aliases[mailbox]
mailbox = mailbox_aliases[mailbox]
end
log "Selecting mailbox #{mailbox.inspect}"
reconnect_if_necessary(15) do
log @imap.select(mailbox)
end
log "Done"
@mailbox = mailbox
@label = Label[name: @mailbox] || Label.create(name: @mailbox)
log "Getting mailbox status"
get_mailbox_status
log "Getting highest message id"
get_highest_message_id
return "OK"
end
|
#signature ⇒ Object
294
295
296
297
|
# File 'lib/vmail/imap_client.rb', line 294
def signature
return '' unless @signature
"\n\n#@signature"
end
|
#smtp_settings ⇒ Object
426
427
428
429
430
431
432
433
434
|
# File 'lib/vmail/imap_client.rb', line 426
def smtp_settings
[:smtp, {:address => "smtp.gmail.com",
:port => 587,
:domain => 'gmail.com',
:user_name => @username,
:password => @password,
:authentication => 'plain',
:enable_starttls_auto => true}]
end
|
#spawn_thread_if_tty(&block) ⇒ Object
234
235
236
237
238
239
240
241
242
|
# File 'lib/vmail/imap_client.rb', line 234
def spawn_thread_if_tty(&block)
if STDIN.tty?
Thread.new do
reconnect_if_necessary(10, &block)
end
else
block.call
end
end
|
#update ⇒ Object
TODO why not just reload the current page?
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
# File 'lib/vmail/imap_client.rb', line 187
def update
if search_query?
log "Update aborted because query is search query: #{@query.inspect}"
return ""
end
prime_connection
old_num_messages = @num_messages
reload_mailbox
update_query = @query.dup
update_query[0] = "#{old_num_messages}:#{@num_messages}"
ids = reconnect_if_necessary {
log "Search #update_query"
@imap.search(Vmail::Query.args2string(update_query))
}
log "- got seqnos: #{ids.inspect}"
log "- getting seqnos > #{self.max_seqno}"
new_ids = ids.select {|seqno| seqno > self.max_seqno}
@ids = @ids + new_ids
log "- update: new uids: #{new_ids.inspect}"
if !new_ids.empty?
self.max_seqno = new_ids[-1]
message_ids = fetch_and_cache_headers(new_ids)
res = (message_ids)
res
else
''
end
rescue
log $!
log $!.backtrace.join("\n")
end
|
#window_width=(width) ⇒ Object
421
422
423
424
|
# File 'lib/vmail/imap_client.rb', line 421
def window_width=(width)
@width = width.to_i
log "Setting window width to #{width}"
end
|
#with_open {|_self| ... } ⇒ Object
expects a block, closes on finish
49
50
51
52
53
54
|
# File 'lib/vmail/imap_client.rb', line 49
def with_open
@imap = Net::IMAP.new(@imap_server, @imap_port, true, nil, false)
log @imap.login(@username, @password)
yield self
close
end
|