CURLOPT_SASL_IR.3 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. .\" generated by cd2nroff 0.1 from CURLOPT_SASL_IR.md
  2. .TH CURLOPT_SASL_IR 3 "2025-01-17" libcurl
  3. .SH NAME
  4. CURLOPT_SASL_IR \- send initial response in first packet
  5. .SH SYNOPSIS
  6. .nf
  7. #include <curl/curl.h>
  8. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SASL_IR, long enable);
  9. .fi
  10. .SH DESCRIPTION
  11. Pass a long. If the value is 1, curl sends the initial response to the server
  12. in the first authentication packet in order to reduce the number of ping pong
  13. requests. Only applicable to the following supporting SASL authentication
  14. mechanisms:
  15. * Login
  16. * Plain
  17. * GSSAPI
  18. * NTLM
  19. * OAuth 2.0
  20. Note: Whilst IMAP supports this option there is no need to explicitly set it,
  21. as libcurl can determine the feature itself when the server supports the
  22. SASL\-IR CAPABILITY.
  23. .SH DEFAULT
  24. 0
  25. .SH PROTOCOLS
  26. This functionality affects imap and smtp
  27. .SH EXAMPLE
  28. .nf
  29. int main(void)
  30. {
  31. CURL *curl = curl_easy_init();
  32. if(curl) {
  33. CURLcode res;
  34. curl_easy_setopt(curl, CURLOPT_URL, "smtp://example.com/");
  35. curl_easy_setopt(curl, CURLOPT_SASL_IR, 1L);
  36. res = curl_easy_perform(curl);
  37. curl_easy_cleanup(curl);
  38. }
  39. }
  40. .fi
  41. .SH AVAILABILITY
  42. Added in curl 7.31.0
  43. .SH RETURN VALUE
  44. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  45. .SH SEE ALSO
  46. .BR CURLOPT_MAIL_AUTH (3),
  47. .BR CURLOPT_MAIL_FROM (3),
  48. .BR CURLOPT_SASL_AUTHZID (3)