Mail::Message::Field::Flex(3pm)

1Mail::Message::Field::FUlseexr(3C)ontributed Perl DocumeMnatialt:i:oMnessage::Field::Flex(3)
2
3
4

NAME

6       Mail::Message::Field::Flex - one line of a message header
7

INHERITANCE

9        Mail::Message::Field::Flex
10          is a Mail::Message::Field
11          is a Mail::Reporter
12

SYNOPSIS

DESCRIPTION

15       This is the flexible implementation of a field: it can easily be
16       extended because it stores its data in a hash and the constructor
17       ("new") and initializer ("init") are split.  However, you pay the price
18       in performance.  Mail::Message::Field::Fast is faster (as the name pre‐
19       dicts).
20

OVERLOADED

22       overload: ""
23
24           See "OVERLOADED" in Mail::Message::Field
25
26       overload: +0
27
28           See "OVERLOADED" in Mail::Message::Field
29
30       overload: <=>
31
32           See "OVERLOADED" in Mail::Message::Field
33
34       overload: bool
35
36           See "OVERLOADED" in Mail::Message::Field
37
38       overload: cmp
39
40           See "OVERLOADED" in Mail::Message::Field
41

METHODS

43       Constructors
44
45       $obj->clone
46
47           See "Constructors" in Mail::Message::Field
48
49       Mail::Message::Field::Flex->new(DATA)
50
51           If you stick to this flexible class of header fields, you have a
52           bit more facilities than with Mail::Message::Field::Fast.  Amongst
53           it, you can specify options with the creation.  Possible arguments:
54
55           * new LINE
56               ass a LINE as it could be found in a file: a (possibly folded)
57               line which is terminated by a new-line.
58
59           * new NAME, (BODY⎪OBJECTS), [ATTRIBUTES], OPTIONS
60               A set of values which shape the line.
61
62           To be able to distinguish the different parameters, you will have
63           to specify the OPTIONS as ARRAY of option pairs, or HASH of
64           options.  The ATTRIBUTES are a flat list of key-value pairs.  The
65           body is specified as one BODY string, one OBJECT, or a reference to
66           an array of OBJECTS.  See Mail::Message::Field:
67
68            Option    --Defined in     --Default
69            attributes                   []
70            comment                      undef
71            log         Mail::Reporter   'WARNINGS'
72            trace       Mail::Reporter   'WARNINGS'
73
74           . attributes ATTRS
75
76               Reference to array with list of key-value pairs representing
77               attributes, or reference to a hash containing these pairs.
78               This is an alternative notation for specifying ATTRIBUTES
79               directly as method arguments.
80
81           . comment STRING
82
83               A pre-formatted list of attributes.
84
85           . log LEVEL
86
87           . trace LEVEL
88
89       The field
90
91       $obj->isStructured
92
93       Mail::Message::Field::Flex->isStructured
94
95           See "The field" in Mail::Message::Field
96
97       $obj->length
98
99           See "The field" in Mail::Message::Field
100
101       $obj->nrLines
102
103           See "The field" in Mail::Message::Field
104
105       $obj->print([FILEHANDLE])
106
107           See "The field" in Mail::Message::Field
108
109       $obj->size
110
111           See "The field" in Mail::Message::Field
112
113       $obj->string([WRAP])
114
115           See "The field" in Mail::Message::Field
116
117       $obj->toDisclose
118
119           See "The field" in Mail::Message::Field
120
121       Access to the name
122
123       $obj->Name
124
125           See "Access to the name" in Mail::Message::Field
126
127       $obj->name
128
129           See "Access to the name" in Mail::Message::Field
130
131       $obj->wellformedName([STRING])
132
133           See "Access to the name" in Mail::Message::Field
134
135       Access to the body
136
137       $obj->body
138
139           See "Access to the body" in Mail::Message::Field
140
141       $obj->folded
142
143           See "Access to the body" in Mail::Message::Field
144
145       $obj->foldedBody([BODY])
146
147           See "Access to the body" in Mail::Message::Field
148
149       $obj->stripCFWS([STRING])
150
151       Mail::Message::Field::Flex->stripCFWS([STRING])
152
153           See "Access to the body" in Mail::Message::Field
154
155       $obj->unfoldedBody([BODY, [WRAP]])
156
157           See "Access to the body" in Mail::Message::Field
158
159       Access to the content
160
161       $obj->addresses
162
163           See "Access to the content" in Mail::Message::Field
164
165       $obj->attribute(NAME [, VALUE])
166
167           See "Access to the content" in Mail::Message::Field
168
169       $obj->attributes
170
171           See "Access to the content" in Mail::Message::Field
172
173       $obj->comment([STRING])
174
175           See "Access to the content" in Mail::Message::Field
176
177       $obj->study
178
179           See "Access to the content" in Mail::Message::Field
180
181       $obj->toDate([TIME])
182
183       Mail::Message::Field::Flex->toDate([TIME])
184
185           See "Access to the content" in Mail::Message::Field
186
187       $obj->toInt
188
189           See "Access to the content" in Mail::Message::Field
190
191       Other methods
192
193       $obj->dateToTimestamp(STRING)
194
195       Mail::Message::Field::Flex->dateToTimestamp(STRING)
196
197           See "Other methods" in Mail::Message::Field
198
199       Internals
200
201       $obj->consume(LINE ⎪ (NAME,BODY⎪OBJECTS))
202
203           See "Internals" in Mail::Message::Field
204
205       $obj->defaultWrapLength([LENGTH])
206
207           See "Internals" in Mail::Message::Field
208
209       $obj->fold(NAME, BODY, [MAXCHARS])
210
211       Mail::Message::Field::Flex->fold(NAME, BODY, [MAXCHARS])
212
213           See "Internals" in Mail::Message::Field
214
215       $obj->setWrapLength([LENGTH])
216
217           See "Internals" in Mail::Message::Field
218
219       $obj->stringifyData(STRING⎪ARRAY⎪OBJECTS)
220
221           See "Internals" in Mail::Message::Field
222
223       $obj->unfold(STRING)
224
225           See "Internals" in Mail::Message::Field
226
227       Error handling
228
229       $obj->AUTOLOAD
230
231           See "Error handling" in Mail::Reporter
232
233       $obj->addReport(OBJECT)
234
235           See "Error handling" in Mail::Reporter
236
237       $obj->defaultTrace([LEVEL]⎪[LOGLEVEL, TRACELEVEL]⎪[LEVEL, CALLBACK])
238
239       Mail::Message::Field::Flex->defaultTrace([LEVEL]⎪[LOGLEVEL,
240       TRACELEVEL]⎪[LEVEL, CALLBACK])
241
242           See "Error handling" in Mail::Reporter
243
244       $obj->errors
245
246           See "Error handling" in Mail::Reporter
247
248       $obj->log([LEVEL [,STRINGS]])
249
250       Mail::Message::Field::Flex->log([LEVEL [,STRINGS]])
251
252           See "Error handling" in Mail::Reporter
253
254       $obj->logPriority(LEVEL)
255
256       Mail::Message::Field::Flex->logPriority(LEVEL)
257
258           See "Error handling" in Mail::Reporter
259
260       $obj->logSettings
261
262           See "Error handling" in Mail::Reporter
263
264       $obj->notImplemented
265
266           See "Error handling" in Mail::Reporter
267
268       $obj->report([LEVEL])
269
270           See "Error handling" in Mail::Reporter
271
272       $obj->reportAll([LEVEL])
273
274           See "Error handling" in Mail::Reporter
275
276       $obj->trace([LEVEL])
277
278           See "Error handling" in Mail::Reporter
279
280       $obj->warnings
281
282           See "Error handling" in Mail::Reporter
283
284       Cleanup
285
286       $obj->DESTROY
287
288           See "Cleanup" in Mail::Reporter
289
290       $obj->inGlobalDestruction
291
292           See "Cleanup" in Mail::Reporter
293

DETAILS

DIAGNOSTICS

296       Warning: Field content is not numerical: $content
297
298       The numeric value of a field is requested (for instance the "Lines" or
299       "Content-Length" fields should be numerical), however the data contains
300       weird characters.
301
302       Warning: Illegal character in field name $name
303
304       A new field is being created which does contain characters not permit‐
305       ted by the RFCs.  Using this field in messages may break other e-mail
306       clients or transfer agents, and therefore mutulate or extinguish your
307       message.
308
309       Error: Package $package does not implement $method.
310
311       Fatal error: the specific package (or one of its superclasses) does not
312       implement this method where it should. This message means that some
313       other related classes do implement this method however the class at
314       hand does not.  Probably you should investigate this and probably
315       inform the author of the package.
316

LICENSE

322       Copyrights 2001-2007 by Mark Overmeer.For other contributors see
323       ChangeLog.
324
325       This program is free software; you can redistribute it and/or modify it
326       under the same terms as Perl itself.  See
327       http://www.perl.com/perl/misc/Artistic.html
328
329
330
331perl v5.8.8                       2007-03-25     Mail::Message::Field::Flex(3)