Blame view

3rdparty/curl/share/man/man3/curl_mime_init.3 2.51 KB
a86c63ca   Hu Chunming   提交三方库文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
  .\" **************************************************************************
  .\" *                                  _   _ ____  _
  .\" *  Project                     ___| | | |  _ \| |
  .\" *                             / __| | | | |_) | |
  .\" *                            | (__| |_| |  _ <| |___
  .\" *                             \___|\___/|_| \_\_____|
  .\" *
  .\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
  .\" *
  .\" * This software is licensed as described in the file COPYING, which
  .\" * you should have received as part of this distribution. The terms
  .\" * are also available at https://curl.se/docs/copyright.html.
  .\" *
  .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  .\" * copies of the Software, and permit persons to whom the Software is
  .\" * furnished to do so, under the terms of the COPYING file.
  .\" *
  .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  .\" * KIND, either express or implied.
  .\" *
  .\" **************************************************************************
  .TH curl_mime_init 3 "November 04, 2020" "libcurl 7.77.0" "libcurl Manual"
  
  .SH NAME
  curl_mime_init - create a mime handle
  .SH SYNOPSIS
  .B #include <curl/curl.h>
  .sp
  .BI "curl_mime * curl_mime_init(CURL * " easy_handle ");"
  .ad
  .SH DESCRIPTION
  \fIcurl_mime_init(3)\fP creates a handle to a new empty mime structure
  intended to be used with \fIeasy_handle\fP. This mime structure can be
  subsequently filled using the mime API, then attached to \fIeasy_handle\fP
  using option \fICURLOPT_MIMEPOST(3)\fP within a \fIcurl_easy_setopt(3)\fP
  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.
  
  .SH AVAILABILITY
  As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
  .SH RETURN VALUE
  A mime struct handle, or NULL upon failure.
  .SH EXAMPLE
  .nf
  
   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);
  
  .SH "SEE ALSO"
  .BR curl_mime_addpart "(3),"
  .BR curl_mime_free "(3),"
  .BR CURLOPT_MIMEPOST "(3)"