Blame view

3rdparty/curl/share/man/man3/CURLOPT_MAIL_AUTH.3 2.77 KB
a86c63ca   Hu Chunming   提交三方库文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
  .\" **************************************************************************
  .\" *                                  _   _ ____  _
  .\" *  Project                     ___| | | |  _ \| |
  .\" *                             / __| | | | |_) | |
  .\" *                            | (__| |_| |  _ <| |___
  .\" *                             \___|\___/|_| \_\_____|
  .\" *
  .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, 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 https://curl.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_AUTH 3 "November 04, 2020" "libcurl 7.77.0" "curl_easy_setopt options"
  
  .SH NAME
  CURLOPT_MAIL_AUTH \- SMTP authentication address
  .SH SYNOPSIS
  #include <curl/curl.h>
  
  CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAIL_AUTH, char *auth);
  .SH DESCRIPTION
  Pass a pointer to a null-terminated string as parameter. This will be used to
  specify the authentication address (identity) of a submitted message that is
  being relayed to another server.
  
  This optional parameter allows co-operating agents in a trusted environment to
  communicate the authentication of individual messages and should only be used
  by the application program, using libcurl, if the application is itself a mail
  server acting in such an environment. If the application is operating as such
  and the AUTH address is not known or is invalid, then an empty string should
  be used for this parameter.
  
  Unlike \fICURLOPT_MAIL_FROM(3)\fP and \fICURLOPT_MAIL_RCPT(3)\fP, the address
  should not be specified within a pair of angled brackets (<>). However, if an
  empty string is used then a pair of brackets will be sent by libcurl as
  required by RFC2554.
  
  The application does not have to keep the string around after setting this
  option.
  .SH DEFAULT
  NULL
  .SH PROTOCOLS
  SMTP
  .SH EXAMPLE
  .nf
  CURL *curl = curl_easy_init();
  if(curl) {
    curl_easy_setopt(curl, CURLOPT_URL, "smtp://example.com/");
    curl_easy_setopt(curl, CURLOPT_MAIL_AUTH, "<secret@cave>");
    ret = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
  .fi
  .SH AVAILABILITY
  Added in 7.25.0
  .SH RETURN VALUE
  Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  .SH "SEE ALSO"
  .BR CURLOPT_MAIL_FROM "(3), " CURLOPT_MAIL_RCPT "(3), "