imap-send: improve error messages with configuration hints
Replace basic error messages with more helpful ones that guide users on how to resolve configuration issues. When imap.host or imap.folder are missing, provide the exact git config commands needed to fix the problem, along with examples of typical values. Use the advise() API to display hints in a multi-line format with proper "hint:" prefixes for each line. Signed-off-by: Jörg Thalheim <joerg@thalheim.io> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jörg Thalheim committed
Jun 20, 2025 at 17:56 UTC
d30bf28d09d4d13ca7984d8593522be22f698f8a
1 file changed
+7
-2
imap-send.c
+7
-2
index 4b63d9ca41..f5a656ac71 100644
--- a/imap-send.c
+++ b/imap-send.c
@@ -25,6 +25,7 @@
#define DISABLE_SIGN_COMPARE_WARNINGS
#include "git-compat-util.h"
+#include "advice.h"
#include "config.h"
#include "credential.h"
#include "gettext.h"
@@ -1804,7 +1805,9 @@ int cmd_main(int argc, const char **argv)
if (!server.host) {
if (!server.tunnel) {
- fprintf(stderr, "no IMAP host specified\n");
+ error(_("no IMAP host specified"));
+ advise(_("set the IMAP host with 'git config imap.host <host>'.\n"
+ "(e.g., 'git config imap.host imaps://imap.example.com')"));
ret = 1;
goto out;
}
@@ -1824,7 +1827,9 @@ int cmd_main(int argc, const char **argv)
}
if (!server.folder) {
- fprintf(stderr, "no IMAP folder specified\n");
+ error(_("no IMAP folder specified"));
+ advise(_("set the target folder with 'git config imap.folder <folder>'.\n"
+ "(e.g., 'git config imap.folder Drafts')"));
ret = 1;
goto out;
}