Table of Contents
Recent documentation is found at:
-
-
Please take note that this work is still ongoing. The documentation should grow in a near future. 
× Internals
In this chapter, we will provide extensive information on what Sympa looks like “under the hood”.
We hope this documentation will be particularly helpful to developers.
Batabase structure
This section was obsoleted. See the manual page sympa_database(5) bundled in Sympa distribution.
See the dedicated page that describe each table of Sympa database.
Focus on the main Sympa modules
This section was obsoleted. See the manual page Sympa::Internals(3) bundled in Sympa distribution.
This chapter describes these modules (or a part of them):
- src/mail.pm: low level of email sending;
- src/List.pm: list processing and informations about structure and access to list configuration parameters;
- src/sympa.pl: the main script, for messages and mail commands processing;
- src/Commands.pm: mail commands processing;
- wwsympa/wwsympa.fcgi: web interface;
- src/report.pm: notification and error reports about requested services (email and web);
- src/tools.pm: various tools;
- src/Message.pm: message object used to encapsule a message received.
- wwsympa/SympaSession.pm: session object use to manage user context with a single cookie and a session table
- wwsympa/Auth.pm
to be completed
- wwsympa/ajax: ajax ;
Sympa modules sorted by directory
This section was obsoleted. See the manual page sympa_toc(1) bundled in Sympa distribution.
This section presents all the files used in the Sympa engine.
The files described are those contained in the sources, consequently:
- you will not find the files generated at compilation time,
- the files are not located in the same directory as you will find them in the compiled application.
Failing a better alternative, we present them as they appear in the src directory from the source distribution.
''./'' : Sympas sources root directory
These scripts are run at installation time. They perform the operations necessary to the correct install and runtime of Sympa.
* [[internals-check_perl_modules|check_perl_modules.pl]] : This script checks installed and required Perl modules. It also does the required installations.
* [[internals-important_changes|important_changes.pl]] : This script prints important changes in Sympa since last install. It is based on the %%NEWS *****%% entries.
* [[internals-set_symlinks|set_symlinks.pl]] : This script sets symbolic links at installation time.
* [[internals-subst|subst.pl]] : This script replaces %%--VAR--%% occurences at installation time.
''./doc/''
''./po/''
''./soap/''
''./src/''
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
''./src/etc/script/''
-
-
-
-
-
-
-
-
-
-
-
-
''./wwsympa/''
-
-
-
-
-
-
-
-
-
-
''./wwsympa/Marc/''