• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1---
2c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
3SPDX-License-Identifier: curl
4Title: curl_mime_addpart
5Section: 3
6Source: libcurl
7See-also:
8  - curl_mime_data (3)
9  - curl_mime_data_cb (3)
10  - curl_mime_encoder (3)
11  - curl_mime_filedata (3)
12  - curl_mime_filename (3)
13  - curl_mime_headers (3)
14  - curl_mime_init (3)
15  - curl_mime_name (3)
16  - curl_mime_subparts (3)
17  - curl_mime_type (3)
18---
19
20# NAME
21
22curl_mime_addpart - append a new empty part to a mime structure
23
24# SYNOPSIS
25
26~~~c
27#include <curl/curl.h>
28
29curl_mimepart *curl_mime_addpart(curl_mime *mime);
30~~~
31
32# DESCRIPTION
33
34curl_mime_addpart(3) creates and appends a new empty part to the given
35mime structure and returns a handle to it. The returned part handle can
36subsequently be populated using functions from the mime API.
37
38*mime* is the handle of the mime structure in which the new part must be
39appended.
40
41# EXAMPLE
42
43~~~c
44int main(void)
45{
46  curl_mime *mime;
47  curl_mimepart *part;
48
49  CURL *curl = curl_easy_init();
50  if(curl) {
51    /* create a mime handle */
52    mime = curl_mime_init(curl);
53
54    /* add a part */
55    part = curl_mime_addpart(mime);
56
57    /* continue and set name + data to the part */
58    curl_mime_data(part, "This is the field data", CURL_ZERO_TERMINATED);
59    curl_mime_name(part, "data");
60  }
61}
62~~~
63
64# AVAILABILITY
65
66As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
67
68# RETURN VALUE
69
70A mime part structure handle, or NULL upon failure.
71