rev 1817 - trunk/Email-Store-Pristine/lib/Email/Store

[prev] [thread] [next] [lurker] [Date index for 2005/02/04]

From: richardc
Subject: rev 1817 - trunk/Email-Store-Pristine/lib/Email/Store
Date: 12:02 on 04 Feb 2005
Author: richardc
Date: 2005-02-04 12:02:33 +0000 (Fri, 04 Feb 2005)
New Revision: 1817

Modified:
   trunk/Email-Store-Pristine/lib/Email/Store/Pristine.pm
Log:
docs, version string


Modified: trunk/Email-Store-Pristine/lib/Email/Store/Pristine.pm
===================================================================
--- trunk/Email-Store-Pristine/lib/Email/Store/Pristine.pm	2005-02-04 10:02:38 UTC (rev 1816)
+++ trunk/Email-Store-Pristine/lib/Email/Store/Pristine.pm	2005-02-04 12:02:33 UTC (rev 1817)
@@ -4,7 +4,30 @@
 
 =head1 DESCRIPTION
 
+Many Email::Store plugins will munge the underlying rfc2822
+representation of the message, which in some cases is undesirable.
 
+When in use Email::Store::Pristine stores a copy of the original
+message in a pristine_copies relationship.  This is a one-to-many
+relationship as in the case of a cross-posted mail you may recieve
+many subtly different versions of the same mail, for which there will
+be only one Email::Store::Mail message due to the unchanging
+Message-ID.
+
+A C<pristine_copies> accessor is added to the Email::Store::Mail
+object, which returns Email::Store::Pristine copies which encapsulate
+the original message.
+
+=head1 METHODS
+
+=head2 ->message
+
+The pristine rfc2822 message.  A readonly accessor.
+
+=head2 ->simple
+
+The message represented as an Email::Simple object.
+
 =head1 AUTHOR
 
 Richard Clamp <richardc@xxxxxxxxx.xxx>
@@ -26,6 +49,7 @@
 package Email::Store::Pristine;
 use strict;
 use warnings;
+our $VERSION = '1.21';
 use base 'Email::Store::DBI';
 __PACKAGE__->table("pristine");
 __PACKAGE__->columns(All  => qw/id mail message/);

Generated at 13:00 on 04 Feb 2005 by mariachi 0.52