cinch-imap 0.0.6 → 0.0.7
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGES.md +17 -0
- data/README.md +33 -40
- data/lib/cinch/plugins/imap.rb +4 -3
- metadata +4 -3
data/CHANGES.md
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# CHANGES
|
|
2
|
+
|
|
3
|
+
## 0.0.7
|
|
4
|
+
- Documentation cleanup
|
|
5
|
+
## 0.0.6
|
|
6
|
+
- Documentation cleanup
|
|
7
|
+
## 0.0.5
|
|
8
|
+
- Fixed bug where polling was interupted because of unknown variable
|
|
9
|
+
## 0.0.4
|
|
10
|
+
- from_rewrites config option added
|
|
11
|
+
- showconfig command added
|
|
12
|
+
## 0.0.3
|
|
13
|
+
- subject_match config option added
|
|
14
|
+
- mark_as_read config option added
|
|
15
|
+
## 0.0.2
|
|
16
|
+
- Initial upload
|
|
17
|
+
|
data/README.md
CHANGED
|
@@ -1,47 +1,42 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
==========
|
|
1
|
+
# Cinch-Imap
|
|
2
|
+
|
|
4
3
|
The Cinch Imap Plugin. Poll an IMAP mailbox at a defined interval.
|
|
5
4
|
|
|
6
|
-
|
|
7
|
-
----------
|
|
8
|
-
0.0.6
|
|
9
|
-
* documentation improvements
|
|
10
|
-
0.0.5
|
|
11
|
-
* bug fixes
|
|
12
|
-
0.0.4
|
|
13
|
-
* from_rewrites configuration option added
|
|
14
|
-
* !monitor showconfig command added
|
|
15
|
-
0.0.3
|
|
16
|
-
* Added configurable prefix based on subject match.
|
|
17
|
-
* Moved "mark messages read" to a configurable option.
|
|
5
|
+
## Required Configuration
|
|
18
6
|
|
|
19
|
-
|
|
20
|
-
|
|
7
|
+
### :host
|
|
8
|
+
The IMAP server
|
|
9
|
+
### :user
|
|
10
|
+
The user id
|
|
11
|
+
### :password
|
|
12
|
+
The password
|
|
21
13
|
|
|
22
|
-
* :host - The IMAP server
|
|
23
|
-
* :user - The user id
|
|
24
|
-
* :password - The password
|
|
25
14
|
|
|
26
|
-
Optional Configuration
|
|
27
|
-
----------------------
|
|
15
|
+
## Optional Configuration
|
|
28
16
|
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
17
|
+
The IMAP port. Default is 143.
|
|
18
|
+
### :port
|
|
19
|
+
Use SSL? Default is false.
|
|
20
|
+
### :ssl
|
|
21
|
+
Number of seconds between polling. Default is 300.
|
|
22
|
+
### :interval
|
|
23
|
+
Sets the IMAP :Seen flag on polled messages. Default is true.
|
|
24
|
+
### :mark_as_read
|
|
33
25
|
|
|
34
|
-
Commands
|
|
35
|
-
--------
|
|
26
|
+
## Commands
|
|
36
27
|
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
28
|
+
Enable/disable IMAP polling
|
|
29
|
+
!monitor on/off
|
|
30
|
+
Outputs status information to the channel
|
|
31
|
+
!monitor status
|
|
32
|
+
Reset the number of messages seen to 0
|
|
33
|
+
!monitor clear
|
|
34
|
+
Set polling interval in seconds. Default is 300.
|
|
35
|
+
!monitor interval [n]
|
|
36
|
+
Outputs configuration to channel. The password attribute is skipped.
|
|
37
|
+
!monitor showconfig
|
|
42
38
|
|
|
43
|
-
Example Configuration
|
|
44
|
-
---------------------
|
|
39
|
+
## Example Configuration
|
|
45
40
|
|
|
46
41
|
> # mybot.rb
|
|
47
42
|
> require 'cinch'
|
|
@@ -74,15 +69,13 @@ Now, run your bot.
|
|
|
74
69
|
|
|
75
70
|
> ruby mybot.rb
|
|
76
71
|
|
|
77
|
-
WARNING
|
|
78
|
-
-------
|
|
72
|
+
## WARNING
|
|
79
73
|
|
|
80
74
|
When enabled, this plugin will output message sender and subject data to the
|
|
81
75
|
channel. Do not enable this plugin on bots that are connected to public
|
|
82
76
|
channels if your email data is something you consider to meant for your
|
|
83
77
|
eyes only.
|
|
84
78
|
|
|
85
|
-
TODO
|
|
86
|
-
----
|
|
79
|
+
## TODO
|
|
87
80
|
|
|
88
|
-
|
|
81
|
+
- Figure out how to auto-start this thing
|
data/lib/cinch/plugins/imap.rb
CHANGED
|
@@ -3,9 +3,10 @@ require 'net/imap'
|
|
|
3
3
|
module Cinch
|
|
4
4
|
module Plugins
|
|
5
5
|
class Imap
|
|
6
|
-
include Cinch::Plugin
|
|
7
6
|
|
|
8
|
-
|
|
7
|
+
PLUGIN_VERSION='0.0.7'
|
|
8
|
+
|
|
9
|
+
include Cinch::Plugin
|
|
9
10
|
|
|
10
11
|
match /monitor (on|off)/
|
|
11
12
|
match /monitor status/, method: :status
|
|
@@ -32,7 +33,7 @@ module Cinch
|
|
|
32
33
|
end
|
|
33
34
|
|
|
34
35
|
def about(m)
|
|
35
|
-
m.reply "Looks like I'm on #{
|
|
36
|
+
m.reply "Looks like I'm on #{PLUGIN_VERSION} #{m.user.nick}"
|
|
36
37
|
end
|
|
37
38
|
|
|
38
39
|
def interval (seconds)
|
metadata
CHANGED
|
@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
|
|
|
5
5
|
segments:
|
|
6
6
|
- 0
|
|
7
7
|
- 0
|
|
8
|
-
-
|
|
9
|
-
version: 0.0.
|
|
8
|
+
- 7
|
|
9
|
+
version: 0.0.7
|
|
10
10
|
platform: ruby
|
|
11
11
|
authors:
|
|
12
12
|
- windowsrefund
|
|
@@ -14,7 +14,7 @@ autorequire:
|
|
|
14
14
|
bindir: bin
|
|
15
15
|
cert_chain: []
|
|
16
16
|
|
|
17
|
-
date: 2011-02-
|
|
17
|
+
date: 2011-02-03 00:00:00 -05:00
|
|
18
18
|
default_executable:
|
|
19
19
|
dependencies:
|
|
20
20
|
- !ruby/object:Gem::Dependency
|
|
@@ -44,6 +44,7 @@ files:
|
|
|
44
44
|
- LICENSE
|
|
45
45
|
- gpl.txt
|
|
46
46
|
- README.md
|
|
47
|
+
- CHANGES.md
|
|
47
48
|
- lib/cinch/plugins/imap.rb
|
|
48
49
|
has_rdoc: true
|
|
49
50
|
homepage:
|