From b1fe12881e8bb29e948d411b706a841454413d15 Mon Sep 17 00:00:00 2001 From: "B. Petersen" Date: Tue, 24 Oct 2023 17:42:34 +0200 Subject: [PATCH] document `configured_addr` in fact, it was already used like that, eg. to detect an AEAP change on android. but it was never documented officially. --- deltachat-ffi/deltachat.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/deltachat-ffi/deltachat.h b/deltachat-ffi/deltachat.h index c330f5510..a1c45214f 100644 --- a/deltachat-ffi/deltachat.h +++ b/deltachat-ffi/deltachat.h @@ -384,7 +384,12 @@ char* dc_get_blobdir (const dc_context_t* context); /** * Configure the context. The configuration is handled by key=value pairs as: * - * - `addr` = address to display (always needed) + * - `addr` = Email address to use for configuration. + * If dc_configure() fails this is not the email address actually in use. + * Use `configured_addr` to find out the email address actually in use. + * - `configured_addr` = Email address actually in use. + * Unless for testing, do not set this value using dc_set_config(). + * Instead, set `addr` and call dc_configure(). * - `mail_server` = IMAP-server, guessed if left out * - `mail_user` = IMAP-username, guessed if left out * - `mail_pw` = IMAP-password (always needed)