author | Pascal Volk <user@localhost.localdomain.org> |
Sun, 20 Jan 2013 15:50:36 +0000 | |
branch | v0.7.x |
changeset 690 | 06c0acf6c45d |
parent 578 | 20141b967c0b |
permissions | -rw-r--r-- |
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
1 |
:mod:`VirtualMailManager.errors` --- Exception classes |
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
2 |
====================================================== |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
3 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
4 |
.. module:: VirtualMailManager.errors |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
5 |
:synopsis: Exception classes |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
6 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
7 |
.. moduleauthor:: Pascal Volk <neverseen@users.sourceforge.net> |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
8 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
9 |
.. toctree:: |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
10 |
:maxdepth: 2 |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
11 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
12 |
Exceptions, used by VirtualMailManager's classes. |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
13 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
14 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
15 |
Exceptions |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
16 |
---------- |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
17 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
18 |
.. exception:: VMMError(msg, code) |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
19 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
20 |
Bases: :exc:`exceptions.Exception` |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
21 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
22 |
:param msg: the error message |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
23 |
:type msg: :obj:`basestring` |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
24 |
:param code: the error code (one of :mod:`VirtualMailManager.constants.ERROR`) |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
25 |
:type code: :obj:`int` |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
26 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
27 |
Base class for all other Exceptions in the VirtualMailManager package. |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
28 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
29 |
The *msg* and *code* are accessible via the both attributes: |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
30 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
31 |
.. attribute:: msg |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
32 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
33 |
The error message of the exception. |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
34 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
35 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
36 |
.. attribute:: code |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
37 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
38 |
The numerical error code of the exception. |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
39 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
40 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
41 |
.. exception:: ConfigError(msg, code) |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
42 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
43 |
Bases: :exc:`VirtualMailManager.errors.VMMError` |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
44 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
45 |
Exception class for configuration (:mod:`VirtualMailManager.Config`) |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
46 |
exceptions. |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
47 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
48 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
49 |
.. exception:: PermissionError(msg, code) |
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
50 |
|
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
51 |
Bases: :exc:`VirtualMailManager.errors.VMMError` |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
52 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
53 |
Exception class for file permission exceptions. |
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
54 |
|
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
55 |
|
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
56 |
.. exception:: NotRootError(msg, code) |
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
57 |
|
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
58 |
Bases: :exc:`VirtualMailManager.errors.VMMError` |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
59 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
60 |
Exception class for non-root exceptions. |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
61 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
62 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
63 |
.. exception:: DomainError(msg, code) |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
64 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
65 |
Bases: :exc:`VirtualMailManager.errors.VMMError` |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
66 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
67 |
Exception class for Domain (:mod:`VirtualMailManager.Domain`) exceptions. |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
68 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
69 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
70 |
.. exception:: AliasDomainError(msg, code) |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
71 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
72 |
Bases: :exc:`VirtualMailManager.errors.VMMError` |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
73 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
74 |
Exception class for AliasDomain (:mod:`VirtualMailManager.AliasDomain`) |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
75 |
exceptions. |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
76 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
77 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
78 |
.. exception:: AccountError(msg, code) |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
79 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
80 |
Bases: :exc:`VirtualMailManager.errors.VMMError` |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
81 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
82 |
Exception class for Account (:mod:`VirtualMailManager.Account`) exceptions. |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
83 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
84 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
85 |
.. exception:: AliasError(msg, code) |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
86 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
87 |
Bases: :exc:`VirtualMailManager.errors.VMMError` |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
88 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
89 |
Exception class for Alias (:mod:`VirtualMailManager.Alias`) exceptions. |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
90 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
91 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
92 |
.. exception:: EmailAddressError(msg, code) |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
93 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
94 |
Bases: :exc:`VirtualMailManager.errors.VMMError` |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
95 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
96 |
Exception class for EmailAddress (:mod:`VirtualMailManager.EmailAddress`) |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
97 |
exceptions. |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
98 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
99 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
100 |
.. exception:: MailLocationError(msg, code) |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
101 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
102 |
Bases: :exc:`VirtualMailManager.errors.VMMError` |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
103 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
104 |
Exception class for MailLocation (:mod:`VirtualMailManager.MailLocation`) |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
105 |
exceptions. |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
106 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
107 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
108 |
.. exception:: RelocatedError(msg, code) |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
109 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
110 |
Bases: :exc:`VirtualMailManager.errors.VMMError` |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
111 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
112 |
Exception class for Relocated (:mod:`VirtualMailManager.Relocated`) |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
113 |
exceptions. |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
114 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
115 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
116 |
.. exception:: TransportError(msg, code) |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
117 |
|
216
0c8c053b451c
Moved VirtualMailManager/Exceptions to VirtualMailManager/errors.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
212
diff
changeset
|
118 |
Bases: :exc:`VirtualMailManager.errors.VMMError` |
212
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
119 |
|
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
120 |
Exception class for Transport (:mod:`VirtualMailManager.Transport`) |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
121 |
exceptions. |
77ac6f572855
doc: extended documentation.
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff
changeset
|
122 |