Create a UNIX-grep like search filter.
- binaries => BOOLEAN
- decode => BOOLEAN
- delayed => BOOLEAN
- deleted => BOOLEAN
- 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 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.
- field => undef|STRING|REGEX|CODE
- Not valid in combination with
in
set to BODY
.
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.
- in => 'HEAD'|'BODY'|'MESSAGE'
- label => STRING
- limit => NUMBER
- log => LEVEL
- logical => 'REPLACE'|'AND'|'OR'|'NOT'|'AND NOT'|'OR NOT'
- 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 $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.
- multiparts => BOOLEAN
- trace => LEVEL