doc/source/vmm_exceptions.rst
author Pascal Volk <neverseen@users.sourceforge.net>
Thu, 25 Feb 2010 17:56:08 +0000
branchv0.6.x
changeset 215 33f727efa7c4
parent 212 77ac6f572855
permissions -rw-r--r--
PEP-8-ified the work of the last days. Renamed methods in class Alias: addDestination() -> add_destination() delDestination() -> del_destination() getDestinations() -> get_destinations() Renamed methods in class Relocated: setDestination() -> set_destination() getInfo() -> get_info() Renamed VMM/constants/VERSION.py -> VMM/constants/version.py Adjusted relevant parts of the documentation.

:mod:`VirtualMailManager.Exceptions` --- Exception classes
==========================================================

.. module:: VirtualMailManager.Exceptions
  :synopsis: Exception classes

.. moduleauthor:: Pascal Volk <neverseen@users.sourceforge.net>

.. toctree::
   :maxdepth: 2

Exceptions, used by VirtualMailManager's classes.


Exceptions
----------

.. exception:: VMMException(msg, code)

  Bases: :exc:`exceptions.Exception`

  :param msg: the error message
  :type msg: :obj:`basestring`
  :param code: the error code (one of :mod:`VirtualMailManager.constants.ERROR`)
  :type code: :obj:`int`

  Base class for all other Exceptions in the VirtualMailManager package.


  .. method:: msg

    :rtype: :obj:`basestring`

    Returns the error message of the exception.


  .. method:: code

    :rtype: :obj:`int`

    Returns the numerical error code of the exception.


.. exception:: VMMConfigException(msg, code)

  Bases: :exc:`VirtualMailManager.Exceptions.VMMException`

  Exception class for configuration (:mod:`VirtualMailManager.Config`)
  exceptions.


.. exception:: VMMNotRootException(msg, code)

  Bases: :exc:`VirtualMailManager.Exceptions.VMMException`

  Exception class for non-root exceptions.


.. exception:: VMMDomainException(msg, code)

  Bases: :exc:`VirtualMailManager.Exceptions.VMMException`

  Exception class for Domain (:mod:`VirtualMailManager.Domain`) exceptions.


.. exception:: VMMAliasDomainException(msg, code)

  Bases: :exc:`VirtualMailManager.Exceptions.VMMException`

  Exception class for AliasDomain (:mod:`VirtualMailManager.AliasDomain`)
  exceptions.


.. exception:: VMMAccountException(msg, code)

  Bases: :exc:`VirtualMailManager.Exceptions.VMMException`

  Exception class for Account (:mod:`VirtualMailManager.Account`) exceptions.


.. exception:: VMMAliasException(msg, code)

  Bases: :exc:`VirtualMailManager.Exceptions.VMMException`

  Exception class for Alias (:mod:`VirtualMailManager.Alias`) exceptions.


.. exception:: VMMEmailAddressException(msg, code)

  Bases: :exc:`VirtualMailManager.Exceptions.VMMException`

  Exception class for EmailAddress (:mod:`VirtualMailManager.EmailAddress`)
  exceptions.


.. exception:: VMMMailLocationException(msg, code)

  Bases: :exc:`VirtualMailManager.Exceptions.VMMException`

  Exception class for MailLocation (:mod:`VirtualMailManager.MailLocation`)
  exceptions.


.. exception:: VMMRelocatedException(msg, code)

  Bases: :exc:`VirtualMailManager.Exceptions.VMMException`

  Exception class for Relocated (:mod:`VirtualMailManager.Relocated`)
  exceptions.


.. exception:: VMMTransportException(msg, code)

  Bases: :exc:`VirtualMailManager.Exceptions.VMMException`

  Exception class for Transport (:mod:`VirtualMailManager.Transport`)
  exceptions.