curl_mime_init - create a mime handle

Name

curl_mime_init - create a mime handle

Synopsis

#include <curl/curl.h>
 
curl_mime *curl_mime_init(CURL *easy_handle);

Description

curl_mime_init creates a handle to a new empty mime structure. This mime structure can be subsequently filled using the mime API, then attached to some easy handle using option CURLOPT_MIMEPOST within a curl_easy_setopt call or added as a multipart in another mime handle's part using curl_mime_subparts.

easy_handle is used for part separator randomization and error reporting. Since 7.87.0, it does not need to be the final target handle.

Using a mime handle is the recommended way to post an HTTP form, format and send a multi-part email with SMTP or upload such an email to an IMAP server.

Protocols

HTTP, IMAP and SMTP

Example

int main(void)
{
  CURL *easy = curl_easy_init();
  curl_mime *mime;
  curl_mimepart *part;
 
  /* Build an HTTP form with a single field named "data", */
  mime = curl_mime_init(easy);
  part = curl_mime_addpart(mime);
  curl_mime_data(part, "This is the field data", CURL_ZERO_TERMINATED);
  curl_mime_name(part, "data");
 
  /* Post and send it. */
  curl_easy_setopt(easy, CURLOPT_MIMEPOST, mime);
  curl_easy_setopt(easy, CURLOPT_URL, "https://example.com");
  curl_easy_perform(easy);
 
  /* Clean-up. */
  curl_easy_cleanup(easy);
  curl_mime_free(mime);
}

Availability

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

Return value

A mime struct handle, or NULL upon failure.

See also

CURLOPT_MIMEPOST(3), curl_mime_addpart(3), curl_mime_free(3), curl_mime_subparts(3)

This HTML page was made with roffit.