Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_SASL_IR (3)

Name

CURLOPT_SASL_IR - send initial response in first packet

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SASL_IR, long enable);

Description

CURLOPT_SASL_IR(3)         curl_easy_setopt options         CURLOPT_SASL_IR(3)



NAME
       CURLOPT_SASL_IR - send initial response in first packet

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SASL_IR, long enable);

DESCRIPTION
       Pass  a long. If the value is 1, curl will send the initial response to
       the server in the first authentication packet in order  to  reduce  the
       number of ping pong requests. Only applicable to the following support-
       ing SASL authentication mechanisms:

       * Login * Plain * GSSAPI * NTLM * OAuth 2.0

       Note: Whilst IMAP supports this option there is no need  to  explicitly
       set  it,  as  libcurl  can determine the feature itself when the server
       supports the SASL-IR CAPABILITY.

DEFAULT
       0

PROTOCOLS
       IMAP, POP3 and SMTP

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "smtp://example.com/");
         curl_easy_setopt(curl, CURLOPT_SASL_IR, 1L);
         ret = curl_easy_perform(curl);
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in 7.31.0

RETURN VALUE
       Returns CURLE_OK if the option is supported,  and  CURLE_UNKNOWN_OPTION
       if not.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       CURLOPT_MAIL_AUTH(3), CURLOPT_MAIL_FROM(3),



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source       was       downloaded      from       https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                 November 26, 2021            CURLOPT_SASL_IR(3)