Home Explore Help
Sign In
OWEALs
/
curl
mirror of https://github.com/curl/curl.git
2
0
Fork 0
Files Issues 8 Wiki
Tree: 8f48b5d783
Branches Tags
curl
/
docs
/
libcurl
/
opts
/
CURLOPT_MIMEPOST.3

CURLOPT_MIMEPOST.3 2.0 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152 
  1. .\" **************************************************************************
    2. 

  2. .\" *                                  _   _ ____  _
    3. 

  3. .\" *  Project                     ___| | | |  _ \| |
    4. 

  4. .\" *                             / __| | | | |_) | |
    5. 

  5. .\" *                            | (__| |_| |  _ <| |___
    6. 

  6. .\" *                             \___|\___/|_| \_\_____|
    7. 

  7. .\" *
    8. 

  8. .\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
    9. 

  9. .\" *
    10. 

  10. .\" * This software is licensed as described in the file COPYING, which
    11. 

  11. .\" * you should have received as part of this distribution. The terms
    12. 

  12. .\" * are also available at https://curl.se/docs/copyright.html.
    13. 

  13. .\" *
    14. 

  14. .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
    15. 

  15. .\" * copies of the Software, and permit persons to whom the Software is
    16. 

  16. .\" * furnished to do so, under the terms of the COPYING file.
    17. 

  17. .\" *
    18. 

  18. .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
    19. 

  19. .\" * KIND, either express or implied.
    20. 

  20. .\" *
    21. 

  21. .\" **************************************************************************
    22. 

  22. .\"
    23. 

  23. .TH CURLOPT_MIMEPOST 3 "22 Aug 2017" "libcurl 7.56.0" "curl_easy_setopt options"
    24. 

  24. .SH NAME
    25. 

  25. CURLOPT_MIMEPOST \- send data from mime structure
    26. 

  26. .SH SYNOPSIS
    27. 

  27. .nf
    28. 

  28. #include <curl/curl.h>
    29. 

  29. 

  30. curl_mime *mime;
    31. 

  31. 

  32. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MIMEPOST, mime);
    33. 

  33. .SH DESCRIPTION
    34. 

  34. Pass a mime handle previously obtained from \fIcurl_mime_init(3)\fP.
    35. 

  35. 

  36. This setting is supported by the HTTP protocol to post forms and by the
    37. 

  37. SMTP and IMAP protocols to provide the email data to send/upload.
    38. 

  38. 

  39. This option is the preferred way of posting an HTTP form, replacing and
    40. 

  40. extending the deprecated \fICURLOPT_HTTPPOST(3)\fP option.
    41. 

  41. .SH PROTOCOLS
    42. 

  42. HTTP, SMTP, IMAP.
    43. 

  43. .SH EXAMPLE
    44. 

  44. Using this option implies the use of several mime structure building
    45. 

  45. functions: see https://curl.se/libcurl/c/smtp-mime.html for a complete
    46. 

  46. example.
    47. 

  47. .SH AVAILABILITY
    48. 

  48. Added in 7.56.0
    49. 

  49. .SH RETURN VALUE
    50. 

  50. This will return CURLE_OK.
    51. 

  51. .SH "SEE ALSO"
    52. 

  52. .BR curl_mime_init "(3)"
    53.