schobes / imap-query Goto Github PK

NAME
    IMAP::Query - Build IMAP search queries!

VERSION
    Version 0.01

SYNOPSIS
    This module is for those of us that can't create Polish notation queries
    by hand, IMAP::Query can help you create them using a syntax inspired by
    other query builder modules such as SQL::Abstract.

        use IMAP::Query qw(build_search_string);

        my $query = build_search_string(
            BEFORE => strftime('%d-%b-%Y', localtime(parsedate('yesterday'))),
            NOT    => 'DELETED',
            -or    => [
                FROM => '[email protected]',
                -and => [
                    FROM    => '[email protected]',
                    SUBJECT => 'TESTING',
                ],
            ],
        );

        ... # Do something interesting with our $query

EXPORT
    A list of functions that can be exported. You can delete this section if
    you don't export anything, such as for a purely object-oriented module.

SUBROUTINES/METHODS
  build_search_string()
    This method can be exported via your use statement.

        use IMAP::Query qw(build_search_string);

    It takes two arguments.

        my $query = build_search_string($query, $operator);

    $query
        This option is requried. It is a HASHREF that contains all the items
        you want to include in your search string.

    $operator
        This argument is optional and defaults to 'AND'. You can use either
        'AND' or 'OR'.

AUTHOR
    Adam R. Schobelock, "<schobes at gmail.com>"

BUGS
    Please report any bugs or feature requests to "bug-imap-query at
    rt.cpan.org", or through the web interface at
    <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=IMAP-Query>. I will be
    notified, and then you'll automatically be notified of progress on your
    bug as I make changes.

SUPPORT
    You can find documentation for this module with the perldoc command.

        perldoc IMAP::Query

    You can also look for information at:

    *   RT: CPAN's request tracker (report bugs here)

        <http://rt.cpan.org/NoAuth/Bugs.html?Dist=IMAP-Query>

    *   AnnoCPAN: Annotated CPAN documentation

        <http://annocpan.org/dist/IMAP-Query>

    *   CPAN Ratings

        <http://cpanratings.perl.org/d/IMAP-Query>

    *   Search CPAN

        <http://search.cpan.org/dist/IMAP-Query/>

ACKNOWLEDGEMENTS
LICENSE AND COPYRIGHT
    Copyright 2015 Adam R. Schobelock.

    This program is free software; you can redistribute it and/or modify it
    under the terms of the the Artistic License (2.0). You may obtain a copy
    of the full license at:

    <http://www.perlfoundation.org/artistic_license_2_0>

    Any use, modification, and distribution of the Standard or Modified
    Versions is governed by this Artistic License. By using, modifying or
    distributing the Package, you accept this license. Do not use, modify,
    or distribute the Package, if you do not accept this license.

    If your Modified Version has been derived from a Modified Version made
    by someone other than you, you are nevertheless required to ensure that
    your Modified Version complies with the requirements of this license.

    This license does not grant you the right to use any trademark, service
    mark, tradename, or logo of the Copyright Holder.

    This license includes the non-exclusive, worldwide, free-of-charge
    patent license to make, have made, use, offer to sell, sell, import and
    otherwise transfer the Package with respect to any patent claims
    licensable by the Copyright Holder that are necessarily infringed by the
    Package. If you institute patent litigation (including a cross-claim or
    counterclaim) against any party alleging that the Package constitutes
    direct or contributory patent infringement, then this Artistic License
    to you shall terminate on the date that such litigation is filed.

    Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
    AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
    THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
    PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY
    YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
    CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
    CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
    EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.