Skip to content

bpo-30088: Document that existing dir structure isn't verified by mailbox.Maildir #1163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Jul 13, 2019
Merged

bpo-30088: Document that existing dir structure isn't verified by mailbox.Maildir #1163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
55f1670
Add test for creation of maildir subdirs
webknjaz Apr 16, 2017
a451dc7
Ensure maildir's subdirs exist upon initialization
webknjaz Apr 16, 2017
f4de906
Add Sviatoslav Sydorenko to Misc/ACKS
webknjaz Apr 16, 2017
26f16a2
Add test for raising error if maildir is invalid
webknjaz Apr 17, 2017
9a42867
Fix mailbox instantiation in test
webknjaz Apr 17, 2017
3059564
Make checked subpath absolute in test
webknjaz Apr 18, 2017
aff2caa
Turn assertRaisesRegex into assertRaises
webknjaz Apr 19, 2017
07c2e76
Revert "Turn assertRaisesRegex into assertRaises"
webknjaz Jul 13, 2019
d9f791d
Revert "Make checked subpath absolute in test"
webknjaz Jul 13, 2019
e0d4f8c
Revert "Fix mailbox instantiation in test"
webknjaz Jul 13, 2019
48dd6d8
Revert "Add test for raising error if maildir is invalid"
webknjaz Jul 13, 2019
3ff5052
Revert "Ensure maildir's subdirs exist upon initialization"
webknjaz Jul 13, 2019
0104260
Revert "Add test for creation of maildir subdirs"
webknjaz Jul 13, 2019
f7aa474
📝 Document Mailbox(create=True) existing behavior
webknjaz Jul 13, 2019
71282da
📜🤖 Added by blurb_it.
blurb-it[bot] Jul 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Doc/library/mailbox.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,9 @@ Supported mailbox formats are Maildir, mbox, MH, Babyl, and MMDF.
representation. If *create* is ``True``, the mailbox is created if it does not
exist.

If *create* is ``True`` and the *dirname* path exists, it will be treated as
an existing maildir without attempting to verify its directory layout.

It is for historical reasons that *dirname* is named as such rather than *path*.

Maildir is a directory-based mailbox format invented for the qmail mail
Expand Down
1 change: 1 addition & 0 deletions Misc/ACKS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1612,6 +1612,7 @@ Kalle Svensson
Andrew Svetlov
Paul Swartz
Al Sweigart
Sviatoslav Sydorenko
Thenault Sylvain
Péter Szabó
John Szakmeister
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Documentation/2019-07-13-12-43-01.bpo-30088.CIcBjy.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Documented that :class:`mailbox.Maildir` constructor doesn't attempt to verify the maildir folder layout correctness. Patch by Sviatoslav Sydorenko.