svn commit: r169682 - /spamassassin/trunk/lib/Mail/SpamAssassin/PerMsgStatus.pm

[fe...@apache.org]

Author: felicity
Date: Wed May 11 12:37:44 2005
New Revision: 169682

URL: http://svn.apache.org/viewcvs?rev=169682&view=rev
Log:
add POD for get_uri_detail_list()

Modified:
    spamassassin/trunk/lib/Mail/SpamAssassin/PerMsgStatus.pm

Modified: spamassassin/trunk/lib/Mail/SpamAssassin/PerMsgStatus.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/PerMsgStatus.pm?rev=169682&r1=169681&r2=169682&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/PerMsgStatus.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/PerMsgStatus.pm Wed May 11 12:37:44 2005
@@ -1886,6 +1886,31 @@
   return @uris;
 }
 
+=item $status->get_uri_detail_list ()
+
+Returns a hash reference of all unique URIs found in the message and
+various data about where the URIs were found in the message.  It takes a
+combination of the URIs found in the rendered (decoded and HTML stripped)
+body and the URIs found when parsing the HTML in the message.  Will also
+set $status->{uri_detail_list} (the hash reference as returned by this
+function).
+
+The hash format looks something like this:
+
+  raw_uri => {
+    types => { a => 1, img => 1, parsed => 1 },
+    cleaned => ( canonified_uri )
+  }
+
+C<raw_uri> is whatever the URI was in the message itself
+(http://spamassassin.apache%2Eorg/).  C<types> is a hash of the HTML
+tags (lowercase) which referenced the raw_uri.  I<parsed> is a faked
+type which specifies that the raw_uri was seen in the rendered text.
+C<cleaned> is an array of the raw and canonified version of the raw_uri
+(http://spamassassin.apache%2Eorg/, http://spamassassin.apache.org/).
+
+=cut
+
 sub get_uri_detail_list {
   my ($self) = @_;