| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758 |
- .\" generated by cd2nroff 0.1 from CURLOPT_MAIL_RCPT.md
- .TH CURLOPT_MAIL_RCPT 3 "2025-01-17" libcurl
- .SH NAME
- CURLOPT_MAIL_RCPT \- list of SMTP mail recipients
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAIL_RCPT,
- struct curl_slist *rcpts);
- .fi
- .SH DESCRIPTION
- Pass a pointer to a linked list of recipients to pass to the server in your
- SMTP mail request. The linked list should be a fully valid list of
- \fBstruct curl_slist\fP structs properly filled in. Use \fIcurl_slist_append(3)\fP to
- create the list and \fIcurl_slist_free_all(3)\fP to clean up an entire list.
- When performing a mail transfer, each recipient should be specified within a
- pair of angled brackets (<>), however, should you not use an angled bracket
- as the first character libcurl assumes you provided a single email address and
- encloses that address within brackets for you.
- When performing an address verification (\fBVRFY\fP command), each recipient
- should be specified as the username or username plus domain (as per Section
- 3.5 of RFC 5321).
- When performing a mailing list expand (\fBEXPN\fP command), each recipient
- should be specified using the mailing list name, such as \fIFriends\fP or
- \fILondon\-Office\fP.
- .SH DEFAULT
- NULL
- .SH PROTOCOLS
- This functionality affects smtp only
- .SH EXAMPLE
- .nf
- int main(void)
- {
- CURL *curl = curl_easy_init();
- if(curl) {
- CURLcode res;
- struct curl_slist *list;
- list = curl_slist_append(NULL, "root@localhost");
- list = curl_slist_append(list, "person@example.com");
- curl_easy_setopt(curl, CURLOPT_URL, "smtp://example.com/");
- curl_easy_setopt(curl, CURLOPT_MAIL_RCPT, list);
- res = curl_easy_perform(curl);
- curl_slist_free_all(list);
- curl_easy_cleanup(curl);
- }
- }
- .fi
- .SH AVAILABILITY
- Added in curl 7.20.0
- .SH RETURN VALUE
- Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- .SH SEE ALSO
- .BR CURLOPT_MAIL_AUTH (3),
- .BR CURLOPT_MAIL_FROM (3)
|