[Checkins] SVN: Products.TransactionalMailHost/trunk/mailhost.py update docstring for send()

Andreas Jung andreas at andreas-jung.com
Sat Aug 18 13:40:19 EDT 2007


Log message for revision 78963:
  update docstring for send()
  

Changed:
  U   Products.TransactionalMailHost/trunk/mailhost.py

-=-
Modified: Products.TransactionalMailHost/trunk/mailhost.py
===================================================================
--- Products.TransactionalMailHost/trunk/mailhost.py	2007-08-18 17:16:33 UTC (rev 78962)
+++ Products.TransactionalMailHost/trunk/mailhost.py	2007-08-18 17:40:19 UTC (rev 78963)
@@ -78,15 +78,17 @@
                                             self.smtp_username or None,
                                             self.smtp_password or None,
                                             )
-
         return self._v_mailer
 
 
     security.declareProtected(use_mailhost_services, 'send')
     def send(self, message, fromaddr, toaddrs, subject=None, encode=None):
-        """ Send out a mail.
+        """ Send out an email.
             'subject' and 'encode' are unused (and kept right now
             for backward compatibility.
+            'message' should be a properly formatted RFC-822 compliant
+            email message (e.g. as produced by Python's email module.
+            
         """
 
         delivery = DirectMailDelivery(self._getMailer())
@@ -100,7 +102,6 @@
 
         if hasattr(self, '_v_mailer'):
             del self._v_mailer
-
         return super(MailHost, self).manage_editProperties(REQUEST)
 
 



More information about the Checkins mailing list