cinch-imap

The Cinch Imap Plugin. Poll an IMAP mailbox at a defined interval.

$ gem install cinch-imap

#####:host The IMAP server

The user id

The password

The IMAP port. Default is 143.

Use SSL? Default is false.

Number of seconds between polling. Default is 300.

Sets the IMAP :Seen flag on polled messages. Default is true.

The bot will start polling when it joins the channel

Enable/disable IMAP polling

!monitor on/off/start/stop

Display status information to the channel

!monitor show status

Reset the number of messages seen to 0

!monitor clear

Set polling interval in seconds. Default is 300.

!monitor interval [n]

Display plugin configuration. The password attribute is skipped.

!monitor show config

Poll the IMAP mailbox

!monitor test

mybot.rb

require 'cinch'
require 'cinch/plugins/imap'

bot = Cinch::Bot.new do
  configure do |c|
    c.server           = "my.ircserver.tld"
    c.nick             = "cinch"
    c.channels         = ["#mychannel"]
    c.plugins.plugins  = [Imap]
 		c.plugins.options[Imap] = {
    	:autostart => true,
   		:host => 'my.imapserver.tld',
      :user => 'me@fqdn.tld',
      :password => "l3tm3out",
      :port => 993,
      :ssl => true,
      :subject_matches => {'ERROR' => '!!', 'SUCCESS' => '..'},
      :from_rewrites => {
        'this@suchalong.silly.address' => 'foo',
        'another@address.that.bugs.me' => 'bugger',
      },	
    }
  end
end

bot.start

Now, run your bot.

$ ruby mybot.rb

When enabled, this plugin will output message sender and subject data to the channel. Do not enable this plugin on bots that are connected to public channels if your email data is something you consider to meant for your eyes only.

The reporting is hardcoded (see the count_database stuff). One day, I'll break this out into something configurable.