CURLOPT_CUSTOMREQUEST explained
Name
CURLOPT_CUSTOMREQUEST - custom request method
Synopsis
#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CUSTOMREQUEST, char *method);
Description
Pass a pointer to a null-terminated string as parameter.
When changing the request method by setting CURLOPT_CUSTOMREQUEST, you do not actually change how libcurl behaves or acts: you only change the actual string sent in the request.
libcurl passes on the verbatim string in its request without any filter or other safe guards. That includes white space and control characters.
The application does not have to keep the string around after setting this option.
Using this option multiple times makes the last set string override the previous ones. Restore to the internal default by setting this to NULL.
This option can be used to specify the request:
Instead of GET or HEAD when performing HTTP based requests. This is particularly useful, for example, for performing an HTTP DELETE request.
For example:
When you tell libcurl to do a HEAD request, but then specify a GET though a custom request libcurl still acts as if it sent a HEAD. To switch to a proper HEAD use CURLOPT_NOBODY, to switch to a proper POST use CURLOPT_POST or CURLOPT_POSTFIELDS and to switch to a proper GET use CURLOPT_HTTPGET.
Many people have wrongly used this option to replace the entire request with their own, including multiple headers and POST contents. While that might work in many cases, it might cause libcurl to send invalid requests and it could possibly confuse the remote server badly. Use CURLOPT_POST and CURLOPT_POSTFIELDS to set POST data. Use CURLOPT_HTTPHEADER to replace or extend the set of headers sent by libcurl. Use CURLOPT_HTTP_VERSION to change HTTP version.
Instead of LIST and NLST when performing FTP directory listings.
Instead of LIST when issuing IMAP based requests.
Instead of LIST and RETR when issuing POP3 based requests.
For example:
When you tell libcurl to use a custom request it behaves like a LIST or RETR command was sent where it expects data to be returned by the server. As such CURLOPT_NOBODY should be used when specifying commands such as DELE and NOOP for example.
Instead of a HELP or VRFY when issuing SMTP based requests.
For example:
Normally a multi line response is returned which can be used, in conjunction with CURLOPT_MAIL_RCPT, to specify an EXPN request. If the CURLOPT_NOBODY option is specified then the request can be used to issue NOOP and RSET commands.
Default
NULL
Protocols
This functionality affects ftp, http, imap, pop3 and smtp
Example
int main(void)
{
CURL *curl = curl_easy_init();
if(curl) {
CURLcode res;
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
/* DELETE the given path */
curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "DELETE");
res = curl_easy_perform(curl);
curl_easy_cleanup(curl);
}
}
Availability
Added in curl 7.1
Return value
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space.
See also
CURLINFO_EFFECTIVE_METHOD(3), CURLOPT_HTTPHEADER(3), CURLOPT_NOBODY(3), CURLOPT_REQUEST_TARGET(3)
This HTML page was made with roffit.