| Mail::Box::Search::Grep(3pm) | User Contributed Perl Documentation | Mail::Box::Search::Grep(3pm) |
Mail::Box::Search::Grep - select messages within a mail box like grep does
Mail::Box::Search::Grep is a Mail::Box::Search is a Mail::Reporter
use Mail::Box::Manager;
my $mgr = Mail::Box::Manager->new;
my $folder = $mgr->open('Inbox');
my $filter = Mail::Box::Search::Grep->new
( label => 'selected'
, in => 'BODY', match => qr/abc?d*e/
);
my @msgs = $filter->search($folder);
my $filter = Mail::Box::Search::Grep->new
( field => 'To'
, match => $my_email
);
if($filter->search($message)) {...}
Try to find some text strings in the header and footer of messages. Various ways to limit the search to certain header fields, the whole header, only the body, the whole message, but even binary multiparts, are provided for.
The name grep is derived from the UNIX tool grep, which means: "Get Regular Expression and Print". Although you can search using regular expressions (the Perl way of them), you do not have to print those as result.
Extends "DESCRIPTION" in Mail::Box::Search.
Extends "METHODS" in Mail::Box::Search.
Extends "Constructors" in Mail::Box::Search.
-Option --Defined in --Default
binaries Mail::Box::Search <false>
decode Mail::Box::Search <true>
delayed Mail::Box::Search <true>
deleted Mail::Box::Search <false>
deliver undef
field undef
in Mail::Box::Search <$field ? 'HEAD' : C<'BODY'>>
label Mail::Box::Search undef
limit Mail::Box::Search 0
log Mail::Reporter 'WARNINGS'
logical Mail::Box::Search 'REPLACE'
match <required>
multiparts Mail::Box::Search <true>
trace Mail::Reporter 'WARNINGS'
When an ARRAY is specified it will contain a list of references to hashes. Each hash contains the information of one match. A match in a header line will result in a line with fields "message", "part", and "field", where the field is a Mail::Message::Field object. When the match is in the body the hash will contain a "message", "part", "linenr", and "line".
In case of a CODE reference, that routine is called for each match. The first argument is this search object and the second a reference to same hash as would be stored in the array.
The "PRINT" will call printMatchedHead() or printMatchedBody() when any matching header resp body line was found. The output is minimized by not reprinting the message info on multiple matches in the same message.
"DELETE" will flag the message to be deleted in case of a match. When a multipart's part is matched, the whole message will be flagged for deletion.
With a CODE reference, that function will be called each field or body-line. When the result is true, the details are delivered. The call formats are
$code->($head, $field); # for HEAD searches
$code->($body, $linenr, $line); # for BODY searches
The $head resp $body are one message's head resp. body object. The $field is a header line which matches. The $line and $linenr tell the matching line in the body.
Be warned that when you search in "MESSAGE" the code must accept both formats.
Extends "Searching" in Mail::Box::Search.
Extends "The Results" in Mail::Box::Search.
Extends "Error handling" in Mail::Box::Search.
Extends "Cleanup" in Mail::Box::Search.
This module is part of Mail-Box distribution version 3.009, built on August 18, 2020. Website: http://perl.overmeer.net/CPAN/
Copyrights 2001-2020 by [Mark Overmeer]. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://dev.perl.org/licenses/
| 2020-08-20 | perl v5.30.3 |