twisted.mail.pop3._HeadersPlusNLines
class documentationtwisted.mail.pop3
View Source
(View In Hierarchy)
A utility class to retrieve the header and some lines of the body of a mail message.
Instance Variable | linecount | The number of full lines of the message body scanned. (type: int ) |
Instance Variable | headers | An indication of which part of the message is being scanned.
True for the header and False for the body. (type: bool ) |
Instance Variable | done | A flag indicating when the desired part of the message has been scanned. (type: bool ) |
Instance Variable | buf | The portion of the message body that has been scanned, up to n
lines. (type: bytes ) |
Method | __init__ | |
Method | read | Scan bytes from the file. |
Instance Variable | _file | See __init__ |
Instance Variable | _extraLines | See __init__ |
True
for the header and False
for the body. (type: bool
)
Parameters | file | A file containing a mail message. (type: file-like object) |
extraLines | The number of lines of the message body to retrieve. (type: int ) |
Scan bytes from the file.
Parameters | bytes | The number of bytes to read from the file. (type: int ) |
Returns | Each portion of the header as it is scanned. Then, full lines of the
message body as they are scanned. When more than one line of the header
and/or body has been scanned, the result is the concatenation of the lines.
When the scan results in no full lines, the empty string is returned. (type: bytes ) |