.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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
.\" ========================================================================
.\"
.IX Title "Email::Thread 3pm"
.TH Email::Thread 3pm "2022-11-21" "perl v5.36.0" "User Contributed Perl Documentation"
.\" 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"
Email::Thread \- Use JWZ's mail threading algorithm with Email::Simple objects
.SH "VERSION"
.IX Header "VERSION"
version 0.713
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use Email::Thread;
\&    my $threader = Email::Thread\->new(@messages);
\&
\&    $threader\->thread;
\&
\&    dump_em($_,0) for $threader\->rootset;
\&
\&    sub dump_em {
\&        my ($self, $level) = @_;
\&        debug (\*(Aq \e\e\-> \*(Aq x $level);
\&        if ($self\->message) {
\&            print $self\->message\->header("Subject") , "\en";
\&        } else {
\&            print "[ Message $self not available ]\en";
\&        }
\&        dump_em($self\->child, $level+1) if $self\->child;
\&        dump_em($self\->next, $level) if $self\->next;
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Strictly speaking, this doesn't really need Email::Simple objects.
It just needs an object that responds to the same \s-1API.\s0 At the time of
writing the list of classes with the Email::Simple \s-1API\s0 comprises just
Email::Simple.
.PP
Due to how it's implemented, its \s-1API\s0 is an exact clone of
Mail::Thread.  Please see that module's documentation for \s-1API\s0
details. Just mentally substitute \f(CW\*(C`Email::Thread\*(C'\fR everywhere you see
\&\f(CW\*(C`Mail::Thread\*(C'\fR and \f(CW\*(C`Email::Thread::Container\*(C'\fR where you see
\&\f(CW\*(C`Mail::Thread::Container\*(C'\fR.
.SH "PERL VERSION"
.IX Header "PERL VERSION"
This module should work on any version of perl still receiving updates from
the Perl 5 Porters.  This means it should work on any version of perl released
in the last two to three years.  (That is, if the most recently released
version is v5.40, then this module should work on both v5.40 and v5.38.)
.PP
Although it may work on older versions of perl, no guarantee is made that the
minimum required version will not be increased.  The version may be increased
for any reason, and there is no promise that patches will be accepted to lower
the minimum required perl.
.SH "THANKS"
.IX Header "THANKS"
Simon Cozens (\s-1SIMON\s0) for encouraging me to release it, and for
Email::Simple and Mail::Thread.
.PP
Richard Clamp (\s-1RCLAMP\s0) for the header patch.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
perl, Mail::Thread, Email::Simple
.SH "AUTHOR"
.IX Header "AUTHOR"
Iain Truskett <spoon@cpan.org>
.SH "CONTRIBUTOR"
.IX Header "CONTRIBUTOR"
Ricardo Signes <rjbs@semiotic.systems>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2003 by Iain Truskett <spoon@cpan.org>.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.