docs/libcurl/opts/CURLOPT_MAIL_RCPT.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, 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 "May 31, 2017" "libcurl 7.59.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 \fBstruct
  36 curl_slist\fP structs properly filled in. Use \fIcurl_slist_append(3)\fP to
  37 create the list and \fIcurl_slist_free_all(3)\fP to clean up an entire list.
  38
  39 When performing a mail transfer, each recipient should be specified within a
  40 pair of angled brackets (<>), however, should you not use an angled bracket as
  41 the first character libcurl will assume you provided a single email address
  42 and enclose that address within brackets for you.
  43
  44 When performing an address verification (VRFY command), each recipient should
  45 be specified as the user name or user name and domain (as per Section 3.5 of
  46 RFC5321).
  47
  48 When performing a mailing list expand (EXPN command), each recipient should be
  49 specified using the mailing list name, such as "Friends" or "London-Office".
  50 .SH DEFAULT
  51 NULL
  52 .SH PROTOCOLS
  53 SMTP
  54 .SH EXAMPLE
  55 .nf
  56 CURL *curl = curl_easy_init();
  57 if(curl) {
  58   struct curl_slist *list;
  59   list = curl_slist_append(NULL, "root@localhost");
  60   list = curl_slist_append(list, "person@example.com");
  61   curl_easy_setopt(curl, CURLOPT_URL, "smtp://example.com/");
  62   curl_easy_setopt(curl, CURLOPT_MAIL_RCPT, list);
  63   ret = curl_easy_perform(curl);
  64   curl_slist_free_all(list);
  65   curl_easy_cleanup(curl);
  66 }
  67 .fi
  68 .SH AVAILABILITY
  69 Added in 7.20.0. The VRFY and EXPN logic was added in 7.34.0
  70 .SH RETURN VALUE
  71 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  72 .SH "SEE ALSO"
  73 .BR CURLOPT_MAIL_FROM "(3), " CURLOPT_MAIL_AUTH "(3), "