vmail 0.4.4 → 0.4.5

data/README.markdown

@@ -63,8 +63,6 @@ You can omit the password key-value pair if you'd rather not have the password
 saved in the file. In that case, you'll prompted for the password each time you
 start vmail.
 
-
-
 ## Contacts autocompletion
 
 vmail uses Vim autocompletion to help you auto-complete email addresses.
@@ -400,22 +398,6 @@ vmail gem is downloaded from).
 [github]:https://github.com/danchoi/vmail
 [rubygems]:https://rubygems.org/gems/vmail
 
-## Additional configuration options
-
-The default IMAP server vmail uses is 'imap.gmail.com` and the default port is
-`993`. If you want to change these values, e.g, because you are behind a
-firewall which blocks IMAP, you can change these values by specifying new ones
-in your .vmailrc, like so:
-
-    server: localhost
-    port: 2999
-
-Then you can create an SSH tunnel, e.g.
-
-    ssh -f user@example.com -L 2999:imap.gmail.com:993 -N
-
-(Thanks to Dave Bolton for this patch.)
-
 ## Bug reports, feature requests
 
 Please file bug reports and feature requests in the [vmail github issue tracker][tracker].

data/Rakefile

@@ -12,11 +12,6 @@ task :web do
   end
 end
 
-desc "git push and rake release bumped version"
-task :bumped do
-  puts `git commit -a -m'bump' && git push && rake release`
-end
-
 desc "Run tests"
 task :test do 
   $:.unshift File.expand_path("test")

data/lib/vmail.vim

@@ -453,7 +453,6 @@ function! s:select_mailbox()
     return
   endif
   let s:mailbox = mailbox
-  let s:query = "100 all"
   let command = s:select_mailbox_command . shellescape(s:mailbox)
   call system(command)
   redraw
@@ -691,9 +690,9 @@ func! s:message_window_mappings()
   nnoremap <silent> <buffer> q :close<cr>
 
   nnoremap <silent> <buffer> <leader>#  :close<cr>:call <SID>focus_list_window()<cr>:call <SID>delete_messages("Deleted")<cr>
+  nmap <silent> <buffer> <leader>d  <leader>#
   nnoremap <silent> <buffer> <leader>*  :call <SID>focus_list_window()<cr>:call <SID>toggle_star()<cr>
-  noremap <silent> <buffer> <leader>! :call <SID>focus_list_window()<cr>:call <SID>delete_messages("[Gmail]/Spam")<CR>
-  noremap <silent> <buffer> <leader>e :call <SID>focus_list_window()<cr>:call <SID>archive_messages()<CR>
+  nmap <silent> <buffer> s  <leader>*
 
   nnoremap <silent> <buffer> <Leader>b :call <SID>focus_list_window()<cr>call <SID>move_to_mailbox(0)<CR>
   nnoremap <silent> <buffer> <Leader>B :call <SID>focus_list_window()<cr>call <SID>move_to_mailbox(1)<CR>

data/lib/vmail/imap_client.rb

@@ -27,13 +27,11 @@ module Vmail
       @logger = Logger.new(config['logfile'] || STDERR)
       @logger.level = Logger::DEBUG
       @current_mail = nil
-      @current_id = nil
-      @imap_server = config['server'] || 'imap.gmail.com'
-      @imap_port = config['port'] || 993
+      @current_uid = nil
     end
 
     def open
-      @imap = Net::IMAP.new(@imap_server, @imap_port, true, nil, false)
+      @imap = Net::IMAP.new('imap.gmail.com', 993, true, nil, false)
       @imap.login(@username, @password)
     end
 
@@ -43,11 +41,11 @@ module Vmail
       @imap.disconnect
     end
 
-    def select_mailbox(mailbox, force=false)
+    def select_mailbox(mailbox)
       if MailboxAliases[mailbox]
         mailbox = MailboxAliases[mailbox]
       end
-      if mailbox == @mailbox && !force
+      if mailbox == @mailbox 
         return
       end
       log "selecting mailbox #{mailbox.inspect}"
@@ -55,23 +53,11 @@ module Vmail
         log @imap.select(mailbox)
       end
       @mailbox = mailbox
-      get_mailbox_status
-      get_highest_message_id
+      @all_uids = []
+      @bad_uids = []
       return "OK"
     end
 
-    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
-
-    def get_mailbox_status
-      @status = @imap.status(@mailbox,  ["MESSAGES", "RECENT", "UNSEEN"])
-      log "mailbox status: #{@status.inspect}"
-    end
-
     def revive_connection
       log "reviving connection"
       open
@@ -79,18 +65,6 @@ module Vmail
       @imap.select(@mailbox)
     end
 
-    def prime_connection
-      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?
-          raise IOError, "IMAP connection seems broken"
-        end
-      end 
-    end
-
     def list_mailboxes
       @mailboxes ||= (@imap.list("[Gmail]/", "%") + @imap.list("", "%")).
         select {|struct| struct.attr.none? {|a| a == :Noselect} }.
@@ -109,19 +83,20 @@ module Vmail
       @mailboxes
     end
 
-    # id_set may be a range, array, or string
-    def fetch_envelopes(id_set)
-      log "fetch_envelopes: #{id_set.inspect}"
-      if id_set.is_a?(String)
-        id_set = id_set.split(',')
+    def fetch_headers(uid_set)
+      if uid_set.is_a?(String)
+        uid_set = uid_set.split(",").map(&:to_i)
+      elsif uid_set.is_a?(Integer)
+        uid_set = [uid_set]
       end
-      max_id = id_set.to_a[-1]
-      if id_set.to_a.empty?
+      max_uid = uid_set.max
+      log "fetch headers for #{uid_set.inspect}"
+      if uid_set.empty?
         log "empty set"
         return ""
       end
       results = reconnect_if_necessary do 
-        @imap.fetch(id_set, ["FLAGS", "ENVELOPE", "RFC822.SIZE" ])
+        @imap.uid_fetch(uid_set, ["FLAGS", "ENVELOPE", "RFC822.SIZE" ])
       end
       log "extracting headers"
       lines = results.
@@ -132,13 +107,13 @@ module Vmail
             Time.now
           end
         }.
-        map {|x| format_list_row(x, max_id)}
+        map {|x| format_header(x, max_uid)}
       log "returning result" 
       return lines.join("\n")
     end
 
-    def format_list_row(fetch_data, max_id=nil)
-      id = fetch_data.seqno
+    def format_header(fetch_data, max_uid=nil)
+      uid = fetch_data.attr["UID"]
       envelope = fetch_data.attr["ENVELOPE"]
       size = fetch_data.attr["RFC822.SIZE"]
       flags = fetch_data.attr["FLAGS"]
@@ -173,18 +148,18 @@ module Vmail
       subject = envelope.subject || ''
       subject = Mail::Encodings.unquote_and_convert_to(subject, 'UTF-8')
       flags = format_flags(flags)
-      first_col_width = max_id.to_s.length 
+      first_col_width = max_uid.to_s.length 
       mid_width = @width - (first_col_width + 33)
       address_col_width = (mid_width * 0.3).ceil
       subject_col_width = (mid_width * 0.7).floor
-      [id.to_s.col(first_col_width), 
+      [uid.to_s.col(first_col_width), 
         (date_formatted || '').col(14),
         address.col(address_col_width),
         subject.col(subject_col_width),
         number_to_human_size(size).rcol(6),
         flags.rcol(7)].join(' ')
     rescue 
-      "#{id.to_s} : error extracting this header"
+      "#{uid.to_s} : error extracting this header"
     end
 
     UNITS = [:b, :kb, :mb, :gb].freeze
@@ -214,119 +189,83 @@ module Vmail
     end
 
     def search(limit, *query)
-      limit = limit.to_i
-      limit = 100 if limit.to_s !~ /^\d+$/
+      log "uid_search limit: #{limit} query: #{@query.inspect}"
+      limit = 25 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" 
-      res = fetch_envelopes(fetch_ids)
-      add_more_message_line(res, fetch_ids[0])
+      @query = query.join(' ')
+      log "uid_search #@query #{limit}"
+      @all_uids = reconnect_if_necessary do
+        @imap.uid_search(@query)
+      end
+      uids = @all_uids[-([limit.to_i, @all_uids.size].min)..-1] || []
+      res = fetch_headers(uids)
+      add_more_message_line(res, uids)
     end
 
     def update
-      prime_connection
-      old_num_messages = @num_messages
-      # we need to re-select the mailbox to get the new highest id
-      select_mailbox(@mailbox, true)
-      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(' ')) 
+      reconnect_if_necessary(4) do 
+        # this is just to prime the IMAP connection
+        # It's necessary for some reason.
+        log "priming connection for update"
+        res = @imap.uid_fetch(@all_uids[-1], ["ENVELOPE"])
+        if res.nil?
+          raise IOError, "IMAP connection seems broken"
+        end
+      end
+      uids = reconnect_if_necessary { 
+        log "uid_search #@query"
+        @imap.uid_search(@query) 
       }
-      # TODO change this. will throw error now
-      new_ids = ids.select {|x| x > @ids.max}
-      @ids = @ids + new_ids
-      log "UPDATE: NEW UIDS: #{new_ids.inspect}"
-      if !new_ids.empty?
-        res = fetch_envelopes(new_ids)
+      new_uids = uids - @all_uids
+      log "UPDATE: NEW UIDS: #{new_uids.inspect}"
+      if !new_uids.empty?
+        res = fetch_headers(new_uids)
+        @all_uids = uids
         res
       end
     end
 
-    # gets 100 messages prior to id
-    def more_messages(message_id, limit=100)
-      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
-
-    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
+    # gets 100 messages prior to uid
+    def more_messages(uid, limit=100)
+      uid = uid.to_i
+      x = [(@all_uids.index(uid) - limit), 0].max
+      y = [@all_uids.index(uid) - 1, 0].max
+      uids = @all_uids[x..y]
+      res = fetch_headers(uids)
+      add_more_message_line(res, uids)
+    end
+
+    def add_more_message_line(res, uids)
+      return res if uids.empty?
+      start_index = @all_uids.index(uids[0])
+      if start_index > 0
+        remaining = start_index 
+        res = "> Load #{[100, remaining].min} more messages. #{remaining} remaining.\n" + res
       end
-      log "remaining messages: #{remaining}"
-      "> Load #{[100, remaining].min} more messages. #{remaining} remaining.\n" + res
+      res 
     end
 
-    def show_message(id, raw=false, forwarded=false)
-      id = id.to_i
+    def show_message(uid, raw=false, forwarded=false)
+      uid = uid.to_i
       if forwarded
         return @current_message.split(/\n-{20,}\n/, 2)[1]
       end
       return @current_mail.to_s if raw 
-      return @current_message if id == @current_id 
-      log "fetching #{id.inspect}" 
+      return @current_message if uid == @current_uid 
+      log "fetching #{uid.inspect}" 
       fetch_data = reconnect_if_necessary do 
-        @imap.fetch(id, ["FLAGS", "RFC822", "RFC822.SIZE"])[0]
+        @imap.uid_fetch(uid, ["FLAGS", "RFC822", "RFC822.SIZE"])[0]
       end
       res = fetch_data.attr["RFC822"]
       mail = Mail.new(res) 
-      @current_id = id
+      @current_uid = uid
       @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} #{id} #{number_to_human_size size} #{format_parts_info(formatter.list_parts)}
+#{@mailbox} #{uid} #{number_to_human_size size} #{format_parts_info(formatter.list_parts)}
 ---------------------------------------
 #{format_headers(formatter.extract_headers)}
 
@@ -344,36 +283,36 @@ EOF
       end
     end
 
-    # id_set is a string comming from the vim client
+    # uid_set is a string comming from the vim client
     # action is -FLAGS or +FLAGS
-    def flag(id_set, action, flg)
-      if id_set.is_a?(String)
-        id_set = id_set.split(",").map(&:to_i)
+    def flag(uid_set, action, flg)
+      if uid_set.is_a?(String)
+        uid_set = uid_set.split(",").map(&:to_i)
       end
       # #<struct Net::IMAP::FetchData seqno=17423, attr={"FLAGS"=>[:Seen, "Flagged"], "UID"=>83113}>
-      log "flag #{id_set} #{flg} #{action}"
+      log "flag #{uid_set} #{flg} #{action}"
       if flg == 'Deleted'
         # for delete, do in a separate thread because deletions are slow
         Thread.new do 
           unless @mailbox == '[Gmail]/Trash'
-            @imap.copy(id_set, "[Gmail]/Trash")
+            @imap.uid_copy(uid_set, "[Gmail]/Trash")
           end
-          res = @imap.store(id_set, action, [flg.to_sym])
+          res = @imap.uid_store(uid_set, action, [flg.to_sym])
         end
-        id_set.each { |id| @all_ids.delete(id) }
+        uid_set.each { |uid| @all_uids.delete(uid) }
       elsif flg == '[Gmail]/Spam'
-        @imap.copy(id_set, "[Gmail]/Spam")
-        res = @imap.store(id_set, action, [:Deleted])
-        "#{id} deleted"
+        @imap.uid_copy(uid_set, "[Gmail]/Spam")
+        res = @imap.uid_store(uid_set, action, [:Deleted])
+        "#{uid} deleted"
       else
         log "Flagging"
-        res = @imap.store(id_set, action, [flg.to_sym])
+        res = @imap.uid_store(uid_set, action, [flg.to_sym])
         # log res.inspect
-        fetch_envelopes(id_set)
+        fetch_headers(uid_set)
       end
     end
 
-    def move_to(id_set, mailbox)
+    def move_to(uid_set, mailbox)
       if mailbox == 'all'
         log "archiving messages"
       end
@@ -381,24 +320,24 @@ EOF
         mailbox = MailboxAliases[mailbox]
       end
       create_if_necessary mailbox
-      if id_set.is_a?(String)
-        id_set = id_set.split(",").map(&:to_i)
+      if uid_set.is_a?(String)
+        uid_set = uid_set.split(",").map(&:to_i)
       end
-      log "move_to #{id_set.inspect} #{mailbox}"
-      log @imap.copy(id_set, mailbox)
-      log @imap.store(id_set, '+FLAGS', [:Deleted])
+      log "move_to #{uid_set.inspect} #{mailbox}"
+      log @imap.uid_copy(uid_set, mailbox)
+      log @imap.uid_store(uid_set, '+FLAGS', [:Deleted])
     end
 
-    def copy_to(id_set, mailbox)
+    def copy_to(uid_set, mailbox)
       if MailboxAliases[mailbox]
         mailbox = MailboxAliases[mailbox]
       end
       create_if_necessary mailbox
-      log "copy #{id_set.inspect} #{mailbox}"
-      if id_set.is_a?(String)
-        id_set = id_set.split(",").map(&:to_i)
+      log "copy #{uid_set.inspect} #{mailbox}"
+      if uid_set.is_a?(String)
+        uid_set = uid_set.split(",").map(&:to_i)
       end
-      log @imap.copy(id_set, mailbox)
+      log @imap.uid_copy(uid_set, mailbox)
     end
 
     def create_if_necessary(mailbox)
@@ -411,18 +350,18 @@ EOF
       end
     end
 
-    def append_to_file(file, id_set)
-      if id_set.is_a?(String)
-        id_set = id_set.split(",").map(&:to_i)
+    def append_to_file(file, uid_set)
+      if uid_set.is_a?(String)
+        uid_set = uid_set.split(",").map(&:to_i)
       end
       log "append messages to file: #{file}"
-      id_set.each do |id|
-        message = show_message(id)
+      uid_set.each do |uid|
+        message = show_message(uid)
         divider = "#{'=' * 39}\n"
         File.open(file, 'a') {|f| f.puts(divider + message + "\n\n")}
-        log "appended id #{id}"
+        log "appended uid #{uid}"
       end
-      "printed #{id_set.size} message#{id_set.size == 1 ? '' : 's'} to #{file.strip}"
+      "printed #{uid_set.size} message#{uid_set.size == 1 ? '' : 's'} to #{file.strip}"
     end
 
 
@@ -445,9 +384,9 @@ EOF
       lines.join("\n")
     end
 
-    def reply_template(id, replyall=false)
-      log "sending reply template for #{id}"
-      fetch_data = @imap.fetch(id.to_i, ["FLAGS", "ENVELOPE", "RFC822"])[0]
+    def reply_template(uid, replyall=false)
+      log "sending reply template for #{uid}"
+      fetch_data = @imap.uid_fetch(uid.to_i, ["FLAGS", "ENVELOPE", "RFC822"])[0]
       envelope = fetch_data.attr['ENVELOPE']
       recipient = [envelope.reply_to, envelope.from].flatten.map {|x| address_to_string(x)}[0]
       cc = [envelope.to, envelope.cc]
@@ -478,8 +417,8 @@ EOF
       "\n\n#@signature"
     end
 
-    def forward_template(id)
-      original_body = show_message(id, false, true)
+    def forward_template(uid)
+      original_body = show_message(uid, false, true)
       new_message_template + 
         "\n---------- Forwarded message ----------\n" +
         original_body + signature
@@ -488,7 +427,15 @@ EOF
     def deliver(text)
       # parse the text. The headers are yaml. The rest is text body.
       require 'net/smtp'
-      prime_connection
+      reconnect_if_necessary(4) do 
+        # this is just to prime the IMAP connection
+        # It's necessary for some reason.
+        log "priming connection for delivering"
+        res = @imap.uid_fetch(@all_uids[-1], ["ENVELOPE"])
+        if res.nil?
+          raise IOError, "IMAP connection seems broken"
+        end
+      end 
       mail = new_mail_from_input(text)
       mail.delivery_method(*smtp_settings)
       log mail.deliver!
@@ -571,8 +518,8 @@ EOF
       "saved:\n" + saved.map {|x| "- #{x}"}.join("\n")
     end
 
-    def open_html_part(id)
-      log "open_html_part #{id}"
+    def open_html_part(uid)
+      log "open_html_part #{uid}"
       log @current_mail.parts.inspect
       multipart = @current_mail.parts.detect {|part| part.multipart?}
       html_part = if multipart 
@@ -624,9 +571,6 @@ EOF
       log(revive_connection)
       # try just once
       block.call
-    rescue
-      log "error: #{$!}"
-      raise
     end
 
     def self.start(config)

data/lib/vmail/version.rb

@@ -1,3 +1,3 @@
 module Vmail
-  VERSION = "0.4.4"
+  VERSION = "0.4.5"
 end

data/website/vmail-template.html

@@ -23,6 +23,10 @@
         
           <div class="sidebar">
 
+            <h4>share this</h4>
+
+<span class="st_twitter_large" displayText="Tweet"></span><span class="st_facebook_large" displayText="Facebook"></span><span class="st_ybuzz_large" displayText="Yahoo! Buzz"></span><span class="st_gbuzz_large" displayText="Google Buzz"></span><span class="st_email_large" displayText="Email"></span><span class="st_sharethis_large" displayText="ShareThis"></span>
+
             <h4>links</h4>
             <ul>
               <li><a href="https://github.com/danchoi/vmail">github repo</a></li>
@@ -30,10 +34,6 @@
               <li><a href="https://github.com/danchoi/vmail/issues">issue tracker</a></li>
               <li><a href="http://www.google.com/search?sourceid=chrome&ie=UTF-8&q=vmail+vim#hl=en&tbo=1&tbs=mbl:1,mbl_sv:0&q=link:http://danielchoi.com/software/vmail.html&sa=X&ei=iw0JTYnsPMT_lgfgvMC1AQ&ved=0CAUQ6QcwCg&fp=1&cad=b">web reactions</a></li>
             </ul>
-            <h4>share this</h4>
-
-<span class="st_twitter_large" displayText="Tweet"></span><span class="st_facebook_large" displayText="Facebook"></span><span class="st_ybuzz_large" displayText="Yahoo! Buzz"></span><span class="st_gbuzz_large" displayText="Google Buzz"></span><span class="st_email_large" displayText="Email"></span><span class="st_sharethis_large" displayText="ShareThis"></span>
-
           </div>
    
       </div>

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  - 4
-  version: 0.4.4
+  - 5
+  version: 0.4.5
 platform: ruby
 authors: 
 - Daniel Choi