.\" 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
.\" ========================================================================
.\"
.IX Title "News::Scan::Article 3pm"
.TH News::Scan::Article 3pm "2021-01-08" "perl v5.32.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"
News::Scan::Article \- collect information about news articles
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use News::Scan::Article;
\&
\&    my $art = News::Scan::Article\->new( ARG, [ OPTIONS, ] SCAN );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides a derived class of \f(CW\*(C`Mail::Internet\*(C'\fR whose objects
are suitable for digesting Usenet news articles.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.IP "new ( \s-1ARG,\s0 [ \s-1OPTIONS,\s0 ] SCAN-OBJ )" 4
.IX Item "new ( ARG, [ OPTIONS, ] SCAN-OBJ )"
The \f(CW\*(C`ARG\*(C'\fR and \f(CW\*(C`OPTIONS\*(C'\fR parameters are identical to those required by
\&\f(CW\*(C`Mail::Internet\*(C'\fR, except \f(CW\*(C`ARG\*(C'\fR is required.  See Mail::Internet.
The \f(CW\*(C`SCAN\*(C'\fR parameter should be a \f(CW\*(C`News::Scan\*(C'\fR object.  See News::Scan.
.Sp
If the article falls into the period of interest for \f(CW\*(C`SCAN\*(C'\fR, the object
is returned, else \f(CW\*(C`undef\*(C'\fR.
.SH "METHODS"
.IX Header "METHODS"
.IP "group ( [ SCAN-OBJ ] )" 4
.IX Item "group ( [ SCAN-OBJ ] )"
Sets or returns an object's group depending on whether \f(CW\*(C`SCAN\-OBJ\*(C'\fR is
present.
.IP "author" 4
.IX Item "author"
Returns the article's author represented as a \f(CW\*(C`Mail::Address\*(C'\fR object.
.IP "message_id" 4
.IX Item "message_id"
Returns the article's Message-ID.
.IP "subject" 4
.IX Item "subject"
Returns the article's subject.
.IP "newsgroups" 4
.IX Item "newsgroups"
Returns the list of newsgroups this article was posted to.
.IP "size" 4
.IX Item "size"
Returns the size of this article in bytes.
.IP "header_size" 4
.IX Item "header_size"
Returns the size of this article's header in bytes.
.IP "header_lines" 4
.IX Item "header_lines"
Returns the number of lines consumed in this article by headers.
.IP "body_size" 4
.IX Item "body_size"
Returns the size of this article's body in bytes.
.IP "body_lines" 4
.IX Item "body_lines"
Returns the number of lines consumed in this article by the body.
.IP "orig_size" 4
.IX Item "orig_size"
Returns the size of this article's original content in bytes.  See
\&\*(L"QuoteRE\*(R" in News::Scan.
.IP "orig_lines" 4
.IX Item "orig_lines"
Returns the number of lines consumed in this article by original content.
Keep in mind that original content is a subset of the body.
.IP "sig_size" 4
.IX Item "sig_size"
Returns the size of this article'ss signature in bytes.
.IP "sig_lines" 4
.IX Item "sig_lines"
Returns the number of lines consumed in this article by the signature.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
News::Scan, Mail::Internet, Mail::Address
.SH "AUTHOR"
.IX Header "AUTHOR"
Greg Bacon <gbacon@cs.uah.edu>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 1997 Greg Bacon.  All Rights Reserved.
This library is free software.  You may distribute and/or modify it under
the same terms as Perl itself.