Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

CURLSMBS.OptionPost as Boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: A boolean parameter tells the library to do a regular HTTP post.
Notes:
This will also make the library use the a "Content-Type: application/x-www-form-urlencoded" header. (This is by far the most commonly used POST method).

Use the OptionPostFields option to specify what data to post.

Optionally, you can provide data to POST using the Read event but then you must make sure to not set OptionPostFields to anything but "". When providing data with an event, you must transmit it using chunked transfer-encoding.

You can override the default POST Content-Type: header by setting your own with OptionHTTPHeader.

Using POST with HTTP 1.1 implies the use of a "Expect: 100-continue" header. You can disable this header with OptionHTTPHeader as usual.

If you use POST to a HTTP 1.1 server, you can send data without knowing the size before starting the POST if you use chunked encoding. You enable this by adding a header like "Transfer-Encoding: chunked" with OptionHTTPHeader. With HTTP 1.0 or without chunked transfer, you must specify the size in the request.

When setting CURLOPT_POST to a non-zero value, it will automatically set OptionNoBody to 0 (since 7.14.1).

If you issue a POST request and then want to make a HEAD or GET using the same re-used handle, you must explictly set the new request type using OptionNoBody or OptionGet or similar.

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 POST option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionPostFields as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: A string which should be the full data to post in an HTTP POST operation.
Example:
dim xml as string // XML or JSON to send as payload
dim c as new CURLSMBS

c.OptionFollowLocation = true
c.OptionMaxRedirs = 3
c.OptionPostFields = xml
c.OptionUserAgent = "Test App"
c.OptionPost = true

// for SOAP use right content type
c.SetOptionHTTPHeader array("Content-Type: application/soap+xml; charset=utf-8")
Notes:
You must make sure that the data is formatted the way you want the server to receive it. libCURL will not convert or encode it for you. Most web servers will assume this data to be url-encoded. Take note.

This POST is a normal application/x-www-form-urlencoded kind (and libCURL will set that Content-Type by default when this option is used), which is the most commonly used one by HTML forms. See also the OptionPost. Using OptionPostFields implies OptionPost.

Using POST with HTTP 1.1 implies the use of a "Expect: 100-continue" header. You can disable this header with CURLOPT_HTTPHEADER as usual.

To make multipart/formdata posts (aka rfc1867-posts), check out the OptionPost option.

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 COPYPOSTFIELDS option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionPostFieldSize as Int64
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: The size of the post data.
Notes:
Optional you can set the size of your post data.
If you specify a postfield string, this size will be set automatically.

If you specify a size and no postfield string, the Read event will request data.
(Read and Write property)

See also POSTFIELDSIZE option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionPostFieldSizeLarge as Int64
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: The size of the post data. (64 bit version)
This item is deprecated and should no longer be used. You can use OptionPostFieldSize instead.
Notes:
Optional you can set the size of your post data.
If you specify a postfield string, this size will be set automatically.

If you specify a size and no postfield string, the Read event will request data.
(Read and Write property)

Feedback, Comments & Corrections

CURLSMBS.OptionPostRedir as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 10.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: A bitmask to control how libCURL acts on redirects after POSTs that get a 301 or 302 response back.
Notes:
A parameter with bit 0 set (value CURL_REDIR_POST_301=1) tells the library to respect RFC 2616/10.3.2 and not convert POST requests into GET requests when following a 301 redirection. Setting bit 1 (value CURL_REDIR_POST_302=2) makes libCURL maintain the request method after a 302 redirect. CURL_REDIR_POST_ALL is a convenience define that sets both bits.

The non-RFC behaviour is ubiquitous in web browsers, so the library does the conversion by default to maintain consistency. However, a server may require a POST to remain a POST after such a redirection. This option is meaningful only when setting OptionFollowLocation. (Added in 7.17.1) (This option was known as CURLOPT_POST301 up to 7.19.0 as it only supported the 301 way before then)
(Read and Write property)

See also POSTREDIR option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionPreProxy as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Name of pre proxy to use.
Notes: (Read and Write property)

See also PRE_PROXY option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProtocols as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 10.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: A bitmask of kProtocol* constants.
Notes:
If used, this bitmask limits what protocols libCURL may use in the transfer. This allows you to have a libCURL built to support a wide range of protocols but still limit specific transfers to only be allowed to use a subset of them. By default libCURL will accept all protocols it supports. See also OptionRedirProtocols. (Added in 7.19.4)
(Read and Write property)

See also PROTOCOLS option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxy as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Set HTTP proxy to use.
Example:
dim c as CURLSMBS // your CURL object
dim psAddress as string // your proxy address
dim psPort as Integer // your proxy port

c.OptionProxy=psAddress
c.OptionProxyPort=psPort
c.OptionProxyType=c.kPROXY_HTTP
Notes:
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.

The parameter should be a string holding the host name or dotted IP address. To specify port number in this string, append :[port] to the end of the host name. The proxy string may be prefixed with [protocol]:// since any such prefix will be ignored. The proxy's port number may optionally be specified with the separate option ProxyHost.

When you tell the library to use an HTTP proxy, libCURL will transparently convert operations to HTTP even if you specify an FTP URL etc. This may have an impact on what other features of the library you can use, such as CURLOPT_QUOTE and similar FTP specifics that don't work unless you tunnel through the HTTP proxy. Such tunneling is activated with HTTPProxyTunnel.

libCURL respects the environment variables http_proxy, ftp_proxy, all_proxy etc, if any of those is set. The Proxy option does however override any possibly set environment variables.

Starting with 7.14.1, the proxy host string given in environment variables can be specified the exact same way as the proxy can be set with Proxy, include protocol prefix (http://) and embedded user + password.

You can use WinHTTPClientMBS class on Windows or CFProxyMBS on Mac to discover system proxy settings.
(Read and Write property)

See also PROXY option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxyAuth as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Which proxy authentication to use.
Notes:
Pass an integer as parameter, which is set to a bitmask, to tell libCURL what authentication method(s) you want it to use for your proxy authentication. If more than one bit is set, libCURL will first query the site to see what authentication methods it supports and then pick the best one you allow it to use. For some methods, this will induce an extra network round-trip. Set the actual name and password with the ProxyUserPassword option. The bitmask can be constructed by or'ing together the bits listed above for the HTTPAuth option. As of this writing, only Basic, Digest and NTLM work. (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.
(Read and Write property)

See also PROXYAUTH option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxyCAInfo as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: The CApath or CAfile used to validate the proxy certificate.
Example:
// if you use SSL, maybe put in a certificate or disable verification?

dim d as CURLSMBS
// your CURL object

// disable
d.OptionProxySSLVerifyHost = 0
d.OptionProxySSLVerifyPeer = 0

// or better provide root certificates:

Dim cacert As FolderItem = GetFolderItem("cacert.pem")
d.OptionProxyCAInfo = cacert.NativePath
d.OptionProxySSLVerifyHost = 2
d.OptionProxySSLVerifyPeer = 1
Notes:
Pass native file path.
This option is used only if CURLSMBS.OptionProxySSLVerifyPeer is true
(Read and Write property)

See also PROXY_CAINFO option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxyCAPath as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: The CApath directory used to validate the proxy certificate.
Notes:
Pass native file path.
This option is used only if CURLSMBS.OptionProxySSLVerifyPeer is true
(Read and Write property)

See also PROXY_CAPATH option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxyCRLFile as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: CRL file for proxy.
Notes:
Pass native file path.
(Read and Write property)

See also PROXY_CRLFILE option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxyIssuerCert as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 20.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Sets the proxy issuer SSL certificate filename.
Notes:
Pass a string naming a file holding a CA certificate in PEM format. If the option is set, an additional check against the peer certificate is performed to verify the issuer of the the HTTPS proxy is indeed the one associated with the certificate provided by the option. This additional check is useful in multi-level PKI where one needs to enforce that the peer certificate is from a specific branch of the tree.

This option makes sense only when used in combination with the OptionProxySSLVerifyPeer option. Otherwise, the result of the check is not considered as failure.

A specific error code (CURLE_SSL_ISSUER_ERROR) is defined with the option, which is returned if the setup of the SSL/TLS session has failed due to a mismatch with the issuer of peer certificate (OptionProxySSLVerifyPeer has to be set too for the check to fail).
(Read and Write property)

See also PROXY_ISSUERCERT option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxyIssuerCertBlob as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 20.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Set proxy issuer SSL certificate from memory blob.
Notes:
Pass data, which contains binary data of a CA certificate in PEM format. If the option is set, an additional check against the peer certificate is performed to verify the issuer of the the HTTPS proxy is indeed the one associated with the certificate provided by the option. This additional check is useful in multi-level PKI where one needs to enforce that the peer certificate is from a specific branch of the tree.

This option should be used in combination with the OptionProxySSLVerifyPeer option. Otherwise, the result of the check is not considered as failure.

A specific error code (CURLE_SSL_ISSUER_ERROR) is defined with the option, which is returned if the setup of the SSL/TLS session has failed due to a mismatch with the issuer of peer certificate (OptionProxySSLVerifyPeer has to be set too for the check to fail).

This option is an alternative to OptionProxyIssuerCert which instead expects a file name as input.
(Read and Write property)

See also PROXY_ISSUERCERT_BLOB option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxyKeyPassword as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Password for the SSL private key for proxy.
Notes: (Read and Write property)

See also PROXY_KEYPASSWD option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxyPassword as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 10.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: A string which should be pointing to the password to use for the transfer while connecting to Proxy.
Notes:
The OptionProxyPassword option should be used in conjunction with the OptionProxyUsername option. (Added in 7.19.1)
(Read and Write property)

See also PROXYPASSWORD option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxyPinnedPublicKey as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: The public key in DER form used to validate the proxy public key.
Notes:
This option is used only if CURLSMBS.OptionProxySSLVerifyPeer is true.
Please path native file path to key file.
(Read and Write property)

See also PROXY_PINNEDPUBLICKEY option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxyPort as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: The proxy port to connect to unless it is specified in the proxy string OptionProxy.
Notes:
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.

You can use OptionProxy with port, e.g. "12.34.56.78:8080" or pass port here and proxy without port.
For some users it seems like the option with OptionProxy including port works better.
(Read and Write property)

See also PROXYPORT option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxyServiceName as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Proxy Service Name.
Notes: (Read and Write property)

See also PROXY_SERVICE_NAME option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxySSLCert as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Name of the file keeping your private SSL-certificate for proxy.
Notes: (Read and Write property)

See also PROXY_SSLCERT option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxySSLCertBlob as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 20.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Sets private key for proxy cert from memory blob.
Notes:
Pass data, which contains the private key for connecting to the HTTPS proxy. Compatible with OpenSSL. The format (like "PEM") must be specified with CURL.SetOptionProxySSLKeyType.
(Read and Write property)

See also PROXY_SSLCERT_BLOB option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxySSLCertType as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Type of the file keeping your SSL-certificate for proxy.
Notes:
Value can be "DER", "PEM" or "ENG".
(Read and Write property)

See also PROXY_SSLCERTTYPE option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxySSLCipherList as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Specify which SSL ciphers to use for proxy.
Notes: (Read and Write property)

See also PROXY_SSL_CIPHER_LIST option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxySSLKey as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Name of the file keeping your private SSL-key for proxy.
Notes:
Pass native file path.
(Read and Write property)

See also PROXY_SSLKEY option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxySSLKeyBlob as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 20.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Set private key for proxy cert from memory blob.
Notes:
Pass data, which contains a private key for connecting to the HTTPS proxy. Compatible with OpenSSL. The format (like "PEM") must be specified with OptionProxySSLKeyType.

This option is an alternative to OptionProxySSLKey which instead expects a file name as input.
(Read and Write property)

See also PROXY_SSLKEY_BLOB option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxySSLKeyType as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Sets type of the file keeping your private SSL-key for proxy.
Notes:
Value is DER, PEM or ENG.
(Read and Write property)

See also PROXY_SSLKEYTYPE option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxySSLOptions as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Enable/disable specific SSL features with a bitmask for proxy.
Notes: (Read and Write property)

See also PROXY_SSL_OPTIONS option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxySSLVerifyHost as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Enable SSL Host verification.
Example:
// if you use SSL, maybe put in a certificate or disable verification?

dim d as CURLSMBS
// your CURL object

// disable
d.OptionProxySSLVerifyHost = 0
d.OptionProxySSLVerifyPeer = 0

// or better provide root certificates:

Dim cacert As FolderItem = GetFolderItem("cacert.pem")
d.OptionProxyCAInfo = cacert.NativePath
d.OptionProxySSLVerifyHost = 2
d.OptionProxySSLVerifyPeer = 1
Notes:
Set if we should verify the Common name from the proxy certificate in ssl handshake, set 1 to check existence, 2 to ensure that it matches the provided hostname.
(Read and Write property)

See also PROXY_SSL_VERIFYHOST option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxySSLVerifyPeer as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Set if we should verify the proxy in ssl handshake.
Example:
// if you use SSL, maybe put in a certificate or disable verification?

dim d as CURLSMBS
// your CURL object

// disable
d.OptionProxySSLVerifyHost = 0
d.OptionProxySSLVerifyPeer = 0

// or better provide root certificates:

Dim cacert As FolderItem = GetFolderItem("cacert.pem")
d.OptionProxyCAInfo = cacert.NativePath
d.OptionProxySSLVerifyHost = 2
d.OptionProxySSLVerifyPeer = 1
Notes:
set 1 to verify.
(Read and Write property)

See also PROXY_SSL_VERIFYPEER option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionProxySSLVersion as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: What version to specifically try to use for proxy.
Notes:
The SSL and TLS versions have typically developed from the most insecure version to be more and more secure in this order through history: SSL v2, SSLv3, TLS v1.0, TLS v1.1, TLS v1.2 and the most recent TLS v1.3.

Use one of the available defines for this purpose. The available options are:

Default0The default acceptable version range. The minimum acceptable version is by default TLS v1.0 since 7.39.0 (unless the TLS library has a stricter rule).
TLSv11TLS v1.0 or later
SSLv22SSL v2 (but not SSLv3)
SSLv33SSL v3 (but not SSLv2)
TLSv1.04TLS v1.0 or later (Added in 7.34.0)
TLSv1.15TLS v1.1 or later (Added in 7.34.0)
TLSv1.26TLS v1.2 or later (Added in 7.34.0)
TLSv1.37TLS v1.3 or later (Added in 7.52.0)

See also kSSLVersion* constants.

The maximum TLS version can be set by using one of the CURL_SSLVERSION_MAX_ macros below. It is also possible to OR one of the CURL_SSLVERSION_ macros with one of the CURL_SSLVERSION_MAX_ macros.

Default&h10000The flag defines the maximum supported TLS version by libcurl, or the default value from the SSL library is used. libcurl will use a sensible default maximum, which was TLS v1.2 up to before 7.61.0 and is TLS v1.3 since then - assuming the TLS library support it. (Added in 7.54.0)
Max TLSv1.0&h40000The flag defines maximum supported TLS version as TLS v1.0. (Added in 7.54.0)
Max TLSv1.1&h50000The flag defines maximum supported TLS version as TLS v1.1. (Added in 7.54.0)
Max TLSv1.2&h60000The flag defines maximum supported TLS version as TLS v1.2. (Added in 7.54.0)
Max TLSv1.3&h70000The flag defines maximum supported TLS version as TLS v1.3. (Added in 7.54.0)

Please note that MBS Plugin does not yet support TLS v1.3 now, but may in future.
(Read and Write property)

See also PROXY_SSLVERSION option in CURL manual.

Feedback, Comments & Corrections

Previous items Next items

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

The biggest plugin in space...




Links
MBS FileMaker Plugins

Start Chat