Mail::Server::IMAP4::Search(3pm)

1Mail::Server::IMAP4::SeUasrecrh(C3o)ntributed Perl DocumMeanitla:t:iSoenrver::IMAP4::Search(3)
2
3
4

NAME

6       Mail::Server::IMAP4::Search - select messages within a IMAP folder (not
7       completed)
8

INHERITANCE

10        Mail::Server::IMAP4::Search
11          is a Mail::Box::Search
12          is a Mail::Reporter
13

SYNOPSIS

15        use Mail::Box::Manager;
16        my $mgr    = Mail::Box::Manager->new;
17        my $folder = $mgr->open('imap4:Inbox');
18
19        my $filter = Mail::Server::IMAP4::Search->new
20           (  ...to be defined...
21           );
22
23        my @msgs   = $filter->search($folder);
24        if($filter->search($message)) {...}
25

DESCRIPTION

27       THIS PACKAGES IS NOT IMPLEMENTED YET...  (it's waiting for a volunteer)
28
29       Extends "DESCRIPTION" in Mail::Box::Search.
30

METHODS

32       Extends "METHODS" in Mail::Box::Search.
33
34   Constructors
35       Extends "Constructors" in Mail::Box::Search.
36
37       Mail::Server::IMAP4::Search->new(%options)
38            -Option    --Defined in       --Default
39             binaries    Mail::Box::Search  <false>
40             decode      Mail::Box::Search  <true>
41             delayed     Mail::Box::Search  <true>
42             deleted     Mail::Box::Search  <false>
43             deliver     Mail::Box::Search  undef
44             in          Mail::Box::Search  'BODY'
45             label       Mail::Box::Search  undef
46             limit       Mail::Box::Search  0
47             log         Mail::Reporter     'WARNINGS'
48             logical     Mail::Box::Search  'REPLACE'
49             multiparts  Mail::Box::Search  <true>
50             trace       Mail::Reporter     'WARNINGS'
51
52           binaries => BOOLEAN
53           decode => BOOLEAN
54           delayed => BOOLEAN
55           deleted => BOOLEAN
56           deliver => undef|CODE|'DELETE'
57           in => 'HEAD'|'BODY'|'MESSAGE'
58           label => STRING
59           limit => NUMBER
60           log => LEVEL
61           logical => 'REPLACE'|'AND'|'OR'|'NOT'|'AND NOT'|'OR NOT'
62           multiparts => BOOLEAN
63           trace => LEVEL
64
65   Searching
66       Extends "Searching" in Mail::Box::Search.
67
68       $obj->inBody($part, $body)
69           Inherited, see "Searching" in Mail::Box::Search
70
71       $obj->inHead($part, $head)
72           Inherited, see "Searching" in Mail::Box::Search
73
74       $obj->search($folder|$thread|$message|ARRAY)
75           Inherited, see "Searching" in Mail::Box::Search
76
77       $obj->searchPart($part)
78           Inherited, see "Searching" in Mail::Box::Search
79
80   The Results
81       Extends "The Results" in Mail::Box::Search.
82
83       $obj->printMatch( [$fh], HASH )
84           Inherited, see "The Results" in Mail::Box::Search
85
86   Error handling
87       Extends "Error handling" in Mail::Box::Search.
88
89       $obj->AUTOLOAD()
90           Inherited, see "Error handling" in Mail::Reporter
91
92       $obj->addReport($object)
93           Inherited, see "Error handling" in Mail::Reporter
94
95       $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,
96       $callback] )
97       Mail::Server::IMAP4::Search->defaultTrace( [$level]|[$loglevel,
98       $tracelevel]|[$level, $callback] )
99           Inherited, see "Error handling" in Mail::Reporter
100
101       $obj->errors()
102           Inherited, see "Error handling" in Mail::Reporter
103
104       $obj->log( [$level, [$strings]] )
105       Mail::Server::IMAP4::Search->log( [$level, [$strings]] )
106           Inherited, see "Error handling" in Mail::Reporter
107
108       $obj->logPriority($level)
109       Mail::Server::IMAP4::Search->logPriority($level)
110           Inherited, see "Error handling" in Mail::Reporter
111
112       $obj->logSettings()
113           Inherited, see "Error handling" in Mail::Reporter
114
115       $obj->notImplemented()
116           Inherited, see "Error handling" in Mail::Reporter
117
118       $obj->report( [$level] )
119           Inherited, see "Error handling" in Mail::Reporter
120
121       $obj->reportAll( [$level] )
122           Inherited, see "Error handling" in Mail::Reporter
123
124       $obj->trace( [$level] )
125           Inherited, see "Error handling" in Mail::Reporter
126
127       $obj->warnings()
128           Inherited, see "Error handling" in Mail::Reporter
129
130   Cleanup
131       Extends "Cleanup" in Mail::Box::Search.
132
133       $obj->DESTROY()
134           Inherited, see "Cleanup" in Mail::Reporter
135

DIAGNOSTICS

137       Error: Package $package does not implement $method.
138           Fatal error: the specific package (or one of its superclasses) does
139           not implement this method where it should. This message means that
140           some other related classes do implement this method however the
141           class at hand does not.  Probably you should investigate this and
142           probably inform the author of the package.
143

LICENSE

149       Copyrights 2001-2019 by [Mark Overmeer]. For other contributors see
150       ChangeLog.
151
152       This program is free software; you can redistribute it and/or modify it
153       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
154
155
156
157perl v5.36.0                      2023-01-20    Mail::Server::IMAP4::Search(3)