Flesh out the IMAP section in usingcurl/reademail.md
#574
Conversation
ernstki
force-pushed
the
expand-reademail-imap
branch
from
8f4e18c to
481c6d9
Compare
| This produces output similar to what's below; the numbers after the asterisks | ||
| are the **mailbox indices** of the messages, counting from 1: | ||
|
|
||
| * 1 FETCH (FLAGS (\Flagged \Deleted \Seen) INTERNALDATE " 3-Dec-2025 12:02:39 -0500" RFC822.SIZE 15163) |
There was a problem hiding this comment.
These lines represent output from a command. Not sure I would want it wrapped just to appease check-quotes.pl, but if this is a hard choice (e.g. because it makes the PDF look bad, or we don't want to alter the CI routines around this), I'll just ellipsize it until it fits.
There was a problem hiding this comment.
All docs look weird and hard-to-read with long lines so I propose we still wrap these lines somehow.
ernstki
force-pushed
the
expand-reademail-imap
branch
from
481c6d9 to
6b998fb
Compare
|
bagder
left a comment
bagder
left a comment
There was a problem hiding this comment.
Thanks for working on this! Some comments:
|
|
||
| curl 'imap://server.example.com/fun;MAILINDEX=57' | ||
|
|
||
| Be aware that deleted but not "expunged" messages still have an index! |
There was a problem hiding this comment.
Our checkers don't like exclamation marks much.
| Be aware that deleted but not "expunged" messages still have an index! | |
| Be aware that deleted but not "expunged" messages still have an index. |
There was a problem hiding this comment.
I'd actually like your permission to simply disable that linting rule (as with the typography checks), because it is not solving a real problem, and as noted here it triggers spuriously.
There is only a single exclamation point in this entire source file, and certainly that is "under control."
| This produces output similar to what's below; the numbers after the asterisks | ||
| are the **mailbox indices** of the messages, counting from 1: | ||
|
|
||
| * 1 FETCH (FLAGS (\Flagged \Deleted \Seen) INTERNALDATE " 3-Dec-2025 12:02:39 -0500" RFC822.SIZE 15163) |
There was a problem hiding this comment.
All docs look weird and hard-to-read with long lines so I propose we still wrap these lines somehow.
|
|
||
| curl 'imap://server.example.com/stuff;UID=57' | ||
|
|
||
| Get the 57<sup>th</sup> message from the mailbox `fun`: |
There was a problem hiding this comment.
Since our typo script is a little silly and I would rather not add th a valid word, how about rephrasing it?
| Get the 57<sup>th</sup> message from the mailbox `fun`: | |
| Get message number 57 from the mailbox `fun`: |
2 participants
There wasn't a lot to go on here, nor in the man page, so I took it upon myself to add a few more examples to the IMAP part of
usingcurl/reademail.md. Mostly so I could have something to refer back to later, since this IMAP stuff didn't stick very well in my brain the first couple times.This IMAP cheatsheet helped me out a lot, and I'd be happy to add another commit to add that as a reference, if desired.