docs/libcurl/curl_mime_init.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
   9 .\" *
  10 .\" * This software is licensed as described in the file COPYING, which
  11 .\" * you should have received as part of this distribution. The terms
  12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
  13 .\" *
  14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15 .\" * copies of the Software, and permit persons to whom the Software is
  16 .\" * furnished to do so, under the terms of the COPYING file.
  17 .\" *
  18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19 .\" * KIND, either express or implied.
  20 .\" *
  21 .\" **************************************************************************
  22 .TH curl_mime_init 3 "September 22, 2017" "libcurl 7.59.0" "libcurl Manual"
  23
  24 .SH NAME
  25 curl_mime_init - create a mime handle
  26 .SH SYNOPSIS
  27 .B #include <curl/curl.h>
  28 .sp
  29 .BI "curl_mime * curl_mime_init(CURL * " easy_handle ");"
  30 .ad
  31 .SH DESCRIPTION
  32 \fIcurl_mime_init(3)\fP creates a handle to a new empty mime structure
  33 intended to be used with \fIeasy_handle\fP. This mime structure can be
  34 subsequently filled using the mime API, then attached to \fIeasy_handle\fP
  35 using option \fICURLOPT_MIMEPOST(3)\fP within a \fIcurl_easy_setopt(3)\fP
  36 call.
  37
  38 Using a mime handle is the recommended way to post an HTTP form, format and
  39 send a multi-part e-mail with SMTP or upload such an e-mail to an IMAP server.
  40
  41 .SH AVAILABILITY
  42 As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
  43 .SH RETURN VALUE
  44 A mime struct handle, or NULL upon failure.
  45 .SH EXAMPLE
  46 .nf
  47
  48  CURL *easy = curl_easy_init();
  49  curl_mime *mime;
  50  curl_mimepart *part;
  51
  52  /* Build an HTTP form with a single field named "data", */
  53  mime = curl_mime_init(easy);
  54  part = curl_mime_addpart(mime);
  55  curl_mime_data(part, "This is the field data", CURL_ZERO_TERMINATED);
  56  curl_mime_name(part, "data");
  57
  58  /* Post and send it. */
  59  curl_easy_setopt(easy, CURLOPT_MIMEPOST, mime);
  60  curl_easy_setopt(easy, CURLOPT_URL, "http://example.com");
  61  curl_easy_perform(easy);
  62
  63  /* Clean-up. */
  64  curl_easy_cleanup(easy);
  65  curl_mime_free(mime);
  66
  67 .SH "SEE ALSO"
  68 .BR curl_mime_addpart "(3),"
  69 .BR curl_mime_free "(3),"
  70 .BR CURLOPT_MIMEPOST "(3)"