Skip to content

Commit 514076c

Browse files
committed
add missing documentation bits, refine some aspects
1 parent a34ea62 commit 514076c

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

deltachat-ffi/deltachat.h

+9
Original file line numberDiff line numberDiff line change
@@ -274,10 +274,12 @@ char* dc_get_blobdir (const dc_context_t* context);
274274
* - `mail_user` = IMAP-username, guessed if left out
275275
* - `mail_pw` = IMAP-password (always needed)
276276
* - `mail_port` = IMAP-port, guessed if left out
277+
* - `mail_security`= IMAP-socket, one of @ref DC_SOCKET, defaults to #DC_SOCKET_AUTO
277278
* - `send_server` = SMTP-server, guessed if left out
278279
* - `send_user` = SMTP-user, guessed if left out
279280
* - `send_pw` = SMTP-password, guessed if left out
280281
* - `send_port` = SMTP-port, guessed if left out
282+
* - `send_security`= SMTP-socket, one of @ref DC_SOCKET, defaults to #DC_SOCKET_AUTO
281283
* - `server_flags` = IMAP-/SMTP-flags as a combination of @ref DC_LP flags, guessed if left out
282284
* - `imap_certificate_checks` = how to check IMAP certificates, one of the @ref DC_CERTCK flags, defaults to #DC_CERTCK_AUTO (0)
283285
* - `smtp_certificate_checks` = how to check SMTP certificates, one of the @ref DC_CERTCK flags, defaults to #DC_CERTCK_AUTO (0)
@@ -4176,19 +4178,25 @@ int64_t dc_lot_get_timestamp (const dc_lot_t* lot);
41764178
* @defgroup DC_SOCKET DC_SOCKET
41774179
*
41784180
* These constants configure socket security.
4181+
* To set socket security,
4182+
* use dc_set_config() with the keys mail_security and/or send_security.
4183+
* If these flags are not specified, #DC_SOCKET_AUTO is used.
41794184
*
41804185
* @addtogroup DC_SOCKET
41814186
* @{
41824187
*/
41834188

41844189
/**
41854190
* Choose socket security automatically.
4191+
* Automatic configuration is disabled if another @ref DC_SOCKET flag is specified
4192+
* or if server or port are specified.
41864193
*/
41874194
#define DC_SOCKET_AUTO 0
41884195

41894196

41904197
/**
41914198
* Connect via SSL/TLS.
4199+
* If this flag is set, automatic configuration is skipped.
41924200
*/
41934201
#define DC_SOCKET_SSL 1
41944202

@@ -4202,6 +4210,7 @@ int64_t dc_lot_get_timestamp (const dc_lot_t* lot);
42024210

42034211
/**
42044212
* Connect unencrypted, this should not be used.
4213+
* If this flag is set, automatic configuration is skipped.
42054214
*/
42064215
#define DC_SOCKET_PLAIN 3
42074216

0 commit comments

Comments
 (0)