docs/libcurl/opts/CURLOPT_POSTREDIR.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2015, 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_POSTREDIR 3 "February 03, 2016" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_POSTREDIR \- how to act on a HTTP POST redirect
  27 .SH SYNOPSIS
  28 .nf
  29 #include <curl/curl.h>
  30
  31 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_POSTREDIR,
  32                           long bitmask);
  33 .SH DESCRIPTION
  34 Pass a bitmask to control how libcurl acts on redirects after POSTs that get a
  35 301, 302 or 303 response back.  A parameter with bit 0 set (value
  36 \fBCURL_REDIR_POST_301\fP) tells the library to respect RFC 7231 (section
  37 6.4.2 to 6.4.4) and not convert POST requests into GET requests when following
  38 a 301 redirection.  Setting bit 1 (value \fBCURL_REDIR_POST_302\fP) makes
  39 libcurl maintain the request method after a 302 redirect whilst setting bit 2
  40 (value \fBCURL_REDIR_POST_303\fP) makes libcurl maintain the request method
  41 after a 303 redirect. The value \fBCURL_REDIR_POST_ALL\fP is a convenience
  42 define that sets all three bits.
  43
  44 The non-RFC behaviour is ubiquitous in web browsers, so the library does the
  45 conversion by default to maintain consistency. However, a server may require a
  46 POST to remain a POST after such a redirection. This option is meaningful only
  47 when setting \fICURLOPT_FOLLOWLOCATION(3)\fP.
  48 .SH DEFAULT
  49 0
  50 .SH PROTOCOLS
  51 HTTP(S)
  52 .SH EXAMPLE
  53 .nf
  54 CURL *curl = curl_easy_init();
  55 if(curl) {
  56   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  57
  58   /* a silly POST example */
  59   curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "data=true");
  60
  61   /* example.com is redirected, so we tell libcurl to send POST on 301, 302 and
  62      303 HTTP response codes */
  63   curl_easy_setopt(curl, CURLOPT_POSTREDIR, CURL_REDIR_POST_ALL);
  64
  65   curl_easy_perform(curl);
  66 }
  67 .fi
  68 .SH AVAILABILITY
  69 Added in 7.17.1. This option was known as CURLOPT_POST301 up to 7.19.0 as it
  70 only supported the 301 then. CURL_REDIR_POST_303 was added in 7.26.0.
  71 .SH RETURN VALUE
  72 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  73 .SH "SEE ALSO"
  74 .BR CURLOPT_FOLLOWLOCATION "(3), " CURLOPT_POSTFIELDS "(3), "