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