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

CURL.SetOptionLoginOptions

Sets login options string to use for the transfer.

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

Parameters

Parameter Description Example Flags
curl The CURL session handle. $curl
Value The options string. ""
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 or error.

Description

Sets login options string to use for the transfer.
For more information about the login options please see RFC 2384, RFC5092 and IETF draft draft-earhart-url-smtp-00.txt

OptionLoginOptions can be used to set protocol specific login options, such as the preferred authentication mechanism via "AUTH=NTLM" or "AUTH=*", and should be used in conjunction with the CURL.SetOptionUserName option.
Only IMAP, POP3 and SMTP support login options.

See also LOGIN_OPTIONS option in CURL manual.

Examples

Use plain authentication:

Set Variable [$r; Value: MBS("CURL.SetOptionLoginOptions"; $curl; "AUTH=PLAIN")]

Use CRAM MD5 authentication:

Set Variable [$r; Value: MBS("CURL.SetOptionLoginOptions"; $curl; "AUTH=CRAM-MD5")]

Use LOGIN with username and password:

Set Variable [$r; Value: MBS("CURL.SetOptionLoginOptions"; $curl; "AUTH=LOGIN")]

Use NTLM authentication:

Set Variable [$r; Value: MBS("CURL.SetOptionLoginOptions"; $curl; "AUTH=NTLM")]

See also

Blog Entries

Created 22nd November 2015, last changed 11st March 2024


CURL.SetOptionLocalPortRange - CURL.SetOptionLowSpeedLimit