docs/libcurl/opts/CURLOPT_MAIL_AUTH.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 http://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 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_MAIL_AUTH \- specify SMTP authentication address
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAIL_AUTH, char *auth);
  30 .SH DESCRIPTION
  31 Pass a pointer to a zero terminated string as parameter. This will be used to
  32 specify the authentication address (identity) of a submitted message that is
  33 being relayed to another server.
  34
  35 This optional parameter allows co-operating agents in a trusted environment to
  36 communicate the authentication of individual messages and should only be used
  37 by the application program, using libcurl, if the application is itself a mail
  38 server acting in such an environment. If the application is operating as such
  39 and the AUTH address is not known or is invalid, then an empty string should
  40 be used for this parameter.
  41
  42 Unlike \fICURLOPT_MAIL_FROM(3)\fP and \fICURLOPT_MAIL_RCPT(3)\fP, the address
  43 should not be specified within a pair of angled brackets (<>). However, if an
  44 empty string is used then a pair of brackets will be sent by libcurl as
  45 required by RFC2554.
  46 .SH DEFAULT
  47 NULL
  48 .SH PROTOCOLS
  49 SMTP
  50 .SH EXAMPLE
  51 TODO
  52 .SH AVAILABILITY
  53 Added in 7.25.0
  54 .SH RETURN VALUE
  55 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  56 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  57 .SH "SEE ALSO"
  58 .BR CURLOPT_MAIL_FROM "(3), " CURLOPT_MAIL_RCPT "(3), "