News::...Article(3pm)

πŸ’– News::Scan::Article β€” the vibe check on your Usenet articles πŸ’–

okay bestie, so this is a page from the User Contributed Perl Documentation and it's literally all about News::Scan::Article, living in section 3pm of the manual. it's giving "I catalog every little thing about your news articles" energy and honestly? iconic. πŸŽ€


✨ NAME ✨

News::Scan::Article β€” collect information about news articles πŸ’…


✨ SYNOPSIS ✨

use News::Scan::Article;

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

✨ DESCRIPTION ✨

so this module hands you a derived class of Mail::Internet β€” like, it inherits all that good stuff β€” and the objects it makes are perfect for digesting Usenet news articles. that's the whole gig. no cap. πŸ¦‹


✨ CONSTRUCTOR ✨

🌸 new ( ARG, [ OPTIONS, ] SCAN-OBJ )

the ARG and OPTIONS parameters are identical to the ones Mail::Internet needs, with one tiny catch: ARG is required, bestie. go peek at Mail::Internet for the deets.

the SCAN parameter should be a News::Scan object. go peek at News::Scan for that one. πŸ“š

and here's the tea: if the article falls into the period of interest for SCAN, you get the object back. if it doesn't? you get undef. that's it. that's the rule. 😭


✨ METHODS ✨

  • group ( [ SCAN-OBJ ] ) β€” sets or returns an object's group, depending on whether SCAN-OBJ is present or not. no SCAN-OBJ? it's a getter, babes. 🫢
  • author β€” returns the article's author, represented as a Mail::Address object. fancy. ✨
  • 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, so don't get it twisted. 🧚
  • sig_size β€” returns the size of this article'ss signature in bytes. (yes, "article'ss" β€” that's literally what it says, and honestly? we're keeping it. it's part of the lore. πŸ’€)
  • sig_lines β€” returns the number of lines consumed in this article by the signature.

✨ SEE ALSO ✨

News::Scan, Mail::Internet, Mail::Address β€” go read those too, bestie, they're all connected. 🌈


✨ AUTHOR ✨

Greg Bacon <gbacon@cs.uah.edu> 🫢


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. ⭐


and that's the whole page, no skips, no cuts, every single method accounted for. slay. πŸ’…

okay bye bestie, this was perl v5.32.0 dated 2021-01-08 β€” the original News::...Article(3pm) footer energy, but make it cute. πŸŽ€πŸŒΈπŸ’œ

πŸ“¦ where this page comes from