From 90b94c2cdd6e3649ce12a7655feea791da488598 Mon Sep 17 00:00:00 2001 From: ekinhbayar Date: Sun, 6 Nov 2022 21:41:08 +0300 Subject: [PATCH] Document more new cURL constants --- reference/curl/constants.xml | 99 ++++++++++++++++++++++++ reference/curl/functions/curl-setopt.xml | 98 +++++++++++++++++++++++ 2 files changed, 197 insertions(+) diff --git a/reference/curl/constants.xml b/reference/curl/constants.xml index 9daea698626c..b9920c5cbd1a 100644 --- a/reference/curl/constants.xml +++ b/reference/curl/constants.xml @@ -428,6 +428,17 @@ + + + CURLOPT_UPLOAD_BUFFERSIZE + (int) + + + + Available as of PHP 8.2.0 and cURL 7.62.0 + + + CURLOPT_POST @@ -1058,6 +1069,39 @@ + + + CURLOPT_MAXAGE_CONN + (int) + + + + Available as of PHP 8.2.0 and cURL 7.65.0 + + + + + + CURLOPT_MAXFILESIZE_LARGE + (int) + + + + Available as of PHP 8.2.0 and cURL 7.11.0 + + + + + + CURLOPT_MAXLIFETIME_CONN + (int) + + + + Available as of PHP 8.2.0 and cURL 7.80.0 + + + CURLOPT_MAXREDIRS @@ -1212,6 +1256,17 @@ + + + CURLOPT_SSL_EC_CURVES + (string) + + + + Available as of PHP 8.2.0 and cURL 7.73.0 + + + CURLOPT_BINARYTRANSFER @@ -1575,6 +1630,28 @@ + + + CURLOPT_MAIL_RCPT_ALLLOWFAILS + (int) + + + + Available as of PHP 8.2.0 and cURL 7.69.0 + + + + + + CURLOPT_UPKEEP_INTERVAL_MS + (int) + + + + Available as of PHP 8.2.0 and cURL 7.62.0 + + + CURLOPT_MAX_RECV_SPEED_LARGE @@ -3441,6 +3518,17 @@ + + + CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256 + (int) + + + + Available as of PHP 8.2.0 and cURL 7.80.0 + + + CURLOPT_SSH_PRIVATE_KEYFILE @@ -3507,6 +3595,17 @@ + + + CURLOPT_SASL_AUTHZID + (int) + + + + Available as of PHP 8.2.0 and cURL 7.66.0 + + + CURLOPT_SASL_IR diff --git a/reference/curl/functions/curl-setopt.xml b/reference/curl/functions/curl-setopt.xml index b09c4c211b27..3810dbc26ba9 100644 --- a/reference/curl/functions/curl-setopt.xml +++ b/reference/curl/functions/curl-setopt.xml @@ -450,6 +450,17 @@ + + CURLOPT_SASL_AUTHZID + + The null-terminated authorization identity (authzid) for the transfer. Only applicable to the PLAIN SASL + authentication mechanism where it is optional. When not specified, only the authentication identity + (authcid) as specified by the username will be sent to the server, along with the password. + The server will derive the authzid from the authcid when not provided, which it will then use internally. + + + + CURLOPT_SASL_IR @@ -589,6 +600,16 @@ + + CURLOPT_UPLOAD_BUFFERSIZE + + Preferred buffer size in bytes for the cURL upload buffer. + The upload buffer size by default is 64 kilobytes. The maximum buffer size allowed to be set is 2 megabytes. + The minimum buffer size allowed to be set is 16 kilobytes. + + + + CURLOPT_VERBOSE @@ -835,6 +856,37 @@ + + CURLOPT_MAXAGE_CONN + + The maximum idle time allowed for an existing connection to be considered for reuse. + Default maximum age is set to 118 seconds. + + + + + + CURLOPT_MAXFILESIZE_LARGE + + The maximum file size in bytes allowed to download. If the file requested is found larger than this value, + the transfer will not start and CURLE_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. + + + + + + CURLOPT_MAXLIFETIME_CONN + + The maximum time in seconds, since the creation of the connection, that is allowed for an existing + connection to have for it to be considered for reuse. If a connection is found in the cache that is older + than this value, it will instead be closed once any in-progress transfers are complete. + Default is 0 seconds, meaning the option is disabled and all connections are eligible for reuse. + + + + CURLOPT_MAXCONNECTS @@ -1232,6 +1284,32 @@ Added in cURL 7.59.0. Available since PHP 7.3.0. + + CURLOPT_MAIL_RCPT_ALLLOWFAILS + + Allow RCPT TO command to fail for some recipients. + + + When sending data to multiple recipients, by default cURL will abort SMTP conversation if at least one of + the recipients causes RCPT TO command to return an error. This option tells cURL to ignore errors and + proceed with the remaining valid recipients. If all recipients trigger RCPT TO failures and this flag is + set, cURL will abort the SMTP conversation and return the error received from the last RCPT TO command. + + + + + + CURLOPT_UPKEEP_INTERVAL_MS + + Some protocols have "connection upkeep" mechanisms. These mechanisms usually send some traffic + on existing connections in order to keep them alive. This option defines the connection upkeep interval. + Currently, the only protocol with a connection upkeep mechanism is HTTP/2. When the connection upkeep + interval is exceeded, an HTTP/2 PING frame is sent on the connection. + Default is 60 seconds. + + + + CURLOPT_MAX_RECV_SPEED_LARGE @@ -1876,6 +1954,15 @@ Added in cURL 7.17.1. + + CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256 + + Base64-encoded SHA256 hash of the remote host's public key. + The transfer will fail if the given hash does not match the hash the remote host provides. + + + + CURLOPT_SSH_PUBLIC_KEYFILE @@ -1910,6 +1997,17 @@ + + CURLOPT_SSL_EC_CURVES + + A colon delimited list of elliptic curve algorithms. For example, + X25519:P-521 is a valid list of two elliptic curves. + This option defines the client's key exchange algorithms in the SSL handshake, + if the SSL backend cURL is built to use supports it. + + + + CURLOPT_SSLCERT