2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from curl_mime_filedata.md
|
2024-06-01 14:49:19 -06:00
|
|
|
.TH curl_mime_filedata 3 "2024-06-01" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH NAME
|
|
|
|
|
curl_mime_filedata \- set a mime part\(aqs body data from a file contents
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLcode curl_mime_filedata(curl_mimepart *part,
|
|
|
|
|
const char *filename);
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
\fIcurl_mime_filedata(3)\fP sets a mime part\(aqs body content from the named
|
|
|
|
|
file\(aqs contents. This is an alternative to \fIcurl_mime_data(3)\fP for setting
|
|
|
|
|
data to a mime part.
|
|
|
|
|
|
|
|
|
|
\fIpart\fP is the part\(aqs to assign contents to.
|
|
|
|
|
|
|
|
|
|
\fIfilename\fP points to the null\-terminated file\(aqs path name. The pointer can
|
|
|
|
|
be NULL to detach the previous part contents settings. Filename storage can
|
|
|
|
|
be safely be reused after this call.
|
|
|
|
|
|
|
|
|
|
As a side effect, the part\(aqs remote filename is set to the base name of the
|
|
|
|
|
given \fIfilename\fP if it is a valid named file. This can be undone or
|
|
|
|
|
overridden by a subsequent call to \fIcurl_mime_filename(3)\fP.
|
|
|
|
|
|
|
|
|
|
The contents of the file is read during the file transfer in a streaming
|
|
|
|
|
manner to allow huge files to get transferred without using much memory. It
|
|
|
|
|
therefore requires that the file is kept intact during the entire request.
|
|
|
|
|
|
|
|
|
|
If the file size cannot be determined before actually reading it (such as for
|
|
|
|
|
a character device or named pipe), the whole mime structure containing the
|
|
|
|
|
part is transferred using chunks by HTTP but is rejected by IMAP.
|
|
|
|
|
|
|
|
|
|
Setting a part\(aqs contents multiple times is valid: only the value set by the
|
|
|
|
|
last call is retained.
|
2024-03-30 12:28:04 -06:00
|
|
|
.SH PROTOCOLS
|
|
|
|
|
HTTP, IMAP and SMTP
|
2024-03-15 20:55:33 -06:00
|
|
|
.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);
|
|
|
|
|
|
|
|
|
|
/* send data from this file */
|
|
|
|
|
curl_mime_filedata(part, "image.png");
|
|
|
|
|
|
|
|
|
|
/* set name */
|
|
|
|
|
curl_mime_name(part, "data");
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
.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. CURLE_READ_ERROR is only an
|
|
|
|
|
indication that the file is not yet readable: it can be safely ignored at
|
|
|
|
|
this time, but the file must be made readable before the pertaining
|
|
|
|
|
easy handle is performed.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR curl_mime_addpart (3),
|
|
|
|
|
.BR curl_mime_data (3),
|
|
|
|
|
.BR curl_mime_filename (3),
|
|
|
|
|
.BR curl_mime_name (3)
|
