gh-148770: Document quoting requirement for IMAP mailbox names with spaces#148785
Open
CodeLine9 wants to merge 2 commits into
Open
gh-148770: Document quoting requirement for IMAP mailbox names with spaces#148785CodeLine9 wants to merge 2 commits into
CodeLine9 wants to merge 2 commits into
Conversation
…with spaces
Add a note to IMAP4.select() documenting that mailbox names containing
spaces must be quoted by the caller, e.g. M.select('"my important mail"').
|
All commit authors signed the Contributor License Agreement. |
bedevere-app
Bot
added
awaiting review
docs
Documentation build overview
126 files changed ·
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
IMAP4.select()docs don't mention that mailbox names containing spaces must be quoted by the caller. Since_command()sends arguments as-is (no auto-quoting), a call likeM.select('my important mail')sends the space-delimited name to the server, causing errors.Added a note to the
select()method documentation showing the correct usage:M.select('"my important mail"').Fixes #148770.
📚 Documentation preview 📚: https://cpython-previews--148785.org.readthedocs.build/