-
-
Notifications
You must be signed in to change notification settings - Fork 32.7k
gh-67512: Document parameters of imaplib's append #113506
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.
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tip: you can add these suggestions to a batch and commit them all at once. See:
Doc/library/imaplib.rst
Outdated
@@ -204,7 +204,15 @@ An :class:`IMAP4` instance has the following methods: | |||
|
|||
.. method:: IMAP4.append(mailbox, flags, date_time, message) | |||
|
|||
Append *message* to named mailbox. | |||
Append *message* to a specified mailbox. | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Hey @hugovk, I have made the changes according to the suggestions, also for the format of data_time, whenever I come across new stuff I try to learn it through books or ChatGPT but I guess the latter fails to get correct information sometimes. Thanks for pointing out the error, will keep it in mind in future. :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, we have to be careful with ChatGPT, it can invent things. Books should be more trustworthy, unless they're written by LLMs!
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Hey @hugovk, I think the branch is now ready for merge. Let me know if not! |
Thank you for the update! Looks good now, I'll leave it to a subject matter expert from the email-team to give it a final review and merge.
* ``\Flagged`` - Message is "flagged" for urgent/special attention. | ||
* ``\Deleted`` - Message is "deleted" for removal by later ``EXPUNGE``. | ||
* ``\Draft`` - Message has not completed composition (marked as a draft). | ||
* ``\Recent`` - Message is "recently" arrived in this mailbox. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The \Recent flag is supposed to be managed automatically by the server. It seems misleading to list it under the append method.
The following commit authors need to sign the Contributor License Agreement: |
The IMAP4.append() method was not properly documented which led to various issues in terms of proper usage of the functions. This change solved the #67512
📚 Documentation preview 📚: https://cpython-previews--113506.org.readthedocs.build/en/113506/library/imaplib.html#imaplib.IMAP4.append