======================
 Upgrading Horde_Mail
======================

:Contact: dev@lists.horde.org

.. contents:: Contents
.. section-numbering::


This lists the API changes between minor releases of the package.


Upgrading To 1.2
================

Method API additions
--------------------

  - Horde_Mail_Rfc822#parseAddressList()

    The first argument can now be a Horde_Mail_Rfc822_Object or an array of
    address strings and/or Horde_Mail_Rfc822_Objects.

  - Horde_Mail_Rfc822_Address#__construct()

    The constructor now takes 1 optional argument: address.

  - Horde_Mail_Rfc822_Group#__construct()

    The constructor now takes 2 optional arguments: groupname and group
    addresses.


New Methods
-----------

  - Horde_Mail_Rfc822#encode()
  - Horde_Mail_Rfc822#trimAddress()


New Objects
-----------

  - Horde_Mail_Rfc822_Object

    Horde_Mail_Rfc822_Address and Horde_Mail_Rfc822_Group now extend this
    class.  Allows for easier determination if an object contains RFC 822
    element information.


Upgrading To 1.1
================

New Objects
-----------

Horde_Mail_Rfc822::parseAddressList() now returns an array of
Horde_Mail_Rfc822_Address objects (and Horde_Mail_Rfc822_Group objects, if
nest_groups is true).

These objects are backward compatible with the former array representation.
They also include additional functionality.

  - Horde_Mail_Rfc822_Address

    Anything other than accessing these properties is a new feature available
    only since 1.1.0:

    - adl
    - comment
    - host
    - mailbox
    - personal

  - Horde_Mail_Rfc822_Group

    Anything other than accessing these properties is a new feature available
    only since 1.1.0:

    - addresses
    - groupname
