docs/libcurl/opts/CURLOPT_SASL_IR.3

   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 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_SASL_IR 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_SASL_IR \- enable sending initial response in first packet
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SASL_IR, long enable);
  30 .SH DESCRIPTION
  31 Pass a long. If the value is 1, curl will send the initial response to the
  32 server in the first authentication packet in order to reduce the number of
  33 ping pong requests. Only applicable to the following supporting SASL
  34 authentication mechanisms:
  35
  36 * Login
  37 * Plain
  38 * GSSAPI
  39 * NTLM
  40 * OAuth 2.0
  41
  42 Note: Whilst IMAP supports this option there is no need to explicitly set it,
  43 as libcurl can determine the feature itself when the server supports the
  44 SASL-IR CAPABILITY.
  45 .SH DEFAULT
  46 0
  47 .SH PROTOCOLS
  48 IMAP, POP3 and SMTP
  49 .SH EXAMPLE
  50 TODO
  51 .SH AVAILABILITY
  52 Added in 7.31.0
  53 .SH RETURN VALUE
  54 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  55 .SH "SEE ALSO"
  56 .BR CURLOPT_MAIL_AUTH "(3), " CURLOPT_MAIL_FROM "(3), "