1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
|
=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<grep> is derived from the UNIX tool I<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.
=head1 METHODS
=head2 Constructors
Mail::Box::Search::Grep-E<gt>B<new>(OPTIONS)
=over 4
Create a UNIX-grep like search filter.
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'
. binaries BOOLEAN
. decode BOOLEAN
. delayed BOOLEAN
. deleted BOOLEAN
. deliver undef|CODE|'DELETE'|LABEL|'PRINT'|REF-ARRAY
=over 4
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<message>, C<part>, and C<field>, where
the field is a L<Mail::Message::Field|Mail::Message::Field> object. When the match is in
the body the hash will contain a C<message>, C<part>, C<linenr>, and C<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 C<PRINT> will call L<printMatchedHead()|Mail::Box::Search::Grep/"The Results"> or L<printMatchedBody()|Mail::Box::Search::Grep/"The Results"> 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<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.
=back
. field undef|STRING|REGEX|CODE
=over 4
Not valid in combination with C<in> set to C<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.
=back
. in 'HEAD'|'BODY'|'MESSAGE'
. label STRING
. limit NUMBER
. log LEVEL
. logical 'REPLACE'|'AND'|'OR'|'NOT'|'AND NOT'|'OR NOT'
. match STRING|REGEX|CODE
=over 4
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<MESSAGE> the code must accept
both formats.
=back
. multiparts BOOLEAN
. trace LEVEL
=back
=head2 Searching
$obj-E<gt>B<inBody>(PART, BODY)
=over 4
See L<Mail::Box::Search/"Searching">
=back
$obj-E<gt>B<inHead>(PART, HEAD)
=over 4
See L<Mail::Box::Search/"Searching">
=back
$obj-E<gt>B<search>(FOLDER|THREAD|MESSAGE|ARRAY-OF-MESSAGES)
=over 4
See L<Mail::Box::Search/"Searching">
=back
$obj-E<gt>B<searchPart>(PART)
=over 4
See L<Mail::Box::Search/"Searching">
=back
=head2 The Results
$obj-E<gt>B<printMatch>([FILEHANDLE], HASH)
=over 4
See L<Mail::Box::Search/"The Results">
=back
$obj-E<gt>B<printMatchedBody>(FILEHANDLE, MATCH)
=over 4
=back
$obj-E<gt>B<printMatchedHead>(FILEHANDLE, MATCH)
=over 4
=back
=head2 Error handling
$obj-E<gt>B<AUTOLOAD>
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<addReport>(OBJECT)
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Box::Search::Grep-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<errors>
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<log>([LEVEL [,STRINGS]])
Mail::Box::Search::Grep-E<gt>B<log>([LEVEL [,STRINGS]])
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<logPriority>(LEVEL)
Mail::Box::Search::Grep-E<gt>B<logPriority>(LEVEL)
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<logSettings>
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<notImplemented>
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<report>([LEVEL])
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<reportAll>([LEVEL])
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<trace>([LEVEL])
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<warnings>
=over 4
See L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
$obj-E<gt>B<DESTROY>
=over 4
See L<Mail::Reporter/"Cleanup">
=back
$obj-E<gt>B<inGlobalDestruction>
=over 4
See L<Mail::Reporter/"Cleanup">
=back
=head1 DIAGNOSTICS
I<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.
=head1 REFERENCES
See the MailBox website at L<http://perl.overmeer.net/mailbox/> for more details.
=head1 COPYRIGHTS
Distribution version 2.068.
Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for
other contributors.
Copyright (c) 2001-2006 by the author(s). All rights reserved.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
|
