Skip to content

gh-93548: Add an example of SASL PLAIN authentication to documentation #93549

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

Closed
JulienFS wants to merge 9 commits into from
Closed

gh-93548: Add an example of SASL PLAIN authentication to documentation #93549

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
30d113e
allow ENABLE command in NONAUTH state for UTF8 passwords
JulienFS Jun 6, 2022
6216e0d
📜🤖 Added by blurb_it.
blurb-it[bot] Jun 6, 2022
d877abe
add sasl plain auth example
JulienFS Jun 6, 2022
bde9207
Revert "allow ENABLE command in NONAUTH state for UTF8 passwords"
JulienFS Jun 6, 2022
12e5a3e
update news
JulienFS Jun 6, 2022
46c9d1e
move the example to the authenticate section
JulienFS Jun 6, 2022
11f7124
smarter syntax
JulienFS Jun 6, 2022
224d63d
We do not add news for documentation changes
arhadthedev Feb 16, 2023
98a6ca8
Merge branch 'main' into fix-utf8_imap_password
arhadthedev Feb 16, 2023
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
13 changes: 11 additions & 2 deletions Doc/library/imaplib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,9 +230,19 @@ An :class:`IMAP4` instance has the following methods:
that will be base64 encoded and sent to the server. It should return
``None`` if the client abort response ``*`` should be sent instead.

Example of a SASL PLAIN *authobject*::

def plain_auth(data):
user = input('User: ')
password = getpass.getpass()
return f'{user}\x00{user}\x00{password}'

M.authenticate('PLAIN', plain_auth)

.. versionchanged:: 3.5
string usernames and passwords are now encoded to ``utf-8`` instead of
being limited to ASCII.
being limited to ASCII. :meth:`authenticate` is the only standard way
to use ``utf-8`` credentials on an ``IMAP4rev1`` server.


.. method:: IMAP4.check()
Expand Down Expand Up @@ -638,4 +648,3 @@ retrieves and prints all messages::
print('Message %s\n%s\n' % (num, data[0][1]))
M.close()
M.logout()