curl / libcurl / API / curl_easy_setopt / CURLOPT_LOGIN_OPTIONS

CURLOPT_LOGIN_OPTIONS explained

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-terminated options string to use for the transfer.

For more information about the login options please see RFC 2384, RFC 5092 and the IETF draft draft-earhart-url-smtp-00.txt.

CURLOPT_LOGIN_OPTIONS 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_USERNAME option.

Since 8.2.0, IMAP supports the login option "AUTH=+LOGIN". With this option, curl uses the plain (not SASL) LOGIN IMAP command even if the server advertises SASL authentication. Care should be taken in using this option, as it sends your password in plain text. This does not work if the IMAP server disables the plain LOGIN (e.g. to prevent password snooping).

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

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    curl_easy_setopt(curl, CURLOPT_URL, "smtp://example.com/");
    curl_easy_setopt(curl, CURLOPT_LOGIN_OPTIONS, "AUTH=*");
    res = 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.