cinch-imap 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/README.md +8 -8
- metadata +2 -2
data/README.md
CHANGED
|
@@ -15,23 +15,23 @@ Setup
|
|
|
15
15
|
|
|
16
16
|
* :host - The IMAP server
|
|
17
17
|
* :user - The user id
|
|
18
|
-
* :password
|
|
18
|
+
* :password - The password
|
|
19
19
|
* :port - The IMAP port. Defaults to 143.
|
|
20
|
-
* :ssl
|
|
21
|
-
* :interval
|
|
20
|
+
* :ssl - Use ssl? Default is false.
|
|
21
|
+
* :interval - Number of seconds between polling. Default is 300.
|
|
22
22
|
|
|
23
23
|
#### Commands ####
|
|
24
24
|
|
|
25
|
-
* !monitor on/off
|
|
26
|
-
* !monitor status
|
|
27
|
-
* !monitor clear
|
|
25
|
+
* !monitor on/off - Enable/Disable IMAP polling
|
|
26
|
+
* !monitor status - Issues a status report to the channel
|
|
27
|
+
* !monitor clear - Resets the number of "messages seen" to 0
|
|
28
28
|
* !monitor interval [n] - Set polling interval to n second
|
|
29
29
|
|
|
30
30
|
#### Integration with Cinch ####
|
|
31
31
|
|
|
32
32
|
# mybot.rb
|
|
33
33
|
require 'cinch'
|
|
34
|
-
require 'cinch/plugins/
|
|
34
|
+
require 'cinch/plugins/imap'
|
|
35
35
|
|
|
36
36
|
bot = Cinch::Bot.new do
|
|
37
37
|
configure do |c|
|
|
@@ -67,5 +67,5 @@ eyes only.
|
|
|
67
67
|
TODO
|
|
68
68
|
----
|
|
69
69
|
|
|
70
|
-
|
|
70
|
+
* Figure out how to auto-start this thing
|
|
71
71
|
* Support a list of sender addresses to rewrite
|