mirror of
https://codeberg.org/kiss-community/repo
synced 2024-08-19 20:56:58 +00:00
72 lines
1.9 KiB
Groff
72 lines
1.9 KiB
Groff
.\" generated by cd2nroff 0.1 from curl_mime_type.md
|
|
.TH curl_mime_type 3 "2024-06-01" libcurl
|
|
.SH NAME
|
|
curl_mime_type \- set a mime part\(aqs content type
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_mime_type(curl_mimepart *part, const char *mimetype);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
\fIcurl_mime_type(3)\fP sets a mime part\(aqs content type.
|
|
|
|
\fIpart\fP is the part\(aqs handle to assign the content type to.
|
|
|
|
\fImimetype\fP points to the null\-terminated file mime type string; it may be
|
|
set to NULL to remove a previously attached mime type.
|
|
|
|
The mime type string is copied into the part, thus the associated storage may
|
|
safely be released or reused after call. Setting a part\(aqs type multiple times
|
|
is valid: only the value set by the last call is retained.
|
|
|
|
In the absence of a mime type and if needed by the protocol specifications,
|
|
a default mime type is determined by the context:
|
|
|
|
- If set as a custom header, use this value.
|
|
|
|
- application/form\-data for an HTTP form post.
|
|
|
|
- If a remote filename is set, the mime type is taken from the filename
|
|
extension, or application/octet\-stream by default.
|
|
|
|
- For a multipart part, multipart/mixed.
|
|
|
|
- text/plain in other cases.
|
|
.SH PROTOCOLS
|
|
HTTP, IMAP and SMTP
|
|
.SH EXAMPLE
|
|
.nf
|
|
int main(void)
|
|
{
|
|
curl_mime *mime;
|
|
curl_mimepart *part;
|
|
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
/* create a mime handle */
|
|
mime = curl_mime_init(curl);
|
|
|
|
/* add a part */
|
|
part = curl_mime_addpart(mime);
|
|
|
|
/* get data from this file */
|
|
curl_mime_filedata(part, "image.png");
|
|
|
|
/* content-type for this part */
|
|
curl_mime_type(part, "image/png");
|
|
|
|
/* set name */
|
|
curl_mime_name(part, "image");
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
|
|
.SH RETURN VALUE
|
|
CURLE_OK or a CURL error code upon failure.
|
|
.SH SEE ALSO
|
|
.BR curl_mime_addpart (3),
|
|
.BR curl_mime_data (3),
|
|
.BR curl_mime_name (3)
|