svn commit: r1931946 - spamassassin/trunk/lib/Mail/SpamAssassin

Author: gbechis
Date: Fri Feb 20 07:15:05 2026
New Revision: 1931946

Log:
document more metadata related subs

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

Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Message.pm
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Message.pm	Fri Feb 20 04:20:03 2026	(r1931945)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Message.pm	Fri Feb 20 07:15:05 2026	(r1931946)
@@ -615,6 +615,8 @@ sub generate_msgid {
 
 =item extract_message_metadata($permsgstatus)
 
+Extracts message metadata from the email, it's called once per message
+
 =cut
 
 sub extract_message_metadata {
@@ -631,6 +633,8 @@ sub extract_message_metadata {
 
 =item $str = get_metadata($hdr)
 
+Returns an item from the metadata structure.
+
 =cut
 
 sub get_metadata {
@@ -646,6 +650,8 @@ sub get_metadata {
 
 =item put_metadata($hdr, $text)
 
+Inserts an item into the metadata structure.
+
 =cut
 
 sub put_metadata {
@@ -659,6 +665,8 @@ sub put_metadata {
 
 =item delete_metadata($hdr)
 
+Removes an item from the metadata structure.
+
 =cut
 
 sub delete_metadata {
@@ -671,6 +679,8 @@ sub delete_metadata {
 
 =item $str = get_all_metadata()
 
+Returns all metadata as a string if in scalar context, otherwise as an array.
+
 =cut
 
 sub get_all_metadata {