76 lines
2.8 KiB
Groff
76 lines
2.8 KiB
Groff
|
.\" **************************************************************************
|
||
|
|
.\" * _ _ ____ _
|
||
|
|
.\" * Project ___| | | | _ \| |
|
||
|
|
.\" * / __| | | | |_) | |
|
||
|
|
.\" * | (__| |_| | _ <| |___
|
||
|
|
.\" * \___|\___/|_| \_\_____|
|
||
|
|
.\" *
|
||
|
|
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
||
|
|
.\" *
|
||
|
|
.\" * This software is licensed as described in the file COPYING, which
|
||
|
|
.\" * you should have received as part of this distribution. The terms
|
||
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
||
|
|
.\" *
|
||
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
||
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
||
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
||
|
|
.\" *
|
||
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
||
|
|
.\" * KIND, either express or implied.
|
||
|
|
.\" *
|
||
|
|
.\" * SPDX-License-Identifier: curl
|
||
|
|
.\" *
|
||
|
|
.\" **************************************************************************
|
||
|
|
.\"
|
||
|
|
.TH CURLOPT_LOGIN_OPTIONS 3 "19 Jun 2014" libcurl libcurl
|
||
|
|
.SH NAME
|
||
|
|
CURLOPT_LOGIN_OPTIONS \- login options
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
#include <curl/curl.h>
|
||
|
|
|
||
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOGIN_OPTIONS, char *options);
|
||
|
|
.fi
|
||
|
|
.SH DESCRIPTION
|
||
|
|
Pass a char * as parameter, which should be pointing to the null-terminated
|
||
|
|
\fIoptions\fP string to use for the transfer.
|
||
|
|
|
||
|
|
For more information about the login options please see RFC 2384, RFC 5092 and
|
||
|
|
the IETF draft \fBdraft-earhart-url-smtp-00.txt\fP.
|
||
|
|
|
||
|
|
\fICURLOPT_LOGIN_OPTIONS(3)\fP 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 \fICURLOPT_USERNAME(3)\fP
|
||
|
|
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.
|
||
|
|
.SH DEFAULT
|
||
|
|
NULL
|
||
|
|
.SH PROTOCOLS
|
||
|
|
Only IMAP, LDAP, POP3 and SMTP support login options.
|
||
|
|
.SH EXAMPLE
|
||
|
|
.nf
|
||
|
|
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);
|
||
|
|
}
|
||
|
|
.fi
|
||
|
|
.SH AVAILABILITY
|
||
|
|
Added in 7.34.0. Support for OpenLDAP added in 7.82.0.
|
||
|
|
.SH 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.
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.BR CURLOPT_PASSWORD (3),
|
||
|
|
.BR CURLOPT_USERNAME (3)
|