E-MailRelay
Main Page
Namespaces
Classes
Files
File List
File Members
src
main
doxygen.h
1
/*
2
Copyright (C) 2001-2018 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 <a href="namespaces.html">Namespace List</a> is a good starting point
24
for browsing -- the detailed description section towards the end of each namespace
25
page gives a list of the namespace's key classes.
26
27
The E-MailRelay <a href="../developer.html">developer guide</a> gives an overview
28
of the code structure.
29
30
*/
31
32
/*! \namespace Main
33
\short
34
Application-level classes.
35
36
The Main namespace contains application-level classes for
37
the E-MailRelay process.
38
39
Key classes are:
40
- Run
41
- CommandLine
42
- Configuration
43
44
*/
45
46
/*! \namespace GPop
47
\short
48
POP3 classes.
49
50
The GPop namespace contains classes relating to the POP3
51
protocol.
52
53
Key classes are:
54
- Server
55
- ServerProtocol
56
- Store
57
- StoreLock
58
59
*/
60
61
/*! \namespace GSsl
62
\short
63
TLS/SSL transport layer security classes.
64
65
The GSsl namespace contains classes that implement the TLS/SSL
66
security layer.
67
68
Key classes are:
69
- Protocol
70
- Library
71
72
*/
73
74
/*! \namespace GSmtp
75
\short
76
SMTP and message-store classes.
77
78
The GSmtp namespace contains classes relating to the SMTP
79
protocol and to e-mail storage.
80
81
Key classes are:
82
- Client
83
- ClientProtocol
84
- ProtocolMessage
85
- MessageStore
86
- Server
87
- ServerProtocol
88
89
*/
90
91
/*! \namespace GAuth
92
\short
93
SASL authentication classes.
94
95
The GAuth namespace contains classes relating to SASL
96
and PAM authentication.
97
98
Key classes are:
99
- SaslClient
100
- SaslServer
101
- SaslServerFactory
102
- Secrets
103
104
*/
105
106
/*! \namespace GNet
107
\short
108
Network classes.
109
110
The GNet namespace contains network interface classes
111
based on the Berkley socket and WinSock system APIs.
112
113
Key classes are:
114
- Address
115
- EventHandler
116
- EventLoop
117
- MultiServer
118
- Resolver
119
- Server
120
- Socket
121
- Timer
122
123
*/
124
125
/*! \namespace G
126
\short
127
Low-level classes.
128
129
The G namespace contains low-level classes for file-system abstraction,
130
date and time representation, string utility functions, logging,
131
command line parsing etc.
132
133
Key classes are:
134
- Directory
135
- File
136
- GetOpt
137
- Log
138
- LogOutput
139
- Path
140
- Process
141
- Str
142
143
*/
144
145
/* \endhtmlonly */
Generated by
1.8.9.1