2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from CURLOPT_XOAUTH2_BEARER.md
|
2024-06-01 14:49:19 -06:00
|
|
|
.TH CURLOPT_XOAUTH2_BEARER 3 "2024-06-01" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH NAME
|
|
|
|
|
CURLOPT_XOAUTH2_BEARER \- OAuth 2.0 access token
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_XOAUTH2_BEARER, char *token);
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
Pass a char pointer as parameter, which should point to the null\-terminated
|
|
|
|
|
OAuth 2.0 Bearer Access Token for use with HTTP, IMAP, LDAP, POP3 and SMTP
|
|
|
|
|
servers that support the OAuth 2.0 Authorization Framework.
|
|
|
|
|
|
2024-03-30 12:28:04 -06:00
|
|
|
Note: For IMAP, LDAP, POP3 and SMTP, the username used to generate the Bearer
|
|
|
|
|
Token should be supplied via the \fICURLOPT_USERNAME(3)\fP option.
|
2024-03-15 20:55:33 -06:00
|
|
|
|
|
|
|
|
The application does not have to keep the string around after setting this
|
|
|
|
|
option.
|
|
|
|
|
.SH DEFAULT
|
|
|
|
|
NULL
|
|
|
|
|
.SH PROTOCOLS
|
|
|
|
|
HTTP, IMAP, LDAP, POP3 and SMTP
|
|
|
|
|
.SH EXAMPLE
|
|
|
|
|
.nf
|
|
|
|
|
int main(void)
|
|
|
|
|
{
|
|
|
|
|
CURL *curl = curl_easy_init();
|
|
|
|
|
if(curl) {
|
|
|
|
|
CURLcode res;
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_URL, "pop3://example.com/");
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_XOAUTH2_BEARER, "1ab9cb22ba269a7");
|
|
|
|
|
res = curl_easy_perform(curl);
|
|
|
|
|
curl_easy_cleanup(curl);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
.fi
|
|
|
|
|
.SH AVAILABILITY
|
|
|
|
|
Added in 7.33.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_MAIL_AUTH (3),
|
|
|
|
|
.BR CURLOPT_USERNAME (3)
|
