docs/libcurl/opts/CURLOPT_MAIL_FROM.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 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_FROM 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_MAIL_FROM \- SMTP sender address
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAIL_FROM, char *from);
  30 .SH DESCRIPTION
  31 Pass a pointer to a zero terminated string as parameter. This should be used
  32 to specify the sender's email address when sending SMTP mail with libcurl.
  33
  34 An originator email address should be specified with angled brackets (<>)
  35 around it, which if not specified will be added automatically.
  36
  37 If this parameter is not specified then an empty address will be sent to the
  38 mail server which may cause the email to be rejected.
  39
  40 The application does not have to keep the string around after setting this
  41 option.
  42 .SH DEFAULT
  43 blank
  44 .SH PROTOCOLS
  45 SMTP
  46 .SH EXAMPLE
  47 TODO
  48 .SH AVAILABILITY
  49 Added in 7.20.0
  50 .SH RETURN VALUE
  51 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  52 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  53 .SH "SEE ALSO"
  54 .BR CURLOPT_MAIL_RCPT "(3), " CURLOPT_MAIL_AUTH "(3), "