doc/source/vmm_relocated.rst
branchv0.6.x
changeset 215 33f727efa7c4
parent 212 77ac6f572855
child 216 0c8c053b451c
equal deleted inserted replaced
214:84e6e898e6c5 215:33f727efa7c4
    18 Relocated
    18 Relocated
    19 ---------
    19 ---------
    20 .. class:: Relocated(dbh, address)
    20 .. class:: Relocated(dbh, address)
    21 
    21 
    22   Creates a new *Relocated* instance. If the relocated user with the given
    22   Creates a new *Relocated* instance. If the relocated user with the given
    23   *address* is already stored in the database use :meth:`getInfo` to get the
    23   *address* is already stored in the database use :meth:`get_info` to get the
    24   destination address of the relocated user. To set or update the destination
    24   destination address of the relocated user. To set or update the destination
    25   of the relocated user use :meth:`setDestination`. Use :meth:`delete` in
    25   of the relocated user use :meth:`set_destination`. Use :meth:`delete` in
    26   order to delete the relocated user from the database.
    26   order to delete the relocated user from the database.
    27   
    27   
    28   :param dbh: a database connection
    28   :param dbh: a database connection
    29   :type dbh: :class:`PgSQL.Connection`
    29   :type dbh: :class:`PgSQL.Connection`
    30   :param address: the e-mail address of the relocated user.
    30   :param address: the e-mail address of the relocated user.
    38       relocated user doesn't exist.
    38       relocated user doesn't exist.
    39 
    39 
    40     Deletes the relocated user from the database.
    40     Deletes the relocated user from the database.
    41 
    41 
    42 
    42 
    43   .. method:: getInfo()
    43   .. method:: get_info()
    44 
    44 
    45     :rtype: :class:`VirtualMailManager.EmailAddress.EmailAddress`
    45     :rtype: :class:`VirtualMailManager.EmailAddress.EmailAddress`
    46     :raise VirtualMailManager.Exceptions.VMMRelocatedException: if the
    46     :raise VirtualMailManager.Exceptions.VMMRelocatedException: if the
    47       relocated user doesn't exist.
    47       relocated user doesn't exist.
    48 
    48 
    49     Returns the destination e-mail address of the relocated user.
    49     Returns the destination e-mail address of the relocated user.
    50 
    50 
    51 
    51 
    52   .. method:: setDestination(destination)
    52   .. method:: set_destination(destination)
    53 
    53 
    54     :param destination: the new address where the relocated user has moved to
    54     :param destination: the new address where the relocated user has moved to
    55     :type destination: :class:`VirtualMailManager.EmailAddress.EmailAddress`
    55     :type destination: :class:`VirtualMailManager.EmailAddress.EmailAddress`
    56     :rtype: :obj:`None`
    56     :rtype: :obj:`None`
    57     :raise VirtualMailManager.Exceptions.VMMRelocatedException: if the
    57     :raise VirtualMailManager.Exceptions.VMMRelocatedException: if the