CURLOPT_LOGIN_OPTIONS(3)

1CURLOPT_LOGIN_OPTIONS(3)   curl_easy_setopt options   CURLOPT_LOGIN_OPTIONS(3)
2
3
4

NAME

6       CURLOPT_LOGIN_OPTIONS - login options
7

SYNOPSIS

9       #include <curl/curl.h>
10
11       CURLcode  curl_easy_setopt(CURL  *handle,  CURLOPT_LOGIN_OPTIONS,  char
12       *options);
13

DESCRIPTION

15       Pass a char * as parameter, which should be pointing to the null-termi‐
16       nated options string to use for the transfer.
17
18       For  more  information  about  the  login  options  please see RFC2384,
19       RFC5092 and IETF draft draft-earhart-url-smtp-00.txt
20
21       CURLOPT_LOGIN_OPTIONS(3) can be used to set protocol specific login op‐
22       tions,  such  as the preferred authentication mechanism via "AUTH=NTLM"
23       or "AUTH=*", and should be used in conjunction with  the  CURLOPT_USER‐
24       NAME(3) option.
25
26       The  application  does not have to keep the string around after setting
27       this option.
28

DEFAULT

30       NULL
31

PROTOCOLS

33       Only IMAP, POP3 and SMTP support login options.
34

EXAMPLE

36       CURL *curl = curl_easy_init();
37       if(curl) {
38         curl_easy_setopt(curl, CURLOPT_URL, "smtp://example.com/");
39         curl_easy_setopt(curl, CURLOPT_LOGIN_OPTIONS, "AUTH=*");
40         ret = curl_easy_perform(curl);
41         curl_easy_cleanup(curl);
42       }
43

AVAILABILITY

45       Added in 7.34.0
46

RETURN VALUE

48       Returns CURLE_OK if the option is  supported,  CURLE_UNKNOWN_OPTION  if
49       not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space.
50