imap-backup 1.0.15 → 1.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3d7f421192f5e5b15efcb55aa13b55cd769899e
-  data.tar.gz: d98f149a116634df9e6aa79898da5e2c61ac770a
+  metadata.gz: 87979e52b9e7629fc1b5a90e2567e795a36cc89c
+  data.tar.gz: 286d05d106efb19a22bda37446154531a396fe41
 SHA512:
-  metadata.gz: 7173984ab8c9ef01013d2d6468097aa7b928b59cf12b363b66b3119074f26996c80ffac4c27b36499cd739132eb4105d6f4c0fbd917ee53df69e90f34918a533
-  data.tar.gz: 3f5a4e52b736fabb1404ffa0b4ed01ff22b83a1c706f6de90c96f68b66fecaf22eed6af251b674c519dcb2e235aaca56d1b074a347a9a4ec54fb7c6a410e92e2
+  metadata.gz: 19e5fecd98e2bedb65b4da2fca103a65baedf04627e5ed83aacabf3b2408b4c4f2b1e0bc2a267705e2acad0d6ecc303c5db15d555759162a2b7356cf24086bcc
+  data.tar.gz: 9f4a7e727c2a544271846cd541adf9e4cd57d190eb31d09c198bf95f242b3d20fcfaac6376f92809ff9887c88432ba7340ad0a8f830e323106d99d1fa657a4be

data/README.md

@@ -53,7 +53,7 @@ It creates ~/.imap-backup directory and configuration file. E.g.:
 It connects to GMail by default, but you can also specify a server:
 
 ```json
-{  
+{
   "accounts":
   [
     {
@@ -68,7 +68,7 @@ It connects to GMail by default, but you can also specify a server:
         ]
     }
   ]
-}  
+}
 ```
 
 ## Google Apps
@@ -101,6 +101,23 @@ Each folder is saved to an mbox file.
 Alongside each mbox is a file with extension '.imap', which lists the source IMAP
 UIDs to allow a full restore.
 
+# Troubleshooting
+
+If you have problems:
+
+1. ensure that you have the latest release,
+2. turn on debugging output:
+
+```json
+{
+  "accounts":
+  [
+    ...
+  ],
+  "debug": true
+}
+```
+
 # Other Usage
 
 List IMAP folders:
@@ -126,6 +143,7 @@ $ imap-backup status
 * https://github.com/thefloweringash/gmail-imap-backup
 * https://github.com/mleonhard/imapbackup
 * https://github.com/rgrove/larch - copies between IMAP servers
+* https://github.com/OfflineIMAP/offlineimap
 
 ## Contributing
 

data/lib/imap/backup/account/connection.rb

@@ -38,7 +38,7 @@ module Imap::Backup
       # start the connection so we get logging messages in the right order
       imap
       backup_folders.each do |folder|
-        Imap::Backup.logger.debug "Folder: #{folder[:name]}"
+        Imap::Backup.logger.debug "[#{folder[:name]}] running backup"
         f = Account::Folder.new(self, folder[:name])
         s = Serializer::Mbox.new(local_path, folder[:name])
         d = Downloader.new(f, s)
@@ -61,6 +61,7 @@ module Imap::Backup
       @imap = Net::IMAP.new(server, options)
       Imap::Backup.logger.debug "Logging in: #{username}/#{masked_password}"
       @imap.login(username, password)
+      Imap::Backup.logger.debug "Login complete"
       @imap
     end
 

data/lib/imap/backup/account/folder.rb

@@ -10,29 +10,34 @@ module Imap::Backup
     REQUESTED_ATTRIBUTES = ['RFC822', 'FLAGS', 'INTERNALDATE']
 
     attr_reader :connection
-    attr_reader :folder
+    attr_reader :name
 
     delegate imap: :connection
 
-    def initialize(connection, folder)
-      @connection, @folder = connection, folder
+    def initialize(connection, name)
+      @connection = connection
+      @name = name
+    end
+
+    def folder
+      name
     end
 
     def uids
-      imap.examine(folder)
+      imap.examine(name)
       imap.uid_search(['ALL']).sort
     rescue Net::IMAP::NoResponseError => e
-      Imap::Backup.logger.warn "Folder '#{folder}' does not exist"
+      Imap::Backup.logger.warn "Folder '#{name}' does not exist"
       []
     end
 
     def fetch(uid)
-      imap.examine(folder)
+      imap.examine(name)
       message = imap.uid_fetch([uid.to_i], REQUESTED_ATTRIBUTES)[0][1]
       message['RFC822'].force_encoding('utf-8') if RUBY_VERSION > '1.9'
       message
     rescue Net::IMAP::NoResponseError => e
-      Imap::Backup.logger.warn "Folder '#{folder}' does not exist"
+      Imap::Backup.logger.warn "Folder '#{name}' does not exist"
       nil
     end
   end

data/lib/imap/backup/downloader.rb

@@ -13,10 +13,14 @@ module Imap::Backup
 
     def run
       uids = folder.uids - serializer.uids
-      Imap::Backup.logger.debug "New messages: #{uids.count}"
+      Imap::Backup.logger.debug "[#{folder.name}] #{uids.count} new messages"
       uids.each do |uid|
         message = folder.fetch(uid)
-        next if message.nil?
+        if message.nil?
+          Imap::Backup.logger.debug "[#{folder.name}] #{uid} - not available - skipped"
+          next
+        end
+        Imap::Backup.logger.debug "[#{folder.name}] #{uid} - #{message["RFC822"].size} bytes"
         serializer.save(uid, message)
       end
     end

data/lib/imap/backup/serializer/base.rb

@@ -6,6 +6,9 @@ module Imap::Backup
     FILE_PERMISSIONS      = 0600
 
     class Base
+      attr_reader :path
+      attr_reader :folder
+
       def initialize(path, folder)
         @path, @folder = path, folder
         Utils.check_permissions(@path, DIRECTORY_PERMISSIONS)

data/lib/imap/backup/serializer/mbox.rb

@@ -29,7 +29,10 @@ module Imap::Backup
 
     def save(uid, message)
       uid = uid.to_s
-      return if uids.include?(uid)
+      if uids.include?(uid)
+        Imap::Backup.logger.debug "[#{folder}] message #{uid} already downloaded - skipping"
+        return
+      end
       body = message['RFC822']
       mboxrd_message = Email::Mboxrd::Message.new(body)
       mbox = imap = nil
@@ -39,7 +42,7 @@ module Imap::Backup
         mbox.write mboxrd_message.to_s
         imap.write uid + "\n"
       rescue => e
-        Imap::Backup.logger.warn "Failed to save message #{uid}:\n#{body}. #{e}"
+        Imap::Backup.logger.warn "[#{folder}] failed to save message #{uid}:\n#{body}. #{e}"
       ensure
         mbox.close if mbox
         imap.close if imap

data/lib/imap/backup/version.rb

@@ -3,6 +3,6 @@ module Imap; end
 module Imap::Backup
   MAJOR    = 1
   MINOR    = 0
-  REVISION = 15
+  REVISION = 16
   VERSION  = [MAJOR, MINOR, REVISION].map(&:to_s).join('.')
 end

data/spec/unit/downloader_spec.rb

@@ -3,8 +3,8 @@ require 'spec_helper'
 
 describe Imap::Backup::Downloader do
   describe '#run' do
-    let(:message) { 'message' }
-    let(:folder) { double('Imap::Backup::Account::Folder', :fetch => message) }
+    let(:message) { {'RFC822' => 'blah'} }
+    let(:folder) { double('Imap::Backup::Account::Folder', :fetch => message, :name => 'folder') }
     let(:folder_uids) { ['111', '222', '333'] }
     let(:serializer) { double('Imap::Backup::Serializer', :save => nil) }
     let(:serializer_uids) { ['222'] }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 1.0.15
+  version: 1.0.16
 platform: ruby
 authors:
 - Joe Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-14 00:00:00.000000000 Z
+date: 2015-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake