Xojo Conferences
MBSSep2018MunichDE
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

CURLNMBS.OptionMailAuth as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 12.4 Yes Yes Yes Yes No
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

CURLNMBS.OptionMailFrom as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 11.0 Yes Yes Yes Yes No
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

CURLNMBS.OptionMaxConnects as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
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

CURLNMBS.OptionMaxFileSize as Int64
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
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

CURLNMBS.OptionMaxFileSizeLarge as Int64
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
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

CURLNMBS.OptionMaxRecvSpeed as Int64
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 15.2 Yes Yes Yes Yes No
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

CURLNMBS.OptionMaxRecvSpeedLarge as Int64
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
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

CURLNMBS.OptionMaxRedirs as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
Function: The set number will be the redirection limit.
Example:
dim c as new CURLNMBS

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

CURLNMBS.OptionMaxSendSpeed as Int64
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 15.2 Yes Yes Yes Yes No
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

CURLNMBS.OptionMaxSendSpeedLarge as Int64
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
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

CURLNMBS.OptionNetRC as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
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

CURLNMBS.OptionNetRCFile as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
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

CURLNMBS.OptionNewDirectoryPerms as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 10.0 Yes Yes Yes Yes No
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

CURLNMBS.OptionNewFilePerms as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 10.0 Yes Yes Yes Yes No
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 Real Studio.
(Read and Write property)

See also NEW_FILE_PERMS option in CURL manual.

Feedback, Comments & Corrections

CURLNMBS.OptionNoBody as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
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

CURLNMBS.OptionNoProxy as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 10.0 Yes Yes Yes Yes No
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

CURLNMBS.OptionNoSignal as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 13.1 Yes Yes Yes Yes No
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

CURLNMBS.OptionPassword as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 10.0 Yes Yes Yes Yes No
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

CURLNMBS.OptionPathAsIs as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
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

CURLNMBS.OptionPinnedPublicKey as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
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

CURLNMBS.OptionPipeWait as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
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

CURLNMBS.OptionPort as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
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

CURLNMBS.OptionPost as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
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

CURLNMBS.OptionPostFields as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
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 CURLNMBS

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

CURLNMBS.OptionPostFieldSize as Int64
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
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

CURLNMBS.OptionPostFieldSizeLarge as Int64
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
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

CURLNMBS.OptionPostRedir as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 10.0 Yes Yes Yes Yes No
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

CURLNMBS.OptionPreProxy as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: Name of pre proxy to use.
Notes: (Read and Write property)

See also PRE_PROXY option in CURL manual.

Feedback, Comments & Corrections

CURLNMBS.OptionProtocols as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 10.0 Yes Yes Yes Yes No
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

CURLNMBS.OptionProxy as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
Function: Set HTTP proxy to use.
Example:
dim c as CURLNMBS // 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

Previous items Next items

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





Links
MBS FileMaker Plugins