commit 8e2b3bd5259e261ddc8670586ac242bfbe9f097b Author: Isis Lovecruft <isis@torproject.org> Date: Thu May 15 00:09:41 2014 +0000 Document instance variables for the email.server.MailMessage class. * FIXES the `list` ivar accidentally being documented in the __init__() method as a parameter. * THANKS to sysrqb for pointing out the mistake. --- lib/bridgedb/email/server.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/lib/bridgedb/email/server.py b/lib/bridgedb/email/server.py index e963e61..f550052 100644 --- a/lib/bridgedb/email/server.py +++ b/lib/bridgedb/email/server.py @@ -457,13 +457,18 @@ class MailResponse(object): class MailMessage(object): - """Plugs into the Twisted Mail and receives an incoming message.""" + """Plugs into the Twisted Mail and receives an incoming message. + + :ivar list lines: A list of lines from an incoming email message. + :ivar int nBytes: The number of bytes received thus far. + :ivar bool ignoring: If ``True``, we're ignoring the rest of this message + because it exceeded :ivar:`MailContext.maximumSize`. + """ implements(smtp.IMessage) def __init__(self, context, fromCanonical=None): """Create a new MailMessage from a MailContext. - :param list lines: A list of lines from an incoming email message. :type context: :class:`MailContext` :param context: The configured context for the email server. :type canonicalFrom: str or None