curl / libcurl / API / curl_mime_type

curl_mime_type - set a mime part content type

Name

curl_mime_type - set a mime part's content type

Synopsis

#include <curl/curl.h>
 
CURLcode curl_mime_type(curl_mimepart *part, const char *mimetype);

Description

curl_mime_type sets a mime part's content type.

part is the part's handle to assign the content type to.

mimetype points to the null-terminated file mime type string; it may be set to NULL to remove a previously attached mime type.

The mime type string is copied into the part, thus the associated storage may safely be released or reused after call. Setting a part's type multiple times is valid: only the value set by the last call is retained.

In the absence of a mime type and if needed by the protocol specifications, a default mime type is determined by the context:

- If set as a custom header, use this value.

- application/form-data for an HTTP form post.

- If a remote filename is set, the mime type is taken from the filename extension, or application/octet-stream by default.

- For a multipart part, multipart/mixed.

- text/plain in other cases.

Protocols

This functionality affects http, imap and smtp

Example

int main(void)
{
  curl_mime *mime;
  curl_mimepart *part;
 
  CURL *curl = curl_easy_init();
  if(curl) {
    /* create a mime handle */
    mime = curl_mime_init(curl);
 
    /* add a part */
    part = curl_mime_addpart(mime);
 
    /* get data from this file */
    curl_mime_filedata(part, "image.png");
 
    /* content-type for this part */
    curl_mime_type(part, "image/png");
 
    /* set name */
    curl_mime_name(part, "image");
}
}

Availability

Added in curl 7.56.0

Return value

CURLE_OK or a CURL error code upon failure.