doc/source/vmm_relocated.rst
branchv0.6.x
changeset 216 0c8c053b451c
parent 215 33f727efa7c4
child 220 8b8d632f0ef3
equal deleted inserted replaced
215:33f727efa7c4 216:0c8c053b451c
    32 
    32 
    33 
    33 
    34   .. method:: delete()
    34   .. method:: delete()
    35   
    35   
    36     :rtype: :obj:`None`
    36     :rtype: :obj:`None`
    37     :raise VirtualMailManager.Exceptions.VMMRelocatedException: if the
    37     :raise VirtualMailManager.errors.RelocatedError: if the relocated user
    38       relocated user doesn't exist.
    38       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:: get_info()
    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.errors.RelocatedError: if the relocated user
    47       relocated user doesn't exist.
    47       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:: set_destination(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.errors.RelocatedError: if the *destination*
    58       *destination* address is already saved or is the same as the relocated
    58       address is already saved or is the same as the relocated user's address.
    59       user's address.
       
    60 
    59 
    61     Sets or updates the *destination* address of the relocated user.
    60     Sets or updates the *destination* address of the relocated user.