config_get_binding_domain_use_tls
Name
config_get_binding_domain_use_tls — Determine the value of the tls option
Synopsis
#include "ec_config.h"
| int **config_get_binding_domain_use_tls** (
| caller_scope, | |
| | binding, | |
| | domain)
; | |
generic_module_infrastructure * <var class="pdparam">caller_scope</var>
;
int <var class="pdparam">binding</var>
;
const * <var class="pdparam">domain</var>
;
Description
Determine the value of the tls configuration option.
Note
The caller_scope
argument is virtually always NULL
; there is no reason for a consumer to make it anything else.
- caller_scope
-
For a definition of this data type see “generic_module_infrastructure”.
- binding
-
The binding identifier.
- domain
-
The domain name.
This function returns one of the following values:
-
EC_USE_TLS_NO – TLS must not be used for this message
-
EC_USE_TLS_IFAVAILABLE – If TLS is available (offered by the remote server) then the state machine should upgrade the current SMTP session to use TLS.
-
EC_USE_TLS_REQUIRED – The message in question requires TLS to be used. If it is unavailable, the message should not be sent.
See tls for more information.
It is legal to call this function in any thread.