Class: Vmail::ImapClient

Inherits:
Object
  • Object
show all
Defined in:
lib/vmail/imap_client.rb

Constant Summary collapse

DIVIDER_WIDTH = 
46
MailboxAliases = 
{ 'sent' => '[Gmail]/Sent Mail',
  'all' => '[Gmail]/All Mail',
  'starred' => '[Gmail]/Starred',
  'important' => '[Gmail]/Important',
  'drafts' => '[Gmail]/Drafts',
  'spam' => '[Gmail]/Spam',
  'trash' => '[Gmail]/Trash'
}
UNITS = 
[:b, :kb, :mb, :gb].freeze
FLAGMAP = 
{:Flagged => '*'}

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ ImapClient

Returns a new instance of ImapClient.



24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/vmail/imap_client.rb', line 24

def initialize(config)
  @username, @password = config['username'], config['password']
  @name = config['name']
  @signature = config['signature']
  @mailbox = nil
  @logger = Logger.new(config['logfile'] || STDERR)
  @logger.level = Logger::DEBUG
  @current_mail = nil
  @current_message_index = nil
  @imap_server = config['server'] || 'imap.gmail.com'
  @imap_port = config['port'] || 993
end

Class Method Details

.daemon(config) ⇒ Object 



731
732
733
734
735
736
737
 
# File 'lib/vmail/imap_client.rb', line 731

def self.daemon(config)
  $gmail = self.start(config)
  DRb.start_service(nil, $gmail)
  uri = DRb.uri
  puts "starting gmail service at #{uri}"
  uri
end

.start(config) ⇒ Object 



725
726
727
728
729
 
# File 'lib/vmail/imap_client.rb', line 725

def self.start(config)
  imap_client  = Vmail::ImapClient.new config
  imap_client.open
  imap_client
end

Instance Method Details

#add_more_message_line(res, start_id) ⇒ Object 



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/vmail/imap_client.rb', line 335

def add_more_message_line(res, start_id)
  log "add_more_message_line for start_id #{start_id}"
  if @all_search
    return res if start_id.nil?
    if start_id <= 1
      return res
    end
    remaining = start_id - 1
  else # filter search
    remaining = @ids.index(start_id) - 1
  end
  if remaining < 1
    log "none remaining"
    return res
  end
  log "remaining messages: #{remaining}"
  ">  Load #{[100, remaining].min} more messages. #{remaining} remaining.\n" + res
end

#append_to_file(file, index_range_as_string) ⇒ Object 



524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/vmail/imap_client.rb', line 524

def append_to_file(file, index_range_as_string)
  raise "expecting a range as string" unless index_range_as_string =~ /^\d+\.\.\d+$/ 
  index_range = eval(index_range_as_string)
  log "append to file range #{index_range.inspect} to file: #{file}"
  index_range.each do |idx|
    message = show_message(idx)
    File.open(file, 'a') {|f| f.puts(divider('=') + "\n" + message + "\n\n")}
    subject = (message[/^subject:(.*)/,1] || '').strip
    log "appended message '#{subject}'"
  end
  "printed #{index_range.to_a.size} message#{index_range.to_a.size == 1 ? '' : 's'} to #{file.strip}"
end

#clear_cached_message ⇒ Object 



69
70
71
72
73
 
# File 'lib/vmail/imap_client.rb', line 69

def clear_cached_message
  @current_mail = nil
  @current_message_index = nil
  @current_message = nil
end

#close ⇒ Object 



42
43
44
45
46
 
# File 'lib/vmail/imap_client.rb', line 42

def close
  log "closing connection"
  @imap.close rescue Net::IMAP::BadResponseError
  @imap.disconnect
end

#copy_to(id_set, mailbox) ⇒ Object 



500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/vmail/imap_client.rb', line 500

def copy_to(id_set, mailbox)
  if MailboxAliases[mailbox]
    mailbox = MailboxAliases[mailbox]
  end
  create_if_necessary mailbox
  uid_set = uids_from_index_range(id_set)
  log "copying #{uid_set.inspect} to #{mailbox}"
  Thread.new do 
    log @imap.uid_copy(uid_set, mailbox)
    log "copied uid_set #{uid_set.inspect} to #{mailbox}"
  end
end

#create_if_necessary(mailbox) ⇒ Object 



513
514
515
516
517
518
519
520
521
522
 
# File 'lib/vmail/imap_client.rb', line 513

def create_if_necessary(mailbox)
  current_mailboxes = mailboxes.map {|m| MailboxAliases[m] || m}
  if !current_mailboxes.include?(mailbox)
    log "current mailboxes: #{current_mailboxes.inspect}"
    log "creating mailbox #{mailbox}"
    log @imap.create(mailbox) 
    @mailboxes = nil # force reload ...
    list_mailboxes
  end
end

#deliver(text) ⇒ Object 



588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
 
# File 'lib/vmail/imap_client.rb', line 588

def deliver(text)
  # parse the text. The headers are yaml. The rest is text body.
  require 'net/smtp'
  prime_connection
  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

#divider(str) ⇒ Object 



584
585
586
 
# File 'lib/vmail/imap_client.rb', line 584

def divider(str)
  str * DIVIDER_WIDTH
end

#extract_row_data(fetch_data) ⇒ Object

TODO extract this to another class or module and write unit tests



176
177
178
179
180
181
182
183
184
185
186
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
221
222
223
224
225
226
227
228
 
# File 'lib/vmail/imap_client.rb', line 176

def extract_row_data(fetch_data)
  seqno = fetch_data.seqno
  uid = fetch_data.attr['UID']
  # log "fetched seqno #{seqno} uid #{uid}"
  envelope = fetch_data.attr["ENVELOPE"]
  size = fetch_data.attr["RFC822.SIZE"]
  flags = fetch_data.attr["FLAGS"]
  address_struct = if @mailbox == '[Gmail]/Sent Mail' 
                     structs = envelope.to || envelope.cc
                     structs.nil? ? nil : structs.first 
                   else
                     envelope.from.first
                   end
  address = if address_struct.nil?
              "unknown"
            elsif address_struct.name
              "#{Mail::Encodings.unquote_and_convert_to(address_struct.name, 'UTF-8')} <#{[address_struct.mailbox, address_struct.host].join('@')}>"
            else
              [Mail::Encodings.unquote_and_convert_to(address_struct.mailbox, 'UTF-8'), Mail::Encodings.unquote_and_convert_to(address_struct.host, 'UTF-8')].join('@') 
            end
  if @mailbox == '[Gmail]/Sent Mail' && envelope.to && envelope.cc
    total_recips = (envelope.to + envelope.cc).size
    address += " + #{total_recips - 1}"
  end
  date = begin 
           Time.parse(envelope.date).localtime
         rescue ArgumentError
           Time.now
         end

  date_formatted = if date.year != Time.now.year
                     date.strftime "%b %d %Y" rescue envelope.date.to_s 
                   else 
                     date.strftime "%b %d %I:%M%P" rescue envelope.date.to_s 
                   end
  subject = envelope.subject || ''
  subject = Mail::Encodings.unquote_and_convert_to(subject, 'UTF-8')
  flags = format_flags(flags)
  mid_width = @width - 38
  address_col_width = (mid_width * 0.3).ceil
  subject_col_width = (mid_width * 0.7).floor
  row_text = [ flags.col(2),
               (date_formatted || '').col(14),
               address.col(address_col_width),
               subject.col(subject_col_width), 
               number_to_human_size(size).rcol(6)
  ].join(' | ')
  {:uid => uid, :seqno => seqno, :row_text => row_text}
rescue 
  log "error extracting header for uid #{uid} seqno #{seqno}: #$!"
  row_text = "#{seqno.to_s} : error extracting this header"
  {:uid => uid, :seqno => seqno, :row_text => row_text}
end

#fetch_envelopes(id_set, are_uids = false, is_update = false) ⇒ Object

id_set may be a range, array, or string



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/vmail/imap_client.rb', line 128

def fetch_envelopes(id_set, are_uids=false, is_update=false)
  log "fetch_envelopes: #{id_set.inspect}"
  if id_set.is_a?(String)
    id_set = id_set.split(',')
  end
  if id_set.to_a.empty?
    log "empty set"
    return ""
  end
  results = reconnect_if_necessary do 
    if are_uids
      @imap.uid_fetch(id_set, ["FLAGS", "ENVELOPE", "RFC822.SIZE", "UID" ])
    else
      @imap.fetch(id_set, ["FLAGS", "ENVELOPE", "RFC822.SIZE", "UID" ])
    end
  end
  if results.nil?
    error = "expected fetch results but got nil"
    log(error) && raise(error)
  end
  log "extracting headers"
  new_message_rows = results.map {|x| extract_row_data(x) }
  if are_uids
    # replace old row_text values
    new_message_rows.each {|new_row_data|
      @message_list.
        select {|old_row_data| old_row_data[:uid] == new_row_data[:uid]}.
        each {|old_row_data| old_row_data[:row_text] = new_row_data[:row_text]}
    }
  else

    if is_update
      log "adding messages from update to end of list"
      @message_list = @message_list.concat new_message_rows
    else
      # this adds old messages to the top of the list
      # put new rows before the current ones
      log "adding more messages to head of list"
      @message_list = new_message_rows + @message_list
    end
  end
  log "returning #{new_message_rows.size} new rows" 
  return new_message_rows.
    map {|x| x[:row_text]}.
    join("\n")
end

#flag(index_range, action, flg) ⇒ Object

id_set is a string comming from the vim client action is -FLAGS or +FLAGS



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/vmail/imap_client.rb', line 397

def flag(index_range, action, flg)
  uid_set = uids_from_index_range(index_range)
  log "flag #{uid_set.inspect} #{flg} #{action}"
  if flg == 'Deleted'
    log "Deleting index_range: #{index_range.inspect}; uid_set: #{uid_set.inspect}"
    # for delete, do in a separate thread because deletions are slow
    Thread.new do 
      unless @mailbox == '[Gmail]/Trash'
        log "@imap.uid_copy #{uid_set.inspect} to trash"
        log @imap.uid_copy(uid_set, "[Gmail]/Trash")
      end
      log "@imap.uid_store #{uid_set.inspect} #{action} [#{flg.to_sym}]"
      log @imap.uid_store(uid_set, action, [flg.to_sym])
      remove_uid_set_from_cached_lists(uid_set)
      reload_mailbox
      clear_cached_message
    end
  elsif flg == '[Gmail]/Spam'
    log "Marking as spam index_range: #{index_range.inspect}; uid_set: #{uid_set.inspect}"
    Thread.new do 
      log "@imap.uid_copy #{uid_set.inspect} to spam"
      log @imap.uid_copy(uid_set, "[Gmail]/Spam")
      log "@imap.uid_store #{uid_set.inspect} #{action} [:Deleted]"
      log @imap.uid_store(uid_set, action, [:Deleted])
      remove_uid_set_from_cached_lists(uid_set)
      reload_mailbox
      clear_cached_message
    end
    "#{id} deleted"
  else
    log "Flagging index_range: #{index_range.inspect}; uid_set: #{uid_set.inspect}"
    Thread.new do
      log "@imap.uid_store #{uid_set.inspect} #{action} [#{flg.to_sym}]"
      log @imap.uid_store(uid_set, action, [flg.to_sym])
    end
  end
end

#format_flags(flags) ⇒ Object

flags is an array like [:Flagged, :Seen]



248
249
250
251
252
253
254
 
# File 'lib/vmail/imap_client.rb', line 248

def format_flags(flags)
  flags = flags.map {|flag| FLAGMAP[flag] || flag}
  if flags.delete(:Seen).nil?
    flags << '+' # unread
  end
  flags.join('')
end

#format_headers(hash) ⇒ Object 



546
547
548
549
550
551
552
553
554
555
 
# File 'lib/vmail/imap_client.rb', line 546

def format_headers(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

#format_parts_info(parts) ⇒ Object 



388
389
390
391
392
393
 
# File 'lib/vmail/imap_client.rb', line 388

def format_parts_info(parts)
  lines = parts.select {|part| part !~ %r{text/plain}}
  if lines.size > 0
    "\n#{lines.join("\n")}"
  end
end

#forward_template ⇒ Object 



571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/vmail/imap_client.rb', line 571

def forward_template
  original_body = @current_message.split(/\n-{20,}\n/, 2)[1]
  formatter = Vmail::MessageFormatter.new(@current_mail)
  headers = formatter.extract_headers
  subject = headers['subject']
  if subject !~ /Fwd: /
    subject = "Fwd: #{subject}"
  end
  new_message_template(subject) + 
    "\n---------- Forwarded message ----------\n" +
    original_body + signature
end

#get_highest_message_id ⇒ Object 



75
76
77
78
79
80
 
# File 'lib/vmail/imap_client.rb', line 75

def get_highest_message_id
  # get highest message ID
  res = @imap.fetch([1,"*"], ["ENVELOPE"])
  @num_messages = res[-1].seqno
  log "HIGHEST ID: #@num_messages"
end

#get_mailbox_status ⇒ Object 



82
83
84
85
 
# File 'lib/vmail/imap_client.rb', line 82

def get_mailbox_status
  @status = @imap.status(@mailbox,  ["MESSAGES", "RECENT", "UNSEEN"])
  log "mailbox status: #{@status.inspect}"
end

#handle_error(error) ⇒ Object 



701
702
703
 
# File 'lib/vmail/imap_client.rb', line 701

def handle_error(error)
  log error
end

#list_mailboxes ⇒ Object 



109
110
111
112
113
114
115
116
117
 
# File 'lib/vmail/imap_client.rb', line 109

def list_mailboxes
  @mailboxes ||= (@imap.list("[Gmail]/", "%") + @imap.list("", "%")).
    select {|struct| struct.attr.none? {|a| a == :Noselect} }.
    map {|struct| struct.name}.
    map {|name| MailboxAliases.invert[name] || name}
  @mailboxes.delete("INBOX")
  @mailboxes.unshift("INBOX")
  @mailboxes.join("\n")
end

#log(string) ⇒ Object 



697
698
699
 
# File 'lib/vmail/imap_client.rb', line 697

def log(string)
  @logger.debug string
end

#mailboxes ⇒ Object

called internally, not by vim client



120
121
122
123
124
125
 
# File 'lib/vmail/imap_client.rb', line 120

def mailboxes
  if @mailboxes.nil?
    list_mailboxes
  end
  @mailboxes
end

#more_messages(limit = 100) ⇒ Object

gets 100 messages prior to id



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/vmail/imap_client.rb', line 315

def more_messages(limit=100)
  message_id = @message_list[0][:seqno]
  log "more_messages: message_id #{message_id}"
  message_id = message_id.to_i
  if @all_search 
    x = [(message_id - limit), 0].max
    y = [message_id - 1, 0].max
    res = fetch_envelopes((x..y))
    add_more_message_line(res, x)
  else
    # filter search query
    log "@start_index #@start_index"
    x = [(@start_index - limit), 0].max
    y = [@start_index - 1, 0].max
    @start_index = x
    res = fetch_envelopes(@ids[x..y]) 
    add_more_message_line(res, @ids[x])
  end
end

#move_to(id_set, mailbox) ⇒ Object 



478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/vmail/imap_client.rb', line 478

def move_to(id_set, mailbox)
  log "move #{id_set.inspect} to #{mailbox}"
  if mailbox == 'all'
    log "archiving messages"
  end
  if MailboxAliases[mailbox]
    mailbox = MailboxAliases[mailbox]
  end
  create_if_necessary mailbox
  log "getting uids form index range #{id_set}"
  uid_set = uids_from_index_range(id_set)
  log "moving uid_set: #{uid_set.inspect} to #{mailbox}"
  Thread.new do 
    log @imap.uid_copy(uid_set, mailbox)
    log @imap.uid_store(uid_set, '+FLAGS', [:Deleted])
    remove_uid_set_from_cached_lists(uid_set)
    reload_mailbox
    clear_cached_message
    log "moved uid_set #{uid_set.inspect} to #{mailbox}"
  end
end

#new_mail_from_input(text) ⇒ Object 



606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/vmail/imap_client.rb', line 606

def new_mail_from_input(text)
  require 'mail'
  mail = Mail.new
  raw_headers, raw_body = *text.split(/\n\s*\n/, 2)
  headers = {}
  raw_headers.split("\n").each do |line|
    key, value = *line.split(/:\s*/, 2)
    headers[key] = value
  end
  log "delivering message with headers: #{headers.to_yaml}"
  mail.from = headers['from'] || @username
  mail.to = headers['to'] #.split(/,\s+/)
  mail.cc = headers['cc'] #&& headers['cc'].split(/,\s+/)
  mail.bcc = headers['bcc'] #&& headers['cc'].split(/,\s+/)
  mail.subject = headers['subject']
  mail.from ||= @username
  # attachments are added as a snippet of YAML after a blank line
  # after the headers, and followed by a blank line
  if (attachments = raw_body.split(/\n\s*\n/, 2)[0]) =~ /^attach(ment|ments)*:/
    # TODO
    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) ⇒ Object 



538
539
540
541
542
543
544
 
# File 'lib/vmail/imap_client.rb', line 538

def new_message_template(subject = nil)
  headers = {'from' => "#{@name} <#{@username}>",
    'to' => nil,
    'subject' => subject
  }
  format_headers(headers) + "\n\n" + signature
end

#number_to_human_size(number) ⇒ Object

borrowed from ActionView/Helpers



233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/vmail/imap_client.rb', line 233

def number_to_human_size(number)
  if number.to_i < 1024
    "#{number} b"
  else
    max_exp = UNITS.size - 1
    exponent = (Math.log(number) / Math.log(1024)).to_i # Convert to base 1024
    exponent = max_exp if exponent > max_exp # we need this to avoid overflow for the highest unit
    number  /= 1024 ** exponent
    unit = UNITS[exponent]
    "#{number}#{unit}"
  end
end

#open ⇒ Object 



37
38
39
40
 
# File 'lib/vmail/imap_client.rb', line 37

def open
  @imap = Net::IMAP.new(@imap_server, @imap_port, true, nil, false)
  @imap.(@username, @password)
end

#open_html_part ⇒ Object 



664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
 
# File 'lib/vmail/imap_client.rb', line 664

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.header["Content-Type"].to_s =~ /text\/html/}
              elsif ! @current_mail.parts.empty?
                @current_mail.parts.detect {|part| part.header["Content-Type"].to_s =~ /text\/html/}
              else
                @current_mail.body
              end
  return if html_part.nil?
  outfile = 'vmail-htmlpart.html'
  File.open(outfile, 'w') {|f| f.puts(html_part.decoded)}
  # client should handle opening the html file
  return outfile
end

#prime_connection ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/vmail/imap_client.rb', line 94

def prime_connection
  return if @ids.nil? || @ids.empty?
  reconnect_if_necessary(4) do 
    # this is just to prime the IMAP connection
    # It's necessary for some reason before update and deliver. 
    log "priming connection for delivering"
    
    res = @imap.fetch(@ids[-1], ["ENVELOPE"])
    if res.nil?
      # just go ahead, just log
      log "priming connection didn't work, connection seems broken, but still going ahead..."
    end
  end 
end

#reconnect_if_necessary(timeout = 60, &block) ⇒ Object 



705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
 
# File 'lib/vmail/imap_client.rb', line 705

def reconnect_if_necessary(timeout = 60, &block)
  # if this times out, we know the connection is stale while the user is
  # trying to update
  Timeout::timeout(timeout) do
    block.call
  end
rescue IOError, Errno::EADDRNOTAVAIL, Timeout::Error
  log "error: #{$!}"
  log "attempting to reconnect"
  close
  log(revive_connection)
  # hope this isn't an endless loop
  reconnect_if_necessary do 
    block.call
  end
rescue
  log "error: #{$!}"
  raise
end

#reload_mailbox ⇒ Object 



65
66
67
 
# File 'lib/vmail/imap_client.rb', line 65

def reload_mailbox
  select_mailbox(@mailbox, true)
end

#remove_uid_set_from_cached_lists(uid_set) ⇒ Object 



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/vmail/imap_client.rb', line 444

def remove_uid_set_from_cached_lists(uid_set)
  # delete from cached @ids and @message_list
  seqnos_to_delete = []
  uid_set.each {|uid| 
    row = @message_list.detect {|row| row[:uid] == uid}
    seqno = row[:seqno]
    log "deleting seqno #{seqno} from @ids"
    @ids.delete seqno
    seqnos_to_delete << seqno
  }
  log "seqnos_to_delete: #{seqnos_to_delete.inspect}"
  seqnos_to_delete.reverse.each do |seqno|
    startsize = @message_list.size 
    log "deleting row with seqno #{seqno}"
    @message_list = @message_list.delete_if {|x| x[:seqno] == seqno}
    endsize = @message_list.size
    log "deleted #{startsize - endsize} rows"
  end
  # now we need to decrement all the higher sequence numbers!
  basenum = seqnos_to_delete.min  # this is the lowested seqno deleted
  diff = seqnos_to_delete.size # substract this from all seqnos >= basenum
  changes = []
  @message_list.each do |row|
    if row[:seqno] >= basenum
      changes << "#{row[:seqno]}->#{row[:seqno] - diff}"
      row[:seqno] -= diff
    end
  end
  log "seqno decremented: #{changes.join(";")}"
rescue
  log "error removing uid set from cached lists"
  log $!
end

#reply_template(replyall = false) ⇒ Object 



557
558
559
560
561
562
563
 
# File 'lib/vmail/imap_client.rb', line 557

def reply_template(replyall=false)
  log "sending reply template"
  # user reply_template class
  reply_headers = Vmail::ReplyTemplate.new(@current_mail, @username, @name, replyall).reply_headers
  body = reply_headers.delete(:body)
  format_headers(reply_headers) + "\n\n\n" + body + signature
end

#revive_connection ⇒ Object 



87
88
89
90
91
92
 
# File 'lib/vmail/imap_client.rb', line 87

def revive_connection
  log "reviving connection"
  open
  log "reselecting mailbox #@mailbox"
  @imap.select(@mailbox)
end

#save_attachments(dir) ⇒ Object 



647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
 
# File 'lib/vmail/imap_client.rb', line 647

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

#search(limit, *query) ⇒ Object 



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/vmail/imap_client.rb', line 256

def search(limit, *query)
  limit = limit.to_i
  limit = 100 if limit.to_s !~ /^\d+$/
  query = ['ALL'] if query.empty?
  if query.size == 1 && query[0].downcase == 'all'
    # form a sequence range
    query.unshift [[@num_messages - limit.to_i + 1 , 1].max, @num_messages].join(':')
    @all_search = true
  else
    # this is a special query search
    # set the target range to the whole set
    query.unshift "1:#@num_messages"
    @all_search = false
  end
  log "@all_search #{@all_search}"
  @query = query
  log "search query: #{@query.inspect}"
  @ids = reconnect_if_necessary do
    @imap.search(@query.join(' '))
  end
  # save ids in @ids, because filtered search relies on it
  fetch_ids = if @all_search
                @ids
              else #filtered search
                @start_index = [@ids.length - limit, 0].max
                @ids[@start_index..-1]
              end
  log "search query got #{@ids.size} results" 
  @message_list = [] # this will hold all the data extracted from these message envelopes
  clear_cached_message
  res = fetch_envelopes(fetch_ids)
  add_more_message_line(res, fetch_ids[0])
end

#select_mailbox(mailbox, force = false) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/vmail/imap_client.rb', line 48

def select_mailbox(mailbox, force=false)
  if MailboxAliases[mailbox]
    mailbox = MailboxAliases[mailbox]
  end
  if mailbox == @mailbox && !force
    return
  end
  log "selecting mailbox #{mailbox.inspect}"
  reconnect_if_necessary do 
    log @imap.select(mailbox)
  end
  @mailbox = mailbox
  get_mailbox_status
  get_highest_message_id
  return "OK"
end

#show_message(index, raw = false) ⇒ Object 



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
385
386
 
# File 'lib/vmail/imap_client.rb', line 354

def show_message(index, raw=false)
  log "showing message at #{index}" 
  return @current_mail.to_s if raw 
  index = index.to_i
  if index == @current_message_index 
    return @current_message 
  end
  envelope_data = @message_list[index]
  seqno = envelope_data[:seqno]
  uid = envelope_data[:uid] 
  log "showing message seqno: #{seqno} uid #{uid}"
  fetch_data = reconnect_if_necessary do 
    @imap.uid_fetch(uid, ["FLAGS", "RFC822", "RFC822.SIZE"])[0]
  end
  res = fetch_data.attr["RFC822"]
  mail = Mail.new(res) 
  @current_message_index = index
  @current_mail = mail # used later to show raw message or extract attachments if any
  log "saving current mail with parts: #{@current_mail.parts.inspect}"
  formatter = Vmail::MessageFormatter.new(mail)
  out = formatter.process_body 
  size = fetch_data.attr["RFC822.SIZE"]
  @current_message = <<-EOF
#{@mailbox} seqno:#{envelope_data[:seqno]} uid:#{uid} #{number_to_human_size size} #{format_parts_info(formatter.list_parts)}
#{divider '-'}
#{format_headers(formatter.extract_headers)}

#{out}
EOF
rescue
  log "parsing error"
  "Error encountered parsing this message:\n#{$!}"
end

#signature ⇒ Object 



566
567
568
569
 
# File 'lib/vmail/imap_client.rb', line 566

def signature
  return '' unless @signature
  "\n\n#@signature"
end

#smtp_settings ⇒ Object 



687
688
689
690
691
692
693
694
695
 
# File 'lib/vmail/imap_client.rb', line 687

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

#uids_from_index_range(index_range_as_string) ⇒ Object 



435
436
437
438
439
440
441
442
 
# File 'lib/vmail/imap_client.rb', line 435

def uids_from_index_range(index_range_as_string)
  raise "expecting String" unless index_range_as_string.is_a?(String)
  raise "expecting a range as string" unless index_range_as_string =~ /^\d+\.\.\d+$/ 
  log "converting index_range #{index_range_as_string} to uids"
  uids = @message_list[eval(index_range_as_string)].map {|row| row[:uid]}
  log "converted index_range #{index_range_as_string} to uids #{uids.inspect}"
  uids
end

#update ⇒ Object 



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/vmail/imap_client.rb', line 290

def update
  prime_connection
  old_num_messages = @num_messages
  # we need to re-select the mailbox to get the new highest id
  reload_mailbox
  update_query = @query
  # set a new range filter
  update_query[0] = "#{old_num_messages}:#{@num_messages}"
  ids = reconnect_if_necessary { 
    log "search #update_query"
    @imap.search(update_query.join(' ')) 
  }
  # TODO change this. will throw error now
  max_seqno = @message_list[-1][:seqno]
  log "lookind for seqnos > #{max_seqno}"
  new_ids = ids.select {|seqno| seqno > max_seqno}
  @ids = @ids + new_ids
  log "update: new uids: #{new_ids.inspect}"
  if !new_ids.empty?
    res = fetch_envelopes(new_ids, false, true)
    res
  end
end

#window_width=(width) ⇒ Object 



682
683
684
685
 
# File 'lib/vmail/imap_client.rb', line 682

def window_width=(width)
  log "setting window width to #{width}"
  @width = width.to_i
end