Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

CURLMBS.OptionKRB4Level 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
Function: Set the krb4 security level, this also enables krb4 awareness.
This item is deprecated and should no longer be used. You can use OptionKRBLevel instead.
Notes:
This is a string, 'clear', 'safe', 'confidential' or 'private'. If the string is set but doesn't match one of these, 'private' will be used. Set the string to "" to disable kerberos4. The kerberos support only works for FTP.

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)

Feedback, Comments & Corrections

CURLMBS.OptionKRBLevel 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
Function: FTP kerberos security level.
Notes:
Set the kerberos security level for FTP; this also enables kerberos awareness. This is a string that should match one of the following: 'clear', 'safe', 'confidential' or 'private'. If the string is set but doesn't match one of these, 'private' will be used. Set the string to NULL to disable kerberos support for FTP.
(Read and Write property)

See also KRBLEVEL option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionLocalPort 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
Function: This sets the local port number of the socket used for connection.
Notes:
This can be used in combination with OptionInterface and you are recommended to use OptionLocalPortRange as well when this is set. Note that port numbers are only valid 1 - 65535. (Added in 7.15.2)
(Read and Write property)

See also LOCALPORT option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionLocalPortRange 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
Function: This is the number of attempts libCURL should do to find a working local port number.
Notes:
It starts with the given OptionLocalPort and adds one to the number for each retry. Setting this value to 1 or below will make libCURL do only one try for exact port number. Note that port numbers by nature is a scarce resource that will be busy at times so setting this value to something too low might cause unnecessary connection setup failures. (Added in 7.15.2)
(Read and Write property)

See also LOCALPORTRANGE option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionLoginOptions as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 15.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: Login options string to use for the transfer.
Notes:
For more information about the login options please see RFC 2384, RFC5092 and IETF draft draft-earhart-url-smtp-00.txt

CURLOPT_LOGIN_OPTIONS 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 OptionUserName option.
Only IMAP, POP3 and SMTP support login options.
(Read and Write property)

See also LOGIN_OPTIONS option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionLowSpeedLimit 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
Function: This property contains the transfer speed in bytes per second that the transfer should be below during OptionLowSpeedTime seconds for the library to consider it too slow and abort.
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.
(Read and Write property)

See also LOW_SPEED_LIMIT option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionLowSpeedTime 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
Function: This property contains the time in seconds that the transfer should be below the OptionLowSpeedLimit for the library to consider it too slow and abort.
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.
(Read and Write property)

See also LOW_SPEED_TIME option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionMailAuth as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: This string will be used to specify the authentication address (identity) of a submitted message that is being relayed to another server.
Notes:
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 OptionMailFrom and 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.
(Read and Write property)

See also MAIL_AUTH option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionMailFrom as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 11.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: A string that will be used to specify the sender address in a mail when sending an SMTP mail with libCURL.
Notes: (Read and Write property)

See also MAIL_FROM option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionMaxAgeConn as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 19.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: The maximum age the connection should have in seconds.
Notes:
Older connections are not reused, but discarded.
(Read and Write property)

See also MAXAGE_CONN option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionMaxConnects 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
Function: The set number will be the persistent connection cache size.
Notes:
The set amount will be the maximum amount of simultaneously open connections that libCURL may cache. Default is 5, and there isn't much point in changing this value unless you are perfectly aware of how this work and changes libCURL's behaviour. This concerns connection using any of the protocols that support persistent connections.

When reaching the maximum limit, CURL closes the oldest one in the cache to prevent the number of open connections to increase.

If you already have performed transfers with this CURL handle, setting a smaller MAXCONNECTS than before may cause open connections to get closed unnecessarily.

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

Feedback, Comments & Corrections

CURLMBS.OptionMaxFileSize as Int64
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: This allows you to specify the maximum size (in bytes) of a file to download.
Notes:
If the file requested is larger than this value, the transfer will not start and kError_FILESIZE_EXCEEDED will be returned.

The file size is not always known prior to download, and for such files this option has no effect even if the file transfer ends up being larger than this given limit. This concerns both FTP and HTTP transfers.

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

Feedback, Comments & Corrections

CURLMBS.OptionMaxFileSizeLarge as Int64
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: This allows you to specify the maximum size (in bytes) of a file to download.
This item is deprecated and should no longer be used. You can use OptionMaxFileSize instead.
Notes:
If the file requested is larger than this value, the transfer will not start and kError_FILESIZE_EXCEEDED will be returned. (Added in 7.11.0)

The file size is not always known prior to download, and for such files this option has no effect even if the file transfer ends up being larger than this given limit. This concerns both FTP and HTTP transfers.

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)

Feedback, Comments & Corrections

CURLMBS.OptionMaxRecvSpeed as Int64
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 15.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: Defines the maximum download speed.
Notes:
If a download exceeds this speed (counted in bytes per second) on cumulative average during the transfer, the transfer will pause to keep the average rate less than or equal to the parameter value. Defaults to unlimited speed. (Added in 7.15.5)
(Read and Write property)

See also MAX_RECV_SPEED option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionMaxRecvSpeedLarge as Int64
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: Defines the maximum download speed.
This item is deprecated and should no longer be used. You can use OptionMaxRecvSpeed instead.
Notes:
If a download exceeds this speed (counted in bytes per second) on cumulative average during the transfer, the transfer will pause to keep the average rate less than or equal to the parameter value. Defaults to unlimited speed. (Added in 7.15.5)
(Read and Write property)

Feedback, Comments & Corrections

CURLMBS.OptionMaxRedirs 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
Function: The set number will be the redirection limit.
Example:
dim c as new CURLMBS

c.OptionFollowLocation = true
c.OptionMaxRedirs = 3
Notes:
If that many redirections have been followed, the next redirect will cause an error (kError_TOO_MANY_REDIRECTS). This option only makes sense if the CURLOPT_FOLLOWLOCATION is used at the same time. Added in 7.15.1: Setting the limit to 0 will make libCURL refuse any redirect. Set it to -1 for an infinite number of redirects (which is the default)

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

Feedback, Comments & Corrections

CURLMBS.OptionMaxSendSpeed as Int64
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 15.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: Defines the maximum upload speed.
Notes:
If an upload exceeds this speed on cumulative average during the transfer, the transfer will pause to keep the average rate less than or equal to the parameter value. Defaults to unlimited speed. (Added in 7.15.5)
Value is in bytes per second.
Useful if you have a limited pipe and you'd like your transfer not to use your entire bandwidth.
Slowing down the transfer speed is also useful for lowering CPU consumption during transfers.
(Read and Write property)

See also MAX_SEND_SPEED option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionMaxSendSpeedLarge as Int64
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: Defines the maximum upload speed.
This item is deprecated and should no longer be used. You can use OptionMaxSendSpeed instead.
Notes:
If an upload exceeds this speed on cumulative average during the transfer, the transfer will pause to keep the average rate less than or equal to the parameter value. Defaults to unlimited speed. (Added in 7.15.5)
Value is in bytes per second.
Useful if you have a limited pipe and you'd like your transfer not to use your entire bandwidth.
Slowing down the transfer speed is also useful for lowering CPU consumption during transfers.
(Read and Write property)

Feedback, Comments & Corrections

CURLMBS.OptionNetRC 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
Function: Controls usage of netrc file.
Notes:
This parameter controls the preference of libCURL between using user names and passwords from your ~/.netrc file, relative to user names and passwords in the URL supplied with OptionURL.

libCURL uses a user name (and supplied or prompted password) supplied with OptionUsername and OptionPassword in preference to any of the options controlled by this parameter.

An integer, set to one of the values described below.

kNETRC_OPTIONAL = 1

The use of your ~/.netrc file is optional, and information in the URL is to be preferred. The file will be scanned with the host and user name (to find the password only) or with the host only, to find the first user name and password after that machine, which ever information is not specified in the URL.

Undefined values of the option will have this effect.

kNETRC_IGNORED = 0

The library will ignore the file and use only the information in the URL.

This is the default.

kNETRC_REQUIRED = 2

This value tells the library that use of the file is required, to ignore the information in the URL, and to search the file with the host only.

Only machine name, user name and password are taken into account (init macros and similar things aren't supported).

libCURL does not verify that the file has the correct properties set (as the standard Unix ftp client does). It should only be readable by user.

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

Feedback, Comments & Corrections

CURLMBS.OptionNetRCFile 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
Function: A string containing the full path name to the file you want libCURL to use as .netrc file.
Notes:
If this option is omitted, and OptionNETRC is set, libCURL will attempt to find the a .netrc file in the current user's home directory. (Added in 7.10.9)

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.

Starting with version 18.0 the plugin will always use UTF-8 encoding for file path on Linux and macOS. For macOS we also do the unicode character normalization for file names for you.
(Read and Write property)

See also NETRC_FILE option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionNewDirectoryPerms as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 10.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: An integer, containing the value of the permissions that will be assigned to newly created directories on the remote server.
Notes:
The default value is 0755, but any valid value can be used. The only protocols that can use this are sftp://, scp://, and file://. (Added in 7.16.4)
Value must be octal, so use &o prefix for number.
(Read and Write property)

See also NEW_DIRECTORY_PERMS option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionNewFilePerms as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 10.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: An integer, containing the value of the permissions that will be assigned to newly created files on the remote server.
Notes:
The default value is &o0644, but any valid value can be used. The only protocols that can use this are sftp://, scp://, and file://. (Added in 7.16.4)
Be aware that you normally specify this in octal values. So use the &o prefix in Xojo.
(Read and Write property)

See also NEW_FILE_PERMS option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionNoBody 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
Function: True tells the library to not include the body-part in the output.
Notes:
This is only relevant for protocols that have separate header and body parts. On HTTP(S) servers, this will make libCURL do a HEAD request.

To change request to GET, you should use OptionGet. Change request to POST with OptionPost etc.

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

Feedback, Comments & Corrections

CURLMBS.OptionNoProxy as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 10.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: A string with a comma- separated list of hosts which do not use a proxy, if one is specified.
Notes:
The only wildcard is a single * character, which matches all hosts, and effectively disables the proxy. Each name in this list is matched as either a domain which contains the hostname, or the hostname itself. For example, local.com would match local.com, local.com:80, and www.local.com, but not www.notlocal.com. (Added in 7.19.4)
(Read and Write property)

See also NOPROXY option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionNoSignal as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 13.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: Whether to not use signals.
Notes:
If it is true, libCURL will not use any functions that install signal handlers or any functions that cause signals to be sent to the process. This option is mainly here to allow multi-threaded unix applications to still set/use all timeout options etc, without risking getting signals. (Added in 7.10)

If this option is set and libCURL has been built with the standard name resolver, timeouts will not occur while the name resolve takes place. Consider building libCURL with c-ares support to enable asynchronous DNS lookups, which enables nice timeouts for name resolves without signals.

Setting OptionNoSignal to true makes libCURL NOT ask the system to ignore SIGPIPE signals, which otherwise are sent by the system when trying to send data to a socket which is closed in the other end. libCURL makes an effort to never cause such SIGPIPEs to trigger, but some operating systems have no way to avoid them and even on those that have there are some corner cases when they may still happen, contrary to our desire. In addition, using CURLAUTH_NTLM_WB authentication could cause a SIGCHLD signal to be raised.
(Read and Write property)

See also NOSIGNAL option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionPassword as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 10.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: The password to use for the transfer.
Notes:
The OptionPassword option should be used in conjunction with the OptionUsername option.
(Read and Write property)

See also PASSWORD option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionPathAsIs 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
Function: Pass path as it is and do not resolve dots.
Notes:
Do not squash dot-dot sequences.
(Read and Write property)

See also PATH_AS_IS option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionPinnedPublicKey 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
Function: The public key in DER form used to validate the peer public key.
Notes:
Native path to key file.
This option is used only if SSLVerifyPeer is true.
(Read and Write property)

See also PINNEDPUBLICKEY option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionPipeWait 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
Function: Wait/don't wait for pipe/mutex to clarify.
Notes: (Read and Write property)

See also PIPEWAIT option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionPort 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
Function: The remote port number to connect to, instead of the one specified in the URL or the default port for the used protocol.
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.
(Read and Write property)

See also PORT 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