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

     2 ==========================================================

     3 

     4 .. module:: VirtualMailManager.Exceptions

     5   :synopsis: Exception classes

     6 

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

     8 

     9 .. toctree::

    10    :maxdepth: 2

    11 

    12 Exceptions, used by VirtualMailManager's classes.

    13 

    14 

    15 Exceptions

    16 ----------

    17 

    18 .. exception:: VMMException(msg, code)

    19 

    20   Bases: :exc:`exceptions.Exception`

    21 

    22   :param msg: the error message

    23   :type msg: :obj:`basestring`

    24   :param code: the error code (one of :mod:`VirtualMailManager.constants.ERROR`)

    25   :type code: :obj:`int`

    26 

    27   Base class for all other Exceptions in the VirtualMailManager package.

    28 

    29 

    30   .. method:: msg

    31 

    32     :rtype: :obj:`basestring`

    33 

    34     Returns the error message of the exception.

    35 

    36 

    37   .. method:: code

    38 

    39     :rtype: :obj:`int`

    40 

    41     Returns the numerical error code of the exception.

    42 

    43 

    44 .. exception:: VMMConfigException(msg, code)

    45 

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

    47 

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

    49   exceptions.

    50 

    51 

    52 .. exception:: VMMNotRootException(msg, code)

    53 

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

    55 

    56   Exception class for non-root exceptions.

    57 

    58 

    59 .. exception:: VMMDomainException(msg, code)

    60 

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

    62 

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

    64 

    65 

    66 .. exception:: VMMAliasDomainException(msg, code)

    67 

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

    69 

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

    71   exceptions.

    72 

    73 

    74 .. exception:: VMMAccountException(msg, code)

    75 

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

    77 

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

    79 

    80 

    81 .. exception:: VMMAliasException(msg, code)

    82 

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

    84 

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

    86 

    87 

    88 .. exception:: VMMEmailAddressException(msg, code)

    89 

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

    91 

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

    93   exceptions.

    94 

    95 

    96 .. exception:: VMMMailLocationException(msg, code)

    97 

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

    99 

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

   101   exceptions.

   102 

   103 

   104 .. exception:: VMMRelocatedException(msg, code)

   105 

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

   107 

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

   109   exceptions.

   110 

   111 

   112 .. exception:: VMMTransportException(msg, code)

   113 

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

   115 

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

   117   exceptions.

   118