vmail 2.3.8 → 2.3.9

data/README.markdown

@@ -198,11 +198,17 @@ To save you keystrokes, Vmail provides alternative key mappings for
 
 These save you from having to press the SHIFT key in each case. 
 
-## Checking for new messages
+## Checking for new messages, INBOX polling
 
 To check for new messages in the current mailbox, press `u` in normal
 mode if you're in the message list window or `,u` if you are in the
 message window. Watch the status line.
+
+If you have `notify-send` (Linux) or `growlnotify` (OS X) installed on
+your system, Vmail will also poll your INBOX every 30 seconds for new
+messages. If it detects a new message, it will alert you through your
+notification program. **NOTE**: You will still have to press `u` in the
+Vmail interface to force the new messages to display.
  
 ## Switching mailboxes, moving messages, copying messages to another mailbox
 

data/lib/vmail.rb

@@ -3,6 +3,7 @@ require 'vmail/options'
 require 'vmail/imap_client'
 require 'vmail/query'
 require 'vmail/message_formatter'
+require 'vmail/inbox_poller'
 require 'iconv'
 
 module Vmail
@@ -55,6 +56,12 @@ module Vmail
 
     puts "Starting vmail imap client for #{config['username']}"
 
+    # start inbox poller
+    inbox_poller = Vmail::InboxPoller.start config
+    Thread.new do
+      inbox_poller.start_polling
+    end
+
     drb_uri = begin 
                 Vmail::ImapClient.daemon config
               rescue 

data/lib/vmail/imap_client.rb

@@ -195,11 +195,11 @@ module Vmail
     end
 
     def check_for_new_messages
+      log "Checking for new messages"
       if search_query?
         log "Update aborted because query is search query: #{@query.inspect}"
         return ""
       end
-      prime_connection
       old_num_messages = @num_messages
       # we need to re-select the mailbox to get the new highest id
       reload_mailbox
@@ -218,8 +218,8 @@ module Vmail
       new_ids
     end
 
-    # TODO why not just reload the current page?
     def update
+      prime_connection
       new_ids = check_for_new_messages 
       if !new_ids.empty?
         self.max_seqno = new_ids[-1]
@@ -490,7 +490,7 @@ EOF
     end
 
     def self.start(config)
-      imap_client  = Vmail::ImapClient.new config
+      imap_client  = self.new config
       imap_client.open
       imap_client
     end

data/lib/vmail/inbox_poller.rb

@@ -0,0 +1,68 @@
+module Vmail
+  class InboxPoller < ImapClient
+
+    # This is a second IMAP client operating in a separate process
+ 
+    def start_polling
+      n = [`which notify-send`.chomp, `which growlnotify`.chomp].detect {|c| c != ''}
+      if n
+        log "Using notify tool: #{n}"
+        @notifier = case n
+          when /notify-send/
+            Proc.new {|t, m| `#{n} '#{t}' '#{m}'` }
+          when /growlnotify/
+            Proc.new {|t, m| `#{n} -t '#{t}' -m '#{m}'` }
+          end
+      else
+        log "No notification tool detected. INBOX polling aborted."
+        return
+      end
+     
+      log "INBOX POLLER: started polling"
+      @mailboxes.unshift "INBOX"
+      select_mailbox "INBOX"
+      search "ALL"
+      loop do
+        log "INBOX POLLER: checking inbox"
+        update
+        sleep 30
+      end
+    end
+
+    def update
+      new_ids = check_for_new_messages 
+      if !new_ids.empty?
+        self.max_seqno = new_ids[-1]
+        @ids = @ids + new_ids
+        message_ids = fetch_and_cache_headers(new_ids)
+        res = get_message_headers(message_ids)
+        @notifier.call "Vmail: new email", "from #{res}"
+      end
+    rescue
+      log "VMAIL_ERROR: #{[$!.message, $!.backtrace].join("\n")}"
+    end
+
+    def get_message_headers(message_ids)
+      messages = message_ids.map {|message_id| 
+        m = Message[message_id]
+        if m.nil?
+          raise "Message #{message_id} not found"
+        end
+        m
+      }
+      res = messages.map {|m| m.sender }.join(", ")
+      res
+    end
+
+    def log(string)
+      if string.is_a?(::Net::IMAP::TaggedResponse)
+        string = string.raw_data
+      end
+      @logger.debug "[INBOX POLLER]: #{string}"
+    end
+
+
+  end
+end
+
+

data/lib/vmail/searching.rb

@@ -2,6 +2,7 @@ module Vmail
   module Searching
     # The main function called by the client to retrieve messages
     def search(query)
+      log "#search: #{query.inspect}"
       @query = Vmail::Query.parse(query) 
       # customizable @limit is Deprecated
       @limit = 100

data/lib/vmail/version.rb

@@ -1,3 +1,3 @@
 module Vmail
-  VERSION = '2.3.8'
+  VERSION = '2.3.9'
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 2
   - 3
-  - 8
-  version: 2.3.8
+  - 9
+  version: 2.3.9
 platform: ruby
 authors: 
 - Daniel Choi
@@ -108,6 +108,7 @@ files:
 - lib/vmail/flagging_and_moving.rb
 - lib/vmail/helpers.rb
 - lib/vmail/imap_client.rb
+- lib/vmail/inbox_poller.rb
 - lib/vmail/message_formatter.rb
 - lib/vmail/options.rb
 - lib/vmail/query.rb