mirror of
https://github.com/curl/curl.git
synced 2025-01-06 13:44:52 +08:00
b935fd4a07
The mandatory header now has a mandatory list of protocols for which the manpage is relevant. Most man pages already has a "PROTOCOLS" section, but this introduces a stricter way to specify the relevant protocols. cd2nroff verifies that at least one protocol is mentioned (which can be `*`). This information is not used just yet, but A) the PROTOCOLS section can now instead get generated and get a unified wording across all manpages and B) this allows us to more reliably filter/search for protocol specific manpages/options. Closes #13166
77 lines
1.8 KiB
Markdown
77 lines
1.8 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: curl_mime_init
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLOPT_MIMEPOST (3)
|
|
- curl_mime_addpart (3)
|
|
- curl_mime_free (3)
|
|
- curl_mime_subparts (3)
|
|
Protocol:
|
|
- HTTP
|
|
- IMAP
|
|
- SMTP
|
|
---
|
|
|
|
# NAME
|
|
|
|
curl_mime_init - create a mime handle
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
curl_mime *curl_mime_init(CURL *easy_handle);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
curl_mime_init(3) 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 CURLOPT_MIMEPOST(3) within
|
|
a curl_easy_setopt(3) call or added as a multipart in another mime
|
|
handle's part using curl_mime_subparts(3).
|
|
|
|
*easy_handle* 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.
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
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);
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
|
|
|
|
# RETURN VALUE
|
|
|
|
A mime struct handle, or NULL upon failure.
|