vmail 1.2.3 → 1.2.4

data/README.markdown

@@ -120,6 +120,11 @@ this number by passing in a number after the mailbox name:
 
     vmail inbox 700 subject unix
 
+Passing in 0 as the number of messages returns all messages that match
+the query:
+
+    vmail inbox 0 subject unix # => returns all matching messages
+
 ## Viewing messages
 
 The first screen vmail shows you is a list of messages. You can view a message

data/bin/vmail

@@ -7,5 +7,11 @@ rescue LoadError
   require 'vmail'
 end
 
-Vmail.start
+if !STDOUT.tty?
+  Vmail.noninteractive_list_messages
+elsif !STDIN.tty?
+  Vmail.batch_run
+else
+  Vmail.start
+end
 

data/lib/vmail.rb

@@ -1,6 +1,7 @@
 require 'vmail/version'
 require 'vmail/options'
 require 'vmail/imap_client'
+require 'vmail/query'
 require 'vmail/message_formatter'
 require 'vmail/reply_template'
 
@@ -11,18 +12,14 @@ module Vmail
     puts "starting vmail #{Vmail::VERSION}"
 
     vim = ENV['VMAIL_VIM'] || 'vim'
-
     ENV['VMAIL_BROWSER'] ||= 'open'
 
-    # check for lynx
-    if `which lynx` == ''
-      puts "You need to install lynx on your system in order to see html-only messages"
-      sleep 3
-    end
+    check_lynx
+
     opts = Vmail::Options.new(ARGV)
     opts.config
-
     config = opts.config
+
     contacts_file = opts.contacts_file
 
     logfile = (vim == 'mvim') ? STDERR : 'vmail.log'
@@ -39,33 +36,25 @@ module Vmail
 
     server = DRbObject.new_with_uri drb_uri
 
-    mailbox = if ARGV[0] =~ /^\d+/ 
-                "INBOX"
-              else 
-                ARGV.shift || 'INBOX' 
-              end
-
+    mailbox, query = parse_query
+    query_string = Vmail::Query.args2string query
     server.select_mailbox mailbox
 
-    query = ARGV.empty? ? [100, 'ALL'] : ARGV
-    if query.size == 1 && query[0] =~ /^\d/
-      query << "ALL"
-    end
-    puts "mailbox: #{mailbox}"
-    puts "query: #{query.inspect}"
+    STDERR.puts "mailbox: #{mailbox}"
+    STDERR.puts "query: #{query.inspect} => #{query_string}"
     
     buffer_file = "vmailbuffer"
     # invoke vim
     vimscript = File.expand_path("../vmail.vim", __FILE__)
-    vim_command = "DRB_URI=#{drb_uri} VMAIL_CONTACTS_FILE=#{contacts_file} VMAIL_MAILBOX=#{String.shellescape(mailbox)} VMAIL_QUERY=#{String.shellescape(query.join(' '))} #{vim} -S #{vimscript} #{buffer_file}"
-    puts vim_command
+    vim_command = "DRB_URI=#{drb_uri} VMAIL_CONTACTS_FILE=#{contacts_file} VMAIL_MAILBOX=#{String.shellescape(mailbox)} VMAIL_QUERY=#{String.shellescape(query_string)} #{vim} -S #{vimscript} #{buffer_file}"
+    STDERR.puts vim_command
 
-    puts "using buffer file: #{buffer_file}"
+    STDERR.puts "using buffer file: #{buffer_file}"
     File.open(buffer_file, "w") do |file|
       file.puts "vmail starting with values:"
       file.puts "- drb uri: #{drb_uri}"
       file.puts "- mailbox: #{mailbox}"
-      file.puts "- query: #{query.join(' ')}"
+      file.puts "- query: #{query_string}"
       file.puts
       file.puts "fetching messages. please wait..."  
     end
@@ -78,7 +67,7 @@ module Vmail
 
     File.delete(buffer_file)
 
-    puts "closing imap connection"  
+    STDERR.puts "closing imap connection"  
     begin
       Timeout::timeout(10) do 
         $gmail.close
@@ -89,5 +78,77 @@ module Vmail
     puts "bye"
     exit
   end
+
+  # non-interactive mode
+  def noninteractive_list_messages
+    check_lynx
+    opts = Vmail::Options.new(ARGV)
+    opts.config
+    config = opts.config.merge 'logfile' => 'vmail.log'
+    mailbox, query = parse_query
+    query_string = Vmail::Query.args2string query
+    imap_client  = Vmail::ImapClient.new config
+    imap_client.with_open do |vmail| 
+      vmail.select_mailbox mailbox
+      vmail.search query_string
+    end 
+  end
+
+  # batch processing mode
+  def batch_run
+    check_lynx
+    opts = Vmail::Options.new(ARGV)
+    opts.config
+    config = opts.config.merge 'logfile' => 'vmail.log'
+    # no search query args, but command args
+    imap_client  = Vmail::ImapClient.new config
+    lines = STDIN.readlines# .reverse
+    mailbox = lines.shift.chomp
+    puts "mailbox: #{mailbox}"
+    uid_set = lines.map do |line| 
+      line[/(\d+)\s*$/,1].to_i
+    end
+    commands = {
+      'rm' => ["flag", "+FLAGS", "Deleted"],
+      'spam' => ["flag", "+FLAGS", "spam"],
+      'mv' => ["move_to"],
+      'cp' => ["copy_to"],
+      'cat' => ["append_to_file"]
+    }
+    args = commands[ARGV.first]
+    if args.nil?
+      abort "command '#{args.inspect}' not recognized"
+    end
+    command = args.shift
+    imap_client.with_open do |vmail| 
+      puts "selecting mailbox: #{mailbox}"
+      vmail.select_mailbox mailbox
+      uid_set.each_slice(5) do |uid_set|
+        params = [uid_set.join(',')] + args + ARGV[1..-1]
+        puts "executing: #{command} #{params.join(' ')}"
+        vmail.send command, *params
+      end
+    end
+  end
+
+  private
+
+  def check_lynx
+    # TODO check for elinks, or firefox (how do we parse VMAIL_HTML_PART_REDAER to determine?)
+    if `which lynx` == ''
+      STDERR.puts "You need to install lynx on your system in order to see html-only messages"
+      sleep 3
+    end
+  end
+
+  def parse_query
+    mailbox = if ARGV[0] =~ /^\d+/ 
+                "INBOX"
+              else 
+                ARGV.shift || 'INBOX' 
+              end
+    query = Vmail::Query.parse(ARGV)
+    [mailbox, query]
+  end
 end
 

data/lib/vmail.vim

@@ -286,7 +286,7 @@ function! s:toggle_star() range
   endif
 endfunction
 
-" flag can be Deleted or [Gmail]/Spam
+" flag can be Deleted or spam
 func! s:delete_messages(flag) range
   let uid_set = s:collect_uids(a:firstline, a:lastline)
   let nummsgs = len(uid_set)
@@ -339,7 +339,7 @@ func! s:append_messages_to_file() range
     return
   endif
   let s:append_file = append_file
-  let command = s:append_to_file_command . s:append_file . ' ' . join(uid_set, ',')
+  let command = s:append_to_file_command . join(uid_set, ',') . ' ' . s:append_file 
   echo "appending " . nummsgs . " message" . (nummsgs == 1 ? '' : 's') . " to " . s:append_file . ". please wait..."
   let res = system(command)
   echo res
@@ -497,7 +497,7 @@ function! s:select_mailbox()
   " now get latest 100 messages
   call s:focus_list_window()  
   setlocal modifiable
-  let command = s:search_command . "100 all"
+  let command = s:search_command . shellescape("100 all")
   echo "loading messages..."
   let res = system(command)
   1,$delete
@@ -527,16 +527,7 @@ function! s:do_search()
   " close message window if open
   call s:focus_message_window()
   close
-  " if query doesn't start with a number, set max returned to 100
-  let limit = 100
-  let imap_query = s:query
-  if match(s:query, '^\d') == 0
-    let query_chunks = split(s:query, '\s')
-    let limit = remove(query_chunks, 0)
-    let imap_query = join(query_chunks, ' ')
-  end
-  let s:query = limit . ' ' . imap_query
-  let command = s:search_command . limit . ' ' . shellescape(imap_query)
+  let command = s:search_command . shellescape(s:query)
   redraw
   call s:focus_list_window()  
   setlocal modifiable
@@ -778,7 +769,7 @@ func! s:message_window_mappings()
 
   nnoremap <silent> <buffer> <leader>#  :close<cr>:call <SID>focus_list_window()<cr>:call <SID>delete_messages("Deleted")<cr>
   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>! :call <SID>focus_list_window()<cr>:call <SID>delete_messages("spam")<CR>
   noremap <silent> <buffer> <leader>e :call <SID>focus_list_window()<cr>:call <SID>archive_messages()<CR>
   " alt mappings for lazy hands
   nmap <silent> <buffer> <leader>8 <leader>*
@@ -805,12 +796,12 @@ func! s:message_list_window_mappings()
 
   noremap <silent> <buffer> <leader>* :call <SID>toggle_star()<CR>
   noremap <silent> <buffer> <leader># :call <SID>delete_messages("Deleted")<CR>
-  noremap <silent> <buffer> <leader>! :call <SID>delete_messages("[Gmail]/Spam")<CR>
+  noremap <silent> <buffer> <leader>! :call <SID>delete_messages("spam")<CR>
   noremap <silent> <buffer> <leader>e :call <SID>archive_messages()<CR>
   " alt mappings for lazy hands
   noremap <silent> <buffer> <leader>8 :call <SID>toggle_star()<CR>
   noremap <silent> <buffer> <leader>3 :call <SID>delete_messages("Deleted")<CR>
-  noremap <silent> <buffer> <leader>1 :call <SID>delete_messages("[Gmail]/Spam")<CR>
+  noremap <silent> <buffer> <leader>1 :call <SID>delete_messages("spam")<CR>
 "  nmap <silent> <buffer> <leader>8 <leader>*
 "  nmap <silent> <buffer> <leader>3 <leader>#
 "  nmap <silent> <buffer> <leader>1 <leader>!

data/lib/vmail/imap_client.rb

@@ -33,6 +33,7 @@ module Vmail
       @imap_port = config['port'] || 993
       @current_mail = nil
       @current_message_uid = nil
+      @width = 140
     end
 
     # holds mail objects keyed by [mailbox, uid]
@@ -52,6 +53,14 @@ module Vmail
       list_mailboxes # prefetch mailbox list
     end
 
+    # expects a block, closes on finish
+    def with_open
+      @imap = Net::IMAP.new(@imap_server, @imap_port, true, nil, false)
+      log @imap.login(@username, @password)
+      yield self
+      close
+    end
+
     def close
       log "closing connection"
       Timeout::timeout(10) do
@@ -82,10 +91,12 @@ module Vmail
     end
 
     def reload_mailbox
+      return unless STDIN.tty?
       select_mailbox(@mailbox, true)
     end
 
     def clear_cached_message
+      return unless STDIN.tty?
       log "CLEARING CACHED MESSAGE"
       @current_mail = nil
       @current_message_uid = nil
@@ -164,6 +175,9 @@ module Vmail
       end
       new_message_rows = fetch_envelopes(id_set, are_uids, is_update)
       new_message_rows.map {|x| x[:row_text]}.join("\n")
+    rescue # Encoding::CompatibilityError (only in 1.9.2)
+      log "Error in fetch_row_text:\n#{$!}\n#{$!.backtrace}"
+      new_message_rows.map {|x| Iconv.conv('US-ASCII//TRANSLIT//IGNORE', 'UTF-8', x[:row_text])}.join("\n")
     end
 
     def fetch_envelopes(id_set, are_uids, is_update)
@@ -226,7 +240,7 @@ module Vmail
       mid_width = @width - 38
       address_col_width = (mid_width * 0.3).ceil
       subject_col_width = (mid_width * 0.7).floor
-      identifier = [@mailbox, [seqno.to_i, uid.to_i].join(':')].join(';')
+      identifier = [seqno.to_i, uid.to_i].join(':')
       row_text = [ flags.col(2),
                    (date_formatted || '').col(14),
                    address.col(address_col_width),
@@ -267,13 +281,16 @@ module Vmail
       flags.join('')
     end
 
-    def search(limit, *query)
-      limit = limit.to_i
-      limit = 100 if limit.to_s !~ /^\d+$/
-      query = ['ALL'] if query.empty?
+    def search(query)
+      query = Vmail::Query.parse(query)
+      @limit = query.shift.to_i
+      # a limit of zero is effectively no limit
+      if @limit == 0
+        @limit = @num_messages
+      end
       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(':')
+        query.unshift [[@num_messages - @limit + 1 , 1].max, @num_messages].join(':')
         @all_search = true
       else # this is a special query search
         # set the target range to the whole set
@@ -281,28 +298,36 @@ module Vmail
         @all_search = false
       end
       @query = query.map {|x| x.to_s.downcase}
-      @limit = limit
-      log "search query: #{@query.inspect}"
+      query_string = Vmail::Query.args2string(@query)
+      log "search query: #{@query} > #{query_string.inspect}"
       log "- @all_search #{@all_search}"
       @query = query
       @ids = reconnect_if_necessary(180) do # increase timeout to 3 minutes
-        @imap.search(@query.join(' '))
+        @imap.search(query_string)
       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
+                    @start_index = [@ids.length - @limit, 0].max
                     @ids[@start_index..-1]
                   end
       self.max_seqno = @ids[-1]
       log "- search query got #{@ids.size} results; max seqno: #{self.max_seqno}" 
       clear_cached_message
       res = fetch_row_text(fetch_ids)
-      add_more_message_line(res, fetch_ids[0])
+      if STDOUT.tty?
+        add_more_message_line(res, fetch_ids[0])
+      else
+        # non interactive mode
+        puts [@mailbox, res].join("\n")
+      end
+    rescue
+      log "ERROR:\n#{$!.inspect}\n#{$!.backtrace.join("\n")}"
     end
 
     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
@@ -318,7 +343,7 @@ module Vmail
       update_query[0] = "#{old_num_messages}:#{@num_messages}"
       ids = reconnect_if_necessary { 
         log "search #update_query"
-        @imap.search(update_query.join(' ')) 
+        @imap.search(Vmail::Query.args2string(update_query))
       }
       log "- got seqnos: #{ids.inspect}"
       log "- getting seqnos > #{self.max_seqno}"
@@ -462,13 +487,13 @@ EOF
     # id_set is a string comming from the vim client
     # action is -FLAGS or +FLAGS
     def flag(uid_set, action, flg)
+      log "flag #{uid_set} #{flg} #{action}"
       uid_set = uid_set.split(',').map(&:to_i)
-      log "flag #{uid_set.inspect} #{flg} #{action}"
       if flg == 'Deleted'
         log "Deleting uid_set: #{uid_set.inspect}"
         decrement_max_seqno(uid_set.size)
         # for delete, do in a separate thread because deletions are slow
-        Thread.new do 
+        spawn_thread_if_tty do 
           unless @mailbox == '[Gmail]/Trash'
             log "@imap.uid_copy #{uid_set.inspect} to trash"
             log @imap.uid_copy(uid_set, "[Gmail]/Trash")
@@ -478,10 +503,10 @@ EOF
           reload_mailbox
           clear_cached_message
         end
-      elsif flg == '[Gmail]/Spam'
+      elsif flg == 'spam' || flg == '[Gmail]/Spam'
         log "Marking as spam uid_set: #{uid_set.inspect}"
         decrement_max_seqno(uid_set.size)
-        Thread.new do 
+        spawn_thread_if_tty 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]"
@@ -489,10 +514,9 @@ EOF
           reload_mailbox
           clear_cached_message
         end
-        "#{id} deleted"
       else
         log "Flagging uid_set: #{uid_set.inspect}"
-        Thread.new do
+        spawn_thread_if_tty do
           log "@imap.uid_store #{uid_set.inspect} #{action} [#{flg.to_sym}]"
           log @imap.uid_store(uid_set, action, [flg.to_sym])
         end
@@ -511,7 +535,7 @@ EOF
       end
       create_if_necessary mailbox
       log "moving uid_set: #{uid_set.inspect} to #{mailbox}"
-      Thread.new do 
+      spawn_thread_if_tty do 
         log @imap.uid_copy(uid_set, mailbox)
         log @imap.uid_store(uid_set, '+FLAGS', [:Deleted])
         reload_mailbox
@@ -527,12 +551,22 @@ EOF
       end
       create_if_necessary mailbox
       log "copying #{uid_set.inspect} to #{mailbox}"
-      Thread.new do 
+      spawn_thread_if_tty do 
         log @imap.uid_copy(uid_set, mailbox)
         log "copied uid_set #{uid_set.inspect} to #{mailbox}"
       end
     end
 
+    def spawn_thread_if_tty 
+      if STDIN.tty?
+        Thread.new do 
+          yield
+        end
+      else
+        yield
+      end
+    end
+
     def create_if_necessary(mailbox)
       current_mailboxes = mailboxes.map {|m| MailboxAliases[m] || m}
       if !current_mailboxes.include?(mailbox)
@@ -544,7 +578,7 @@ EOF
       end
     end
 
-    def append_to_file(file, uid_set)
+    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|

data/lib/vmail/options.rb

@@ -48,9 +48,9 @@ module Vmail
         begin
           opts.parse!(argv)
           if @config_file && File.exists?(@config_file)
-            puts "using config file: #{@config_file}"
+            STDERR.puts "using config file: #{@config_file}"
           else
-            puts <<EOF
+            STDERR.puts <<EOF
 
 Missing config file! 
 
@@ -59,11 +59,13 @@ EOF
             exit(1)
           end
 
-          if @contacts_file.nil?
-            puts "No contacts file found for auto-completion. See help for how to generate it."
-            sleep 0.5
-          else
-            puts "using contacts file: #{@contacts_file}"
+          if STDOUT.tty?
+            if @contacts_file.nil?
+              STDERR.puts "No contacts file found for auto-completion. See help for how to generate it."
+              sleep 0.5
+            else
+              STDERR.puts "using contacts file: #{@contacts_file}"
+            end
           end
 
           @config = YAML::load(File.read(@config_file))

data/lib/vmail/query.rb

@@ -0,0 +1,28 @@
+require 'shellwords'
+module Vmail
+  class Query
+    # args is an array like ARGV
+    def self.parse(args)
+      if args.is_a?(String)
+        args = Shellwords.shellwords args
+      end
+      query = if args.empty? 
+                [100, 'ALL']
+              elsif args.size == 1 && args[0] =~ /^\d+/ 
+                [args.shift, "ALL"] 
+              elsif args[0] =~ /^\d+/
+                args
+              else
+                [100] + args
+              end
+      query
+    end
+
+    def self.args2string(array)
+      array.map {|x|
+        x.to_s.split(/\s+/).size > 1 ? "\"#{x}\"" : x.to_s
+      }.join(' ')
+    end
+
+  end
+end

data/lib/vmail/version.rb

@@ -1,3 +1,3 @@
 module Vmail
-  VERSION = "1.2.3"
+  VERSION = "1.2.4"
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 2
-  - 3
-  version: 1.2.3
+  - 4
+  version: 1.2.4
 platform: ruby
 authors: 
 - Daniel Choi
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-06 00:00:00 -05:00
+date: 2011-01-08 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -73,6 +73,7 @@ files:
 - lib/vmail/imap_client.rb
 - lib/vmail/message_formatter.rb
 - lib/vmail/options.rb
+- lib/vmail/query.rb
 - lib/vmail/reply_template.rb
 - lib/vmail/send_options.rb
 - lib/vmail/sender.rb