Return to CURLOPT_MAIL_RCPT_ALLLOWFAILS.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

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

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2020, 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_ALLLOWFAILS 3 "January 14, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_MAIL_RCPT_ALLLOWFAILS \- allow RCPT TO command to fail for some recipients
                     27: .SH SYNOPSIS
                     28: .nf
                     29: #include <curl/curl.h>
                     30: 
                     31: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAIL_RCPT_ALLLOWFAILS,
                     32:                           long allow);
                     33: .SH DESCRIPTION
                     34: If \fIallow\fP is set to 1L, allow RCPT TO command to fail for some recipients.
                     35: 
                     36: When sending data to multiple recipients, by default curl will abort SMTP
                     37: conversation if at least one of the recipients causes RCPT TO command to
                     38: return an error.
                     39: 
                     40: The default behavior can be changed by setting \fIignore\fP to 1L which will
                     41: make curl ignore errors and proceed with the remaining valid recipients.
                     42: 
                     43: In case when all recipients cause RCPT TO command to fail, curl will abort SMTP
                     44: conversation and return the error received from to the last RCPT TO command.
                     45: .SH DEFAULT
                     46: 0
                     47: .SH PROTOCOLS
                     48: SMTP
                     49: .SH EXAMPLE
                     50: .nf
                     51: CURL *curl = curl_easy_init();
                     52: if(curl) {
                     53:   struct curl_slist *list;
                     54: 
                     55:   /* Adding one valid and one invalid email address */
                     56:   list = curl_slist_append(NULL, "person@example.com");
                     57:   list = curl_slist_append(list, "invalidemailaddress");
                     58: 
                     59:   curl_easy_setopt(curl, CURLOPT_URL, "smtp://example.com/");
                     60:   curl_easy_setopt(curl, CURLOPT_MAIL_RCPT_ALLLOWFAILS, 1L);
                     61: 
                     62:   ret = curl_easy_perform(curl);
                     63:   curl_slist_free_all(list);
                     64:   curl_easy_cleanup(curl);
                     65: }
                     66: .fi
                     67: .SH AVAILABILITY
                     68: Added in 7.69.0.
                     69: .SH RETURN VALUE
                     70: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
                     71: .SH "SEE ALSO"
                     72: .BR CURLOPT_MAIL_FROM "(3), " CURLOPT_MAIL_RCPT "(3), "