Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_MAIL_RCPT (3)

Name

CURLOPT_MAIL_RCPT - list of SMTP mail recipients

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAIL_RCPT,
struct curl_slist *rcpts);

Description

CURLOPT_MAIL_RCPT(3)       curl_easy_setopt options       CURLOPT_MAIL_RCPT(3)



NAME
       CURLOPT_MAIL_RCPT - list of SMTP mail recipients

SYNOPSIS
       #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 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".

DEFAULT
       NULL

PROTOCOLS
       SMTP

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         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);
         ret = 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.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_MAIL_FROM(3), CURLOPT_MAIL_AUTH(3),



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was    downloaded    from     https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.37.0                    19 Jun 2014             CURLOPT_MAIL_RCPT(3)