Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

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)               libcurl 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
       intended to be used with easy_handle. This mime structure can be subse-
       quently  filled  using the mime API, then attached to easy_handle using
       option CURLOPT_MIMEPOST(3) within a curl_easy_setopt(3) call.

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


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.

EXAMPLE
        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, "http://example.com");
        curl_easy_perform(easy);

        /* Clean-up. */
        curl_easy_cleanup(easy);
        curl_mime_free(mime);



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       curl_mime_addpart(3), curl_mime_free(3), CURLOPT_MIMEPOST(3)



NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was    downloaded    from    https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.56.0                  22 August 2017               curl_mime_init(3)