Changeset 88

Timestamp:

03/10/08 14:02:00 (8 months ago)

Author:

amcgregor

Message:

Added docstring to Address class.

Files:

• trunk/turbomail/util.py (modified) (2 diffs)

trunk/turbomail/util.py

@@ -1 +1 @@
 # encoding: utf-8
 
-"""MIME-encoded electronic mail message classes."""
+"""TurboMail utility functions and support classes."""
 
 __version__ = "$Revision$"
@@ -15 +15 @@
 
 class Address(object):
+    """Validated electonic mail address class.
+    
+    This class knows how to validate and format e-mail addresses.  It
+    uses Python's built-in `parseaddr` and `formataddr` helper
+    functions and helps guarentee a uniform base for all e-mail
+    address operations.
+    
+    The AddressList unit tests provide comprehensive testing of this
+    class as well."""
+    
     validator = re.compile(r'^([0-9a-zA-Z]([-.\w]*[0-9a-zA-Z])*(\+([0-9a-zA-Z])+)?@([0-9a-zA-Z][-\w]*[0-9a-zA-Z]\.)+[a-zA-Z]{2,9})$')