.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Sympa::Internals 3Sympa"
.TH Sympa::Internals 3Sympa "2020-12-30" "6.2.58" "sympa 6.2.58"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Sympa::Internals \- Sympa internals
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Below is the list of Sympa internal modules.
To know details of each module, run:
.PP
.Vb 1
\&  man Sympa::ModuleName
.Ve
.SS "Modules"
.IX Subsection "Modules"
.IP "Sympa" 4
.IX Item "Sympa"
Future base class of Sympa functional objects
.IP "Sympa::Aliases" 4
.IX Item "Sympa::Aliases"
Base class for alias management
.IP "Sympa::Aliases::CheckSMTP" 4
.IX Item "Sympa::Aliases::CheckSMTP"
Alias management: Check addresses using \s-1SMTP\s0
.IP "Sympa::Aliases::External" 4
.IX Item "Sympa::Aliases::External"
Alias management: Updating aliases by external program
.IP "Sympa::Aliases::Template" 4
.IX Item "Sympa::Aliases::Template"
Alias management: Aliases file based on template
.IP "Sympa::Archive" 4
.IX Item "Sympa::Archive"
Archives of Sympa
.IP "Sympa::CommandDef" 4
.IX Item "Sympa::CommandDef"
Definition of mail commands
.IP "Sympa::ConfDef" 4
.IX Item "Sympa::ConfDef"
Definition of site and robot configuration parameters
.IP "Sympa::Config" 4
.IX Item "Sympa::Config"
List configuration
.IP "Sympa::Config::Schema" 4
.IX Item "Sympa::Config::Schema"
Definition of list configuration parameters
.IP "Sympa::Config_XML" 4
.IX Item "Sympa::Config_XML"
\&\s-1TBD\s0
.IP "Sympa::Constants" 4
.IX Item "Sympa::Constants"
Definition of constants
.IP "Sympa::Crash" 4
.IX Item "Sympa::Crash"
Show traceback on critical error
.IP "Sympa::Database" 4
.IX Item "Sympa::Database"
Handling databases
.IP "Sympa::DatabaseDescription" 4
.IX Item "Sympa::DatabaseDescription"
Definition of core database structure
.IP "Sympa::DatabaseDriver" 4
.IX Item "Sympa::DatabaseDriver"
Base class of database drivers for Sympa
.IP "Sympa::DatabaseDriver::CSV" 4
.IX Item "Sympa::DatabaseDriver::CSV"
Database driver for \s-1CSV\s0
.IP "Sympa::DatabaseDriver::LDAP" 4
.IX Item "Sympa::DatabaseDriver::LDAP"
Database driver for \s-1LDAP\s0 search operation
.IP "Sympa::DatabaseDriver::MySQL" 4
.IX Item "Sympa::DatabaseDriver::MySQL"
Database driver for MySQL / MariaDB
.IP "Sympa::DatabaseDriver::ODBC" 4
.IX Item "Sympa::DatabaseDriver::ODBC"
Database driver for \s-1ODBC\s0
.IP "Sympa::DatabaseDriver::Oracle" 4
.IX Item "Sympa::DatabaseDriver::Oracle"
Database driver for Oracle Database
.IP "Sympa::DatabaseDriver::Oracle::St" 4
.IX Item "Sympa::DatabaseDriver::Oracle::St"
Correcting behavior of DBD::Oracle
.IP "Sympa::DatabaseDriver::PostgreSQL" 4
.IX Item "Sympa::DatabaseDriver::PostgreSQL"
Database driver for PostgreSQL
.IP "Sympa::DatabaseDriver::SQLite" 4
.IX Item "Sympa::DatabaseDriver::SQLite"
Database driver for SQLite
.IP "Sympa::DatabaseManager" 4
.IX Item "Sympa::DatabaseManager"
Managing schema of Sympa core database
.IP "Sympa::DataSource" 4
.IX Item "Sympa::DataSource"
Base class of Sympa data source subclasses
.IP "Sympa::DataSource::File" 4
.IX Item "Sympa::DataSource::File"
Data source based on local file
.IP "Sympa::DataSource::LDAP" 4
.IX Item "Sympa::DataSource::LDAP"
Data source based on \s-1LDAP\s0 search operation
.IP "Sympa::DataSource::LDAP2" 4
.IX Item "Sympa::DataSource::LDAP2"
Data source based on \s-1LDAP\s0 with two-level search operations
.IP "Sympa::DataSource::List" 4
.IX Item "Sympa::DataSource::List"
Data source based on a list at local machine
.IP "Sympa::DataSource::RemoteDump" 4
.IX Item "Sympa::DataSource::RemoteDump"
Data source based on a user dump at remote host
.IP "Sympa::DataSource::RemoteFile" 4
.IX Item "Sympa::DataSource::RemoteFile"
Data source based on a file at remote host
.IP "Sympa::DataSource::SQL" 4
.IX Item "Sympa::DataSource::SQL"
Data source based on \s-1SQL\s0 query
.IP "Sympa::Family" 4
.IX Item "Sympa::Family"
List families
.IP "Sympa::HTML::FormatText" 4
.IX Item "Sympa::HTML::FormatText"
\&\s-1TBD\s0
.IP "Sympa::HTMLDecorator" 4
.IX Item "Sympa::HTMLDecorator"
Decorating \s-1HTML\s0 texts
.IP "Sympa::HTMLSanitizer" 4
.IX Item "Sympa::HTMLSanitizer"
Sanitize \s-1HTML\s0 contents
.IP "Sympa::Language" 4
.IX Item "Sympa::Language"
Handling languages and locales
.IP "Sympa::List" 4
.IX Item "Sympa::List"
Mailing list
.IP "Sympa::List::Config" 4
.IX Item "Sympa::List::Config"
List configuration
.IP "Sympa::List::Users" 4
.IX Item "Sympa::List::Users"
List users
.IP "Sympa::ListDef" 4
.IX Item "Sympa::ListDef"
Definition of list configuration parameters
.IP "Sympa::ListOpt" 4
.IX Item "Sympa::ListOpt"
Definition of list configuration parameter values
.IP "Sympa::LockedFile" 4
.IX Item "Sympa::LockedFile"
Filehandle with locking
.IP "Sympa::Log" 4
.IX Item "Sympa::Log"
Logging facility of Sympa
.IP "Sympa::Mailer" 4
.IX Item "Sympa::Mailer"
Store messages to sendmail
.IP "Sympa::Message" 4
.IX Item "Sympa::Message"
Mail message embedding for internal use in Sympa
.IP "Sympa::Message::Plugin" 4
.IX Item "Sympa::Message::Plugin"
process hooks
.IP "Sympa::Message::Plugin::FixEncoding" 4
.IX Item "Sympa::Message::Plugin::FixEncoding"
Example module for message hook to correct charset and encoding of messages
.IP "Sympa::Message::Template" 4
.IX Item "Sympa::Message::Template"
Mail message generated from template
.IP "Sympa::Process" 4
.IX Item "Sympa::Process"
Process of Sympa
.IP "Sympa::Regexps" 4
.IX Item "Sympa::Regexps"
Definition of regular expressions
.IP "Sympa::Request" 4
.IX Item "Sympa::Request"
Requests for operation
.IP "Sympa::Request::Collection" 4
.IX Item "Sympa::Request::Collection"
Collection of requests
.IP "Sympa::Request::Handler" 4
.IX Item "Sympa::Request::Handler"
Base class of request handler classes
.IP "Sympa::Request::Message" 4
.IX Item "Sympa::Request::Message"
Command message as spool of requests
.IP "Sympa::Robot" 4
.IX Item "Sympa::Robot"
\&\s-1TBD\s0
.IP "Sympa::Scenario" 4
.IX Item "Sympa::Scenario"
Authorization scenarios
.IP "Sympa::Spindle" 4
.IX Item "Sympa::Spindle"
Base class of subclasses to define Sympa workflows
.IP "Sympa::Spindle::AuthorizeMessage" 4
.IX Item "Sympa::Spindle::AuthorizeMessage"
Workflow to authorize messages bound for lists
.IP "Sympa::Spindle::AuthorizeRequest" 4
.IX Item "Sympa::Spindle::AuthorizeRequest"
Workflow to authorize requests in command messages
.IP "Sympa::Spindle::DispatchRequest" 4
.IX Item "Sympa::Spindle::DispatchRequest"
Workflow to dispatch requests
.IP "Sympa::Spindle::DistributeMessage" 4
.IX Item "Sympa::Spindle::DistributeMessage"
Workflow to distribute messages to list members
.IP "Sympa::Spindle::DoCommand" 4
.IX Item "Sympa::Spindle::DoCommand"
Workflow to handle command messages
.IP "Sympa::Spindle::DoForward" 4
.IX Item "Sympa::Spindle::DoForward"
Workflow to forward messages to administrators
.IP "Sympa::Spindle::DoMessage" 4
.IX Item "Sympa::Spindle::DoMessage"
Workflow to handle messages bound for lists
.IP "Sympa::Spindle::ProcessArchive" 4
.IX Item "Sympa::Spindle::ProcessArchive"
Workflow of archive storage
.IP "Sympa::Spindle::ProcessAuth" 4
.IX Item "Sympa::Spindle::ProcessAuth"
Workflow of request confirmation
.IP "Sympa::Spindle::ProcessAutomatic" 4
.IX Item "Sympa::Spindle::ProcessAutomatic"
Workflow of automatic list creation
.IP "Sympa::Spindle::ProcessBounce" 4
.IX Item "Sympa::Spindle::ProcessBounce"
Workflow of bounce processing
.IP "Sympa::Spindle::ProcessDigest" 4
.IX Item "Sympa::Spindle::ProcessDigest"
Workflow of digest sending
.IP "Sympa::Spindle::ProcessHeld" 4
.IX Item "Sympa::Spindle::ProcessHeld"
Workflow of message confirmation
.IP "Sympa::Spindle::ProcessIncoming" 4
.IX Item "Sympa::Spindle::ProcessIncoming"
Workflow of processing incoming messages
.IP "Sympa::Spindle::ProcessMessage" 4
.IX Item "Sympa::Spindle::ProcessMessage"
Workflow of command processing
.IP "Sympa::Spindle::ProcessModeration" 4
.IX Item "Sympa::Spindle::ProcessModeration"
Workflow of message moderation
.IP "Sympa::Spindle::ProcessOutgoing" 4
.IX Item "Sympa::Spindle::ProcessOutgoing"
Workflow of message distribution
.IP "Sympa::Spindle::ProcessRequest" 4
.IX Item "Sympa::Spindle::ProcessRequest"
Workflow of request processing
.IP "Sympa::Spindle::ProcessTask" 4
.IX Item "Sympa::Spindle::ProcessTask"
Workflow of task processing
.IP "Sympa::Spindle::ProcessTemplate" 4
.IX Item "Sympa::Spindle::ProcessTemplate"
Workflow of template sending
.IP "Sympa::Spindle::ResendArchive" 4
.IX Item "Sympa::Spindle::ResendArchive"
Workflow of resending messages in archive
.IP "Sympa::Spindle::ToArchive" 4
.IX Item "Sympa::Spindle::ToArchive"
Process to store messages into archiving spool
.IP "Sympa::Spindle::ToAuth" 4
.IX Item "Sympa::Spindle::ToAuth"
Process to store requests into request spool to wait for moderation
.IP "Sympa::Spindle::ToAuthOwner" 4
.IX Item "Sympa::Spindle::ToAuthOwner"
Process to store requests into request spool to wait for moderation
.IP "Sympa::Spindle::ToDigest" 4
.IX Item "Sympa::Spindle::ToDigest"
Process to store messages into digest spool
.IP "Sympa::Spindle::ToEditor" 4
.IX Item "Sympa::Spindle::ToEditor"
Process to forward messages to list editors
.IP "Sympa::Spindle::ToHeld" 4
.IX Item "Sympa::Spindle::ToHeld"
Process to store messages into held spool to wait for confirmation
.IP "Sympa::Spindle::ToList" 4
.IX Item "Sympa::Spindle::ToList"
Process to distribute messages to list members
.IP "Sympa::Spindle::ToListmaster" 4
.IX Item "Sympa::Spindle::ToListmaster"
Process to store messages into spool on memory for listmaster notification
.IP "Sympa::Spindle::ToMailer" 4
.IX Item "Sympa::Spindle::ToMailer"
Process to store messages into sendmail component
.IP "Sympa::Spindle::ToModeration" 4
.IX Item "Sympa::Spindle::ToModeration"
Process to store messages into held spool to wait for moderation
.IP "Sympa::Spindle::ToOutgoing" 4
.IX Item "Sympa::Spindle::ToOutgoing"
Process to store messages into outgoing spool
.IP "Sympa::Spindle::TransformDigestFinal" 4
.IX Item "Sympa::Spindle::TransformDigestFinal"
Process to transform digest messages \- final stage
.IP "Sympa::Spindle::TransformIncoming" 4
.IX Item "Sympa::Spindle::TransformIncoming"
Process to transform messages \- first stage
.IP "Sympa::Spindle::TransformOutgoing" 4
.IX Item "Sympa::Spindle::TransformOutgoing"
Process to transform messages \- second stage
.IP "Sympa::Spool" 4
.IX Item "Sympa::Spool"
Base class of spool classes
.IP "Sympa::Spool::Archive" 4
.IX Item "Sympa::Spool::Archive"
Spool for messages waiting for archiving
.IP "Sympa::Spool::Auth" 4
.IX Item "Sympa::Spool::Auth"
Spool for held requests waiting for moderation
.IP "Sympa::Spool::Automatic" 4
.IX Item "Sympa::Spool::Automatic"
Spool for incoming messages in automatic spool
.IP "Sympa::Spool::Bounce" 4
.IX Item "Sympa::Spool::Bounce"
Spool for incoming bounce messages
.IP "Sympa::Spool::Digest" 4
.IX Item "Sympa::Spool::Digest"
Spool for messages waiting for digest sending
.IP "Sympa::Spool::Digest::Collection" 4
.IX Item "Sympa::Spool::Digest::Collection"
Collection of digest spools
.IP "Sympa::Spool::Held" 4
.IX Item "Sympa::Spool::Held"
Spool for held messages waiting for confirmation
.IP "Sympa::Spool::Incoming" 4
.IX Item "Sympa::Spool::Incoming"
Spool for incoming messages
.IP "Sympa::Spool::Listmaster" 4
.IX Item "Sympa::Spool::Listmaster"
Spool on memory for listmaster notification
.IP "Sympa::Spool::Moderation" 4
.IX Item "Sympa::Spool::Moderation"
Spool for held messages waiting for moderation
.IP "Sympa::Spool::Outgoing" 4
.IX Item "Sympa::Spool::Outgoing"
Spool for outgoing messages
.IP "Sympa::Spool::Task" 4
.IX Item "Sympa::Spool::Task"
Spool for tasks
.IP "Sympa::Spool::Topic" 4
.IX Item "Sympa::Spool::Topic"
Message topic
.IP "Sympa::Task" 4
.IX Item "Sympa::Task"
Tasks of Sympa
.IP "Sympa::Template" 4
.IX Item "Sympa::Template"
Template parser
.IP "Sympa::Ticket" 4
.IX Item "Sympa::Ticket"
One-time ticket for authorization
.IP "Sympa::Tools::Data" 4
.IX Item "Sympa::Tools::Data"
\&\s-1TBD\s0
.IP "Sympa::Tools::DKIM" 4
.IX Item "Sympa::Tools::DKIM"
\&\s-1TBD\s0
.IP "Sympa::Tools::Domains" 4
.IX Item "Sympa::Tools::Domains"
Domains-related functions
.IP "Sympa::Tools::File" 4
.IX Item "Sympa::Tools::File"
File-related functions
.IP "Sympa::Tools::Password" 4
.IX Item "Sympa::Tools::Password"
\&\s-1TBD\s0
.IP "Sympa::Tools::SMIME" 4
.IX Item "Sympa::Tools::SMIME"
\&\s-1TBD\s0
.IP "Sympa::Tools::Text" 4
.IX Item "Sympa::Tools::Text"
Text-related functions
.IP "Sympa::Tools::Time" 4
.IX Item "Sympa::Tools::Time"
Time-related functions
.IP "Sympa::Tracking" 4
.IX Item "Sympa::Tracking"
Spool for message tracking
.IP "Sympa::Upgrade" 4
.IX Item "Sympa::Upgrade"
\&\s-1TBD\s0
.IP "Sympa::User" 4
.IX Item "Sympa::User"
All Users Identified by Sympa
.IP "Sympa::WWW::Auth" 4
.IX Item "Sympa::WWW::Auth"
\&\s-1TBD\s0
.IP "Sympa::WWW::FastCGI" 4
.IX Item "Sympa::WWW::FastCGI"
\&\s-1CGI\s0 Interface for FastCGI of Sympa
.IP "Sympa::WWW::Marc" 4
.IX Item "Sympa::WWW::Marc"
\&\s-1TBD\s0
.IP "Sympa::WWW::Marc::Search" 4
.IX Item "Sympa::WWW::Marc::Search"
Search archives of Sympa
.IP "Sympa::WWW::Report" 4
.IX Item "Sympa::WWW::Report"
\&\s-1TBD\s0
.IP "Sympa::WWW::Session" 4
.IX Item "Sympa::WWW::Session"
Web session
.IP "Sympa::WWW::SharedDocument" 4
.IX Item "Sympa::WWW::SharedDocument"
Shared document repository and its nodes
.IP "Sympa::WWW::SOAP" 4
.IX Item "Sympa::WWW::SOAP"
\&\s-1TBD\s0
.IP "Sympa::WWW::SOAP::Transport" 4
.IX Item "Sympa::WWW::SOAP::Transport"
\&\s-1TBD\s0
.IP "Sympa::WWW::Tools" 4
.IX Item "Sympa::WWW::Tools"
\&\s-1TBD\s0
.SS "Workflow"
.IX Subsection "Workflow"
See Sympa::Internals::Workflow.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBsympa_toc\fR\|(1).
.PP
\&\fISympa Administration Manual\fR.
<https://sympa\-community.github.io/manual/>.