NAME

Bot::IRC::History - Bot::IRC selected channel history dumped to email

VERSION

version 1.14

SYNOPSIS

use Bot::IRC;

Bot::IRC->new(
    connect => { server => 'irc.perl.org' },
    plugins => ['History'],
    history => { filter => ['#perl'] },
)->run;

DESCRIPTION

This Bot::IRC plugin gives the bot the capability to dump channel chat history to an email.

The bot will only dump history from which the request originates. If you are currently in a channel, the bot will happily dump you anything from that channel's history, even prior to your joining. The idea here being that if you've got access to join a channel, you have access to that channel's history.

If you don't like this behavior, don't load this plugin.

Requesting History

To request channel history for the channel you're currently in:

bot history [DATE] [EMAIL]
bot history 01/Dec/2016 gryphon@example.com

The "date" is any partial date or date/time used in the Common Log Format (CLF). So to select everything from the hour of 11 AM:

bot history 01/Dec/2016:11 gryphon@example.com

You can also search for any particular string in the chat history of the channel:

bot history string gryphon@example.com

Filtering Channels

You can specify the channels to filter or disallow from history with vars, history, filter, which can be either a string or arrayref.

Bot::IRC->new(
    connect => { server => 'irc.perl.org' },
    plugins => ['History'],
    history => { filter => ['#perl'] },
)->run;

SEE ALSO

Bot::IRC

AUTHOR

Gryphon Shafer <gryphon@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Gryphon Shafer.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.