From 290e1bbe0d6ee5f8cc7b326c3895b2323edfa30a Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Fri, 20 Jun 2014 00:58:18 +0200 Subject: opts: the final bunch of options as man pages Now all current options have their own man pages. --- docs/libcurl/opts/CURLOPT_MAIL_RCPT.3 | 60 +++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 docs/libcurl/opts/CURLOPT_MAIL_RCPT.3 (limited to 'docs/libcurl/opts/CURLOPT_MAIL_RCPT.3') diff --git a/docs/libcurl/opts/CURLOPT_MAIL_RCPT.3 b/docs/libcurl/opts/CURLOPT_MAIL_RCPT.3 new file mode 100644 index 000000000..6bda950c9 --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_MAIL_RCPT.3 @@ -0,0 +1,60 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at http://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_MAIL_RCPT 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_MAIL_RCPT \- provide list of mail recipients +.SH SYNOPSIS +.nf +#include + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAIL_RCPT, + struct curl_slist *rcpts); +.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 will assume you provided a single email address +and enclose 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 +RFC5321). + +When performing a mailing list expand (EXPN command), each recipient should be +specified using the mailing list name, such as "Friends" or "London-Office". +.SH DEFAULT +NULL +.SH PROTOCOLS +SMTP +.SH EXAMPLE +TODO +.SH AVAILABILITY +Added in 7.20.0. The VRFY and EXPN logic was added in 7.34.0 +.SH RETURN VALUE +Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. +.SH "SEE ALSO" +.BR CURLOPT_MAIL_FROM "(3), " CURLOPT_MAIL_AUTH "(3), " -- cgit v1.2.3