Platforms to show: All Mac Windows Linux Cross-Platform

Previous items

CURLMBS.SetOptionHTTP200Aliases(list() as string)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: A linked list of aliases to be treated as valid HTTP 200 responses.
Notes:
Some servers respond with a custom header response line. For example, IceCast servers respond with "ICY 200 OK". By including this string in your list of aliases, the response will be treated as a valid HTTP header line such as "HTTP/1.0 200 OK".

The alias itself is not parsed for any version strings. So if your alias is "MYHTTP/9.9", LibCURL will not treat the server as responding with HTTP version 9.9. Instead LibCURL will use the value set by option HTTPVersion.

The Lasterror property is set. 0 for success.

Feedback, Comments & Corrections

CURLMBS.SetOptionHTTPHeader(list() as string)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: A linked list of HTTP headers to pass to the server in your HTTP request.
Example:
dim c as new CURLMBS
c.SetOptionHTTPHeader array("Expect:", "Content-Type: text/xml", "SOAPAction: ""login""")
Notes:
If you add a header that is otherwise generated and used by libCURL internally, your added one will be used instead. If you add a header with no contents as in 'Accept:' (no data on the right side of the colon), the internally used header will get disabled. Thus, using this option you can add new headers, replace internal headers and remove internal headers. To add a header with no contents, make the contents be two quotes: "". The headers included in the linked list must not be CRLF-terminated, because CURL adds CRLF after each header item. Failure to comply with this will result in strange bugs because the server will most likely ignore part of the headers you specified.

The first line in a request (containing the method, usually a GET or POST) is not a header and cannot be replaced using this option. Only the lines following the request-line are headers. Adding this method line in this list of headers will only cause your request to send an invalid header.

Pass an empty array to this to reset back to no custom headers.

The Lasterror property is set. 0 for success.

Feedback, Comments & Corrections

CURLMBS.SetOptionMailRecipients(list() as string)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 11.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: Sets the array of email recipient addresses.

Feedback, Comments & Corrections

CURLMBS.SetOptionPostQuote(list() as string)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: Pass an array to a list of FTP commands to pass to the server after your ftp transfer request.
Example:
dim d as CURLMBS // your CURL object

dim ws() As String
ws.Append "RNFR Temp.txt"
ws.append "RNTO MyFile.txt"
d.SetOptionPostQuote(ws)
Notes:
Disable this operation again by using an empty array for this option.

The Lasterror property is set. 0 for success.
If you want to do a ftp operation instead of download/upload/directory listing, please use SetOptionQuote.

Feedback, Comments & Corrections

CURLMBS.SetOptionPreQuote(list() as string)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: Pass an array to a list of FTP commands to pass to the server after the transfer type is set.
Notes:
Disable this operation again by using an empty array for this option. Before version 7.15.6, if you also set Nobody to true, this option didn't work.

The Lasterror property is set. 0 for success.

Feedback, Comments & Corrections

CURLMBS.SetOptionProxyHeader(list() as string)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: Set list of headers used for proxy requests only.

Feedback, Comments & Corrections

CURLMBS.SetOptionQuote(list() as string)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: Pass an array or a list of FTP commands to pass to the server prior to your ftp request.
Example:
dim curl as new CURLMBS
curl.SetOptionQuote array("DELE filename.txt")
Notes:
This will be done before any other FTP commands are issued (even before the CWD command).

Disable this operation again by using an empty array for this option.

The Lasterror property is set. 0 for success.

Feedback, Comments & Corrections

CURLMBS.SetOptionResolve(list() as string)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: Send linked-list of name:port:address sets.

Feedback, Comments & Corrections

CURLMBS.SetOptionTelnetOptions(list() as string)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: Provide an array of variables to pass to the telnet negotiations.
Notes:
The variables should be in the format <option=value>. libCURL supports the options 'TTYPE', 'XDISPLOC' and 'NEW_ENV'. See the TELNET standard for details.

The Lasterror property is set. 0 for success.

Feedback, Comments & Corrections

CURLMBS.SetPathCAInfo(path as folderitem)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 10.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: A path holding one or more certificates to verify the peer with.
Example:
dim cacert as FolderItem // your cacert.pem file
dim CURL as new CURLMBS
CURL.OptionSSLVerifyHost = 2 // verify server
CURL.OptionSSLVerifyPeer = 1 // proofs certificate is authentic
CURL.SetPathCAInfo cacert
Notes:
This makes sense only when used in combination with the OptionSSLVerifyPeer option. If OptionSSLVerifyPeer is false, OptionCAINFO need not even indicate an accessible file.

Note that option is by default set to the system path where libCURL's cacert bundle is assumed to be stored, as established at build time.

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.

Feedback, Comments & Corrections

CURLMBS.SetPathCAPath(path as folderitem)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 10.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: A path to the directory holding multiple CA certificates to verify the peer with.
Example:
dim c as new CURLMBS

Dim cacert As FolderItem = GetFolderItem("cacert.pem")
c.SetPathCAPath cacert
Notes:
The certificate directory must be prepared using the openssl c_rehash utility. This makes sense only when used in combination with the CURLOPT_SSL_VERIFYPEER option. If OptionSSLVerifyPeer is zero, OptionCAPath need not even indicate an accessible path. The OptionCAPath function apparently does not work in Windows due to some limitation in openssl. This option is OpenSSL-specific and does nothing if libCURL is built to use GnuTLS.

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.

Feedback, Comments & Corrections

CURLMBS.SetPathCRLFile(path as folderitem)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 10.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: Sets the path with the concatenation of CRL (in PEM format) to use in the certificate validation that occurs during the SSL exchange.
Notes:
When CURL is built to use NSS or GnuTLS, there is no way to influence the use of CRL passed to help in the verification process. When libCURL is built with OpenSSL support, X509_V_FLAG_CRL_CHECK and X509_V_FLAG_CRL_CHECK_ALL are both set, requiring CRL check against all the elements of the certificate chain if a CRL file is passed.

This option makes sense only when used in combination with the OptionSSLVerifyPeer option.

A specific error code (CURLE_SSL_CRL_BADFILE) is defined with the option. It is returned when the SSL exchange fails because the CRL file cannot be loaded. Note that a failure in certificate verification due to a revocation information found in the CRL does not trigger this specific error. (Added in 7.19.0)

Feedback, Comments & Corrections

CURLMBS.SetPathIssuerCert(path as folderitem)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 10.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: Sets the path to a CA certificate in PEM format.
Notes:
If the option is set, an additional check against the peer certificate is performed to verify the issuer 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 OptionSSLVerifyPeer 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 (OptionSSLVerifyPeer has to be set too for the check to fail). (Added in 7.19.0)

Feedback, Comments & Corrections

CURLMBS.SetPathNetRCFile(path as folderitem)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 10.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: Sets the path 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.

Feedback, Comments & Corrections

CURLMBS.SetPathProxyIssuerCert(path as folderitem)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 20.3 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
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).

Feedback, Comments & Corrections

CURLMBS.SetupEmail(email as Variant) as boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 14.3 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: Setups existing CURL session for an email transfer.
Example:
dim e as new CURLEmailMBS

e.SetFrom "test@test.test", "Christian Müller"
e.Subject = "Hello World ☺️"
e.SMTPPassword = "xxx"
e.SMTPUsername = "xxx"
e.SetServer "smtp.test.test", true
e.AddTo "test@test.test", "Test Müller"
e.PlainText = "Hello World," + EndOfLine + "Smilies: ☺️ 😘 😄"

dim c as new CURLMBS

if c.SetupEmail(e) then

dim er as Integer = c.Perform
if er = 0 then
MsgBox "Email sent"
end if
end if
Notes:
You can set your own settings like proxy after this function call.
If you like you can reuse the email and CURL objects after you sent an email, change values and send another email.
Returns true on success or false on failure.

Feedback, Comments & Corrections

CURLMBS.UpKeep
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 18.5 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Function: Perform any connection upkeep checks.
Notes:
Perform any connection upkeep checks.
Some protocols have "connection upkeep" mechanisms. These mechanisms usually send some traffic on existing connections in order to keep them alive; this can prevent connections from being closed due to overzealous firewalls, for example.
Currently the only protocol with a connection upkeep mechanism is HTTP/2: when the connection upkeep interval is exceeded and Upkeep is called, an HTTP/2 PING frame is sent on the connection.
This function must be explicitly called in order to perform the upkeep work. The connection upkeep interval is set with OptionUpkeepIntervalMS.

Feedback, Comments & Corrections

Previous items

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

The biggest plugin in space...




Links
MBS Xojo PDF Plugins

Start Chat