Changeset 114 for trunk

Timestamp:

11/07/08 15:33:01 (2 months ago)

Author:

amcgregor

Message:

Fixed docstring as per #88.

Files:

• trunk/turbomail/control.py (modified) (1 diff)

trunk/turbomail/control.py

@@ -7 +7 @@
 in your own applications::
 
-  from turbomail.message import Message
-  from turbomail.control import interface
-  interface.start()
+  import turbomail
   
-  message = Message(...)
-  interface.send(message)
+  turbomail.interface.config = {'mail.on': True, ...}
+  turbomail.interface.start()
   
-  interface.stop()
+  message = turbomail.Message(...)
+  turbomail.interface.send(message)
+  
+  turbomail.interface.stop()
+
+Remember to configure your outbound settings in the config dictionary.
 
 TurboMail will, by default, immediately delete any messages remaining in
-the queue and wait on any in-progress deliveries.  To block execution and
-allow the queue to empty, pass `blocking=True` as an argument to `stop`.
+the queue and wait on any in-progress deliveries.
 """