Commit ba352027 authored by sikeda's avatar sikeda
Browse files

[-dev] Copyedit of documentation.


git-svn-id: https://subversion.renater.fr/sympa/branches/sympa-6.2-branch@12406 05aa8bb8-cd2b-0410-b1d7-8918dfa770ce
parent 007166d5
......@@ -4370,41 +4370,9 @@ This is set by L</check_spam_status>() method.
=head2 Serialization
L<Sympa::Message> object includes number of slots as hash items:
metadata, context, attributes and message content.
B<Metadata> is given by spool.
On spool based on filesystem, it is typically encoded into file names.
For example a file name
listname-owner@domain.name.143599229.12345
encodes the metadata
localpart => 'listname-owner',
listname => 'listname',
listtype => 'return_path',
domainpart => 'domain.name',
date => 143599229,
Metadata always includes information of B<context>: List, Robot or
Site. For example:
- Incoming post bound for E<lt>listname@domain.nameE<gt>:
context => Sympa::List <listname@domain.name>,
- Incoming command message bound for E<lt>sympa@domain.nameE<gt>:
context => 'domain.name',
- Message sent from Sympa to super-listmaster(s):
context => '*'
Context is determined when the object is instantiated, and never
changed through its lifetime.
Thus, constructor of objects should take context object as an
argument.
B<metadata>, B<context>, B<attributes> and B<message content>.
Metadata including context are given by spool:
See L<Sympa::Spool/"Marshaling and unmarshaling metadata">.
Logically, objects are stored into physical spool as B<serialized form>
and deserialized when they are fetched from spool.
......
......@@ -828,6 +828,42 @@ By default store() returns marshalled metadata
=back
=head2 Marshaling and unmarshaling metadata
Spool class gives generator class the B<metadata> to instantiate it.
On spool based on filesystem, it is typically encoded into file names.
For example a file name in incoming spool (L<Sympa::Spool::Incoming>)
listname-owner@domain.name.143599229.12345
encodes the metadata
localpart => 'listname-owner',
listname => 'listname',
listtype => 'return_path',
domainpart => 'domain.name',
date => 143599229,
Metadata always includes information of B<context>: List, Robot or
Site. For example:
- Message in incoming spool bound for E<lt>listname@domain.nameE<gt>:
context => Sympa::List <listname@domain.name>,
- Command message in incoming spool bound for E<lt>sympa@domain.nameE<gt>:
context => 'domain.name',
- Message sent from Sympa to super-listmaster(s):
context => '*'
Context is determined when the generator class is instantiated, and
generally never changed through lifetime of instance.
Thus, constructor of generator class should take context object as an
argument.
=head1 CONFIGURATION PARAMETERS
Following site configuration parameters in sympa.conf will be referred.
......
......@@ -77,9 +77,13 @@ See also L<Sympa::Spool/"Public methods">.
Order is controled by delivery date, then by reception date.
=item store ( $message, [ original =E<gt> $original ] )
=back
=head2 Context and metadata
See also L<Sympa::Spool/"Marshaling and unmarshaling metadata">.
Following metadata of $message are referred:
This class particularly gives following metadata:
=over
......@@ -93,8 +97,6 @@ Unix time in floating point number when the message was stored.
=back
=back
=head1 CONFIGURATION PARAMETERS
Following site configuration parameters in sympa.conf will be referred.
......
......@@ -77,7 +77,13 @@ Messages with lowest priority (C<z> or C<Z>) are skipped.
In most cases, familyqueue(8) program stores messages to automatic spool.
This method is not used in ordinal case.
Following metadata is referred:
=back
=head2 Context and metadata
See also L<Sympa::Spool/"Marshaling and unmarshaling metadata">.
This class particularly gives following metadata:
=over
......@@ -87,8 +93,6 @@ Unix time when the message would be delivered.
=back
=back
=head1 CONFIGURATION PARAMETERS
Following site configuration parameters in sympa.conf will be referred.
......
......@@ -76,7 +76,13 @@ Order is controled by modification time of files and delivery date.
In most cases, bouncequeue(8) program stores messages to bounce spool.
This method is not used in ordinal case.
Following metadata is referred:
=back
=head2 Context and metadata
See also L<Sympa::Spool/"Marshaling and unmarshaling metadata">.
This class particularly gives following metadata:
=over
......@@ -86,8 +92,6 @@ Unix time when the message would be delivered.
=back
=back
=head1 CONFIGURATION PARAMETERS
Following site configuration parameters in sympa.conf will be referred.
......
......@@ -146,33 +146,35 @@ Creates new instance of L<Sympa::Spool::Digest> related to the list $list.
Order is controled by delivery date, then by reception date.
=item store ( $message, [ original =E<gt> $original ] )
Following metadata of $message are referred:
=back
=over
=head2 Properties
=item {date}
See also L<Sympa::Spool/"Properties">.
Unix time when the message was delivered.
=over
=item {time}
Unix time in floating point number when the message was stored.
Earliest time of messages in the spool, or C<undef>.
=back
=back
=head2 Context and metadata
=head2 Properties
See also L<Sympa::Spool/"Marshaling and unmarshaling metadata">.
See also L<Sympa::Spool/"Properties">.
This class particularly gives following metadata:
=over
=item {date}
Unix time when the message was delivered.
=item {time}
Earliest time of messages in the spool, or C<undef>.
Unix time in floating point number when the message was stored.
=back
......
......@@ -104,6 +104,21 @@ If storing succeeded, returns authentication key.
=back
=head2 Context and metadata
See also L<Sympa::Spool/"Marshaling and unmarshaling metadata">.
This class particularly gives following metadata:
=over
=item {authkey}
Authentication key generated automatically
when the message is stored to spool.
=back
=head1 CONFIGURATION PARAMETERS
Following site configuration parameters in sympa.conf will be referred.
......
......@@ -119,7 +119,13 @@ Messages with lowest priority (C<z> or C<Z>) are skipped.
In most cases, queue(8) program stores messages to incoming spool.
Daemon such as sympa_automatic(8) uses this method to store messages.
Following metadata is referred:
=back
=head2 Context and metadata
See also L<Sympa::Spool/"Marshaling and unmarshaling metadata">.
This class particularly gives following metadata:
=over
......@@ -129,8 +135,6 @@ Unix time when the message would be delivered.
=back
=back
=head1 CONFIGURATION PARAMETERS
Following site configuration parameters in sympa.conf will be referred.
......
......@@ -225,6 +225,26 @@ None.
=back
=head2 Context and metadata
See also L<Sympa::Spool/"Marshaling and unmarshaling metadata">.
This class particularly gives following metadata:
=over
=item {authkey}
Moderation key generated automatically
when the message is stored into spool.
=item {validated}
Keeps a string representing extension, if message has been renamed using
remove() with option.
=back
=head1 CONFIGURATION PARAMETERS
Following site configuration parameters in sympa.conf will be referred.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment