curl / libcurl / API / curl_mime_data

curl_mime_data - set a mime part body data from memory

Name

curl_mime_data - set a mime part's body data from memory

Synopsis

#include <curl/curl.h>
 
CURLcode curl_mime_data(curl_mimepart *part, const char *data,
                        size_t datasize);

Description

curl_mime_data sets a mime part's body content from memory data.

part is the mime part to assign contents to, created with curl_mime_addpart.

data points to the data that gets copied by this function. The storage may safely be reused after the call.

datasize is the number of bytes data points to. It can be set to CURL_ZERO_TERMINATED to indicate data is a null-terminated character string.

Setting a part's contents multiple times is valid: only the value set by the last call is retained. It is possible to unassign part's contents by setting data to NULL.

Setting large data is memory consuming: one might consider using curl_mime_data_cb in such a case.

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);
 
    /* add data to the part  */
    curl_mime_data(part, "raw contents to send", CURL_ZERO_TERMINATED);
  }
}

Availability

Added in curl 7.56.0

Return value

This function returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors. If CURLOPT_ERRORBUFFER was set with curl_easy_setopt there can be an error message stored in the error buffer when non-zero is returned.