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

DESCRIPTION

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

OVERLOADED

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

METHODS

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

DIAGNOSTICS

234       Warning: Field content is not numerical: $content
235           The numeric value of a field is requested (for instance the "Lines"
236           or "Content-Length" fields should be numerical), however the data
237           contains weird characters.
238
239       Warning: Illegal character in field name $name
240           A new field is being created which does contain characters not
241           permitted by the RFCs.  Using this field in messages may break
242           other e-mail clients or transfer agents, and therefore mutulate or
243           extinguish your message.
244
245       Error: Package $package does not implement $method.
246           Fatal error: the specific package (or one of its superclasses) does
247           not implement this method where it should. This message means that
248           some other related classes do implement this method however the
249           class at hand does not.  Probably you should investigate this and
250           probably inform the author of the package.
251

LICENSE

257       Copyrights 2001-2011 by Mark Overmeer. For other contributors see
258       ChangeLog.
259
260       This program is free software; you can redistribute it and/or modify it
261       under the same terms as Perl itself.  See
262       http://www.perl.com/perl/misc/Artistic.html
263
264
265
266perl v5.12.3                      2011-01-26     Mail::Message::Field::Flex(3)