Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

curl_mime_data (3)

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(3)               libcurl Manual               curl_mime_data(3)



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(3) sets a mime part's body content from memory data.

       data  points  to the data bytes: those are copied to the part and their
       storage may safely be reused after call.  datasize  is  the  number  of
       data bytes: it can be set to CURL_ZERO_TERMINATED to indicate data is a
       null-terminated character string.  part is the part's  to  assign  con-
       tents to.

       Setting  a  part's  contents  twice 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(3) in such a case.

EXAMPLE
        curl_mime *mime;
        curl_mimepart *part;

        /* create a mime handle */
        mime = curl_mime_init(easy);

        /* 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
       As long as at least one of HTTP, SMTP or  IMAP  is  enabled.  Added  in
       7.56.0.

RETURN VALUE
       CURLE_OK or a CURL error code upon failure.


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_data_cb(3),     curl_mime_name(3),
       curl_mime_type(3)



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source      was      downloaded       from        https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

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



libcurl 7.83.1                 November 26, 2021             curl_mime_data(3)