Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_LOGIN_OPTIONS.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
9: .\" *
10: .\" * This software is licensed as described in the file COPYING, which
11: .\" * you should have received as part of this distribution. The terms
12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13: .\" *
14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15: .\" * copies of the Software, and permit persons to whom the Software is
16: .\" * furnished to do so, under the terms of the COPYING file.
17: .\" *
18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19: .\" * KIND, either express or implied.
20: .\" *
21: .\" **************************************************************************
22: .\"
23: .TH CURLOPT_LOGIN_OPTIONS 3 "May 31, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_LOGIN_OPTIONS \- set login options
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOGIN_OPTIONS, char *options);
31: .SH DESCRIPTION
32: Pass a char * as parameter, which should be pointing to the zero terminated
33: \fIoptions\fP string to use for the transfer.
34:
35: For more information about the login options please see RFC2384, RFC5092 and
36: IETF draft draft-earhart-url-smtp-00.txt
37:
38: \fICURLOPT_LOGIN_OPTIONS(3)\fP can be used to set protocol specific login
39: options, such as the preferred authentication mechanism via "AUTH=NTLM" or
40: "AUTH=*", and should be used in conjunction with the \fICURLOPT_USERNAME(3)\fP
41: option.
42:
43: The application does not have to keep the string around after setting this
44: option.
45: .SH DEFAULT
46: NULL
47: .SH PROTOCOLS
48: Only IMAP, POP3 and SMTP support login options.
49: .SH EXAMPLE
50: .nf
51: CURL *curl = curl_easy_init();
52: if(curl) {
53: curl_easy_setopt(curl, CURLOPT_URL, "smtp://example.com/");
54: curl_easy_setopt(curl, CURLOPT_LOGIN_OPTIONS, "AUTH=*");
55: ret = curl_easy_perform(curl);
56: curl_easy_cleanup(curl);
57: }
58: .fi
59: .SH AVAILABILITY
60: Added in 7.34.0
61: .SH RETURN VALUE
62: Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
63: CURLE_OUT_OF_MEMORY if there was insufficient heap space.
64: .SH "SEE ALSO"
65: .BR CURLOPT_USERNAME "(3), " CURLOPT_PASSWORD "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>