.\" 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::Tracking 3Sympa"
.TH Sympa::Tracking 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::Tracking \- Spool for message tracking
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\s-1TBD.\s0
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The tracking feature is a way to request Delivery Status Notification (\s-1DSN\s0) or
\&\s-1DSN\s0 and Message Disposition Notification (\s-1MDN\s0) when sending a 
message to each subscribers. In that case, Sympa (bounced.pl) collect both 
\&\s-1DSN\s0 and \s-1MDN\s0 and store them in tracking spools.
Thus, for each message, the user can know which subscribers has displayed,
received or not received the message. This can be used for some important 
list where list owner need to collect the proof of reception or display of 
each message.
.SS "Methods"
.IX Subsection "Methods"
.ie n .IP "new ( context => $list )" 4
.el .IP "new ( context => \f(CW$list\fR )" 4
.IX Item "new ( context => $list )"
\&\fIConstructor\fR.
Creates new Sympa::Tracking instance.
.Sp
Parameter:
.RS 4
.ie n .IP "context => $list" 4
.el .IP "context => \f(CW$list\fR" 4
.IX Item "context => $list"
Sympa::List object.
.RE
.RS 4
.Sp
Returns:
.Sp
New Sympa::Tracking object or \f(CW\*(C`undef\*(C'\fR.
If unrecoverable error occurred, this method will die.
.RE
.ie n .IP "db_fetch ( recipient => $email, envid => $envid )" 4
.el .IP "db_fetch ( recipient => \f(CW$email\fR, envid => \f(CW$envid\fR )" 4
.IX Item "db_fetch ( recipient => $email, envid => $envid )"
\&\s-1TBD.\s0
.IP "get_recipients_status" 4
.IX Item "get_recipients_status"
\&\s-1TBD.\s0
.ie n .IP "register ( $message, $rcpts, reception_option => $mode )" 4
.el .IP "register ( \f(CW$message\fR, \f(CW$rcpts\fR, reception_option => \f(CW$mode\fR )" 4
.IX Item "register ( $message, $rcpts, reception_option => $mode )"
\&\fIInstance method\fR.
Initializes notification table for each subscriber.
.Sp
Parameters:
.RS 4
.ie n .IP "$message" 4
.el .IP "\f(CW$message\fR" 4
.IX Item "$message"
The message.
.ie n .IP "$rcpts" 4
.el .IP "\f(CW$rcpts\fR" 4
.IX Item "$rcpts"
An arrayref of recipients.
.ie n .IP "reception_option => $mode" 4
.el .IP "reception_option => \f(CW$mode\fR" 4
.IX Item "reception_option => $mode"
The reception option of those subscribers.
.RE
.RS 4
.Sp
Returns:
.Sp
\&\f(CW1\fR or \f(CW\*(C`undef\*(C'\fR.
.RE
.ie n .IP "store ( $message, $rcpt, [ envid => $envid, status => $status, type => $type, arrival_date => $datestring ] )" 4
.el .IP "store ( \f(CW$message\fR, \f(CW$rcpt\fR, [ envid => \f(CW$envid\fR, status => \f(CW$status\fR, type => \f(CW$type\fR, arrival_date => \f(CW$datestring\fR ] )" 4
.IX Item "store ( $message, $rcpt, [ envid => $envid, status => $status, type => $type, arrival_date => $datestring ] )"
\&\fIInstance method\fR.
Store notification into tracking spool.
.Sp
Parameters:
.RS 4
.ie n .IP "$message" 4
.el .IP "\f(CW$message\fR" 4
.IX Item "$message"
Notification message.
.ie n .IP "$rcpt" 4
.el .IP "\f(CW$rcpt\fR" 4
.IX Item "$rcpt"
E\-mail address of recipient of original message.
.ie n .IP "envid => $envid, status => $status, type => $type, arrival_date => $datestring" 4
.el .IP "envid => \f(CW$envid\fR, status => \f(CW$status\fR, type => \f(CW$type\fR, arrival_date => \f(CW$datestring\fR" 4
.IX Item "envid => $envid, status => $status, type => $type, arrival_date => $datestring"
If these optional parameters are specified,
notification table is updated.
.RE
.RS 4
.Sp
Returns:
.Sp
True value if storing succeed.  Otherwise false.
.RE
.IP "find_notification_id_by_message" 4
.IX Item "find_notification_id_by_message"
\&\s-1TBD.\s0
.IP "remove_message_by_email" 4
.IX Item "remove_message_by_email"
\&\s-1TBD.\s0
Introduced on Sympa 6.2.19b.
.IP "remove_message_by_id" 4
.IX Item "remove_message_by_id"
\&\s-1TBD.\s0
.IP "remove_message_by_period" 4
.IX Item "remove_message_by_period"
\&\s-1TBD.\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBbounced\fR\|(8), Sympa::Message, Sympa::Spool::Bounce.
.SH "HISTORY"
.IX Header "HISTORY"
The tracking feature was contributed by
Guillaume Colotte and laurent Cailleux,
French army \s-1DGA\s0 Information Superiority.
.PP
Sympa::Tracking module appeared on Sympa 6.2.