plucky (3) CURLOPT_MAIL_FROM.3.gz

Provided by: libcurl4-doc_8.12.1-2ubuntu1_all bug

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 are added automatically.

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

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

       Using this option multiple times makes the last set string override the previous ones. Set it to NULL  to
       disable its use again.

DEFAULT

       blank

PROTOCOLS

       This functionality affects smtp only

EXAMPLE

       int main(void)
       {
         CURL *curl = curl_easy_init();
         if(curl) {
           CURLcode res;
           curl_easy_setopt(curl, CURLOPT_URL, "smtp://example.com/");
           curl_easy_setopt(curl, CURLOPT_MAIL_FROM, "president@example.com");
           res = curl_easy_perform(curl);
           curl_easy_cleanup(curl);
         }
       }

AVAILABILITY

       Added in curl 7.20.0

RETURN VALUE

       curl_easy_setopt(3) returns a CURLcode indicating success or error.

       CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors(3).

SEE ALSO

       CURLOPT_MAIL_AUTH(3), CURLOPT_MAIL_RCPT(3)