App::grep::email - Print lines having email address(es) (optionally of certain criteria) in them
This document describes version 0.001 of App::grep::email (from Perl distribution App-grep-email), released on 2021-08-02.
Usage:
grep_email(%args) -> [$status_code, $reason, $payload, \%result_meta]
Print lines having email address(es) (optionally of certain criteria) in them.
This is a grep-like utility that greps for emails of certain criteria.
This function is not exported.
Arguments ('*' denotes required arguments):
address_contains => str
address_matches => re
address_not_contains => str
color => str (default: "auto")
comment_contains => str
comment_matches => re
comment_not_contains => str
count => true
Supress normal output, return a count of matching lines.
files => array[filename]
host_contains => str
host_matches => re
host_not_contains => str
ignore_case => bool
invert_match => bool
Invert the sense of matching.
line_number => true
max_emails => int (default: -1)
min_emails => uint (default: 1)
name_contains => str
name_matches => re
name_not_contains => str
quiet => true
user_contains => str
user_matches => re
user_not_contains => str
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.
Return value: (any)
Please visit the project's homepage at https://metacpan.org/release/App-grep-email.
Source repository is at https://github.com/perlancar/perl-App-grep-email.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-grep-email
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2021 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install App::grep::email, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::grep::email
CPAN shell
perl -MCPAN -e shell install App::grep::email
For more information on module installation, please visit the detailed CPAN module installation guide.