imap_mogura 0.1.1 → 0.2.2.pre.dev

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f5a65d48e4e81a37e519995c39cddf533e3336477c358044462f51935ee1d0f
-  data.tar.gz: 59975c34bdd3ce2d372c71c5d6b8d9689867e431956104df8cd958294a18dc3d
+  metadata.gz: e8ab3a83b682da8cfeeb55ea96c1e1bd3b046246da28923196d33fe7cd3d7f26
+  data.tar.gz: 3d0fd5fa039f632ed3c63e2467e3eb31703cb4ec9aca2aa8a0a15d2592b04124
 SHA512:
-  metadata.gz: c29a3b716cfde67b59876ad149add941ac2db45fa92154fbaa0a3587e438939568ae6eb536b12ddcc28bd14c0ab131a3f4a5725d0e11775cc3f1a95d30400b84
-  data.tar.gz: fc9c28711eb63e293e09173a3b4eac353e5ca40d4b3d7b01b07ea5f571c80d941d669c1bd93217c21d179a16ff59b116996f0a581b80ad883c5875a590e2f8b2
+  metadata.gz: 05230b9da5a38e8abc1b398d0939528fed9dcccf1f01dae327844d63e26f25dfa009083c3ee5b84d070fc164cce22ce18c23a52edb3fcbbef34926f908fd256f
+  data.tar.gz: c81ee3bc93144669f170ea3d139aac88bbfc2c660d6fa3e15a2f653b7fde2ff8b2f69bb7dbcef69fed73ff51845aa6ce08f005d1b4326e2ed0798fe397cf3249

data/README.md

@@ -4,13 +4,13 @@ A mail filtering tool for IMAP.
 
 ## Installation
 
-To install this gem, you can get it from RubyGems.org. Just run as following.
+To install this gem, just run as following. You can get the gem from [RubyGems.org](https://rubygems.org/).
 
 ```console
 $ gem install imap_mogura --pre
 ```
 
-(This gem has only released pre-release versions now, so you must specify `--pre` option.)
+(This branch is `develop`, that means this is a pre-release version. You can install this version by specifying `--pre` option.)
 
 ## Usage
 
@@ -35,22 +35,21 @@ rules:
       subject: "i'm trash-like email!!"
 ```
 
-As following, `start` command will start monitoring RECENT mails on "INBOX". If a mail is coming
- and it's RECENT, it will be filtered.
+Running `mogura start` command will start monitoring RECENT mails coming to "INBOX". If a mail with RECENT flag is coming to the mailbox, it will be filtered.
 
 ```console
 $ mogura start <host> -u <user> --password-base64=<password-base64-encoded> -c rules.yml -b INBOX
 ```
 
-You can specify a mailbox which to be monitored by `-b` option.
+You can specify the mailbox by `-b` option.
 
-If you want to just filter mails on a specific mailbox, run the `filter` command as following.
+If you want to just filter mails on the specific mailbox, use `mogura filter` command.
 
 ```console
 $ mogura filter <host> -u <user> --password-base64=<password-base64-encoded> -c rules.yml -b <mailbox>
 ```
 
-You can check your config by `check-config` command. It returns just OK if no errors in the config.
+You can check your config by `mogura check-config` command. It returns just OK if no errors in the config.
 
 ```console
 $ mogura check-config -c rules.yml

data/lib/imap_mogura/cli.rb

@@ -42,7 +42,6 @@ module ImapMogura
       create_directory = options[:create_directory]
       dry_run = options[:dry_run]
 
-      monitored_events = ["RECENT"]
       search_keys = ["RECENT", *(["UNSEEN"] if filter_unseen)]
 
       with_preparation_ready(config_name, host, port, starttls, use_ssl,
@@ -51,7 +50,8 @@ module ImapMogura
                              dry_run: dry_run) do |imap_handler, rules|
         warn "* start monitoring recent mails in \"#{target_mailbox}\""
 
-        imap_handler.monitor_events(target_mailbox, monitored_events) do
+        monitor_recents_on_mailbox(imap_handler, target_mailbox) do
+          # find mails with search keys on the target mailbox and handle them
           imap_handler.find_and_handle_mails(target_mailbox, search_keys) do |message_id|
             warn "mail (id = #{message_id} on \"#{target_mailbox}\") is recent"
 
@@ -86,13 +86,12 @@ module ImapMogura
       all_mailbox = options[:all_mailbox]
       exclude_mailboxes = options[:exclude_mailboxes]
       target_mailbox = options[:target_mailbox] unless all_mailbox
-
-      raise CustomOptionError, "--all-mailbox (-a) or --target-mailbox (-b) is required" if !all_mailbox && target_mailbox.nil?
-
       filter_only_unseen = options[:filter_only_unseen]
       create_directory = options[:create_directory]
       dry_run = options[:dry_run]
 
+      raise CustomOptionError, "--all-mailbox (-a) or --target-mailbox (-b) is required" if !all_mailbox && target_mailbox.nil?
+
       search_keys = if filter_only_unseen
                       ["UNSEEN"]
                     else
@@ -107,7 +106,10 @@ module ImapMogura
         if all_mailbox
           excluded_mailboxes = options[:excluded_mailboxes]
 
-          imap_handler.all_mailbox_list.reject { |mailbox| excluded_mailboxes.include?(mailbox) }.each do |mailbox|
+          # figure out target mailboxes
+          target_mailboxes = imap_handler.all_mailbox_list.reject { |mailbox| excluded_mailboxes.include?(mailbox) }
+
+          target_mailboxes.each do |mailbox|
             filter_mails(imap_handler, rules, mailbox, search_keys, dry_run: dry_run)
           end
         else
@@ -135,6 +137,7 @@ module ImapMogura
                                      starttls: starttls, usessl: use_ssl, certs: nil, verify: true,
                                      auth_info: { auth_type: auth_type, user: user, password: password })
 
+      # output all mailbox list
       puts imap_handler.all_mailbox_list
 
       imap_handler.close
@@ -174,10 +177,12 @@ module ImapMogura
       #   exit
       # end
 
+      # create directories specified as destination
       touch_all_mailboxes_in_rules(imap_handler, rules, dry_run: dry_run) if create_directory
 
       options = { excluded_mailboxes: excluded_mailboxes }
 
+      # call the given block
       block[imap_handler, rules, options]
 
       imap_handler.close
@@ -208,29 +213,39 @@ module ImapMogura
       end
     end
 
+    def monitor_recents_on_mailbox(imap_handler, mailbox, retry_count = 0, &block)
+      imap_handler.monitor_events(mailbox, ["RECENT"], &block)
+    rescue IMAPHandler::MailFetchError => e
+      handle_mail_fetch_error_and_preprocess_retrying(e, retry_count)
+
+      # retry monitor recents on mailbox itself with retry count to be incremented
+      warn "retry monitoring mails on #{e.mailbox}..."
+
+      monitor_recents_on_mailbox(imap_handler, mailbox, retry_count + 1)
+    end
+
     def filter_mails(imap_handler, rules, mailbox, search_keys = ["ALL"], retry_count = 0, dry_run: false)
       imap_handler.find_and_handle_mails(mailbox, search_keys) do |message_id|
         filter_mail(imap_handler, rules, mailbox, message_id, dry_run: dry_run)
       end
     rescue IMAPHandler::MailFetchError => e
-      warn "failed to fetch mail (id = #{e.message_id} on mailbox #{e.mailbox}): #{e.bad_response_error_message}"
+      handle_mail_fetch_error_and_preprocess_retrying(e, retry_count)
 
-      # if retry_count is over the threshold, terminate processing
-      unless retry_count < 3
-        warn "retry count is over the threshold, stop processing"
+      # retry filter all mails itself with retry count to be incremented
+      warn "retry filtering all mails on #{e.mailbox}"
 
-        return
-      end
+      filter_mails(imap_handler, rules, mailbox, search_keys, retry_count + 1, dry_run: dry_run)
+    end
 
-      warn "wait a moment..."
+    def handle_mail_fetch_error_and_preprocess_retrying(error, retry_count)
+      warn "failed to fetch mail (id = #{error.message_id} on mailbox #{error.mailbox}): #{error.bad_response_error_message}"
 
-      # wait a moment...
-      sleep 10
+      # if retry_count is over the threshold, abort processing
+      raise Thor::Error, "retry count is over the threshold, stop processing" unless retry_count < 3
 
-      warn "retry filter all mails on #{e.mailbox}"
+      warn "wait a moment..."
 
-      # retry filter all mails itself
-      filter_mails(imap_handler, rules, mailbox, search_keys, retry_count + 1, dry_run: dry_run)
+      sleep 10
     end
 
     def filter_mail(imap_handler, rules, mailbox, message_id, dry_run: false)
@@ -239,27 +254,31 @@ module ImapMogura
       warn "# filtering mail on \"#{mailbox}\" of subject \"#{mail.subject}\"..."
 
       rules.each do |rule_set|
-        dst_mailbox = rule_set.destination
-        rule = rule_set.rule
+        try_to_filter_mail_for_rule_set(imap_handler, rule_set, mailbox, message_id, mail, dry_run: dry_run)
+      end
+
+      imap_handler.close_operation_for_mailbox(mailbox)
+    end
 
-        next unless rule.match?(mail)
+    def try_to_filter_mail_for_rule_set(imap_handler, rule_set, mailbox, message_id, mail, dry_run: false)
+      dst_mailbox = rule_set.destination
+      rule = rule_set.rule
 
-        warn "the mail matches for the rule of the destination \"#{dst_mailbox}\""
-        warn "moving the mail..."
+      return unless rule.match?(mail)
 
-        if dry_run
-          warn "moving skipped because this is dry run"
+      warn "the mail matches for the rule of the destination \"#{dst_mailbox}\""
+      warn "moving the mail..."
+
+      if dry_run
+        warn "moving skipped because this is dry run"
+      else
+        result = imap_handler.move(mailbox, message_id, dst_mailbox)
+        if result
+          warn "moving done"
         else
-          result = imap_handler.move(mailbox, message_id, dst_mailbox)
-          if result
-            warn "moving done"
-          else
-            warn "moving skipped because the destination is the same with the current mailbox \"#{mailbox}\""
-          end
+          warn "moving skipped because the destination is the same with the current mailbox \"#{mailbox}\""
         end
       end
-
-      imap_handler.close_operation_for_mailbox(mailbox)
     end
   end
 end

data/lib/imap_mogura/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ImapMogura
-  VERSION = "0.1.1"
+  VERSION = "0.2.2.pre.dev"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap_mogura
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.2.pre.dev
 platform: ruby
 authors:
 - ysk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-19 00:00:00.000000000 Z
+date: 2024-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64