docs/libcurl/opts/CURLOPT_SASL_IR.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, 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 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_SASL_IR \- enable sending initial response in first packet
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SASL_IR, long enable);
  31 .SH DESCRIPTION
  32 Pass a long. If the value is 1, curl will send the initial response to the
  33 server in the first authentication packet in order to reduce the number of
  34 ping pong requests. Only applicable to the following supporting SASL
  35 authentication mechanisms:
  36
  37 * Login
  38 * Plain
  39 * GSSAPI
  40 * NTLM
  41 * OAuth 2.0
  42
  43 Note: Whilst IMAP supports this option there is no need to explicitly set it,
  44 as libcurl can determine the feature itself when the server supports the
  45 SASL-IR CAPABILITY.
  46 .SH DEFAULT
  47 0
  48 .SH PROTOCOLS
  49 IMAP, POP3 and SMTP
  50 .SH EXAMPLE
  51 .nf
  52 CURL *curl = curl_easy_init();
  53 if(curl) {
  54   curl_easy_setopt(curl, CURLOPT_URL, "smtp://example.com/");
  55   curl_easy_setopt(curl, CURLOPT_SASL_IR, 1L);
  56   ret = curl_easy_perform(curl);
  57   curl_easy_cleanup(curl);
  58 }
  59 .fi
  60 .SH AVAILABILITY
  61 Added in 7.31.0
  62 .SH RETURN VALUE
  63 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  64 .SH "SEE ALSO"
  65 .BR CURLOPT_MAIL_AUTH "(3), " CURLOPT_MAIL_FROM "(3), "