CURLOPT_XOAUTH2_BEARER.3 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2014, 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 http://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 access token
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_XOAUTH2_BEARER, char *token);
  29. .SH DESCRIPTION
  30. Pass a char * as parameter, which should point to the zero terminated OAuth
  31. 2.0 Bearer Access Token for use with IMAP, POP3 and SMTP servers that support
  32. the OAuth 2.0 Authorization Framework.
  33. Note: The user name used to generate the Bearer Token should be supplied via
  34. the \fICURLOPT_USERNAME(3)\fP option.
  35. .SH DEFAULT
  36. NULL
  37. .SH PROTOCOLS
  38. IMAP, POP3 and SMTP
  39. .SH EXAMPLE
  40. TODO
  41. .SH AVAILABILITY
  42. Added in 7.33.0
  43. .SH RETURN VALUE
  44. Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  45. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  46. .SH "SEE ALSO"
  47. .BR CURLOPT_MAIL_AUTH "(3), " CURLOPT_USERNAME "(3), "