Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_MAIL_FROM (3)

Name

CURLOPT_MAIL_FROM - SMTP sender address

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAIL_FROM, char *from);

Description

CURLOPT_MAIL_FROM(3)       curl_easy_setopt options       CURLOPT_MAIL_FROM(3)



NAME
       CURLOPT_MAIL_FROM - SMTP sender address

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAIL_FROM, char *from);

DESCRIPTION
       Pass a pointer to a null-terminated string as parameter. This should be
       used to specify the sender's email address when sending SMTP mail  with
       libcurl.

       An  originator  email  address should be specified with angled brackets
       (<>) around it, which if not specified will be added automatically.

       If this parameter is not specified then an empty address will  be  sent
       to the mail server which may cause the email to be rejected.

       The  application  does not have to keep the string around after setting
       this option.

DEFAULT
       blank

PROTOCOLS
       SMTP

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "smtp://example.com/");
         curl_easy_setopt(curl, CURLOPT_MAIL_FROM, "president@example.com");
         ret = curl_easy_perform(curl);
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in 7.20.0

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.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       CURLOPT_MAIL_RCPT(3), CURLOPT_MAIL_AUTH(3),



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source       was       downloaded      from       https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                 November 26, 2021          CURLOPT_MAIL_FROM(3)