actionmailbox-imap 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 376f10979ea6f2c65fccb83629829919116f6022940af536622fb4873d1745d2
-  data.tar.gz: 12b8fa355b3dab2f0a1f5d3aafc6f1dbf2ebf9cdf653e85dc74e8925c97e7a94
+  metadata.gz: 37710107210c5ddec08e3b9fe1706ba0802d8a6890cb13c4368afb6387fe54ff
+  data.tar.gz: '0804774914cad237468d29e1eccb4369c094a33515dbc72a3791251363448f02'
 SHA512:
-  metadata.gz: 8b5e9f33726a4607eaf3b2eb848004b8e9f237900a952e3240bebb5f5ecedfb941b3e0ae9a57e67b510e2d9fd25ccb0deaeece0c87963fe415f6202dcfccd04a
-  data.tar.gz: c4d1d058b1a1277e2c35d32d33fe1ada479f8e4bd4887bb97f62581c3049802f744543f0e3a58ff647f62ac40ee9f8209d3c4912190d70f6814a8d34f67993f8
+  metadata.gz: 4de92fb2f82dd2c30c97a4ccb4fb9b40eed310e97d2022266b94a3d98e84d5e1042ca3b8c4a33622abb18d8561a5515807371b479d892eaa6cebcc162efb6c74
+  data.tar.gz: d23dcce0383eb7db0a1cddd7ffc0e01a34b6a004d4d739ba10dcaf798028eea430d3b0c217d70177b571ac1ed4d24d1e58b02bf8fc89fcf07c93addbe52163a8

data/README.md

@@ -53,11 +53,13 @@ Prepare your IMAP server and account by ensuring/creating the mailboxes for `ing
 
 Update the `config/imap.yml` that was generated to include server and credentials information, `mailbox`. Currently SSL is required.
 
-Run the [ActionMailbox::IMAP Client](https://github.com/kimmelsg/actionmailbox-imap/blob/master/CLIENT.md) like so `URL=... INGRESS_PASSWORD=... ./actionmailbox-imap` to begin processing emails.
+Run the [ActionMailbox::IMAP Client](https://github.com/kimmelsg/actionmailbox-imap/blob/master/CLIENT.md) like so `URL=... INGRESS_PASSWORD=... ./actionmailbox-imap` from within rails root to begin processing emails.
+
+`NOTE: Running the client will begin immediately begin processing unread emails in the configured mailbox. The server (URL) needs to be running. You may also want to start from a empty, or plan on watching the process to ensure no performance issues occur.`
 
 ### Rake Task
 
-The rake task behaves much like that of the other `action_mailbox:ingress:...` commands in that it relays the message the same way. Although messages should be piped to the other ingress commands and `rails action_mailbox:ingress:imap ...` needs to be scheduled appropriately.
+The rake task behaves much like that of the other `action_mailbox:ingress:...` commands in that it relays the message the same way.
 
 ## Installation
 Add this line to your application's Gemfile:

data/config/actionmailbox_imap.yaml

@@ -1,6 +1,20 @@
-server: "smtp.testing.com"
+server: "outlook.office365.com"
+
+# Currently TLS is required
 port: 993
 tls: true
-username: "test@test.com"
-password: "test"
-mailbox: "INBOX"
+
+username: "walter2@kimmel.com"
+password: "Kimmel trench capon2"
+
+# The mailbox to select unread messages from
+mailbox: "RETRY"
+
+#
+# Workers
+#
+# This is the number of threads used to process
+# all unread messages from the IMAP server.
+#
+# DO NOT use more workers than you have threads available.
+workers: 4

data/lib/actionmailbox/imap/version.rb

@@ -1,5 +1,5 @@
 module Actionmailbox
   module Imap
-    VERSION = "0.2.1"
+    VERSION = "0.2.2"
   end
 end

data/lib/generators/imap/templates/config.yml

@@ -1,6 +1,20 @@
-server: "imap.domain.com"
+server: "some.server.com"
+
+# Currently TLS is required
 port: 993
 tls: true
-username: "username"
+
+username: "user@domain.com"
 password: "password"
+
+# The mailbox to select unread messages from
 mailbox: "INBOX"
+
+#
+# Workers
+#
+# This is the number of threads used to process
+# all unread messages from the IMAP server.
+#
+# DO NOT use more workers than you have threads available.
+workers: 4

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: actionmailbox-imap
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Ethan Knowlton