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