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

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

     3 

     4 .. module:: VirtualMailManager.errors

     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:: VMMError(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   The *msg* and *code* are accessible via the both attributes:

    30 

    31   .. attribute:: msg

    32 

    33     The error message of the exception.

    34 

    35 

    36   .. attribute:: code

    37 

    38     The numerical error code of the exception.

    39 

    40 

    41 .. exception:: ConfigError(msg, code)

    42 

    43   Bases: :exc:`VirtualMailManager.errors.VMMError`

    44 

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

    46   exceptions.

    47 

    48 

    49 .. exception:: PermissionError(msg, code)

    50 

    51   Bases: :exc:`VirtualMailManager.errors.VMMError`

    52 

    53   Exception class for file permission exceptions.

    54 

    55 

    56 .. exception:: NotRootError(msg, code)

    57 

    58   Bases: :exc:`VirtualMailManager.errors.VMMError`

    59 

    60   Exception class for non-root exceptions.

    61 

    62 

    63 .. exception:: DomainError(msg, code)

    64 

    65   Bases: :exc:`VirtualMailManager.errors.VMMError`

    66 

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

    68 

    69 

    70 .. exception:: AliasDomainError(msg, code)

    71 

    72   Bases: :exc:`VirtualMailManager.errors.VMMError`

    73 

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

    75   exceptions.

    76 

    77 

    78 .. exception:: AccountError(msg, code)

    79 

    80   Bases: :exc:`VirtualMailManager.errors.VMMError`

    81 

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

    83 

    84 

    85 .. exception:: AliasError(msg, code)

    86 

    87   Bases: :exc:`VirtualMailManager.errors.VMMError`

    88 

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

    90 

    91 

    92 .. exception:: EmailAddressError(msg, code)

    93 

    94   Bases: :exc:`VirtualMailManager.errors.VMMError`

    95 

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

    97   exceptions.

    98 

    99 

   100 .. exception:: MailLocationError(msg, code)

   101 

   102   Bases: :exc:`VirtualMailManager.errors.VMMError`

   103 

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

   105   exceptions.

   106 

   107 

   108 .. exception:: RelocatedError(msg, code)

   109 

   110   Bases: :exc:`VirtualMailManager.errors.VMMError`

   111 

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

   113   exceptions.

   114 

   115 

   116 .. exception:: TransportError(msg, code)

   117 

   118   Bases: :exc:`VirtualMailManager.errors.VMMError`

   119 

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

   121   exceptions.

   122