[PATCH v2] docs: explain how to use `git imap-send --list` command to get a list of available folders

From

Aditya Garg <gargaditya08@live.com>

Date

Jul 22, 2025, 11:48 UTC

Message-ID

<20250722114827.22493-1-gargaditya08@live.com>

In-Reply-To

<20250722114246.20422-1-gargaditya08@live.com>

Signed-off-by: Aditya Garg <gargaditya08@live.com>
---
 Documentation/git-imap-send.adoc | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/Documentation/git-imap-send.adoc b/Documentation/git-imap-send.adoc
index 17147f93c3..278e5ccd36 100644
--- a/Documentation/git-imap-send.adoc
+++ b/Documentation/git-imap-send.adoc
@@ -68,6 +68,34 @@ include::includes/cmd-config-section-rest.adoc[]
 
 include::config/imap.adoc[]
 
+GETTING A LIST OF AVAILABLE FOLDERS
+-----------------------------------
+
+In order to send an email to a specific folder, you need to know the correct name of
+intended folder in your mailbox. The names like "Junk", "Trash" etc. displayed by
+various email clients need not be the actual names of the folders stored in the mail
+server of your email provider.
+
+In order to get the correct folder name to be used with `git imap-send`, you can run
+`git imap-send --list`. This will display a list of valid folder names. An example
+of such an output when run on a Gmail account is:
+
+.........................
+* LIST (\HasNoChildren) "/" "INBOX"
+* LIST (\HasChildren \Noselect) "/" "[Gmail]"
+* LIST (\All \HasNoChildren) "/" "[Gmail]/All Mail"
+* LIST (\Drafts \HasNoChildren) "/" "[Gmail]/Drafts"
+* LIST (\HasNoChildren \Important) "/" "[Gmail]/Important"
+* LIST (\HasNoChildren \Sent) "/" "[Gmail]/Sent Mail"
+* LIST (\HasNoChildren \Junk) "/" "[Gmail]/Spam"
+* LIST (\Flagged \HasNoChildren) "/" "[Gmail]/Starred"
+* LIST (\HasNoChildren \Trash) "/" "[Gmail]/Trash"
+.........................
+
+Here, you can observe that the correct name for the "Junk" folder is `[Gmail]/Spam`
+and for the "Trash" folder is `[Gmail]/Trash`. Similar logic can be used to determine
+other folders as well.
+
 EXAMPLES
 --------
 Using tunnel mode:

Range-diff against v1:
1:  369d96569e ! 1:  75cafeebf1 docs: explain how to use `git imap-send --list` command to get a list of available folders
    @@ Documentation/git-imap-send.adoc: include::includes/cmd-config-section-rest.adoc
     +
     +In order to send an email to a specific folder, you need to know the correct name of
     +intended folder in your mailbox. The names like "Junk", "Trash" etc. displayed by
    -+various email clients need to be the actual names of the folders stored in the mail
    ++various email clients need not be the actual names of the folders stored in the mail
     +server of your email provider.
     +
     +In order to get the correct folder name to be used with `git imap-send`, you can run

-- 
2.50.1.319.gda7cee769f