1Mail::Message::Head::PaUrsteiralC(o3n)tributed Perl DocuMmaeinlt:a:tMieosnsage::Head::Partial(3)
2
6 Mail::Message::Head::Partial - subset of header information of a
7 message
8
10 Mail::Message::Head::Partial
11 is a Mail::Message::Head::Complete
12 is a Mail::Message::Head
13 is a Mail::Reporter
14
16 my $partial = $head->strip;
17 $partial->isa('Mail::Message::Head') # true
18 $partial->isDelayed # false
19 $partial->isPartial # true
20 $partial->removeFields( qr/^X-/ );
22 $partial->removeFieldsExcept( qw/To From/ );
23 $partial->removeResentGroups;
24 $partial->removeListGroup;
25 $partial->removeSpamGroups;
26
28 Header information consumes a considerable amount of memory. Most of
29 this information is only useful during a short period of time in your
30 program, or sometimes it is not used at all. You then can decide to
31 remove most of the header information. However, be warned that it will
32 be lost permanently: the header (and therefore the message) gets
33 mutulated!
34
36 overload: ""
37 See "OVERLOADED" in Mail::Message::Head
38 overload: bool
40 See "OVERLOADED" in Mail::Message::Head
41
43 Constructors
44 $obj->build([PAIR|FIELD]-LIST)
45 See "Constructors" in Mail::Message::Head::Complete
46 $obj->clone([NAMES|ARRAY-OF-NAMES|REGEXS])
48 See "Constructors" in Mail::Message::Head::Complete
49 Mail::Message::Head::Partial->new(OPTIONS)
51 See "Constructors" in Mail::Message::Head
52 The header
54 $obj->isDelayed
55 See "The header" in Mail::Message::Head
56 $obj->isEmpty
58 See "The header" in Mail::Message::Head
59 $obj->isModified
61 See "The header" in Mail::Message::Head
62 $obj->knownNames
64 See "The header" in Mail::Message::Head
65 $obj->message([MESSAGE])
67 See "The header" in Mail::Message::Head
68 $obj->modified([BOOLEAN])
70 See "The header" in Mail::Message::Head
71 $obj->nrLines
73 See "The header" in Mail::Message::Head::Complete
74 $obj->orderedFields
76 See "The header" in Mail::Message::Head
77 $obj->size
79 See "The header" in Mail::Message::Head::Complete
80 $obj->wrap(INTEGER)
82 See "The header" in Mail::Message::Head::Complete
83 Access to the header
85 $obj->add(FIELD | LINE | (NAME,BODY[,ATTRS]))
86 See "Access to the header" in Mail::Message::Head::Complete
87 $obj->addListGroup(OBJECT)
89 See "Access to the header" in Mail::Message::Head::Complete
90 $obj->addResentGroup(RESENT-GROUP|DATA)
92 See "Access to the header" in Mail::Message::Head::Complete
93 $obj->addSpamGroup(OBJECT)
95 See "Access to the header" in Mail::Message::Head::Complete
96 $obj->cleanupOrderedFields
98 The header maintains a list of fields which are ordered in sequence
99 of definition. It is required to maintain the header order to keep
100 the related fields of resent groups together. The fields are also
101 included in a hash, sorted on their name for fast access.
102 The references to field objects in the hash are real, those in the
104 ordered list are weak. So when field objects are removed from the
105 hash, their references in the ordered list are automagically
106 undef'd.
107 When many fields are removed, for instance with removeFields() or
109 removeFieldsExcept(), then it is useful to remove the list of
110 undefs from the ordered list as well. In those cases, this method
111 is called automatically, however you may have your own reasons to
112 call this method.
113 $obj->count(NAME)
115 See "Access to the header" in Mail::Message::Head::Complete
116 $obj->delete(NAME)
118 See "Access to the header" in Mail::Message::Head::Complete
119 $obj->get(NAME [,INDEX])
121 See "Access to the header" in Mail::Message::Head
122 $obj->grepNames([NAMES|ARRAY-OF-NAMES|REGEXS])
124 See "Access to the header" in Mail::Message::Head::Complete
125 $obj->listGroup
127 See "Access to the header" in Mail::Message::Head::Complete
128 $obj->names
130 See "Access to the header" in Mail::Message::Head::Complete
131 $obj->print([FILEHANDLE])
133 See "Access to the header" in Mail::Message::Head::Complete
134 $obj->printSelected(FILEHANDLE, (STRING|REGEXP)s)
136 See "Access to the header" in Mail::Message::Head::Complete
137 $obj->printUndisclosed([FILEHANDLE])
139 See "Access to the header" in Mail::Message::Head::Complete
140 $obj->removeContentInfo
142 See "Access to the header" in Mail::Message::Head::Complete
143 $obj->removeField(FIELD)
145 See "Access to the header" in Mail::Message::Head::Complete
146 $obj->removeFields(STRING|REGEXP, [STRING|REGEXP, ...])
148 Remove the fields from the header which are exactly named 'STRING'
149 (case insensitive) or match the REGular EXPresssion. Do not forget
150 to add the 'i' modifier to the REGEXP, because fields are case
151 insensitive.
152 See also removeField() which is used to remove one field object
154 from the header. The reverse specification can be made with
155 "removeFieldsExcept()".
156 example:
158 $head->removeFields('bcc', 'received');
160 $head->removeFields( qr/^content-/i );
161 $obj->removeFieldsExcept(STRING|REGEXP, [STRING|REGEXP, ...])
163 Remove all fields from the header which are not equivalent to one
164 of the specified STRINGs (case-insensitive) and which are not
165 matching one of the REGular EXPressions. Do not forget to add the
166 'i' modifier to the REGEXP, because fields are case insensitive.
167 See also removeField() which is used to remove one field object
169 from the header. The reverse specification can be made with
170 "removeFields()".
171 example:
173 $head->removeFieldsExcept('subject', qr/^content-/i );
175 $head->removeFieldsExcept( qw/subject to from sender cc/ );
176 $obj->removeListGroup
178 Removes all header lines which are used to administer mailing
179 lists. Which fields that are is explained in
180 Mail::Message::Head::ListGroup. Returned is the number of removed
181 lines.
182 $obj->removeResentGroups
184 Removes all header lines which are member of a resent group, which
185 are explained in Mail::Message::Head::ResentGroup. Returned is the
186 number of removed lines.
187 For removing single groups (for instance because you want to keep
189 the last), use Mail::Message::Head::FieldGroup::delete().
190 $obj->removeSpamGroups
192 Removes all header lines which were produced by spam detection and
193 spam-fighting software. Which fields that are is explained in
194 Mail::Message::Head::SpamGroup. Returned is the number of removed
195 lines.
196 $obj->resentGroups
198 See "Access to the header" in Mail::Message::Head::Complete
199 $obj->reset(NAME, FIELDS)
201 See "Access to the header" in Mail::Message::Head::Complete
202 $obj->set(FIELD | LINE | (NAME, BODY [,ATTRS]))
204 See "Access to the header" in Mail::Message::Head::Complete
205 $obj->spamDetected
207 See "Access to the header" in Mail::Message::Head::Complete
208 $obj->spamGroups([NAMES])
210 See "Access to the header" in Mail::Message::Head::Complete
211 $obj->string
213 See "Access to the header" in Mail::Message::Head::Complete
214 $obj->study(NAME [,INDEX])
216 See "Access to the header" in Mail::Message::Head
217 About the body
219 $obj->guessBodySize
220 See "About the body" in Mail::Message::Head
221 $obj->guessTimeStamp
223 See "About the body" in Mail::Message::Head::Complete
224 $obj->isMultipart
226 See "About the body" in Mail::Message::Head
227 $obj->recvstamp
229 See "About the body" in Mail::Message::Head::Complete
230 $obj->timestamp
232 See "About the body" in Mail::Message::Head::Complete
233 Internals
235 $obj->addNoRealize(FIELD)
236 See "Internals" in Mail::Message::Head
237 $obj->addOrderedFields(FIELDS)
239 See "Internals" in Mail::Message::Head
240 $obj->createFromLine
242 See "Internals" in Mail::Message::Head::Complete
243 $obj->createMessageId
245 See "Internals" in Mail::Message::Head::Complete
246 $obj->fileLocation
248 See "Internals" in Mail::Message::Head
249 $obj->load
251 See "Internals" in Mail::Message::Head
252 $obj->messageIdPrefix([PREFIX, [HOSTNAME]|CODE])
254 Mail::Message::Head::Partial->messageIdPrefix([PREFIX,
255 [HOSTNAME]|CODE])
256 See "Internals" in Mail::Message::Head::Complete
258 $obj->moveLocation(DISTANCE)
260 See "Internals" in Mail::Message::Head
261 $obj->read(PARSER)
263 See "Internals" in Mail::Message::Head
264 $obj->setNoRealize(FIELD)
266 See "Internals" in Mail::Message::Head
267 Error handling
269 $obj->AUTOLOAD
270 See "Error handling" in Mail::Reporter
271 $obj->addReport(OBJECT)
273 See "Error handling" in Mail::Reporter
274 $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
276 Mail::Message::Head::Partial->defaultTrace([LEVEL]|[LOGLEVEL,
277 TRACELEVEL]|[LEVEL, CALLBACK])
278 See "Error handling" in Mail::Reporter
280 $obj->errors
282 See "Error handling" in Mail::Reporter
283 $obj->log([LEVEL [,STRINGS]])
285 Mail::Message::Head::Partial->log([LEVEL [,STRINGS]])
286 See "Error handling" in Mail::Reporter
288 $obj->logPriority(LEVEL)
290 Mail::Message::Head::Partial->logPriority(LEVEL)
291 See "Error handling" in Mail::Reporter
293 $obj->logSettings
295 See "Error handling" in Mail::Reporter
296 $obj->notImplemented
298 See "Error handling" in Mail::Reporter
299 $obj->report([LEVEL])
301 See "Error handling" in Mail::Reporter
302 $obj->reportAll([LEVEL])
304 See "Error handling" in Mail::Reporter
305 $obj->trace([LEVEL])
307 See "Error handling" in Mail::Reporter
308 $obj->warnings
310 See "Error handling" in Mail::Reporter
311 Cleanup
313 $obj->DESTROY
314 See "Cleanup" in Mail::Reporter
315 $obj->inGlobalDestruction
317 See "Cleanup" in Mail::Reporter
318
320 Ordered header fields
321 Head class implementation
322 Subsets of header fields
323 Reducing the header size
324 A message header is very large in memory and quite large on disk, and
325 therefore a good candidate for size reduction. One way to reduce the
326 size is by simply eliminating superfluous header fields. Each field
327 requires at least 100 bytes of run-time memory, so this may help!
328 Before you start playing around with removeFields() and
330 removeFieldsExcept(), you may take a look at two large groups of fields
331 which can be removes as sets: the resent headers and the mailinglist
332 headers.
333 Resent headers describe the intermediate steps in the transmission
335 process for the messages. After successful delivery, they are rarely
336 useful.
337 When you are archiving a mailinglist, it is hardly ever useful to store
339 a the list administration lines for each message as well.
340
342 Warning: Cannot remove field $name from header: not found.
343 You ask to remove a field which is not known in the header. Using
344 delete(), reset(), or set() to do the job will not result in
345 warnings: those methods check the existence of the field first.
346 Warning: Field objects have an implied name ($name)
348 Error: Package $package does not implement $method.
349 Fatal error: the specific package (or one of its superclasses) does
350 not implement this method where it should. This message means that
351 some other related classes do implement this method however the
352 class at hand does not. Probably you should investigate this and
353 probably inform the author of the package.
354
356 This module is part of Mail-Box distribution version 2.097, built on
357 January 26, 2011. Website: http://perl.overmeer.net/mailbox/
358
360 Copyrights 2001-2011 by Mark Overmeer. For other contributors see
361 ChangeLog.
362 This program is free software; you can redistribute it and/or modify it
364 under the same terms as Perl itself. See
365 http://www.perl.com/perl/misc/Artistic.html
366perl v5.12.3 2011-01-26 Mail::Message::Head::Partial(3)