news::scan::article(3pm) [debian man page]

News::Scan::Article(3pm)				User Contributed Perl Documentation				  News::Scan::Article(3pm)

NAME

       News::Scan::Article - collect information about news articles

SYNOPSIS

	   use News::Scan::Article;

	   my $art = News::Scan::Article->new( ARG, [ OPTIONS, ] SCAN );

DESCRIPTION

       This module provides a derived class of "Mail::Internet" whose objects are suitable for digesting Usenet news articles.

CONSTRUCTOR

       new ( ARG, [ OPTIONS, ] SCAN-OBJ )
	   The "ARG" and "OPTIONS" parameters are identical to those required by "Mail::Internet", except "ARG" is required.  See Mail::Internet.
	   The "SCAN" parameter should be a "News::Scan" object.  See News::Scan.

	   If the article falls into the period of interest for "SCAN", the object is returned, else "undef".

METHODS

       group ( [ SCAN-OBJ ] )
	   Sets or returns an object's group depending on whether "SCAN-OBJ" is present.

       author
	   Returns the article's author represented as a "Mail::Address" object.

       message_id
	   Returns the article's Message-ID.

       subject
	   Returns the article's subject.

       newsgroups
	   Returns the list of newsgroups this article was posted to.

       size
	   Returns the size of this article in bytes.

       header_size
	   Returns the size of this article's header in bytes.

       header_lines
	   Returns the number of lines consumed in this article by headers.

       body_size
	   Returns the size of this article's body in bytes.

       body_lines
	   Returns the number of lines consumed in this article by the body.

       orig_size
	   Returns the size of this article's original content in bytes.  See "QuoteRE" in News::Scan.

       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.

       sig_size
	   Returns the size of this article'ss signature in bytes.

       sig_lines
	   Returns the number of lines consumed in this article by the signature.

SEE ALSO

       News::Scan, Mail::Internet, Mail::Address

AUTHOR

       Greg Bacon <gbacon@cs.uah.edu>

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.

perl v5.10.1							    2000-08-09						  News::Scan::Article(3pm)

News::Scan::Poster(3pm) 				User Contributed Perl Documentation				   News::Scan::Poster(3pm)

NAME

       News::Scan::Poster - keep track of posters to a newsgroup

SYNOPSIS

	   use News::Scan::Poster;

	   my $poster = News::Scan::Poster->new($news_scan_article_obj);

DESCRIPTION

       This module provides a class whose objects can be used to keep track of cumulative statistics for posters to a Usenet newsgroup such as
       header volume or signature lines.

CONSTRUCTOR

       new ( ARTICLE )
	   "ARTICLE" should be a "News::Scan::Article" object or inherit from the "News::Scan::Article" class.

	   "new" performs some initialization and returns a "News::Scan::Poster" object.

METHODS

       address ( [ ADDRESS ] )
	   Returns the address of this poster represented as a "Mail::Internet" object.

	   If present, "ADDRESS" tells the object that the "Mail::Internet" object in "ADDRESS" is its address.  idea.

       attrib ( [ ATTRIBUTION ] )
	   Returns some nice attribution for this poster.

	   If present, "ATTRIBUTION" tells the object how it shall identify itself when asked.

       message_ids ( [ MESSAGE-ID ] )
	   Returns a list of Message-IDs attributed to this poster.

	   If present, "MESSAGE-ID" is added to this list of this poster's articles.

       volume
	   Returns the volume in bytes of the traffic generated by this poster.

       articles
	   Returns the number of articles attributed to this poster.

       posted_to
	   Returns a hash whose keys are newsgroup names and whose values are the number of times this poster has crossposted to the group of
	   interest and the corresponding newsgroup.

       crossposts
	   Returns the total number of crossposts this poster has sent through the group of interest.

       header_volume
	   Returns the volume in bytes generated by this poster's headers.

       header_lines
	   Returns the number of header lines generated by this poster.

       body_volume
	   Returns the volume in bytes generated by this poster's message bodies.

       body_lines
	   Returns the number of body lines generated by this poster.

       orig_volume
	   Returns the volume in bytes of original content generated by this poster.

       orig_lines
	   Returns the number of original lines generated by this poster.

       sig_volume
	   Returns the volume in bytes generated by this poster's signatures.

       sig_lines
	   Returns the number of signature lines generated by this poster.

SEE ALSO

       News::Scan, Mail::Address, News::Scan::Article

AUTHOR

       Greg Bacon <gbacon@cs.uah.edu>

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.

perl v5.10.1							    2000-04-13						   News::Scan::Poster(3pm)