Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
curl_mime_init(3)	   Library Functions Manual	     curl_mime_init(3)

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(3) creates a handle to a new empty mime structure.  This
       mime  structure can be subsequently filled using	the mime API, then at-
       tached to some easy handle using	option	CURLOPT_MIMEPOST(3)  within  a
       curl_easy_setopt(3)  call  or added as a	multipart in another mime han-
       dle's part using	curl_mime_subparts(3).

       easy_handle is used for part separator randomization and	error  report-
       ing. 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
       This functionality affects 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
       Added in	curl 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)

libcurl				  2025-06-03		     curl_mime_init(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=curl_mime_init&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help