comparison mupdf-source/thirdparty/curl/docs/libcurl/opts/CURLOPT_SASL_AUTHZID.3 @ 2:b50eed0cc0ef upstream

ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
comparison
equal deleted inserted replaced
1:1d09e1dec1d9 2:b50eed0cc0ef
1 .\" **************************************************************************
2 .\" * _ _ ____ _
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2019, 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_SASL_AUTHZID 3 "11 Sep 2019" "libcurl 7.66.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_SASL_AUTHZID \- authorisation identity (identity to act as)
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SASL_AUTHZID, char *authzid);
30 .SH DESCRIPTION
31 Pass a char * as parameter, which should be pointing to the zero terminated
32 authorisation identity (authzid) for the transfer. Only applicable to the PLAIN
33 SASL authentication mechanism where it is optional.
34
35 When not specified only the authentication identity (authcid) as specified by
36 the username will be sent to the server, along with the password. The server
37 will derive a authzid from the authcid when not provided, which it will then
38 uses internally.
39
40 When the authzid is specified, the use of which is server dependent, it can be
41 used to access another user's inbox, that the user has been granted access to,
42 or a shared mailbox for example.
43 .SH DEFAULT
44 blank
45 .SH PROTOCOLS
46 IMAP, POP3 and SMTP
47 .SH EXAMPLE
48 .nf
49 CURL *curl = curl_easy_init();
50 if(curl) {
51 curl_easy_setopt(curl, CURLOPT_URL, "imap://example.com/");
52 curl_easy_setopt(curl, CURLOPT_USERNAME, "Kurt");
53 curl_easy_setopt(curl, CURLOPT_PASSWORD, "xipj3plmq");
54 curl_easy_setopt(curl, CURLOPT_SASL_AUTHZID, "Ursel");
55 ret = curl_easy_perform(curl);
56 curl_easy_cleanup(curl);
57 }
58 .fi
59 .SH AVAILABILITY
60 Added in 7.66.0
61 .SH RETURN VALUE
62 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
63 .SH "SEE ALSO"
64 .BR CURLOPT_USERNAME "(3), " CURLOPT_PASSWORD "(3), ".BR CURLOPT_USERPWD "(3)"