[Rt-commit] r7383 - in rt/branches/3.7-EXPERIMENTAL: .

[ruz at bestpractical.com]

Author: ruz
Date: Thu Mar 29 11:04:05 2007
New Revision: 7383

Modified:
   rt/branches/3.7-EXPERIMENTAL/   (props changed)
   rt/branches/3.7-EXPERIMENTAL/lib/RT/Interface/Email.pm

Log:
 r4829 at cubic-pc:  cubic | 2007-03-29 10:40:47 +0400
 * docs update


Modified: rt/branches/3.7-EXPERIMENTAL/lib/RT/Interface/Email.pm
==============================================================================
--- rt/branches/3.7-EXPERIMENTAL/lib/RT/Interface/Email.pm	(original)
+++ rt/branches/3.7-EXPERIMENTAL/lib/RT/Interface/Email.pm	Thu Mar 29 11:04:05 2007
@@ -104,8 +104,9 @@
 
 =head2 CheckForLoops HEAD
 
-Returns true if the message's been sent by this RT instance.
-Uses "X-RT-Loop-Prevention" field of the head for that.
+Takes a HEAD object of L<MIME::Head> class and returns true if the
+message's been sent by this RT instance. Uses "X-RT-Loop-Prevention"
+field of the head for test.
 
 =cut
 
@@ -126,7 +127,8 @@
 
 =head2 CheckForSuspiciousSender HEAD
 
-Returns true if sender is suspicious. Suspicious means mailer daemon.
+Takes a HEAD object of L<MIME::Head> class and returns true if sender
+is suspicious. Suspicious means mailer daemon.
 
 See also L</ParseSenderAddressFromHead>.
 
@@ -156,8 +158,9 @@
 
 =head2 CheckForAutoGenerated HEAD
 
-Returns true if message is autogenerated. Checks 'Precedence'
-and 'X-FC-Machinegenerated' fields of the head.
+Takes a HEAD object of L<MIME::Head> class and returns true if message
+is autogenerated. Checks 'Precedence' and 'X-FC-Machinegenerated'
+fields of the head in tests.
 
 =cut
 
@@ -294,13 +297,15 @@
 }
 
 
-=head2 SendEmail entity => ENTITY, [bounce => BOUNCE]
+=head2 SendEmail Entity => undef, [ Bounce => 0, Ticket => undef, Transaction => undef ]
 
 Sends an email (passed as a L<MIME::Entity> object C<ENTITY>) using
-RT's outgoing mail configuration.  If C<BOUNCE> is passed, and is a
+RT's outgoing mail configuration. If C<BOUNCE> is passed, and is a
 true value, the message will be marked as an autogenerated error, if
 possible.
 
+Sets Date field of the head to now if it's not set.
+
 =cut
 
 sub SendEmail {