1======================
2 Upgrading Horde_Mail
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.5
15================
16
17  - Horde_Mail_Rfc822
18
19    - encode()
20
21      Added the 'comment' option to the 'type' parameter.
22
23  - Horde_Mail_Rfc822_Object
24
25    - Added the 'comment' option to the writeAddress() method.
26
27
28Upgrading to 2.5
29================
30
31  - Horde_Mail_Rfc822
32
33    - ATEXT
34
35      This constant is deprecated.
36
37    - parseAddressList()
38
39      Added the 'eai' option to the 'validate' optional parameter.
40
41  - Horde_Mail_Rfc822_Address
42
43    Added the 'eai' property.
44
45  - Horde_Mail_Rfc822_List
46
47    - first()
48
49      This method has been added.
50
51  - Horde_Mail_Mbox_Parse
52
53    Added object to parse mbox format mailbox data.
54
55  - Horde_Mail_Transport
56
57    Added 'eai' property.
58
59  - Horde_Mail_Transport_Smtp
60  - Horde_Mail_Transport_Smtpmx
61
62    These Transport drivers are deprecated. Use Horde_Mail_Transport_Hordesmtp
63    instead.
64
65
66Upgrading to 2.4
67================
68
69  - Horde_Mail_Rfc822_Object
70
71    - writeAddress()
72
73      Added the 'noquote' option.
74
75
76Upgrading to 2.3
77================
78
79  - Horde_Mail_Transport_Lmtphorde
80
81    This Transport driver has been added.
82
83
84Upgrading to 2.2
85================
86
87  - Horde_Mail_Rfc822_Identification
88
89    This class has been added.
90
91
92Upgrading to 2.1
93================
94
95  - Horde_Mail_Rfc822_Address
96
97    Added the 'bare_address_idn' property.
98
99  - Horde_Mail_Rfc822_List
100
101    Added the 'bare_addresses_idn' property.
102
103  - Horde_Mail_Transport_Smtphorde
104
105    This Transport driver has been added.
106
107
108Upgrading to 2.0
109================
110
111  - Horde_Mail
112
113    This class has been removed (no more Horde_Mail#factory()). Directly
114    instantiate a transport driver instead.
115
116  - Horde_Mail_Rfc822
117
118    The 'num_groups' property has been removed.
119    The validateMailbox() method has been removed.
120    parseAddressList() now returns a Horde_Mail_Rfc822_List object.
121    The 'group' parameter to parseAddressList() has been added.
122    The 'nest_groups' parameter to parseAddressList() has been removed.
123    parseAddressList() does not validate by default.
124
125  - Horde_Mail_Rfc822_Address
126
127    The object can no longer be accessed as an array.
128    Removed the 'adl', 'route', and 'personal_decoded' properties.
129    The 'personal' property now always returns the MIME decoded personal part.
130    The 'host' property now always returns the IDN decoded host.
131    The 'encode' and 'idn' parameters to writeAddress() have changed behavior.
132    Added the 'host_idn' and 'valid' properties.
133    Renamed the 'full_address' property to 'bare_address'.
134
135  - Horde_Mail_Rfc822_Group
136
137    The object can no longer be accessed as an array.
138    Removed the 'groupname_decoded' property.
139    The 'groupname' property now always returns the MIME decoded groupname.
140    The 'encode' and 'idn' parameters to writeAddress() have changed behavior.
141    Added the 'valid' property.
142
143  - Horde_Mail_Rfc822_Object
144
145    Added a match() method.
146    Passing boolean true to writeAddress() now defaults to full encoding of
147    the address.
148
149
150Upgrading To 1.2
151================
152
153Method API additions
154--------------------
155
156  - Horde_Mail_Rfc822#parseAddressList()
157
158    The first argument can now be a Horde_Mail_Rfc822_Object or an array of
159    address strings and/or Horde_Mail_Rfc822_Objects.
160
161  - Horde_Mail_Rfc822_Address#__construct()
162
163    The constructor now takes 1 optional argument: address.
164
165  - Horde_Mail_Rfc822_Group#__construct()
166
167    The constructor now takes 2 optional arguments: groupname and group
168    addresses.
169
170
171New Methods
172-----------
173
174  - Horde_Mail_Rfc822#encode()
175  - Horde_Mail_Rfc822#trimAddress()
176
177
178New Objects
179-----------
180
181  - Horde_Mail_Rfc822_Object
182
183    Horde_Mail_Rfc822_Address and Horde_Mail_Rfc822_Group now extend this
184    class.  Allows for easier determination if an object contains RFC 822
185    element information.
186
187
188Upgrading To 1.1
189================
190
191New Objects
192-----------
193
194Horde_Mail_Rfc822::parseAddressList() now returns an array of
195Horde_Mail_Rfc822_Address objects (and Horde_Mail_Rfc822_Group objects, if
196nest_groups is true).
197
198These objects are backward compatible with the former array representation.
199They also include additional functionality.
200
201  - Horde_Mail_Rfc822_Address
202
203    Anything other than accessing these properties is a new feature available
204    only since 1.1.0:
205
206    - adl
207    - comment
208    - host
209    - mailbox
210    - personal
211
212  - Horde_Mail_Rfc822_Group
213
214    Anything other than accessing these properties is a new feature available
215    only since 1.1.0:
216
217    - addresses
218    - groupname
219