curl_mime_headers(3)

curl_mime_headers3

Set a mime part's custom headers

Usage

#include <curl/curl.h>
CURLcode curl_mime_headers(curl_mimepart *part,
                           struct curl_slist *headers, int take_ownership);

Overview

curl_mime_headers(3) sets a mime part's custom headers.

part is the part's handle to assign the custom headers list to.

headers is the head of a list of custom headers; it may be set to NULL to remove a previously attached custom header list.

take_ownership: when non-zero, causes the list to be freed upon replacement or mime structure deletion; in this case the list must not be freed explicitly.

Setting a part's custom headers list multiple times is valid: only the value set by the last call is retained.

Examples

int main(void)
{
  struct curl_slist *headers = NULL;
  CURL *easy = curl_easy_init();
  curl_mime *mime;
  curl_mimepart *part;
  headers = curl_slist_append(headers, "Custom-Header: mooo");
  mime = curl_mime_init(easy);
  part = curl_mime_addpart(mime);
  /* use these headers in the part, takes ownership */
  curl_mime_headers(part, headers, 1);
  /* pass on this data */
  curl_mime_data(part, "12345679", CURL_ZERO_TERMINATED);
  /* set name */
  curl_mime_name(part, "numbers");
  /* Post and send it. */
  curl_easy_setopt(easy, CURLOPT_MIMEPOST, mime);
  curl_easy_setopt(easy, CURLOPT_URL, "https://example.com");
  curl_easy_perform(easy);
}

Return value

CURLE_OK or a CURL error code upon failure.

Releases

32 releases since macOS 12.0.1; the text changed 9 times.

  1. 12.0.1–12.2
  2. 12.3–12.5
  3. 13.0
  4. 13.1
  5. 13.2
  6. 13.3
  7. 13.4
  8. 13.5–14.1
  9. 14.2–14.4
  10. 14.5–26.5

Availability

As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.

From curl 166.0.0.0.1 in macOS 26.5. Parsed by carta from the page's man source.