Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

CURL.SetOptionMailAuth

Sets the mail auth option.

Component Version macOS Windows Linux Server iOS SDK
CURL 2.9 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "CURL.SetOptionMailAuth"; curl; Value { ; Encoding } )   More

Parameters

Parameter Description Example Flags
curl The CURL session handle. $curl
Value The new options. ""
Encoding The text encoding for text parameter.
Default is UTF-8.
Possible encoding names: ANSI, ISO-8859-1, Latin1, Mac, Native, UTF-8, DOS, Hex, Base64 or Windows. More listed in the FAQ.		 "UTF8" Optional

Result

Returns "OK" on success.

Description

Sets the mail auth option.
This string will be used to specify the authentication address (identity) of a submitted message that is being relayed to another server.
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.
Unlike CURL.SetOptionMailRecipients, the address should not be specified within a pair of angled brackets (<>). However, if an empty string is used then a pair of brackets will be sent by libcurl as required by RFC 2554.

See also MAIL_AUTH option in CURL manual.

Examples

Set mail auth address:

MBS( "CURL.SetOptionMailAuth"; $curl; "<secret@cave>" )

See also

Blog Entries

Created 18th August 2014, last changed 8th February 2018


CURL.SetOptionLowSpeedTime - CURL.SetOptionMailFrom