1======================
2 Upgrading Horde_Mime
3======================
4
5:Contact: dev@lists.horde.org
6
7.. contents:: Contents
8.. section-numbering::
9
10
11This lists the API changes between releases of the package.
12
13
14Upgrading to 2.10
15=================
16
17  - Horde_Mime_Part
18
19    - isAttachment()
20
21      This method has been added.
22
23
24Upgrading to 2.9
25================
26
27  - Horde_Mime_Part_Iterator
28
29    This class has been added.
30
31
32Upgrading to 2.8
33================
34
35  - Horde_Mime_Part
36
37    - $encodingTypes
38    - $mimeTypes
39
40      These static properties are deprecated.
41
42    - Iteration
43
44      The object can now be iterated through to access the subparts.
45      partIterator() can be used to obtain a RecursiveIteratorIterator that
46      will iterator through all descendants.
47      The $parent property has been added; it will be set, and is only
48      guaranteed to be accurate, during iteration.
49
50    - addPart()
51
52      This method is deprecated. Use array access to add a subpart (e.g.
53      $part[] = $new_part).
54
55    - alterPart()
56
57      This method is deprecated. Use array access (with the MIME ID as the
58      key) to alter a subpart.
59
60    - clearContentTypeParameter()
61
62      This method is deprecated. Use Horde_Mime_Part#setContentTypeParameter()
63      instead with null as the second argument to delete a Content-Type
64      parameter.
65
66    - contentTypeMap()
67
68      This method is deprecated. Use partIterator() to recursively iterate
69      through the parts instead.
70
71    - getPart()
72
73      This method is deprecated. Use array access (with the MIME ID as the
74      key) to obtain a subpart.
75
76    - setContentTypeParameter()
77
78      Passing null as the second argument will cause the Content-Type
79      parameter identified by the first argument to be deleted.
80
81    - setDispositionParameter()
82
83      Passing null as the second argument will cause the Content-Disposition
84      parameter identified by the first argument to be deleted.
85
86    - setDescription()
87
88      Passing null as the argument will cause the description to be deleted.
89
90    - removePart()
91
92      This method is deprecated. Use array access (with the MIME ID as the
93      key) to remove a subpart.
94
95  - Horde_Mime_Headers_ContentId
96  - Horde_Mime_Headers_ContentLanguage
97  - Horde_Mime_Headers_ContentParam_ContentDisposition
98  - Horde_Mime_Headers_ContentParam_ContentType
99  - Horde_Mime_Headers_ContentTransferEncoding
100  - Horde_Mime_Headers_Mime
101
102    These classes have been added.
103
104  - Horde_Mime_Headers_Element
105
106    - isDefault()
107
108      This method has been added.
109
110  - Horde_Mime_Headers_Extension_Mime
111
112    This interface has been added.
113
114  - Horde_Mime_Headers_ContentParam
115
116    - setContentParamValue()
117
118      This method has been added.
119
120
121
122Upgrading to 2.7
123================
124
125  - Horde_Mime_Headers_ContentDescription
126
127    This class has been added.
128
129
130Upgrading to 2.6
131================
132
133  - Horde_Mime_Filter_Encoding
134
135    This class has been added.
136
137  - Horde_Mime
138
139    - $decodeWindows1252
140
141      This property now defaults to true. (HTML 5 demands that ISO-8859-1 be
142      treated as Windows-1252, so this is matching conventional usage.)
143
144
145Upgrading to 2.5
146================
147
148  - Horde_Mime
149
150    - $brokenRFC2231
151
152      This static property is deprecated. Use the 'broken_rfc2231' parameter
153      to Horde_Mime_Headers_ContentParam#encode() instead.
154
155    - decodeParam()
156
157      This method is deprecated. Use Horde_Mime_Headers_ContentParam#decode()
158      instead.
159
160    - encodeParam()
161
162      This method is deprecated. Use Horde_Mime_Headers_ContentParam#encode()
163      instead.
164
165    - generateMessageId()
166
167      This method is deprecated. Use Horde_Mime_Headers_MessageId::create()
168      instead.
169
170    - is8bit()
171
172      The 2nd parameter ($charset) is no longer needed/used.
173
174    - isChild()
175
176      This method is deprecated. Use Horde_Mime_Id#isChild() instead.
177
178    - mimeIdArithmetic()
179
180      This method is deprecated. Use Horde_Mime_Id#idArithmetic() instead.
181
182    - quotedPrintableEncode()
183
184      This method is deprecated. Use PHP's quoted_printable_encode() method
185      instead (or, if you need to control EOL and/or wrapping length, use
186      Horde_Mime_QuotedPrintable::encode()).
187
188    - uudecode()
189
190      This method is deprecated. Use the Horde_Mime_Uudecode() class instead.
191
192  - Horde_Mime_Headers
193
194    Headers are now internally stored in a list of Horde_Mime_Headers_Element
195    objects.
196
197    - addHeader()
198
199      Deprecate the 'decode' and 'params' optional parameters.
200      To indicate distinct value and parameter data, use the
201      Horde_Mime_Headers_ContentParam object to add the data.
202      MIME decoding is now done automatically, based on the header name.
203
204    - addHeaderOb()
205
206      This method has been added.
207
208    - addMessageIdHeader()
209
210      This method is deprecated. Add a Horde_Mime_Headers_MessageId object via
211      Horde_Mime_Headers#addHeaderOb() instead.
212
213    - addReceivedHeader()
214
215      This method is deprecated. Create an object using
216      Horde_Mime_Headers_Received::createHordeHop() and add to the headers
217      object via Horde_Mime_Headers#addHeaderOb().
218
219    - addUserAgentHeader()
220
221      This method is deprecated. Add a Horde_Mime_Headers_UserAgent object via
222      Horde_Mime_Headers#addHeaderOb() instead.
223
224    - getEOL()
225
226      This method is deprecated.
227
228    - getUserAgent()
229
230      This method is deprecated. Get the default user agent via
231      strval(Horde_Mime_Headers_UserAgent::create()) instead.
232
233    - listHeadersExist()
234
235      This method is deprecated. Use Horde_ListHeaders#listHeadersExist()
236      instead.
237
238    - getOb()
239
240      This method is deprecated. Directly obtain the header element that
241      implements Horde_Mime_Headers_Element_Address and call
242      getAddressList() on it.
243
244    - getString()
245
246      This method is deprecated. Directly obtain the header element and query
247      its 'name' property instead.
248
249    - replaceHeader()
250
251      This method is deprecated. Use Horde_Mime_Headers#removeHeader()
252      followed by Horde_Mime_Headers#addHeader[Ob]() instead.
253
254    - setEOL()
255
256      This method is deprecated. EOLs are only needed for
257      Horde_Mime_Headers#toString(), where the 'canonical' parameter already
258      exists for the same purpose.
259
260    - setUserAgent()
261
262      This method is deprecated. Set the user agent via
263      Horde_Mime_Headers#addHeaderOb() instead.
264
265  - Horde_Mime_ContentParam_Decode
266  - Horde_Mime_Id
267  - Horde_Mime_QuotedPrintable
268  - Horde_Mime_Uudecode
269
270    These classes were added.
271
272  - Horde_Mime_Part
273
274    - send()
275
276      Added the 'broken_rfc2231' option.
277
278
279Upgrading to 2.4
280================
281
282  - Horde_Mime_Mail
283
284    - getRaw()
285
286      This method was added.
287
288
289Upgrading to 2.3
290================
291
292  - Horde_Mime_Headers
293
294    - parseHeaders()
295
296      The $text parameter now accepts both resources and Horde_Stream objects.
297
298
299Upgrading to 2.2
300================
301
302  - Horde_Mime
303
304    - parseMessage()
305
306      Added the 'no_body' parameter.
307
308
309Upgrading to 2.1
310================
311
312  - Horde_Mime
313
314    - encodeParam()
315
316      The 'escape' option has been removed.
317      The MIME_PARAM_QUOTED constant has been added.
318
319  - Horde_Mime_Related
320
321    - cidReplace()
322
323      The $text parameter can now be a Horde_Domhtml object.
324
325
326Upgrading to 2.0
327================
328
329  - Horde_Mime
330
331    - decode()
332
333      Removed the second parameter ($to_charset). Output is now in UTF-8.
334
335    - decodeAddrString()
336
337      This method has been removed.
338      Equivalent functionality can now be found in the Horde_Mail package
339      (version 2.0.0+).
340
341    - decodeParam()
342
343      Removed the third parameter ($charset). Output is now in UTF-8.
344
345    - encode()
346
347      The first parameter ($text) now requires a UTF-8 string.
348      The second parameter ($charset) is now optional and indicates the
349      charset to MIME encode to.
350
351    - encodeAddress()
352
353      This method has been removed.
354      Equivalent functionality can now be found in the Horde_Mail package
355      (version 2.0.0+).
356
357    - encodeParam()
358
359      The third parameter ($charset) has been removed and moved to the options.
360      By default, the string is encoded in UTF-8.
361
362  - Horde_Mime_Address
363
364    This class has been removed. Equivalent functionality can now be found
365    in the Horde_Mail package (version 2.0.0+).
366
367  - Horde_Mime_Headers
368
369    - addHeader()
370
371      Removed the 'charset' and 'decode' parameters.
372      Added the 'sanity_check' parameter.
373
374    - getOb()
375
376      Now returns null if the header does not exist.
377
378    - replaceHeader()
379
380      Removed the 'charset' and 'decode' parameters.
381      Added the 'sanity_check' parameter.
382
383    - setValue()
384    - sanityCheck()
385
386      These methods have been removed.
387