=encoding utf8 =head1 NAME Mail::Box::Search::Grep - select messages within a mail box like grep does =head1 INHERITANCE Mail::Box::Search::Grep is a Mail::Box::Search is a Mail::Reporter =head1 SYNOPSIS 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)) {...} =head1 DESCRIPTION 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 I is derived from the UNIX tool I, 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 L<"DESCRIPTION" in Mail::Box::Search|Mail::Box::Search/"DESCRIPTION">. =head1 METHODS Extends L<"METHODS" in Mail::Box::Search|Mail::Box::Search/"METHODS">. =head2 Constructors Extends L<"Constructors" in Mail::Box::Search|Mail::Box::Search/"Constructors">. =over 4 =item Mail::Box::Search::Grep-EB(%options) Create a UNIX-grep like search filter. -Option --Defined in --Default binaries Mail::Box::Search decode Mail::Box::Search delayed Mail::Box::Search deleted Mail::Box::Search 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 multiparts Mail::Box::Search trace Mail::Reporter 'WARNINGS' =over 2 =item binaries => BOOLEAN =item decode => BOOLEAN =item delayed => BOOLEAN =item deleted => BOOLEAN =item deliver => undef|CODE|'DELETE'|LABEL|'PRINT'|REF-ARRAY Store the details about where the match was found. The search may take much longer when this feature is enabled. 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 C, C, and C, where the field is a L object. When the match is in the body the hash will contain a C, C, C, and C. 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 C will call L or L 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. C 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. =item field => undef|STRING|REGEX|CODE Not valid in combination with C set to C. The STRING is one full field name (case-insensitive). Use a REGEX to select more than one header line to be scanned. CODE is a routine which is called for each field in the header. The CODE is called with the header as first, and the field as second argument. If the CODE returns true, the message is selected. =item in => 'HEAD'|'BODY'|'MESSAGE' =item label => STRING =item limit => NUMBER =item log => LEVEL =item logical => 'REPLACE'|'AND'|'OR'|'NOT'|'AND NOT'|'OR NOT' =item match => STRING|REGEX|CODE The pattern to be search for can be a REGular EXpression, or a STRING. In both cases, the match succeeds if it is found anywhere within the selected fields. 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 C<$head> resp C<$body> are one message's head resp. body object. The C<$field> is a header line which matches. The C<$line> and C<$linenr> tell the matching line in the body. Be warned that when you search in C the code must accept both formats. =item multiparts => BOOLEAN =item trace => LEVEL =back =back =head2 Searching Extends L<"Searching" in Mail::Box::Search|Mail::Box::Search/"Searching">. =over 4 =item $obj-EB($part, $body) Inherited, see L =item $obj-EB($part, $head) Inherited, see L =item $obj-EB($folder|$thread|$message|ARRAY) Inherited, see L =item $obj-EB($part) Inherited, see L =back =head2 The Results Extends L<"The Results" in Mail::Box::Search|Mail::Box::Search/"The Results">. =over 4 =item $obj-EB( [$fh], $match ) =item $obj-EB($fh, $match) =item $obj-EB($fh, $match) =back =head2 Error handling Extends L<"Error handling" in Mail::Box::Search|Mail::Box::Search/"Error handling">. =over 4 =item $obj-EB() Inherited, see L =item $obj-EB($object) Inherited, see L =item $obj-EB( [$level]|[$loglevel, $tracelevel]|[$level, $callback] ) =item Mail::Box::Search::Grep-EB( [$level]|[$loglevel, $tracelevel]|[$level, $callback] ) Inherited, see L =item $obj-EB() Inherited, see L =item $obj-EB( [$level, [$strings]] ) =item Mail::Box::Search::Grep-EB( [$level, [$strings]] ) Inherited, see L =item $obj-EB($level) =item Mail::Box::Search::Grep-EB($level) Inherited, see L =item $obj-EB() Inherited, see L =item $obj-EB() Inherited, see L =item $obj-EB( [$level] ) Inherited, see L =item $obj-EB( [$level] ) Inherited, see L =item $obj-EB( [$level] ) Inherited, see L =item $obj-EB() Inherited, see L =back =head2 Cleanup Extends L<"Cleanup" in Mail::Box::Search|Mail::Box::Search/"Cleanup">. =over 4 =item $obj-EB() Inherited, see L =back =head1 DIAGNOSTICS =over 4 =item Error: Package $package does not implement $method. Fatal error: the specific package (or one of its superclasses) does not implement this method where it should. This message means that some other related classes do implement this method however the class at hand does not. Probably you should investigate this and probably inform the author of the package. =back =head1 SEE ALSO This module is part of Mail-Box distribution version 3.009, built on August 18, 2020. Website: F =head1 LICENSE 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 F