cinch-imap 0.0.5 → 0.0.6

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.
Files changed (2) hide show
  1. data/README.md +48 -50
  2. metadata +2 -2
data/README.md CHANGED
@@ -1,80 +1,78 @@
1
+ " vim:nu:ai:si:et:ts=2:sw=2
1
2
  Cinch-Imap
2
3
  ==========
3
4
  The Cinch Imap Plugin. Poll an IMAP mailbox at a defined interval.
4
5
 
5
6
  Change Log
6
7
  ----------
8
+ 0.0.6
9
+ * documentation improvements
7
10
  0.0.5
8
- - bug fixes
9
-
11
+ * bug fixes
10
12
  0.0.4
11
- - Added from_rewrites configuration option
12
- - Added !monitor showconfig command
13
- - Added !monitor version command
14
-
13
+ * from_rewrites configuration option added
14
+ * !monitor showconfig command added
15
15
  0.0.3
16
- -------
17
- - Added configurable prefix based on subject match.
18
- - Moved "mark messages read" to a configurable option.
16
+ * Added configurable prefix based on subject match.
17
+ * Moved "mark messages read" to a configurable option.
19
18
 
20
19
  Required Configuration
21
20
  ----------------------
22
21
 
23
- :host - The IMAP server
24
- :user - The user id
25
- :password - The password
22
+ * :host - The IMAP server
23
+ * :user - The user id
24
+ * :password - The password
26
25
 
27
26
  Optional Configuration
28
27
  ----------------------
29
28
 
30
- :port - The IMAP port. Default to 143.
31
- :ssl - Use ssl? Default is false.
32
- :interval - Number of seconds between polling. Default is 300.
33
- :mark_as_read - Sets the IMAP :Seen flag on polled messages. Default is true.
29
+ * :port - The IMAP port. Default to 143.
30
+ * :ssl - Use ssl? Default is false.
31
+ * :interval - Number of seconds between polling. Default is 300.
32
+ * :mark_as_read - Sets the IMAP :Seen flag on polled messages. Default is true.
34
33
 
35
34
  Commands
36
35
  --------
37
36
 
38
- !monitor on/off - Enable/Disable IMAP polling
39
- !monitor status - Issues a status report to the channel
40
- !monitor clear - Resets the number of "messages seen" to 0
41
- !monitor interval [n] - Set polling interval to n second
42
- !monitor showconfig - shows all config options other than password
37
+ * !monitor on/off - Enable/Disable IMAP polling
38
+ * !monitor status - Issues a status report to the channel
39
+ * !monitor clear - Resets the number of "messages seen" to 0
40
+ * !monitor interval [n] - Set polling interval to n second
41
+ * !monitor showconfig - shows all config options other than password
43
42
 
44
43
  Example Configuration
45
44
  ---------------------
46
45
 
47
- # mybot.rb
48
- require 'cinch'
49
- require 'cinch/plugins/imap'
50
-
51
- bot = Cinch::Bot.new do
52
- configure do |c|
53
- c.server = "my.ircserver.tld"
54
- c.nick = "cinch"
55
- c.channels = ["#mychannel"]
56
- c.plugins.plugins = [Cinch::Plugins::Imap]
57
- c.plugins.options[Cinch::Plugins::Imap] = {
58
- :host => 'my.imapserver.tld',
59
- :user => 'me@fqdn.tld',
60
- :password => "l3tm3out",
61
- :port => 993,
62
- :ssl => true,
63
- :subject_matches => {'ERROR' => '!!', 'SUCCESS' => '..'},
64
- :from_rewrites => {
65
- 'this@suchalong.silly.address' => 'foo',
66
- 'another@address.that.bugs.me' => 'bugger',
67
- },
68
- }
69
- end
70
-
71
- end
72
-
73
- bot.start
46
+ > # mybot.rb
47
+ > require 'cinch'
48
+ > require 'cinch/plugins/imap'
49
+ >
50
+ > bot = Cinch::Bot.new do
51
+ > configure do |c|
52
+ > c.server = "my.ircserver.tld"
53
+ > c.nick = "cinch"
54
+ > c.channels = ["#mychannel"]
55
+ > c.plugins.plugins = [Cinch::Plugins::Imap]
56
+ > c.plugins.options[Cinch::Plugins::Imap] = {
57
+ > :host => 'my.imapserver.tld',
58
+ > :user => 'me@fqdn.tld',
59
+ > :password => "l3tm3out",
60
+ > :port => 993,
61
+ > :ssl => true,
62
+ > :subject_matches => {'ERROR' => '!!', 'SUCCESS' => '..'},
63
+ > :from_rewrites => {
64
+ > 'this@suchalong.silly.address' => 'foo',
65
+ > 'another@address.that.bugs.me' => 'bugger',
66
+ > },
67
+ > }
68
+ > end
69
+ > end
70
+ >
71
+ > bot.start
74
72
 
75
73
  Now, run your bot.
76
74
 
77
- ruby mybot.rb
75
+ > ruby mybot.rb
78
76
 
79
77
  WARNING
80
78
  -------
@@ -87,4 +85,4 @@ eyes only.
87
85
  TODO
88
86
  ----
89
87
 
90
- - Figure out how to auto-start this thing
88
+ * Figure out how to auto-start this thing
metadata CHANGED
@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
5
5
  segments:
6
6
  - 0
7
7
  - 0
8
- - 5
9
- version: 0.0.5
8
+ - 6
9
+ version: 0.0.6
10
10
  platform: ruby
11
11
  authors:
12
12
  - windowsrefund