Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

curl_mime_subparts (3)

Name

curl_mime_subparts - set subparts of a multipart mime part

Synopsis

#include <curl/curl.h>

CURLcode curl_mime_subparts(curl_mimepart *part, curl_mime *subparts);

Description

curl_mime_subparts(3)           libcurl Manual           curl_mime_subparts(3)



NAME
       curl_mime_subparts - set subparts of a multipart mime part

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_mime_subparts(curl_mimepart *part, curl_mime *subparts);

DESCRIPTION
       curl_mime_subparts(3)  sets a multipart mime part's content from a mime
       structure.

       part is a handle to the multipart part.

       subparts is  a  mime  structure  handle  holding  the  subparts.  After
       curl_mime_subparts  succeeds,  the mime structure handle belongs to the
       multipart part and must not be freed  explicitly.  It  may  however  be
       updated by subsequent calls to mime API functions.

       Setting  a  part's  contents  twice is valid: only the value set by the
       last call is retained. It is possible to unassign previous part's  con-
       tents by setting subparts to NULL.

EXAMPLE
        /* The inline part is an alternative proposing the html and the text
           versions of the email. */
        alt = curl_mime_init(curl);

        /* HTML message. */
        part = curl_mime_addpart(alt);
        curl_mime_data(part, inline_html, CURL_ZERO_TERMINATED);
        curl_mime_type(part, "text/html");

        /* Text message. */
        part = curl_mime_addpart(alt);
        curl_mime_data(part, inline_text, CURL_ZERO_TERMINATED);

        /* Create the inline part. */
        part = curl_mime_addpart(mime);
        curl_mime_subparts(part, alt);
        curl_mime_type(part, "multipart/alternative");
        slist = curl_slist_append(NULL, "Content-Disposition: inline");
        curl_mime_headers(part, slist, 1);

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_init(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                 December 17, 2021         curl_mime_subparts(3)