Platforms to show: All Mac Windows Linux Cross-Platform

Back to CURLMBS class.

Previous items Next items

CURLMBS.OptionCustomRequest as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
It will be user instead of GET or HEAD when doing an HTTP request, or instead of LIST or NLST when doing an ftp directory listing.
Example
Var c as CURLMBS // your CURL instance

c.URL = "ftp://..."
c.customRequest = "MLSD" // ftp advanced directory listing

This is useful for doing DELETE or other more or less obscure HTTP requests. Don't do this at will, make sure your server supports the command first.

Restore to the internal default by setting this to "".

Many people have wrongly used this option to replace the entire request with their own, including multiple headers and POST contents. While that might work in many cases, it will cause libCURL to send invalid requests and it could possibly confuse the remote server badly. Use CURLOPT_POST and OptionPostFields to set POST data. Use OptionHTTPHeader to replace or extend the set of headers sent by libCURL. Use OptionHTTPVersion to change HTTP version.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.

For WebDAV, you can set this to "MKCOL" to create a folder at the given URL.
(Read and Write property)

See also CUSTOMREQUEST option in CURL manual.

CURLMBS.OptionDefaultProtocol as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set the protocol used when curl is given a URL without a protocol.

(Read and Write property)

See also DEFAULT_PROTOCOL option in CURL manual.

CURLMBS.OptionDirListOnly as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 15.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
For FTP and SFTP based URLs a parameter set to true tells the library to list the names of files in a directory, rather than performing a full directory listing that would normally include file sizes, dates etc.

For POP3 a parameter of true tells the library to list the email message or messages on the POP3 server. This can be used to change the default behaviour of libCURL, when combined with a URL that contains a message ID, to perform a "scan listing" which can then be used to determine the size of an email.

Note: For FTP this causes a NLST command to be sent to the FTP server. Beware that some FTP servers list only files in their response to NLST; they might not include subdirectories and symbolic links.

Setting this option to true also implies a directory listing even if the URL doesn't end with a slash, which otherwise is necessary.

Do NOT use this option if you also use OptionWildCardMatch as it will effectively break that feature then.
(Read and Write property)

See also DIRLISTONLY option in CURL manual.

CURLMBS.OptionDisableUserNameInURL as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.3 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Disallow specifying username/login in URL.

The value true tells the library to not allow URLs that include an username.
(Read and Write property)

CURLMBS.OptionDNSCacheTimeout as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The timeout in seconds.

Name resolves will be kept in memory for this number of seconds. Set to zero (0) to completely disable caching, or set to -1 to make the cached entries remain forever. By default, libCURL caches this info for 60 seconds.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

See also DNS_CACHE_TIMEOUT option in CURL manual.

CURLMBS.OptionDNSInterface as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 15.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set the name of the network interface that the DNS resolver should bind to.

This must be an interface name (not an address). Set this option to "" to use the default setting (don't bind to a specific interface).
(Read and Write property)

See also DNS_INTERFACE option in CURL manual.

CURLMBS.OptionDNSLocalIPv4 as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 15.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set the local IPv4 address that the resolver should bind to.

The argument should be of string and contain a single numerical IPv4 address as a string.
Set this option to "" to use the default setting (don't bind to a specific IP address).
(Read and Write property)

See also DNS_LOCAL_IP4 option in CURL manual.

CURLMBS.OptionDNSLocalIPv6 as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 15.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set the local IPv6 address that the resolver should bind to.

The argument should be of type string and contain a single IPv6 address as a string.
Set this option to "" to use the default setting (don't bind to a specific IP address).
(Read and Write property)

See also DNS_LOCAL_IP6 option in CURL manual.

CURLMBS.OptionDNSServers as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set the name servers to use for DNS resolution.

(Read and Write property)

See also DNS_SERVERS option in CURL manual.

CURLMBS.OptionDNSShuffleAddresses as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Whether to shuffle DNS addresses.

When a name is resolved and more than one IP address is returned, shuffle the order of all returned addresses so that they will be used in a random order. This is similar to the ordering behavior of gethostbyname which is no longer used on most platforms.

Addresses will not be reshuffled if a name resolution is completed using the DNS cache. DNSCacheTimeout property can be used together with this option to reduce DNS cache timeout or disable caching entirely if frequent reshuffling is needed.

Since the addresses returned will be reordered randomly, their order will not be in accordance with RFC 3484 or any other deterministic order that may be generated by the system's name resolution implementation. This may have performance impacts and may cause IPv4 to be used before IPv6 or vice versa.
Default is false.
(Read and Write property)

See also DNS_SHUFFLE_ADDRESSES option in CURL manual.

CURLMBS.OptionDOHSSLVerifyHost as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Whether to verify the host name in the DOH (DNS-over-HTTPS) SSL certificate.

Pass a 2 as asking curl to verify the DOH (DNS-over-HTTPS) server's certificate name fields against the host name.
This option is the DOH equivalent of OptionSSLVerifyPeer and only affects requests to the DOH server.
When OptionDOHSSLVerifyHost is 2, the SSL certificate provided by the DOH server must indicate that the server name is the same as the server name to which you meant to connect to, or the connection fails.
Curl considers the DOH server the intended one when the Common Name field or a Subject Alternate Name field in the certificate matches the host name in the DOH URL to which you told Curl to connect.
When the verify value is set to 1 it is treated the same as 2. However for consistency with the other VerifyHost options we suggest use 2 and not 1.
When the verify value is set to 0, the connection succeeds regardless of the names used in the certificate. Use that ability with caution!
(Read and Write property)

See also DOH_SSL_VERIFYHOST option in CURL manual.

CURLMBS.OptionDOHSSLVerifyPeer as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Whether to verify the DOH SSL certificate.

Pass 1 to enable or 0 to disable.
This option tells curl to verify the authenticity of the DOH (DNS-over-HTTPS) server's certificate. A value of 1 means curl verifies; 0 (zero) means it doesn't.
This option is the DOH equivalent of CURL.SetOptionSSLVerifyPeer and only affects requests to the DOH server.
When negotiating a TLS or SSL connection, the server sends a certificate indicating its identity. Curl verifies whether the certificate is authentic, i.e. that you can trust that the server is who the certificate says it is. This trust is based on a chain of digital signatures, rooted in certification authority (CA) certificates you supply. curl uses a default bundle of CA certificates (the path for that is determined at build time) and you can specify alternate certificates with the CURL.SetOptionCAInfo option or the CURL.SetOptionCAPath option.
When CURL.SetOptionDOHSSLVerifyPeer is enabled, and the verification fails to prove that the certificate is authentic, the connection fails. When the option is zero, the peer certificate verification succeeds regardless.
Authenticating the certificate is not enough to be sure about the server. You typically also want to ensure that the server is the server you mean to be talking to. Use CURL.SetOptionDOHSSLVerifyHost for that. The check that the host name in the certificate is valid for the host name you're connecting to is done independently of the CURL.SetOptionDOHSSLVerifyPeer option.

WARNING: disabling verification of the certificate allows bad guys to man-in-the-middle the communication without you knowing it. Disabling verification makes the communication insecure. Just having encryption on a transfer is not enough as you cannot be sure that you are communicating with the correct end-point.
(Read and Write property)

See also DOH_SSL_VERIFYPEER option in CURL manual.

CURLMBS.OptionDOHSSLVerifyStatus as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Whether to verify the DOH SSL certificate's status.

Pass 2 to ask curl to verify the DOH (DNS-over-HTTPS) server's certificate name fields against the host name.
This option is the DOH equivalent of OptionSSLVerifyHost and only affects requests to the DOH server.
When OptionDOHSSLVerifyHost is 2, the SSL certificate provided by the DOH server must indicate that the server name is the same as the server name to which you meant to connect to, or the connection fails.
Curl considers the DOH server the intended one when the Common Name field or a Subject Alternate Name field in the certificate matches the host name in the DOH URL to which you told Curl to connect.
When the verify value is set to 1L it is treated the same as 2L. However for consistency with the other VerifyHost options we suggest use 2 and not 1.
When the verify value is set to 0L, the connection succeeds regardless of the names used in the certificate. Use that ability with caution!

See also OptionDOHSSLVerifyPeer to verify the digital signature of the DOH server certificate. If libcurl is built against NSS and OptionDOHSSLVerifyPeer is zero, OptionDOHSSLVerifyHost is also set to zero and cannot be overridden.
(Read and Write property)

See also DOH_SSL_VERIFYSTATUS option in CURL manual.

CURLMBS.OptionDOHURL as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.5 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Provides the DNS-over-HTTPS URL.

Pass in a string to a URL for the DOH server to use for name resolving. The parameter should be URL-encoded in the following format: "https://host:port/path". It MUST specify a HTTPS URL.

libcurl doesn't validate the syntax or use this variable until the transfer is issued. Even if you set a crazy value here, OptionDOHURL will still return CURLE_OK.

curl sends POST requests to the given DNS-over-HTTPS URL.

To find the DOH server itself, which might be specified using a name, libcurl will use the default name lookup function. You can bootstrap that by providing the address for the DOH server with OptionResolve.

Disable DOH use again by setting this option to "".
(Read and Write property)

See also DOH_URL option in CURL manual.

CURLMBS.OptionEGDSocket as String   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
This item is deprecated and should no longer be used.
The path name to the Entropy Gathering Daemon socket.

It will be used to seed the random engine for SSL.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

CURLMBS.OptionExpect100TimeoutMS as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Sets Expect 100 timeout.

Time to wait in milliseconds for a response to a HTTP request containing an Expect: 100-continue header before sending the data anyway.
(Read and Write property)

See also EXPECT_100_TIMEOUT_MS option in CURL manual.

CURLMBS.OptionFailOnError as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
True tells the library to fail silently if the HTTP code returned is equal to or larger than 400. The default action would be to return the page normally, ignoring that code.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.

This method is not fail-safe and there are occasions where non-succesful response codes will slip through, especially when authentication is involved (response codes 401 and 407).

You might get some amounts of headers transferred before this situation is detected, like for when a "100-continue" is received as a response to a POST/PUT and a 401 or 407 is received immediately afterwards.
(Read and Write property)

See also FAILONERROR option in CURL manual.

CURLMBS.OptionFileTime as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Whether filetime should be querried.
Example
// init CURL with options
Var d as new CURLMBS
d.OptionFileTime = true
d.OptionURL = "http://www.monkeybreadsoftware.de/images/mbs.jpg"

// run query
Var e as Integer = d.Perform

// calculate date object
Var da as new date(1970,1,1,0,0,0)
da.TotalSeconds = da.TotalSeconds + d.GetInfoFileTime

// show date
ResultText.text=str(d.GetInfoFileTime)+" "+da.ShortDate+" "+da.ShortTime

If it is true, libCURL will attempt to get the modification date of the remote document in this operation. This requires that the remote server sends the time or replies to a time querying command.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

See also FILETIME option in CURL manual.

CURLMBS.OptionFollowLocation as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
A boolean parameter tells the library to follow any Location: header that the server sends as part of an HTTP header.
Example
Var c as new CURLMBS

c.OptionFollowLocation = true
c.OptionMaxRedirs = 3

This means that the library will re-send the same request on the new location and follow new Location: headers all the way until no more such headers are returned. OptionMaxRedirs can be used to limit the number of redirects libCURL will follow.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

See also FOLLOWLOCATION option in CURL manual.

CURLMBS.OptionForbidReuse as Boolean   New in 24.2

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 24.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set to true to make the next transfer explicitly close the connection when done.

Normally, libCURL keep all connections alive when done with one transfer in case there comes a succeeding one that can re-use them. This option should be used with caution and only if you understand what it does. Set to false to have libCURL keep the connection open for possibly later re-use (default behavior).

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

See also FORBID_REUSE option in CURL manual.

CURLMBS.OptionForbitReuse as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set to true to make the next transfer explicitly close the connection when done.

Normally, libCURL keep all connections alive when done with one transfer in case there comes a succeeding one that can re-use them. This option should be used with caution and only if you understand what it does. Set to false to have libCURL keep the connection open for possibly later re-use (default behavior).

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

CURLMBS.OptionFreshConnect as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set to true to make the next transfer use a new (fresh) connection by force.
Example
Var c as new CURLMBS

c.OptionFreshConnect=True

If the connection cache is full before this connection, one of the existing connections will be closed as according to the selected or default policy. This option should be used with caution and only if you understand what it does. Set this to 0 to have libCURL attempt re-using an existing connection (default behavior).

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

See also FRESH_CONNECT option in CURL manual.

CURLMBS.OptionFTPAccount as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 15.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The FTP account name to use.

When an FTP server asks for "account data" after user name and password has been provided, this data is sent off using the ACCT command.
(Read and Write property)

See also FTP_ACCOUNT option in CURL manual.

CURLMBS.OptionFTPAlternativeToUser as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The alternative username.

Pass a string as parameter, pointing to a string which will be used to authenticate if the usual FTP "USER user" and "PASS password" negotiation fails. This is currently only known to be required when connecting to Tumbleweed's Secure Transport FTPS server using client certificates for authentication. (Added in 7.15.5)
(Read and Write property)

See also FTP_ALTERNATIVE_TO_USER option in CURL manual.

CURLMBS.OptionFTPAppend as Boolean   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
This item is deprecated and should no longer be used. You can use OptionAppend instead.
True tells the library to append to the remote file instead of overwrite it.

This is only useful when uploading to an ftp site.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

CURLMBS.OptionFTPCreateMissingDirs as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
If the value is 1, CURL will attempt to create any remote directory that it fails to CWD into.

CWD is the command that changes working directory. (Added in 7.10.7)

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
Newer CURL Library versions allow a value of 2 to do a CWD after the directory was created, so this property changed from boolean to integer.
(Read and Write property)

See also FTP_CREATE_MISSING_DIRS option in CURL manual.

CURLMBS.OptionFTPFileMethod as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Pass an integer that should have one of the following values.

This option controls what method libCURL should use to reach a file on a FTP(S) server. The argument should be one of the following alternatives:

URLFTPMETHOD_MULTICWD = 1

libCURL does a single CWD operation for each path part in the given URL. For deep hierarchies this means very many commands. This is how RFC1738 says it should be done. This is the default but the slowest behavior.

CURLFTPMETHOD_NOCWD = 2

libCURL does no CWD at all. libCURL will do SIZE, RETR, STOR etc and give a full path to the server for all these commands. This is the fastest behavior.

CURLFTPMETHOD_SINGLECWD = 3

libCURL does one CWD with the full target directory and then operates on the file "normally" (like in the multicwd case). This is somewhat more standards compliant than 'nocwd' but without the full penalty of 'multicwd'.
(Read and Write property)

See also FTP_FILEMETHOD option in CURL manual.

CURLMBS.OptionFTPListOnly as Boolean   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
This item is deprecated and should no longer be used. You can use OptionDirListOnly instead.
True tells the library to just list the names of an ftp directory, instead of doing a full directory listing that would include file sizes, dates etc.

This causes an FTP NLST command to be sent. Beware that some FTP servers list only files in their response to NLST; they might not include subdirectories and symbolic links.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

CURLMBS.OptionFTPPort as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The port to use for ftp.

It will be used to get the IP address to use for the ftp PORT instruction. The PORT instruction tells the remote server to connect to our specified IP address. The string may be a plain IP address, a host name, an network interface name (under Unix) or just a '-' letter to let the library use your systems default IP address. Default FTP operations are passive, and thus won't use PORT.

You disable PORT again and go back to using the passive version by setting this option to "".

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

See also FTPPORT option in CURL manual.

CURLMBS.OptionFTPResponseTimeout as Integer   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
This item is deprecated and should no longer be used. You can use OptionServerResponseTimeout instead.
Causes CURL to set a timeout period (in seconds) on the amount of time that the server is allowed to take in order to generate a response message for a command before the session is considered hung.

With v22.4 or newer, please use newer property name OptionServerResponseTimeout.

While CURL is waiting for a response, this value overrides OptionTimeout. It is recommended that if used in conjunction with OptionTimeout, you set OptionFTPResponseTimeout to a value smaller than OptionTimeout. (Added in 7.10.8)

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

CURLMBS.OptionFTPSkipPasvIP as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
If set to a non-zero value, it instructs libCURL to not use the IP address the server suggests in its 227-response to libCURL's PASV command when libCURL connects the data connection.

Instead libCURL will re-use the same IP address it already uses for the control connection. But it will use the port number from the 227-response. (Added in 7.14.2)

This option has no effect if PORT, EPRT or EPSV is used instead of PASV.
(Read and Write property)

See also FTP_SKIP_PASV_IP option in CURL manual.

CURLMBS.OptionFTPSSL as Integer   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
This item is deprecated and should no longer be used. You can use OptionUseSSL instead.
Request using SSL / TLS for the transfer.
Example
Var c as CURLMBS
c.OptionUseSSL = c.kFTPSSL_ALL
c.OptionSSLVersion = c.kSSLVersionTLSv12

Set to an integer using one of the values from below, to make libCURL use your desired level of SSL for the transfer.
These are all protocols that start out plain text and get "upgraded" to SSL using the STARTTLS command.
This is for enabling SSL/TLS when you use FTP, SMTP, POP3, IMAP etc.

CURLUSESSL_NONE0Don't attempt to use SSL.
CURLUSESSL_TRY1Try using SSL, proceed as normal otherwise.
CURLUSESSL_CONTROL2Require SSL for the control connection or fail with CURLE_USE_SSL_FAILED.
CURLUSESSL_ALL3Require SSL for all communication or fail with CURLE_USE_SSL_FAILED.
(Read and Write property)

CURLMBS.OptionFTPSSLAuth as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
What kind of SSL authentication to use for FTP.

Pass an integer using one of the values from below, to alter how libCURL issues "AUTH TLS" or "AUTH SSL" when FTP over SSL is activated (see CURLOPT_FTP_SSL). (Added in 7.12.2)

kFTPAUTH_DEFAULT = 0

Allow libCURL to decide

kFTPAUTH_SSL = 1

Try "AUTH SSL" first, and only if that fails try "AUTH TLS"

kFTPAUTH_TLS = 2

Try "AUTH TLS" first, and only if that fails try "AUTH SSL"

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

See also FTPSSLAUTH option in CURL manual.

CURLMBS.OptionFTPSSLCCC as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
If enabled, this option makes libCURL use CCC (Clear Command Channel).

It shuts down the SSL/TLS layer after authenticating. The rest of the control channel communication will be unencrypted. This allows NAT routers to follow the FTP transaction. Pass a long using one of the values below. (Added in 7.16.1)

CURLFTPSSL_CCC_NONE0Don't attempt to use CCC.
CURLFTPSSL_CCC_PASSIVE1Do not initiate the shutdown, but wait for the server to do it. Do not send a reply.
CURLFTPSSL_CCC_ACTIVE2Initiate the shutdown and wait for a reply.
(Read and Write property)

See also FTP_SSL_CCC option in CURL manual.

CURLMBS.OptionFTPUseEPRT as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
If the value is true, it tells CURL to use the EPRT (and LPRT) command when doing active FTP downloads (which is enabled by CURLOPT_FTPPORT).

Using EPRT means that it will first attempt to use EPRT and then LPRT before using PORT, but if you pass FALSE (zero) to this option, it will not try using EPRT or LPRT, only plain PORT. (Added in 7.10.5)

If the server is an IPv6 host, this option will have no effect as of 7.12.3.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

See also FTP_USE_EPRT option in CURL manual.

CURLMBS.OptionFTPUseEPSV as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
If the value is true, it tells CURL to use the EPSV command when doing passive FTP downloads (which it always does by default).

Using EPSV means that it will first attempt to use EPSV before using PASV, but if you pass FALSE (zero) to this option, it will not try using EPSV, only plain PASV.

If the server is an IPv6 host, this option will have no effect as of 7.12.3.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

See also FTP_USE_EPSV option in CURL manual.

CURLMBS.OptionFTPusePret as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 11.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
If the value is true, it tells CURL to send a PRET command before PASV (and EPSV). Certain FTP servers, mainly drftpd, require this non-standard command for directory listings as well as up and downloads in PASV mode.

Has no effect when using the active FTP transfers mode. (Added in 7.20.0)
(Read and Write property)

See also FTP_USE_PRET option in CURL manual.

CURLMBS.OptionGet as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
If the true, this forces the HTTP request to get back to GET.

usable if a POST, HEAD, PUT or a custom request have been used previously using the same CURL handle.

When setting OptionGet to a true value, it will automatically set OptionNoBody to true (since 7.14.1).

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

CURLMBS.OptionGSSAPIDelegation as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Allow GSSAPI credential delegation.

(Read and Write property)

See also GSSAPI_DELEGATION option in CURL manual.

CURLMBS.OptionHappyEyeballsTimeOutMS as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The happy eyeballs timeout.

Head start in milliseconds to give happy eyeballs.
(Read and Write property)

See also HAPPY_EYEBALLS_TIMEOUT_MS option in CURL manual.

CURLMBS.OptionHAProxyProtocol as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Whether to send an HAProxy PROXY protocol header.

Set to true to tell the library to send an HAProxy PROXY protocol header at beginning of the connection. The default action is not to send this header.
This option is primarily useful when sending test requests to a service that expects this header.
Most applications do not need this option.
Default false, do not send HAProxy PROXY protocol header.
(Read and Write property)

See also HAPROXYPROTOCOL option in CURL manual.

CURLMBS.OptionHeader as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
True tells the library to include the header in the body output.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.

This is only relevant for protocols that actually have headers preceding the data (like HTTP).
(Read and Write property)

See also HEADER option in CURL manual.

Previous items Next items

The items on this page are in the following plugins: MBS CURL Plugin.


The biggest plugin in space...