E-MailRelay
src
main
doxygen.h
1
/*
2
Copyright (C) 2001-2021 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
- CommandLine
43
- Configuration
44
45
*/
46
47
/*! \namespace GPop
48
\short
49
POP3 classes.
50
51
The GPop namespace contains classes relating to the POP3
52
protocol.
53
54
Key classes are:
55
- Server
56
- ServerProtocol
57
- Store
58
- StoreLock
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 and message-store classes.
78
79
The GSmtp namespace contains classes relating to the SMTP
80
protocol and to e-mail storage.
81
82
Key classes are:
83
- Client
84
- ClientProtocol
85
- ProtocolMessage
86
- MessageStore
87
- Server
88
- ServerProtocol
89
90
*/
91
92
/*! \namespace GAuth
93
\short
94
SASL authentication classes.
95
96
The GAuth namespace contains classes relating to SASL
97
and PAM authentication.
98
99
Key classes are:
100
- SaslClient
101
- SaslServer
102
- SaslServerFactory
103
- Secrets
104
105
*/
106
107
/*! \namespace GNet
108
\short
109
Network classes.
110
111
The GNet namespace contains network interface classes
112
based on the Berkley socket and WinSock system APIs.
113
114
Key classes are:
115
- Address
116
- EventHandler
117
- EventLoop
118
- MultiServer
119
- Resolver
120
- Server
121
- Socket
122
- Timer
123
124
*/
125
126
/*! \namespace G
127
\short
128
Low-level classes.
129
130
The G namespace contains low-level classes for file-system abstraction,
131
date and time representation, string utility functions, logging,
132
command line parsing etc.
133
134
Key classes are:
135
- Directory
136
- File
137
- GetOpt
138
- Log
139
- LogOutput
140
- Path
141
- Process
142
- Str
143
144
*/
145
146
/* \endhtmlonly */
Generated by
1.9.3