aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/opts/CURLOPT_MAIL_RCPT.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_MAIL_RCPT.md')
-rw-r--r--docs/libcurl/opts/CURLOPT_MAIL_RCPT.md80
1 files changed, 80 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLOPT_MAIL_RCPT.md b/docs/libcurl/opts/CURLOPT_MAIL_RCPT.md
new file mode 100644
index 000000000..ce57074f0
--- /dev/null
+++ b/docs/libcurl/opts/CURLOPT_MAIL_RCPT.md
@@ -0,0 +1,80 @@
+---
+c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
+SPDX-License-Identifier: curl
+Title: CURLOPT_MAIL_RCPT
+Section: 3
+Source: libcurl
+See-also:
+ - CURLOPT_MAIL_AUTH (3)
+ - CURLOPT_MAIL_FROM (3)
+---
+
+# NAME
+
+CURLOPT_MAIL_RCPT - list of SMTP mail recipients
+
+# SYNOPSIS
+
+~~~c
+#include <curl/curl.h>
+
+CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAIL_RCPT,
+ struct curl_slist *rcpts);
+~~~
+
+# 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
+**struct curl_slist** structs properly filled in. Use
+curl_slist_append(3) to create the list and curl_slist_free_all(3)
+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 (**VRFY** command), each recipient
+should be specified as the user name or user name and domain (as per Section
+3.5 of RFC 5321).
+
+When performing a mailing list expand (**EXPN** command), each recipient
+should be specified using the mailing list name, such as "Friends" or
+"London-Office".
+
+# DEFAULT
+
+NULL
+
+# PROTOCOLS
+
+SMTP
+
+# EXAMPLE
+
+~~~c
+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);
+ }
+}
+~~~
+
+# AVAILABILITY
+
+Added in 7.20.0. The **VRFY** and **EXPN** logic was added in 7.34.0
+
+# RETURN VALUE
+
+Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.