comparison mupdf-source/thirdparty/curl/docs/libcurl/curl_mime_init.3 @ 2:b50eed0cc0ef upstream

ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
comparison
equal deleted inserted replaced
1:1d09e1dec1d9 2:b50eed0cc0ef
1 .\" **************************************************************************
2 .\" * _ _ ____ _
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, 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 .TH curl_mime_init 3 "22 August 2017" "libcurl 7.56.0" "libcurl Manual"
23 .SH NAME
24 curl_mime_init - create a mime handle
25 .SH SYNOPSIS
26 .B #include <curl/curl.h>
27 .sp
28 .BI "curl_mime * curl_mime_init(CURL * " easy_handle ");"
29 .ad
30 .SH DESCRIPTION
31 \fIcurl_mime_init(3)\fP creates a handle to a new empty mime structure
32 intended to be used with \fIeasy_handle\fP. This mime structure can be
33 subsequently filled using the mime API, then attached to \fIeasy_handle\fP
34 using option \fICURLOPT_MIMEPOST(3)\fP within a \fIcurl_easy_setopt(3)\fP
35 call.
36
37 Using a mime handle is the recommended way to post an HTTP form, format and
38 send a multi-part e-mail with SMTP or upload such an e-mail to an IMAP server.
39
40 .SH AVAILABILITY
41 As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
42 .SH RETURN VALUE
43 A mime struct handle, or NULL upon failure.
44 .SH EXAMPLE
45 .nf
46
47 CURL *easy = curl_easy_init();
48 curl_mime *mime;
49 curl_mimepart *part;
50
51 /* Build an HTTP form with a single field named "data", */
52 mime = curl_mime_init(easy);
53 part = curl_mime_addpart(mime);
54 curl_mime_data(part, "This is the field data", CURL_ZERO_TERMINATED);
55 curl_mime_name(part, "data");
56
57 /* Post and send it. */
58 curl_easy_setopt(easy, CURLOPT_MIMEPOST, mime);
59 curl_easy_setopt(easy, CURLOPT_URL, "http://example.com");
60 curl_easy_perform(easy);
61
62 /* Clean-up. */
63 curl_easy_cleanup(easy);
64 curl_mime_free(mime);
65
66 .SH "SEE ALSO"
67 .BR curl_mime_addpart "(3),"
68 .BR curl_mime_free "(3),"
69 .BR CURLOPT_MIMEPOST "(3)"