All of lore.kernel.org
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Aditya Garg <gargaditya08@live.com>
Cc: "git@vger.kernel.org" <git@vger.kernel.org>,
	 Eric Sunshine <sunshine@sunshineco.com>,
	 Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com>,
	 Ben Knoble <ben.knoble@gmail.com>,
	"brian m. carlson" <sandals@crustytoothpaste.net>
Subject: Re: [PATCH] docs: explain how to use `git imap-send --list` command to get a list of available folders
Date: Tue, 22 Jul 2025 08:47:10 -0700	[thread overview]
Message-ID: <xmqqfreotegx.fsf@gitster.g> (raw)
In-Reply-To: <20250722114246.20422-1-gargaditya08@live.com> (Aditya Garg's message of "Tue, 22 Jul 2025 11:43:27 +0000")

Aditya Garg <gargaditya08@live.com> writes:

> The output `git imap-send --list` command can be a bit confusing for new
> users since the IMAP LIST command output is very verbose. Help such users
> to analyse the same by using an example output.

The documentation added by 067a91b0 (imap-send: add ability to list
the available folders, 2025-06-20) is overly insufficient, so let's
queue this update on top of it.

But I am not sure if "very verbose" is a cause for worry.  I would
agree if the argument were that it is not very friendly to end-users
to throw raw IMAP protocol messages at them.  But it is what needs
to be fixed in the implementation, not papered over with
documentation.

Thanks.

> +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 to 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:

  parent reply	other threads:[~2025-07-22 15:47 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-07-22 11:43 [PATCH] docs: explain how to use `git imap-send --list` command to get a list of available folders Aditya Garg
2025-07-22 11:48 ` [PATCH v2] " Aditya Garg
2025-07-22 15:47 ` Junio C Hamano [this message]
2025-07-22 16:35   ` [PATCH] " Aditya Garg

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqfreotegx.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=ben.knoble@gmail.com \
    --cc=gargaditya08@live.com \
    --cc=git@vger.kernel.org \
    --cc=kristofferhaugsbakk@fastmail.com \
    --cc=sandals@crustytoothpaste.net \
    --cc=sunshine@sunshineco.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.