Skip to content

gh-40038: Quote imaplib command arguments when necessary #152703

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

Open
serhiy-storchaka wants to merge 1 commit into
base: main
Choose a base branch
from
+878 −69
Open

gh-40038: Quote imaplib command arguments when necessary #152703

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions Doc/library/imaplib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,9 @@ enclosed with either parentheses or double quotes) each string is quoted.
However, the *password* argument to the ``LOGIN`` command is always quoted. If
you want to avoid having an argument string quoted (eg: the *flags* argument to
``STORE``) then enclose the string in parentheses (eg: ``r'(\Deleted)'``).
In general, pass arguments unquoted and let the module quote them as needed.
An argument that is already enclosed in double quotes is left unchanged,
so that code which quotes arguments itself keeps working.

Most commands return a tuple: ``(type, [data, ...])`` where *type* is usually
``'OK'`` or ``'NO'``, and *data* is either the text from the command response,
Expand Down Expand Up @@ -392,7 +395,7 @@ An :class:`IMAP4` instance has the following methods:
.. versionadded:: 3.14


.. method:: IMAP4.list([directory[, pattern]])
.. method:: IMAP4.list(directory='', pattern='*')

List mailbox names in *directory* matching *pattern*. *directory* defaults to
the top-level mail folder, and *pattern* defaults to match anything. Returned
Expand Down Expand Up @@ -422,7 +425,7 @@ An :class:`IMAP4` instance has the following methods:
The method no longer ignores silently arbitrary exceptions.


.. method:: IMAP4.lsub(directory='""', pattern='*')
.. method:: IMAP4.lsub(directory='', pattern='*')

List subscribed mailbox names in directory matching pattern. *directory*
defaults to the top level directory and *pattern* defaults to match any mailbox.
Expand Down
Loading
Loading