The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Bot-IRC-1.27
River stage two • 10 direct dependents • 10 total dependents
2 ++
/ Bot::IRC::History

NAME

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

VERSION

version 1.27

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 on DATE EMAIL
    bot history from DATE to DATE EMAIL
    bot history matching STRING EMAIL

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) 2021 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.