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.
This commit is contained in:
B. Petersen
2023-10-24 17:42:34 +02:00
committed by bjoern
parent 03bb92c942
commit b1fe12881e

View File

@@ -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)