docs/libcurl/opts/CURLOPT_MAIL_FROM.3

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