METHODS

See METHODS in Mail::Reporter

Constructors

$class->new( %options )

Create a filter.

Option Defined in Default

binaries

<false>

decode

<true>

delayed

<true>

deleted

<false>

deliver

undef

in

'BODY'

label

undef

limit

0

log

Mail::Reporter

'WARNINGS'

logical

'REPLACE'

multiparts

<true>

trace

Mail::Reporter

'WARNINGS'

binaries => BOOLEAN
Whether to include binary bodies in the search.
decode => BOOLEAN
Decode the messages before the search takes place. Even plain text messages can be encoded, for instance as quoted-printable, which may disturb the results. However, decoding will slow-down the search.
delayed => BOOLEAN
Include the delayed messages (which will be parsed) in the search. If you set this to false, you may find fewer hits.
deleted => BOOLEAN
In most cases, you will not be interested in results which are found in messages flagged to be deleted. However, with this option you can specify you want them to be searched too.
deliver => undef|CODE|'DELETE'
The exact functionality of this parameter differs per search method, so read the applicable man-page. In any case undef means that details are not collected for this search, which is the fastest search.
DELETE will flag the message to be flagged for deletion. You may also specify your own CODE reference. With an reference to an array, the information about the matches is collected as a list of hashes, one hash per match.
in => 'HEAD'|'BODY'|'MESSAGE'
Where to look for the match.
label => STRING
Mark all selected messages with the specified STRING. If this field is not specified, the message will not get a label; search() also returns a list of selected messages.
limit => NUMBER
Limit the search to the specified NUMBER of messages. When the NUMBER is positive, the search starts at the first message in the folder or thread. A negative NUMBER starts at the end of the folder. If the limit is set to zero, there is no limit.
log => LEVEL
logical => 'REPLACE'|'AND'|'OR'|'NOT'|'AND NOT'|'OR NOT'
Only applicable in combination with a label. How to handle the existing labels. In case of REPLACE, messages which already are carrying the label are stripped from their selection (unless they match again). With AND, the message must be selected by this search and already carry the label, otherwise the label will not be set. Specify OR to have newly selected messages added to the set of already selected messages.
NOT is true for messages which do not fulfil the search. The details output will still contain the places where the match was found, however those messages will complementary set of messages will be labeled and returned.
multiparts => BOOLEAN
Are multiparts to be included in the search results? Some MUA have problems handling details received from the search. When this flag is turned off, the body of multiparts will be ignored. The parts search will include the preamble and epilogue.
trace => LEVEL
» Error: Cannot search in body.

Th search object does not implement inBody(), and can therefore not search a message body.

» Error: Cannot search in header.

Th search object does not implement inHead(), and can therefore not search a message header.

» Error: Don't know how to deliver via results in $way.

The search results cannot be delivered in the specific way, because that is not a defined alternative.

» Error: Search in BODY, HEAD or MESSAGE not $in.

The in option defines only three names.

Searching

$obj->inBody( $part, $body )

Tests whether body contains the requesting information. See the specific search module for its parameters.

$obj->inHead( $part, $head )

Tests whether header contains the requesting information. See the specific search module for its parameters.

$obj->searchPart( $part )

Search this message $part for matches.

The Results

$obj->printMatch( [$fh], HASH )

Print the information about the match (see new(deliver)) in some understandable way. If no file handle is specified, the output will go to the selected filehandle (see perldoc -f select).

Error handling

$obj->AUTOLOAD
See AUTOLOAD in Mail::Reporter.
$obj->addReport( $object )
See addReport in Mail::Reporter.
$obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
$class->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
See defaultTrace in Mail::Reporter.
$obj->errors
See errors in Mail::Reporter.
$obj->log( [$level, [$strings]] )
$class->log( [$level, [$strings]] )
See log in Mail::Reporter.
$obj->logPriority( $level )
$class->logPriority( $level )
See logPriority in Mail::Reporter.
$obj->logSettings
See logSettings in Mail::Reporter.
$obj->notImplemented
See notImplemented in Mail::Reporter.
$obj->report( [$level] )
See report in Mail::Reporter.
$obj->reportAll( [$level] )
See reportAll in Mail::Reporter.
$obj->trace( [$level] )
See trace in Mail::Reporter.
$obj->warnings
See warnings in Mail::Reporter.

Cleanup

$obj->DESTROY
See DESTROY in Mail::Reporter.