mirror of
https://codeberg.org/kiss-community/repo
synced 2024-12-23 07:40:11 -07:00
63 lines
1.9 KiB
Groff
63 lines
1.9 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLOPT_MIMEPOST.md
|
|
.TH CURLOPT_MIMEPOST 3 "2024-08-02" libcurl
|
|
.SH NAME
|
|
CURLOPT_MIMEPOST \- send data from mime structure
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
curl_mime *mime;
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MIMEPOST, mime);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a mime handle previously obtained from \fIcurl_mime_init(3)\fP.
|
|
|
|
This setting is supported by the HTTP protocol to post forms and by the
|
|
SMTP and IMAP protocols to provide the email data to send/upload.
|
|
|
|
This option is the preferred way of posting an HTTP form, replacing and
|
|
extending the \fICURLOPT_HTTPPOST(3)\fP option.
|
|
|
|
When setting \fICURLOPT_MIMEPOST(3)\fP to NULL, libcurl resets the request
|
|
type for HTTP to the default to disable the POST. Typically that would mean it
|
|
is reset to GET. Instead you should set a desired request method explicitly.
|
|
.SH PROTOCOLS
|
|
This functionality affects http, imap and smtp
|
|
.SH EXAMPLE
|
|
.nf
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
curl_mime *multipart = curl_mime_init(curl);
|
|
if(multipart) {
|
|
curl_mimepart *part = curl_mime_addpart(multipart);
|
|
curl_mime_name(part, "name");
|
|
curl_mime_data(part, "daniel", CURL_ZERO_TERMINATED);
|
|
part = curl_mime_addpart(multipart);
|
|
curl_mime_name(part, "project");
|
|
curl_mime_data(part, "curl", CURL_ZERO_TERMINATED);
|
|
part = curl_mime_addpart(multipart);
|
|
curl_mime_name(part, "logotype-image");
|
|
curl_mime_filedata(part, "curl.png");
|
|
|
|
/* Set the form info */
|
|
curl_easy_setopt(curl, CURLOPT_MIMEPOST, multipart);
|
|
|
|
curl_easy_perform(curl); /* post away! */
|
|
curl_mime_free(multipart); /* free the post data */
|
|
}
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in curl 7.56.0
|
|
.SH RETURN VALUE
|
|
This returns CURLE_OK.
|
|
.SH SEE ALSO
|
|
.BR CURLOPT_HTTPPOST (3),
|
|
.BR CURLOPT_POSTFIELDS (3),
|
|
.BR CURLOPT_PUT (3),
|
|
.BR curl_mime_init (3)
|