xref: /aosp_15_r20/external/curl/docs/libcurl/curl_mime_subparts.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: curl_mime_subparts
5*6236dae4SAndroid Build Coastguard WorkerSection: 3
6*6236dae4SAndroid Build Coastguard WorkerSource: libcurl
7*6236dae4SAndroid Build Coastguard WorkerSee-also:
8*6236dae4SAndroid Build Coastguard Worker  - curl_mime_addpart (3)
9*6236dae4SAndroid Build Coastguard Worker  - curl_mime_init (3)
10*6236dae4SAndroid Build Coastguard WorkerProtocol:
11*6236dae4SAndroid Build Coastguard Worker  - HTTP
12*6236dae4SAndroid Build Coastguard Worker  - IMAP
13*6236dae4SAndroid Build Coastguard Worker  - SMTP
14*6236dae4SAndroid Build Coastguard WorkerAdded-in: 7.56.0
15*6236dae4SAndroid Build Coastguard Worker---
16*6236dae4SAndroid Build Coastguard Worker
17*6236dae4SAndroid Build Coastguard Worker# NAME
18*6236dae4SAndroid Build Coastguard Worker
19*6236dae4SAndroid Build Coastguard Workercurl_mime_subparts - set sub-parts of a multipart mime part
20*6236dae4SAndroid Build Coastguard Worker
21*6236dae4SAndroid Build Coastguard Worker# SYNOPSIS
22*6236dae4SAndroid Build Coastguard Worker
23*6236dae4SAndroid Build Coastguard Worker~~~c
24*6236dae4SAndroid Build Coastguard Worker#include <curl/curl.h>
25*6236dae4SAndroid Build Coastguard Worker
26*6236dae4SAndroid Build Coastguard WorkerCURLcode curl_mime_subparts(curl_mimepart *part, curl_mime *subparts);
27*6236dae4SAndroid Build Coastguard Worker~~~
28*6236dae4SAndroid Build Coastguard Worker
29*6236dae4SAndroid Build Coastguard Worker# DESCRIPTION
30*6236dae4SAndroid Build Coastguard Worker
31*6236dae4SAndroid Build Coastguard Workercurl_mime_subparts(3) sets a multipart mime part's content from a mime
32*6236dae4SAndroid Build Coastguard Workerstructure.
33*6236dae4SAndroid Build Coastguard Worker
34*6236dae4SAndroid Build Coastguard Worker*part* is a handle to the multipart part.
35*6236dae4SAndroid Build Coastguard Worker
36*6236dae4SAndroid Build Coastguard Worker*subparts* is a mime structure handle holding the sub-parts. After
37*6236dae4SAndroid Build Coastguard Workercurl_mime_subparts(3) succeeds, the mime structure handle belongs to the
38*6236dae4SAndroid Build Coastguard Workermultipart part and must not be freed explicitly. It may however be updated by
39*6236dae4SAndroid Build Coastguard Workersubsequent calls to mime API functions.
40*6236dae4SAndroid Build Coastguard Worker
41*6236dae4SAndroid Build Coastguard WorkerSetting a part's contents multiple times is valid: only the value set by the
42*6236dae4SAndroid Build Coastguard Workerlast call is retained. It is possible to unassign previous part's contents by
43*6236dae4SAndroid Build Coastguard Workersetting *subparts* to NULL.
44*6236dae4SAndroid Build Coastguard Worker
45*6236dae4SAndroid Build Coastguard Worker# %PROTOCOLS%
46*6236dae4SAndroid Build Coastguard Worker
47*6236dae4SAndroid Build Coastguard Worker# EXAMPLE
48*6236dae4SAndroid Build Coastguard Worker
49*6236dae4SAndroid Build Coastguard Worker~~~c
50*6236dae4SAndroid Build Coastguard Worker
51*6236dae4SAndroid Build Coastguard Workerstatic char *inline_html = "<title>example</title>";
52*6236dae4SAndroid Build Coastguard Workerstatic char *inline_text = "once upon the time";
53*6236dae4SAndroid Build Coastguard Worker
54*6236dae4SAndroid Build Coastguard Workerint main(void)
55*6236dae4SAndroid Build Coastguard Worker{
56*6236dae4SAndroid Build Coastguard Worker  CURL *curl = curl_easy_init();
57*6236dae4SAndroid Build Coastguard Worker  if(curl) {
58*6236dae4SAndroid Build Coastguard Worker    struct curl_slist *slist;
59*6236dae4SAndroid Build Coastguard Worker
60*6236dae4SAndroid Build Coastguard Worker    /* The inline part is an alternative proposing the html and the text
61*6236dae4SAndroid Build Coastguard Worker       versions of the email. */
62*6236dae4SAndroid Build Coastguard Worker    curl_mime *alt = curl_mime_init(curl);
63*6236dae4SAndroid Build Coastguard Worker    curl_mimepart *part;
64*6236dae4SAndroid Build Coastguard Worker
65*6236dae4SAndroid Build Coastguard Worker    /* HTML message. */
66*6236dae4SAndroid Build Coastguard Worker    part = curl_mime_addpart(alt);
67*6236dae4SAndroid Build Coastguard Worker    curl_mime_data(part, inline_html, CURL_ZERO_TERMINATED);
68*6236dae4SAndroid Build Coastguard Worker    curl_mime_type(part, "text/html");
69*6236dae4SAndroid Build Coastguard Worker
70*6236dae4SAndroid Build Coastguard Worker    /* Text message. */
71*6236dae4SAndroid Build Coastguard Worker    part = curl_mime_addpart(alt);
72*6236dae4SAndroid Build Coastguard Worker    curl_mime_data(part, inline_text, CURL_ZERO_TERMINATED);
73*6236dae4SAndroid Build Coastguard Worker
74*6236dae4SAndroid Build Coastguard Worker    /* Create the inline part. */
75*6236dae4SAndroid Build Coastguard Worker    part = curl_mime_addpart(alt);
76*6236dae4SAndroid Build Coastguard Worker    curl_mime_subparts(part, alt);
77*6236dae4SAndroid Build Coastguard Worker    curl_mime_type(part, "multipart/alternative");
78*6236dae4SAndroid Build Coastguard Worker    slist = curl_slist_append(NULL, "Content-Disposition: inline");
79*6236dae4SAndroid Build Coastguard Worker    curl_mime_headers(part, slist, 1);
80*6236dae4SAndroid Build Coastguard Worker  }
81*6236dae4SAndroid Build Coastguard Worker}
82*6236dae4SAndroid Build Coastguard Worker~~~
83*6236dae4SAndroid Build Coastguard Worker
84*6236dae4SAndroid Build Coastguard Worker# %AVAILABILITY%
85*6236dae4SAndroid Build Coastguard Worker
86*6236dae4SAndroid Build Coastguard Worker# RETURN VALUE
87*6236dae4SAndroid Build Coastguard Worker
88*6236dae4SAndroid Build Coastguard WorkerCURLE_OK or a CURL error code upon failure.
89