xref: /aosp_15_r20/external/curl/docs/libcurl/opts/CURLOPT_MIMEPOST.md (revision 6236dae45794135f37c4eb022389c904c8b0090d)
1*6236dae4SAndroid Build Coastguard Worker---
2*6236dae4SAndroid Build Coastguard Workerc: Copyright (C) Daniel Stenberg, <[email protected]>, et al.
3*6236dae4SAndroid Build Coastguard WorkerSPDX-License-Identifier: curl
4*6236dae4SAndroid Build Coastguard WorkerTitle: CURLOPT_MIMEPOST
5*6236dae4SAndroid Build Coastguard WorkerSection: 3
6*6236dae4SAndroid Build Coastguard WorkerSource: libcurl
7*6236dae4SAndroid Build Coastguard WorkerSee-also:
8*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_HTTPPOST (3)
9*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_POSTFIELDS (3)
10*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_PUT (3)
11*6236dae4SAndroid Build Coastguard Worker  - curl_mime_init (3)
12*6236dae4SAndroid Build Coastguard WorkerProtocol:
13*6236dae4SAndroid Build Coastguard Worker  - HTTP
14*6236dae4SAndroid Build Coastguard Worker  - SMTP
15*6236dae4SAndroid Build Coastguard Worker  - IMAP
16*6236dae4SAndroid Build Coastguard WorkerAdded-in: 7.56.0
17*6236dae4SAndroid Build Coastguard Worker---
18*6236dae4SAndroid Build Coastguard Worker
19*6236dae4SAndroid Build Coastguard Worker# NAME
20*6236dae4SAndroid Build Coastguard Worker
21*6236dae4SAndroid Build Coastguard WorkerCURLOPT_MIMEPOST - send data from mime structure
22*6236dae4SAndroid Build Coastguard Worker
23*6236dae4SAndroid Build Coastguard Worker# SYNOPSIS
24*6236dae4SAndroid Build Coastguard Worker
25*6236dae4SAndroid Build Coastguard Worker~~~c
26*6236dae4SAndroid Build Coastguard Worker#include <curl/curl.h>
27*6236dae4SAndroid Build Coastguard Worker
28*6236dae4SAndroid Build Coastguard Workercurl_mime *mime;
29*6236dae4SAndroid Build Coastguard Worker
30*6236dae4SAndroid Build Coastguard WorkerCURLcode curl_easy_setopt(CURL *handle, CURLOPT_MIMEPOST, mime);
31*6236dae4SAndroid Build Coastguard Worker~~~
32*6236dae4SAndroid Build Coastguard Worker
33*6236dae4SAndroid Build Coastguard Worker# DESCRIPTION
34*6236dae4SAndroid Build Coastguard Worker
35*6236dae4SAndroid Build Coastguard WorkerPass a mime handle previously obtained from curl_mime_init(3).
36*6236dae4SAndroid Build Coastguard Worker
37*6236dae4SAndroid Build Coastguard WorkerThis setting is supported by the HTTP protocol to post forms and by the
38*6236dae4SAndroid Build Coastguard WorkerSMTP and IMAP protocols to provide the email data to send/upload.
39*6236dae4SAndroid Build Coastguard Worker
40*6236dae4SAndroid Build Coastguard WorkerThis option is the preferred way of posting an HTTP form, replacing and
41*6236dae4SAndroid Build Coastguard Workerextending the CURLOPT_HTTPPOST(3) option.
42*6236dae4SAndroid Build Coastguard Worker
43*6236dae4SAndroid Build Coastguard WorkerWhen setting CURLOPT_MIMEPOST(3) to NULL, libcurl resets the request
44*6236dae4SAndroid Build Coastguard Workertype for HTTP to the default to disable the POST. Typically that would mean it
45*6236dae4SAndroid Build Coastguard Workeris reset to GET. Instead you should set a desired request method explicitly.
46*6236dae4SAndroid Build Coastguard Worker
47*6236dae4SAndroid Build Coastguard Worker# %PROTOCOLS%
48*6236dae4SAndroid Build Coastguard Worker
49*6236dae4SAndroid Build Coastguard Worker# EXAMPLE
50*6236dae4SAndroid Build Coastguard Worker
51*6236dae4SAndroid Build Coastguard Worker~~~c
52*6236dae4SAndroid Build Coastguard Workerint main(void)
53*6236dae4SAndroid Build Coastguard Worker{
54*6236dae4SAndroid Build Coastguard Worker  CURL *curl = curl_easy_init();
55*6236dae4SAndroid Build Coastguard Worker  if(curl) {
56*6236dae4SAndroid Build Coastguard Worker    curl_mime *multipart = curl_mime_init(curl);
57*6236dae4SAndroid Build Coastguard Worker    if(multipart) {
58*6236dae4SAndroid Build Coastguard Worker      curl_mimepart *part = curl_mime_addpart(multipart);
59*6236dae4SAndroid Build Coastguard Worker      curl_mime_name(part, "name");
60*6236dae4SAndroid Build Coastguard Worker      curl_mime_data(part, "daniel", CURL_ZERO_TERMINATED);
61*6236dae4SAndroid Build Coastguard Worker      part = curl_mime_addpart(multipart);
62*6236dae4SAndroid Build Coastguard Worker      curl_mime_name(part, "project");
63*6236dae4SAndroid Build Coastguard Worker      curl_mime_data(part, "curl", CURL_ZERO_TERMINATED);
64*6236dae4SAndroid Build Coastguard Worker      part = curl_mime_addpart(multipart);
65*6236dae4SAndroid Build Coastguard Worker      curl_mime_name(part, "logotype-image");
66*6236dae4SAndroid Build Coastguard Worker      curl_mime_filedata(part, "curl.png");
67*6236dae4SAndroid Build Coastguard Worker
68*6236dae4SAndroid Build Coastguard Worker      /* Set the form info */
69*6236dae4SAndroid Build Coastguard Worker      curl_easy_setopt(curl, CURLOPT_MIMEPOST, multipart);
70*6236dae4SAndroid Build Coastguard Worker
71*6236dae4SAndroid Build Coastguard Worker      curl_easy_perform(curl); /* post away */
72*6236dae4SAndroid Build Coastguard Worker      curl_mime_free(multipart); /* free the post data */
73*6236dae4SAndroid Build Coastguard Worker    }
74*6236dae4SAndroid Build Coastguard Worker  }
75*6236dae4SAndroid Build Coastguard Worker}
76*6236dae4SAndroid Build Coastguard Worker~~~
77*6236dae4SAndroid Build Coastguard Worker
78*6236dae4SAndroid Build Coastguard Worker# %AVAILABILITY%
79*6236dae4SAndroid Build Coastguard Worker
80*6236dae4SAndroid Build Coastguard Worker# RETURN VALUE
81*6236dae4SAndroid Build Coastguard Worker
82*6236dae4SAndroid Build Coastguard WorkerThis returns CURLE_OK.
83