mirror of
https://codeberg.org/kiss-community/repo
synced 2024-08-19 12:46:58 +00:00
49 lines
1.3 KiB
Groff
49 lines
1.3 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLOPT_MAIL_FROM.md
|
|
.TH CURLOPT_MAIL_FROM 3 "2024-06-01" libcurl
|
|
.SH NAME
|
|
CURLOPT_MAIL_FROM \- SMTP sender address
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAIL_FROM, char *from);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a pointer to a null\-terminated string as parameter. This should be used
|
|
to specify the sender\(aqs email address when sending SMTP mail with libcurl.
|
|
|
|
An originator email address should be specified with angled brackets (<>)
|
|
around it, which if not specified are added automatically.
|
|
|
|
If this parameter is not specified then an empty address is sent to the SMTP
|
|
server which might cause the email to be rejected.
|
|
|
|
The application does not have to keep the string around after setting this
|
|
option.
|
|
.SH DEFAULT
|
|
blank
|
|
.SH PROTOCOLS
|
|
SMTP
|
|
.SH EXAMPLE
|
|
.nf
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
CURLcode res;
|
|
curl_easy_setopt(curl, CURLOPT_URL, "smtp://example.com/");
|
|
curl_easy_setopt(curl, CURLOPT_MAIL_FROM, "president@example.com");
|
|
res = curl_easy_perform(curl);
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in 7.20.0
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
|
|
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
|
.SH SEE ALSO
|
|
.BR CURLOPT_MAIL_AUTH (3),
|
|
.BR CURLOPT_MAIL_RCPT (3)
|