Rev 2595: Doc for EmailMessage.send in http://sourcefrog.net/bzr/email_message

[Martin Pool]

At http://sourcefrog.net/bzr/email_message

------------------------------------------------------------
revno: 2595
revision-id: mbp at sourcefrog.net-20070709045800-16e3clqhjgdq7djf
parent: mbp at sourcefrog.net-20070709044312-ltf0i26brexb8i2d
committer: Martin Pool <mbp at sourcefrog.net>
branch nick: email_message
timestamp: Mon 2007-07-09 14:58:00 +1000
message:
  Doc for EmailMessage.send
modified:
  bzrlib/email_message.py        email_message.py-20070619201106-2k56zg9cd41qp3nh-1
=== modified file 'bzrlib/email_message.py'
--- a/bzrlib/email_message.py	2007-06-26 19:49:21 +0000
+++ b/bzrlib/email_message.py	2007-07-09 04:58:00 +0000
@@ -90,13 +90,18 @@
         self.attach(payload)
 
     @staticmethod
-    def send(config, from_address, to_address, subject, body, attachment=None,
+    def send(config, from_address, to_address, subject, body,
+            attachment=None,
             attachment_filename=None):
         """Create an email message and send it with SMTPConnection.
 
         See SMTPConnection.__init__(), EmailMessage.__init__() and
         EmailMessage.add_inline_attachment() for an explanation of the
         parameters.
+
+        :param config: ConfigObj instance governing how the message 
+            is sent, typically for the branch etc that's causing it 
+            to be sent.
         """
         msg = EmailMessage(from_address, to_address, subject, body)
         if attachment is not None: