diff options
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_XOAUTH2_BEARER.3')
-rw-r--r-- | docs/libcurl/opts/CURLOPT_XOAUTH2_BEARER.3 | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLOPT_XOAUTH2_BEARER.3 b/docs/libcurl/opts/CURLOPT_XOAUTH2_BEARER.3 new file mode 100644 index 00000000..2644c883 --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_XOAUTH2_BEARER.3 @@ -0,0 +1,49 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at http://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_XOAUTH2_BEARER 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_XOAUTH2_BEARER \- specify OAuth 2.0 access token +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_XOAUTH2_BEARER, char *token); +.SH 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 \fICURLOPT_USERNAME(3)\fP option. +.SH DEFAULT +NULL +.SH PROTOCOLS +IMAP, POP3 and SMTP +.SH EXAMPLE +TODO +.SH AVAILABILITY +Added in 7.33.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), " CURLOPT_USERNAME "(3), " |