2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from curl_mime_init.md
|
2024-07-29 18:00:04 -06:00
|
|
|
.TH curl_mime_init 3 "2024-07-29" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH NAME
|
|
|
|
|
curl_mime_init \- create a mime handle
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
curl_mime *curl_mime_init(CURL *easy_handle);
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
\fIcurl_mime_init(3)\fP creates a handle to a new empty mime structure.
|
|
|
|
|
This mime structure can be subsequently filled using the mime API, then
|
|
|
|
|
attached to some easy handle using option \fICURLOPT_MIMEPOST(3)\fP within
|
|
|
|
|
a \fIcurl_easy_setopt(3)\fP call or added as a multipart in another mime
|
|
|
|
|
handle\(aqs part using \fIcurl_mime_subparts(3)\fP.
|
|
|
|
|
|
|
|
|
|
\fIeasy_handle\fP is used for part separator randomization and error
|
|
|
|
|
reporting. Since 7.87.0, it does not need to be the final target handle.
|
|
|
|
|
|
|
|
|
|
Using a mime handle is the recommended way to post an HTTP form, format and
|
|
|
|
|
send a multi\-part email with SMTP or upload such an email to an IMAP server.
|
2024-03-30 12:28:04 -06:00
|
|
|
.SH PROTOCOLS
|
2024-07-29 18:00:04 -06:00
|
|
|
This functionality affects http, imap and smtp
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH EXAMPLE
|
|
|
|
|
.nf
|
|
|
|
|
int main(void)
|
|
|
|
|
{
|
|
|
|
|
CURL *easy = curl_easy_init();
|
|
|
|
|
curl_mime *mime;
|
|
|
|
|
curl_mimepart *part;
|
|
|
|
|
|
|
|
|
|
/* Build an HTTP form with a single field named "data", */
|
|
|
|
|
mime = curl_mime_init(easy);
|
|
|
|
|
part = curl_mime_addpart(mime);
|
|
|
|
|
curl_mime_data(part, "This is the field data", CURL_ZERO_TERMINATED);
|
|
|
|
|
curl_mime_name(part, "data");
|
|
|
|
|
|
|
|
|
|
/* Post and send it. */
|
|
|
|
|
curl_easy_setopt(easy, CURLOPT_MIMEPOST, mime);
|
|
|
|
|
curl_easy_setopt(easy, CURLOPT_URL, "https://example.com");
|
|
|
|
|
curl_easy_perform(easy);
|
|
|
|
|
|
|
|
|
|
/* Clean-up. */
|
|
|
|
|
curl_easy_cleanup(easy);
|
|
|
|
|
curl_mime_free(mime);
|
|
|
|
|
}
|
|
|
|
|
.fi
|
|
|
|
|
.SH AVAILABILITY
|
2024-07-29 18:00:04 -06:00
|
|
|
Added in curl 7.56.0
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH RETURN VALUE
|
|
|
|
|
A mime struct handle, or NULL upon failure.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR CURLOPT_MIMEPOST (3),
|
|
|
|
|
.BR curl_mime_addpart (3),
|
|
|
|
|
.BR curl_mime_free (3),
|
|
|
|
|
.BR curl_mime_subparts (3)
|
