CURLOPT_LOGIN_OPTIONS - login options
#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOGIN_OPTIONS, char *options);
CURLOPT_LOGIN_OPTIONS(3) curl_easy_setopt options CURLOPT_LOGIN_OPTIONS(3)
NAME
CURLOPT_LOGIN_OPTIONS - login options
SYNOPSIS
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOGIN_OPTIONS, char *options);
DESCRIPTION
Pass a char * as parameter, which should be pointing to the null-termi-
nated options string to use for the transfer.
For more information about the login options please see RFC2384,
RFC5092 and IETF draft draft-earhart-url-smtp-00.txt
CURLOPT_LOGIN_OPTIONS(3) can be used to set protocol specific login
options, such as the preferred authentication mechanism via "AUTH=NTLM"
or "AUTH=*", and should be used in conjunction with the CURLOPT_USER-
NAME(3) option.
The application does not have to keep the string around after setting
this option.
DEFAULT
NULL
PROTOCOLS
Only IMAP, LDAP, POP3 and SMTP support login options.
EXAMPLE
CURL *curl = curl_easy_init();
if(curl) {
curl_easy_setopt(curl, CURLOPT_URL, "smtp://example.com/");
curl_easy_setopt(curl, CURLOPT_LOGIN_OPTIONS, "AUTH=*");
ret = curl_easy_perform(curl);
curl_easy_cleanup(curl);
}
AVAILABILITY
Added in 7.34.0. Support for OpenLDAP added in 7.82.0.
RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if
not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | web/curl |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
SEE ALSO
CURLOPT_USERNAME(3), CURLOPT_PASSWORD(3),
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://curl.se/down-
load/curl-7.83.1.tar.bz2.
Further information about this software can be found on the open source
community website at http://curl.haxx.se/.
libcurl 7.83.1 January 10, 2022 CURLOPT_LOGIN_OPTIONS(3)