From 8e8844a5aaba94df32ab037acd3bae028d2e19e8 Mon Sep 17 00:00:00 2001 From: Kartikaya Gupta Date: Wed, 22 Jun 2016 10:10:50 -0400 Subject: Update package documentation to mention Maildir --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 36fd249..a22d019 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ The primary entry point for this library is the following function: This function takes the raw message data, including headers and body, and returns a structured object to more easily access pieces of the email message. There are other public functions that allow parsing smaller parts of the message as well; refer to the [full documentation](http://staktrace.github.io/mailparse/target/doc/mailparse/). -The library is designed to process real-world email data such as might be obtained by using the FETCH command on an IMAP server. +The library is designed to process real-world email data such as might be obtained by using the FETCH command on an IMAP server, or in a Maildir. As such, this library should successfully handle any valid MIME-formatted message, although it may not follow all the strict requirements in the various specifications that cover the format (predominantly IETF RFC 822 and IETF RFC 2045). As an example, this library accepts raw message data which uses \n (ASCII LF) as line delimiters rather than the RFC-mandated \r\n (ASCII CRLF) line delimiters. -- cgit v1.2.3