docs/libcurl/opts/CURLOPT_MAIL_AUTH.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2  "http://www.w3.org/TR/html4/loose.dtd">
   3 <html><head>
   4 <title>CURLOPT_MAIL_AUTH man page</title>
   5 <meta name="generator" content="roffit">
   6 <STYLE type="text/css">
   7 pre {
   8   overflow: auto;
   9   margin: 0;
  10 }
  11
  12 P.level0, pre.level0 {
  13  padding-left: 2em;
  14 }
  15
  16 P.level1, pre.level1 {
  17  padding-left: 4em;
  18 }
  19
  20 P.level2, pre.level2 {
  21  padding-left: 6em;
  22 }
  23
  24 span.emphasis {
  25  font-style: italic;
  26 }
  27
  28 span.bold {
  29  font-weight: bold;
  30 }
  31
  32 span.manpage {
  33  font-weight: bold;
  34 }
  35
  36 h2.nroffsh {
  37  background-color: #e0e0e0;
  38 }
  39
  40 span.nroffip {
  41  font-weight: bold;
  42  font-size: 120%;
  43  font-family: monospace;
  44 }
  45
  46 p.roffit {
  47  text-align: center;
  48  font-size: 80%;
  49 }
  50 </STYLE>
  51 </head><body>
  52
  53 <p class="level0"><a name="NAME"></a><h2 class="nroffsh">NAME</h2>
  54 <p class="level0">CURLOPT_MAIL_AUTH - SMTP authentication address <a name="SYNOPSIS"></a><h2 class="nroffsh">SYNOPSIS</h2>
  55 <p class="level0">&#35;include &lt;curl/curl.h&gt;
  56 <p class="level0">CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAIL_AUTH, char *auth); <a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2>
  57 <p class="level0">Pass a pointer to a zero terminated string as parameter. This will be used to specify the authentication address (identity) of a submitted message that is being relayed to another server.
  58 <p class="level0">This optional parameter allows co-operating agents in a trusted environment to communicate the authentication of individual messages and should only be used by the application program, using libcurl, if the application is itself a mail server acting in such an environment. If the application is operating as such and the AUTH address is not known or is invalid, then an empty string should be used for this parameter.
  59 <p class="level0">Unlike <a Class="emphasis" href="./CURLOPT_MAIL_FROM.html">CURLOPT_MAIL_FROM</a> and <a Class="emphasis" href="./CURLOPT_MAIL_RCPT.html">CURLOPT_MAIL_RCPT</a>, the address should not be specified within a pair of angled brackets (&lt;&gt;). However, if an empty string is used then a pair of brackets will be sent by libcurl as required by <a href="http://www.ietf.org/rfc/rfc2554.txt">RFC 2554</a>. <a name="DEFAULT"></a><h2 class="nroffsh">DEFAULT</h2>
  60 <p class="level0">NULL <a name="PROTOCOLS"></a><h2 class="nroffsh">PROTOCOLS</h2>
  61 <p class="level0">SMTP <a name="EXAMPLE"></a><h2 class="nroffsh">EXAMPLE</h2>
  62 <p class="level0">TODO <a name="AVAILABILITY"></a><h2 class="nroffsh">AVAILABILITY</h2>
  63 <p class="level0">Added in 7.25.0 <a name="RETURN"></a><h2 class="nroffsh">RETURN VALUE</h2>
  64 <p class="level0">Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space. <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2>
  65 <p class="level0"><a Class="manpage" href="./CURLOPT_MAIL_FROM.html">CURLOPT_MAIL_FROM</a>, <a Class="manpage" href="./CURLOPT_MAIL_RCPT.html">CURLOPT_MAIL_RCPT</a><p class="roffit">
  66  This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>.
  67 </body></html>