Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_MAIL_RCPT.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al.
                      9: .\" *
                     10: .\" * This software is licensed as described in the file COPYING, which
                     11: .\" * you should have received as part of this distribution. The terms
                     12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
                     13: .\" *
                     14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
                     15: .\" * copies of the Software, and permit persons to whom the Software is
                     16: .\" * furnished to do so, under the terms of the COPYING file.
                     17: .\" *
                     18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
                     19: .\" * KIND, either express or implied.
                     20: .\" *
                     21: .\" **************************************************************************
                     22: .\"
                     23: .TH CURLOPT_MAIL_RCPT 3 "July 16, 2019" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_MAIL_RCPT \- list of SMTP mail recipients
                     27: .SH SYNOPSIS
                     28: .nf
                     29: #include <curl/curl.h>
                     30: 
                     31: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAIL_RCPT,
                     32:                           struct curl_slist *rcpts);
                     33: .SH DESCRIPTION
                     34: Pass a pointer to a linked list of recipients to pass to the server in your
                     35: SMTP mail request. The linked list should be a fully valid list of
                     36: \fBstruct curl_slist\fP structs properly filled in. Use
                     37: \fIcurl_slist_append(3)\fP to create the list and \fIcurl_slist_free_all(3)\fP
                     38: to clean up an entire list.
                     39: 
                     40: When performing a mail transfer, each recipient should be specified within a
                     41: pair of angled brackets (<>), however, should you not use an angled bracket as
                     42: the first character libcurl will assume you provided a single email address
                     43: and enclose that address within brackets for you.
                     44: 
                     45: When performing an address verification (VRFY command), each recipient should
                     46: be specified as the user name or user name and domain (as per Section 3.5 of
                     47: RFC5321).
                     48: 
                     49: When performing a mailing list expand (EXPN command), each recipient should be
                     50: specified using the mailing list name, such as "Friends" or "London-Office".
                     51: .SH DEFAULT
                     52: NULL
                     53: .SH PROTOCOLS
                     54: SMTP
                     55: .SH EXAMPLE
                     56: .nf
                     57: CURL *curl = curl_easy_init();
                     58: if(curl) {
                     59:   struct curl_slist *list;
                     60:   list = curl_slist_append(NULL, "root@localhost");
                     61:   list = curl_slist_append(list, "person@example.com");
                     62:   curl_easy_setopt(curl, CURLOPT_URL, "smtp://example.com/");
                     63:   curl_easy_setopt(curl, CURLOPT_MAIL_RCPT, list);
                     64:   ret = curl_easy_perform(curl);
                     65:   curl_slist_free_all(list);
                     66:   curl_easy_cleanup(curl);
                     67: }
                     68: .fi
                     69: .SH AVAILABILITY
                     70: Added in 7.20.0. The VRFY and EXPN logic was added in 7.34.0
                     71: .SH RETURN VALUE
                     72: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
                     73: .SH "SEE ALSO"
                     74: .BR CURLOPT_MAIL_FROM "(3), " CURLOPT_MAIL_AUTH "(3), "

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>