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
19       predicts).
20
21       Extends "DESCRIPTION" in Mail::Message::Field.
22

OVERLOADED

24       Extends "OVERLOADED" in Mail::Message::Field.
25
26       overload: ""
27           Inherited, see "OVERLOADED" in Mail::Message::Field
28
29       overload: 0+
30           Inherited, see "OVERLOADED" in Mail::Message::Field
31
32       overload: <=>
33           Inherited, see "OVERLOADED" in Mail::Message::Field
34
35       overload: bool
36           Inherited, see "OVERLOADED" in Mail::Message::Field
37
38       overload: cmp
39           Inherited, see "OVERLOADED" in Mail::Message::Field
40

METHODS

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

DETAILS

249       Extends "DETAILS" in Mail::Message::Field.
250

DIAGNOSTICS

252       Warning: Field content is not numerical: $content
253           The numeric value of a field is requested (for instance the "Lines"
254           or "Content-Length" fields should be numerical), however the data
255           contains weird characters.
256
257       Warning: Illegal character in field name $name
258           A new field is being created which does contain characters not
259           permitted by the RFCs.  Using this field in messages may break
260           other e-mail clients or transfer agents, and therefore mutulate or
261           extinguish your message.
262
263       Error: Package $package does not implement $method.
264           Fatal error: the specific package (or one of its superclasses) does
265           not implement this method where it should. This message means that
266           some other related classes do implement this method however the
267           class at hand does not.  Probably you should investigate this and
268           probably inform the author of the package.
269

LICENSE

275       Copyrights 2001-2022 by [Mark Overmeer <markov@cpan.org>]. For other
276       contributors see ChangeLog.
277
278       This program is free software; you can redistribute it and/or modify it
279       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
280
281
282
283perl v5.36.0                      2022-07-22     Mail::Message::Field::Flex(3)