CURLOPT_XOAUTH2_BEARER man page

CURLOPT_XOAUTH2_BEARER — specify OAuth 2.0 access token

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_XOAUTH2_BEARER, char *token);

Description

Pass a char * as parameter, which should point to the zero terminated OAuth 2.0 Bearer Access Token for use with IMAP, POP3 and SMTP servers that support the OAuth 2.0 Authorization Framework.

Note: The user name used to generate the Bearer Token should be supplied via the CURLOPT_USERNAME(3) option.

The application does not have to keep the string around after setting this option.

Default

NULL

Protocols

IMAP, POP3 and SMTP

Example

TODO

Availability

Added in 7.33.0

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.

See Also

CURLOPT_MAIL_AUTH(3), CURLOPT_USERNAME(3),

Referenced By

curl_easy_setopt(3).

December 21, 2016 libcurl 7.54.0 curl_easy_setopt options