E-MailRelay

doxygen.h
1/*
2 Copyright (C) 2001-2024 Graeme Walker <graeme_walker@users.sourceforge.net>
3
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>.
16*/
17
18/* \htmlonly */
19
20/*! \mainpage E-MailRelay Source code
21
22 This documentation has been generated by doxygen from the E-MailRelay's
23 source code. The top-level namespaces in the <a href="namespaces.html">Namespace List</a>
24 page are a good starting point for browsing -- the detailed description section
25 towards the end of each namespace page gives a list of the namespace's
26 key classes.
27
28 The E-MailRelay <a href="../developer.html">developer guide</a> gives an overview
29 of the code structure.
30
31*/
32
33/*! \namespace Main
34\short
35 Application-level classes.
36
37 The Main namespace contains application-level classes for
38 the E-MailRelay process.
39
40 Key classes are:
41- Run
42- Unit
43- CommandLine
44- Configuration
45
46 */
47
48/*! \namespace GPop
49\short
50 POP3 classes.
51
52 The GPop namespace contains classes relating to the POP3
53 protocol.
54
55 Key classes are:
56- Server
57- ServerProtocol
58- Store
59
60 */
61
62/*! \namespace GSsl
63\short
64 TLS/SSL transport layer security classes.
65
66 The GSsl namespace contains classes that implement the TLS/SSL
67 security layer.
68
69 Key classes are:
70- Protocol
71- Library
72
73 */
74
75/*! \namespace GSmtp
76\short
77 SMTP classes.
78
79 The GSmtp namespace contains classes relating to the SMTP
80 protocol.
81
82 Key classes are:
83- Client
84- ClientProtocol
85- ProtocolMessage
86- Server
87- ServerProtocol
88
89 */
90
91/*! \namespace GFilters
92\short
93 Message filter classes.
94
95 The GFilters namespace contains classes relating to message filtering.
96
97 Key classes are:
98- FilterFactory
99- ExecutableFilter
100
101 */
102
103/*! \namespace GVerifiers
104\short
105 Address verifier classes.
106
107 The GVerifiers namespace contains classes for address verification.
108
109 Key classes are:
110- VerifierFactory
111- ExecutableVerifier
112
113 */
114
115/*! \namespace GStore
116\short
117 Message store classes.
118
119 The GStore namespace contains classes relating to e-mail storage.
120
121 Key classes are:
122- MessageStore
123- FileStore
124- NewMessage
125- NewFile
126- StoredMessage
127- StoredFile
128
129 */
130
131/*! \namespace GAuth
132\short
133 SASL authentication classes.
134
135 The GAuth namespace contains classes relating to SASL
136 and PAM authentication.
137
138 Key classes are:
139- SaslClient
140- SaslServer
141- SaslServerFactory
142- Secrets
143
144 */
145
146/*! \namespace GNet
147\short
148 Network classes.
149
150 The GNet namespace contains network interface classes
151 based on the Berkley socket and WinSock system APIs.
152
153 Key classes are:
154- Address
155- EventHandler
156- EventLoop
157- MultiServer
158- Resolver
159- Server
160- Socket
161- Timer
162
163*/
164
165/*! \namespace G
166\short
167 Low-level classes.
168
169 The G namespace contains low-level classes for file-system abstraction,
170 date and time representation, string utility functions, logging,
171 command line parsing etc.
172
173 Key classes are:
174- Directory
175- File
176- OptionParser
177- Log
178- LogOutput
179- Path
180- Process
181- Str
182
183*/
184
185/* \endhtmlonly */