Return to CURLOPT_MAIL_AUTH.3 CVS log

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

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

1.1       misho       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_AUTH 3 "May 31, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_MAIL_AUTH \- SMTP authentication address
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAIL_AUTH, char *auth);
                     31: .SH DESCRIPTION
                     32: Pass a pointer to a zero terminated string as parameter. This will be used to
                     33: specify the authentication address (identity) of a submitted message that is
                     34: being relayed to another server.
                     35: 
                     36: This optional parameter allows co-operating agents in a trusted environment to
                     37: communicate the authentication of individual messages and should only be used
                     38: by the application program, using libcurl, if the application is itself a mail
                     39: server acting in such an environment. If the application is operating as such
                     40: and the AUTH address is not known or is invalid, then an empty string should
                     41: be used for this parameter.
                     42: 
                     43: Unlike \fICURLOPT_MAIL_FROM(3)\fP and \fICURLOPT_MAIL_RCPT(3)\fP, the address
                     44: should not be specified within a pair of angled brackets (<>). However, if an
                     45: empty string is used then a pair of brackets will be sent by libcurl as
                     46: required by RFC2554.
                     47: 
                     48: The application does not have to keep the string around after setting this
                     49: option.
                     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:   curl_easy_setopt(curl, CURLOPT_URL, "smtp://example.com/");
                     59:   curl_easy_setopt(curl, CURLOPT_MAIL_AUTH, "<secret@cave>");
                     60:   ret = curl_easy_perform(curl);
                     61:   curl_easy_cleanup(curl);
                     62: }
                     63: .fi
                     64: .SH AVAILABILITY
                     65: Added in 7.25.0
                     66: .SH RETURN VALUE
                     67: Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
                     68: CURLE_OUT_OF_MEMORY if there was insufficient heap space.
                     69: .SH "SEE ALSO"
                     70: .BR CURLOPT_MAIL_FROM "(3), " CURLOPT_MAIL_RCPT "(3), "