comparison mupdf-source/thirdparty/curl/docs/libcurl/opts/CURLOPT_XOAUTH2_BEARER.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 - 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_XOAUTH2_BEARER 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_XOAUTH2_BEARER \- specify OAuth 2.0 access token
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_XOAUTH2_BEARER, char *token);
30 .SH DESCRIPTION
31 Pass a char * as parameter, which should point to the zero terminated OAuth
32 2.0 Bearer Access Token for use with HTTP, IMAP, POP3 and SMTP servers
33 that support the OAuth 2.0 Authorization Framework.
34
35 Note: For IMAP, POP3 and SMTP, the user name used to generate the Bearer Token
36 should be supplied via the \fICURLOPT_USERNAME(3)\fP option.
37
38 The application does not have to keep the string around after setting this
39 option.
40 .SH DEFAULT
41 NULL
42 .SH PROTOCOLS
43 IMAP, POP3 and SMTP
44 .SH EXAMPLE
45 .nf
46 CURL *curl = curl_easy_init();
47 if(curl) {
48 curl_easy_setopt(curl, CURLOPT_URL, "pop3://example.com/");
49 curl_easy_setopt(curl, CURLOPT_XOAUTH2_BEARER, "1ab9cb22ba269a7");
50 ret = curl_easy_perform(curl);
51 curl_easy_cleanup(curl);
52 }
53 .fi
54 .SH AVAILABILITY
55 Added in 7.33.0
56 .SH RETURN VALUE
57 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
58 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
59 .SH "SEE ALSO"
60 .BR CURLOPT_MAIL_AUTH "(3), " CURLOPT_USERNAME "(3), "