# S3 Module The S3 module provides an easy-to-use interface for Amazon S3 and other S3-compatible services. ## Syntax ```text CloudStorage.S3 ``` ## Remarks The S3 class allows you to access Amazon's Simple Storage Service (S3), as well as other S3-compatible services, in a secure manner using Secure Sockets Layer/Transport Layer Security (TLS/SSL). S3-like services allow you to store arbitrary data objects in various buckets and to access them from anywhere with an internet connection. A brief synopsis follows, but please refer to Amazon's [S3 documentation](https://docs.aws.amazon.com/s3/index.html) for more information about the general capabilities of S3. S3 supports the following providers: - Amazon S3 - Backblaze B2 - Cloudflare R2 - Digital Ocean Spaces - Google Cloud Storage - IBM Cloud Object Storage - Linode Object Storage - Oort DSS - Oracle Cloud Object Storage - Seagate Lyve Cloud - Wasabi - And more! A "custom provider" option also allows you to interact with any S3-compatible API by specifying its base URL. ### Getting Started To begin, use the [ServiceProvider](#serviceprovider-property-s3-module) property to select the S3 service provider to use. Then, use the [AccessKey](#accesskey-property-s3-module) and [SecretKey](#secretkey-property-s3-module) properties to specify the access key and secret key that the class should use to sign requests. These keys can be obtained after signing up for an account with the selected service provider. ### Working with Buckets S3 services store objects in various buckets. The following methods can be used to interact with the buckets in an S3 account: - Creating and deleting buckets: [CreateBucket](#createbucket-method-s3-module) and [DeleteBucket](#deletebucket-method-s3-module) - Checking whether a bucket exists, and its location: [BucketExists](#bucketexists-method-s3-module) and [GetBucketLocation](#getbucketlocation-method-s3-module) - Listing buckets: [ListBuckets](#listbuckets-method-s3-module) - Updating a bucket's canned ACL: [UpdateBucketACL](#updatebucketacl-method-s3-module) ### Working with Objects Once the desired buckets are ready, the following methods can be used to interact with objects: - Creating, downloading, and deleting objects: [CreateObject](#createobject-method-s3-module), [GetObject](#getobject-method-s3-module), [DeleteObject](#deleteobject-method-s3-module) - Copying objects: [CopyObject](#copyobject-method-s3-module) - Listing objects, or getting information about a single object: [ListObjects](#listobjects-method-s3-module), [GetObjectInfo](#getobjectinfo-method-s3-module) - Updating an object's canned ACL: [UpdateObjectACL](#updateobjectacl-method-s3-module) ### Working with Multipart Uploads For S3 providers that support them, multipart uploads make it possible to upload very large objects in multiple parts. - Starting, completing, and aborting multipart uploads: [StartMultipartUpload](#startmultipartupload-method-s3-module), [CompleteMultipartUpload](#completemultipartupload-method-s3-module), [AbortMultipartUpload](#abortmultipartupload-method-s3-module) - Listing multipart uploads: [ListMultipartUploads](#listmultipartuploads-method-s3-module) - Uploading and copying parts: [UploadPart](#uploadpart-method-s3-module), [CopyPart](#copypart-method-s3-module) - Listing parts: [ListParts](#listparts-method-s3-module) ### Cloudflare R2 Notes The Cloudflare R2 service provider possesses the following unique requirements and characteristics: - In addition to needing an [AccessKey](#accesskey-property-s3-module) and [SecretKey](#secretkey-property-s3-module), a [CloudflareAccountID](#CloudflareAccountID) is also required to work with this provider. - The [Region](#region-property-s3-module) property is automatically set to "auto" when this service provider is selected, which is the only valid value. - [ListParts](#listparts-method-s3-module) is not supported natively by Cloudflare R2, which means that the behavior of [CompleteMultipartUpload](#completemultipartupload-method-s3-module) changes when using this provider. Instead, calling [UploadPart](#uploadpart-method-s3-module) or [CopyPart](#copypart-method-s3-module) populates the [LastPartInfo](#LastPartInfo) and [PartInfo\[i\]](#PartInfo[i]) configuration settings. [CompleteMultipartUpload](#completemultipartupload-method-s3-module) will then use the values in [PartInfo\[i\]](#PartInfo[i]) to complete the multipart upload. ### Other Features The S3 class also supports a variety of other features, including the following: - Versioning support - Object metadata manipulation - Presigned link generation ## Property List *The following is the full list of the properties of the module with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AccessKey](#accesskey-property-s3-module) | This property includes the access key to use for authentication. | | [AccessPolicy](#accesspolicy-property-s3-module) | This property includes the canned access policy to apply to a bucket or object. | | [Bucket](#bucket-property-s3-module) | This property selects a bucket. | | [Buckets](#buckets-property-s3-module) | This property includes the collection of buckets. | | [CompressionMethod](#compressionmethod-property-s3-module) | Specifies an optional compression method. | | [ContentDisposition](#contentdisposition-property-s3-module) | This property includes content disposition to send for an object. | | [ContentType](#contenttype-property-s3-module) | This property includes the content type to send for an object. | | [EncryptionAlgorithm](#encryptionalgorithm-property-s3-module) | This property includes the encryption algorithm. | | [EncryptionPassword](#encryptionpassword-property-s3-module) | This property includes the encryption password. | | [Firewall](#firewall-property-s3-module) | A set of properties related to firewall access. | | [FollowRedirects](#followredirects-property-s3-module) | This property determines what happens when the server issues a redirect. | | [Idle](#idle-property-s3-module) | The current status of the module. | | [LocalFile](#localfile-property-s3-module) | This property includes the location of the local file. | | [LocalHost](#localhost-property-s3-module) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [Metadata](#metadata-property-s3-module) | This property includes a collection of metadata items. | | [ObjectData](#objectdata-property-s3-module) | This property includes the data that were downloaded or that should be uploaded. | | [ObjectDelimiter](#objectdelimiter-property-s3-module) | This property includes the delimiter string to use when listing objects. | | [ObjectMarker](#objectmarker-property-s3-module) | This property includes a marker indicating what page of objects to return next. | | [ObjectPrefix](#objectprefix-property-s3-module) | This property includes a prefix used to restrict the results returned when listing objects. | | [Objects](#objects-property-s3-module) | This property includes a collection of objects. | | [OtherHeaders](#otherheaders-property-s3-module) | Other headers as determined by the user (optional). | | [Overwrite](#overwrite-property-s3-module) | This property determines if local files are overwritten. | | [ParsedHeaders](#parsedheaders-property-s3-module) | This property includes a collection of headers returned from the last request. | | [PartMarker](#partmarker-property-s3-module) | This property includes a marker indicating what page of parts to return next. | | [Parts](#parts-property-s3-module) | This property includes a collection of multipart upload parts. | | [Proxy](#proxy-property-s3-module) | A set of properties related to proxy access. | | [QueryParams](#queryparams-property-s3-module) | This property includes the additional query parameters to be included in the request. | | [Range](#range-property-s3-module) | This property includes the range of bytes to request. | | [Region](#region-property-s3-module) | This property includes the region the module will make requests against. | | [SecretKey](#secretkey-property-s3-module) | This property includes the secret key to use for authentication. | | [ServiceProvider](#serviceprovider-property-s3-module) | This property includes the S3 service provider to use. | | [SSLAcceptServerCert](#sslacceptservercert-property-s3-module) | Instructs the module to unconditionally accept the server certificate that matches the supplied certificate. | | [SSLCert](#sslcert-property-s3-module) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. | | [SSLProvider](#sslprovider-property-s3-module) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [SSLServerCert](#sslservercert-property-s3-module) | The server certificate for the last established connection. | | [StartByte](#startbyte-property-s3-module) | This property includes the byte offset from which to resume the upload or download. | | [Timeout](#timeout-property-s3-module) | The timeout for the module. | | [UseSSL](#usessl-property-s3-module) | This method includes whether to use SSL/TLS when connecting. | | [UseVirtualHosting](#usevirtualhosting-property-s3-module) | This property determines which URL style to use when making requests. | | [VersionId](#versionid-property-s3-module) | This property includes the object version to make requests against. | | [VersionMarker](#versionmarker-property-s3-module) | This property includes a marker indicating what page of object versions to return next. | ## Method List *The following is the full list of the methods of the module with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AbortMultipartUpload](#abortmultipartupload-method-s3-module) | This method aborts a multipart upload. | | [AddMetadata](#addmetadata-method-s3-module) | Adds a metadata item to the Metadata properties. | | [AddQueryParam](#addqueryparam-method-s3-module) | This method adds a query parameter to the QueryParams properties. | | [AppendObject](#appendobject-method-s3-module) | This method appends data to the end of the existing object specified by ObjectName . | | [BucketExists](#bucketexists-method-s3-module) | This method checks whether the bucket exists. | | [CheckVersioningEnabled](#checkversioningenabled-method-s3-module) | This method checks whether versioning is enabled for the currently selected bucket. | | [CompleteMultipartUpload](#completemultipartupload-method-s3-module) | This method completes a multipart upload by assembling previously uploaded parts. | | [Config](#config-method-s3-module) | Sets or retrieves a configuration setting. | | [CopyObject](#copyobject-method-s3-module) | This method copies an object. | | [CopyPart](#copypart-method-s3-module) | This method copies the specified object as a part of a multipart upload. | | [CreateBucket](#createbucket-method-s3-module) | This method creates a new bucket. | | [CreateObject](#createobject-method-s3-module) | This method creates a new object in the currently selected bucket. | | [DeleteBucket](#deletebucket-method-s3-module) | This method deletes a bucket. | | [DeleteObject](#deleteobject-method-s3-module) | This method deletes an object. | | [DisableVersioning](#disableversioning-method-s3-module) | This method disables versioning for the currently selected bucket. | | [DoEvents](#doevents-method-s3-module) | This method processes events from the internal message queue. | | [EnableVersioning](#enableversioning-method-s3-module) | This method enables versioning for the currently selected bucket. | | [GetBucketLocation](#getbucketlocation-method-s3-module) | This method gets a bucket's location. | | [GetLink](#getlink-method-s3-module) | This method creates a link that provides access to an object for a specified amount of time. | | [GetObject](#getobject-method-s3-module) | This method downloads an object. | | [GetObjectInfo](#getobjectinfo-method-s3-module) | This method gets an object's information and metadata. | | [Interrupt](#interrupt-method-s3-module) | This method interrupts the current method. | | [ListBuckets](#listbuckets-method-s3-module) | This method lists all buckets in the account. | | [ListMultipartUploads](#listmultipartuploads-method-s3-module) | This method lists the current multipart uploads. | | [ListObjects](#listobjects-method-s3-module) | This method lists the objects in a bucket. | | [ListParts](#listparts-method-s3-module) | This method lists the parts in a multipart upload. | | [ListVersions](#listversions-method-s3-module) | This method lists the object versions in a bucket. | | [Reset](#reset-method-s3-module) | This method resets the module to its initial state. | | [ResetHeaders](#resetheaders-method-s3-module) | This method resets all HTTP headers, cookies, and LocalFile. | | [SendCustomRequest](#sendcustomrequest-method-s3-module) | This method sends a custom request to the server. | | [StartMultipartUpload](#startmultipartupload-method-s3-module) | This method starts a new manual multipart upload. | | [UpdateBucketACL](#updatebucketacl-method-s3-module) | This method updates a bucket's canned access policy. | | [UpdateObjectACL](#updateobjectacl-method-s3-module) | This method updates an object's canned access policy. | | [UploadPart](#uploadpart-method-s3-module) | This method uploads a multipart upload part. | ## Event List *The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.* | | | | --- | --- | | [BucketList](#bucketlist-event-s3-module) | This event fires once for each bucket returned when listing buckets. | | [EndTransfer](#endtransfer-event-s3-module) | This event fires when a document finishes transferring. | | [Error](#error-event-s3-module) | Fired when information is available about errors during data delivery. | | [FragmentComplete](#fragmentcomplete-event-s3-module) | This event fires after each part in an automatic multipart upload is complete. | | [Header](#header-event-s3-module) | Fired every time a header line comes in. | | [Log](#log-event-s3-module) | Fired once for each log message. | | [MetadataList](#metadatalist-event-s3-module) | This event fires once for each metadata item returned when object information and metadata are retrieved. | | [ObjectList](#objectlist-event-s3-module) | This event fires once for each object, object version, or multipart upload returned when listing such items. | | [PartList](#partlist-event-s3-module) | This event fires once for every part returned when listing a multipart upload's parts. | | [PrefixList](#prefixlist-event-s3-module) | This event fires once for each common prefix returned when listing objects. | | [Progress](#progress-event-s3-module) | This event fires during an upload or download to indicate transfer progress. | | [SSLServerAuthentication](#sslserverauthentication-event-s3-module) | Fired after the server presents its certificate to the client. | | [SSLStatus](#sslstatus-event-s3-module) | Fired when secure connection progress messages are available. | | [StartTransfer](#starttransfer-event-s3-module) | This event fires when a document starts transferring (after the headers). | | [Transfer](#transfer-event-s3-module) | Fired while a document transfers (delivers document). | ## Config Settings *The following is a list of config settings for the module with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AccumulatePages](#AccumulatePages) | Whether the module should accumulate subsequent pages of results when listing them. | | [ADFSAuthScheme](#ADFSAuthScheme) | The authentication scheme to use with the ADFS STS endpoint. | | [ADFSPassword](#ADFSPassword) | The password to use if the auth scheme is set to NTLM. | | [ADFSRelyingParty](#ADFSRelyingParty) | The endpoint to request the SAML Response from. | | [ADFSSTSEndpoint](#ADFSSTSEndpoint) | The endpoint to request the SAML Response from. | | [ADFSUser](#ADFSUser) | The username to use if the auth scheme is set to NTLM. | | [AssumeRoleARN](#AssumeRoleARN) | Amazon Resource Name used when assuming a role for authentication. | | [AssumeRoleDuration](#AssumeRoleDuration) | The duration for role session in seconds. | | [AssumeRolePrincipalARN](#AssumeRolePrincipalARN) | The Amazon Resource Name of the SAML provider. | | [AssumeRoleSessionName](#AssumeRoleSessionName) | Unique name for current role session. | | [AutoDetectSigningRegion](#AutoDetectSigningRegion) | Whether or not to automatically detect the region from the base URL in order to use it for the HMAC signing process. | | [AWSProfile](#AWSProfile) | The name of the AWS CLI profile that the module should use to obtain authentication and region information. | | [AWSProfileDir](#AWSProfileDir) | The location of the AWS CLI credentials and config files. | | [CloudflareAccountID](#CloudflareAccountID) | The Cloudflare R2 account ID to use. | | [ContentRange](#ContentRange) | This contains the range of bytes of the current object that are being returned. | | [CopyPartRange](#CopyPartRange) | Specifies the range of bytes to copy when calling CopyPart. | | [DownloadTempFile](#DownloadTempFile) | The temporary file used when downloading encrypted data. | | [EncodeSlashInObjectName](#EncodeSlashInObjectName) | Whether or not to encode slashes in an object name. | | [EncryptionIV](#EncryptionIV) | The initialization vector to be used for encryption/decryption. | | [EncryptionKey](#EncryptionKey) | The key to use during encryption/decryption. | | [EncryptionPasswordKDF](#EncryptionPasswordKDF) | The KDF algorithm to use during password based encryption and decryption. | | [EnforceBucketNameRestrictions](#EnforceBucketNameRestrictions) | Whether or not to enforce bucket naming conventions. | | [ETag](#ETag) | The ETag for the object returned by the server. | | [ForceDeleteNonEmptyBuckets](#ForceDeleteNonEmptyBuckets) | Forces buckets to be deleted even if they aren't empty. | | [FragmentSize](#FragmentSize) | The part size to use when uploading a new object. | | [GoogleProjectId](#GoogleProjectId) | The Google project Id to send when using OAuth 2.0 to authenticate to Google Storage. | | [IfMatch](#IfMatch) | Check to make sure the object has not been modified since the last request. | | [IncludeContentMD5](#IncludeContentMD5) | Whether an MD5 digest of a custom request's data should be included. | | [IncludeObjectMD5](#IncludeObjectMD5) | Whether an MD5 digest of a object's data should be included. | | [IncludePartMD5](#IncludePartMD5) | Whether an MD5 digest of a part's data should be included. | | [LastPartInfo](#LastPartInfo) | The part number and part ETag of the last CopyPart or UploadPart request. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in the Log event. | | [MaxObjects](#MaxObjects) | The maximum number of results to return when listing objects. | | [MaxParts](#MaxParts) | The maximum number of results to return when listing parts. | | [OAuthAuthorization](#OAuthAuthorization) | The OAuth 2.0 authorization token to use to authenticate to Google Storage. | | [OracleNamespace](#OracleNamespace) | The Oracle Cloud Object Storage namespace to use. | | [OverwriteRemote](#OverwriteRemote) | Whether to allow overwrites of existing remote data. | | [PartInfo\[i\]](#PartInfo[i]) | The i'th part number and part ETag corresponding to a part of a multipart upload. | | [PartInfoCount](#PartInfoCount) | The number of items in the PartInfo collection. | | [Prefix\[i\]](#Prefix[i]) | The i'th common prefix returned. | | [PrefixCount](#PrefixCount) | The number of common prefixes returned. | | [ProgressAbsolute](#ProgressAbsolute) | Whether the module should track transfer progress absolutely. | | [ProgressStep](#ProgressStep) | How often the progress event should be fired, in terms of percentage. | | [RawRequest](#RawRequest) | Returns the data that was sent to the server. | | [RawResponse](#RawResponse) | Returns the data that was received from the server. | | [ResponseCacheControl](#ResponseCacheControl) | Sets the Cache-Control header of the response. | | [ResponseContentDisposition](#ResponseContentDisposition) | Sets the Content-Disposition header of the response. | | [ResponseContentEncoding](#ResponseContentEncoding) | Sets the Content-Encoding header of the response. | | [ResponseContentLanguage](#ResponseContentLanguage) | Sets the Content-Language header of the response. | | [ResponseContentType](#ResponseContentType) | Sets the Content-Type header of the response. | | [ResponseExpires](#ResponseExpires) | Sets the Expires header of the response. | | [ResumableUploadState](#ResumableUploadState) | Tracks upload state information during an automatic multipart upload. | | [SendObjectACLs](#SendObjectACLs) | Whether to include object-level ACL headers when making requests. | | [ServiceProviderURL](#ServiceProviderURL) | The base URL to use when communicating with a service provider. | | [SessionToken](#SessionToken) | The session token to send in the request when using temporary credentials. | | [SignCustomRequest](#SignCustomRequest) | Tells the module to sign the outgoing request. | | [SigningTime](#SigningTime) | A custom date to send to the module to use while signing all requests. | | [SimpleUploadLimit](#SimpleUploadLimit) | The maximum data size the module should attempt to upload directly when creating an object. | | [StorageClass](#StorageClass) | Specifies the storage class to be used for the uploaded object. | | [StoreObjectData](#StoreObjectData) | Whether module stores object data or not. | | [StorePrefixList](#StorePrefixList) | Whether to store the common prefixes returned when listing objects. | | [SupabaseProjectId](#SupabaseProjectId) | The project reference ID to use when communicating with the Supabase provider. | | [TempPath](#TempPath) | The path to the directory where temporary files are created. | | [UseEC2RoleCredentials](#UseEC2RoleCredentials) | Whether to authenticate requests with credentials obtained from the IAM role attached to the EC2 instance. | | [XChildCount](#XChildCount) | The number of child elements of the current element. | | [XChildName\[i\]](#XChildName[i]) | The name of the child element. | | [XChildXText\[i\]](#XChildXText[i]) | The inner text of the child element. | | [XElement](#XElement) | The name of the current element. | | [XParent](#XParent) | The parent of the current element. | | [XPath](#XPath) | Provides a way to point to a specific element in the returned XML or JSON response. | | [XSubTree](#XSubTree) | A snapshot of the current element in the document. | | [XText](#XText) | The text of the current element. | | [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. | | [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. | | [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. | | [Append](#Append) | Whether to append data to LocalFile. | | [Authorization](#Authorization) | The Authorization string to be sent to the server. | | [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. | | [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. | | [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. | | [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the module. | | [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. | | [GetOn302Redirect](#GetOn302Redirect) | If set to True the module will perform a GET on the new location. | | [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. | | [HTTPVersion](#HTTPVersion) | The version of HTTP used by the module. | | [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. | | [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. | | [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. | | [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. | | [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). | | [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. | | [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. | | [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. | | [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). | | [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). | | [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. | | [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. | | [StatusCode](#StatusCode) | The status code of the last response from the server. | | [StatusLine](#StatusLine) | The first line of the last response from the server. | | [TransferredData](#TransferredData) | The contents of the last response from the server. | | [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the module. | | [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. | | [TransferredRequest](#TransferredRequest) | The full request as sent by the client. | | [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. | | [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. | | [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. | | [UserAgent](#UserAgent) | Information about the user agent (browser). | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the module whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the module binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # AccessKey Property ([S3](#s3-module) Module) This property includes the access key to use for authentication. ## Syntax ```text public var accessKey: String { get {...} set {...} } ``` ## Default Value "" ## Remarks This property specifies the access key that should be used for authentication. Both this property and [SecretKey](#secretkey-property-s3-module) must be set before attempting any operations that connect to the server. # AccessPolicy Property ([S3](#s3-module) Module) This property includes the canned access policy to apply to a bucket or object. ## Syntax ```text public var accessPolicy: S3AccessPolicies { get {...} set {...} } public enum S3AccessPolicies: Int32 { case ptPrivate = 0 case ptPublicRead = 1 case ptPublicReadWrite = 2 case ptAuthenticatedRead = 3 case ptBucketOwnerRead = 4 case ptBucketOwnerFullControl = 5 case ptNone = 6 } ``` ## Default Value 0 ## Remarks This property specifies the canned access policy that should be applied to a bucket or object when one of the following methods is called: - [CopyObject](#copyobject-method-s3-module) (for the destination object) - [CreateBucket](#createbucket-method-s3-module) - [CreateObject](#createobject-method-s3-module) - [StartMultipartUpload](#startmultipartupload-method-s3-module) - [UpdateBucketACL](#updatebucketacl-method-s3-module) - [UpdateObjectACL](#updateobjectacl-method-s3-module) The valid values are as follows: | | | | --- | --- | | ptPrivate (0) (default) | Owner gets full control. No one else has access. | | ptPublicRead (1) | Owner gets full control. Everyone else gets read access. | | ptPublicReadWrite (2) | Owner gets full control. Everyone else gets read/write access. | | ptAuthenticatedRead (3) | Owner gets full control. Authenticated users get read access. | | ptBucketOwnerRead (4) | Applicable only to objects. Object owner gets full control. Bucket owner gets read access. | | ptBucketOwnerFullControl (5) | Applicable only to objects. Both object and bucket owner get full control. | | ptNone (6) | Instructs the class to not explicitly set a canned access policy for a bucket or object. | NOTE: Most S3-compatible service providers support all of the canned access policies listed above, but some do not, or they have additional restrictions. Refer to the provider's documentation for more information. # Bucket Property ([S3](#s3-module) Module) This property selects a bucket. ## Syntax ```text public var bucket: String { get {...} set {...} } ``` ## Default Value "" ## Remarks This property selects a bucket, by name, for the class to operate against. It must be set before attempting most operations. # Buckets Property ([S3](#s3-module) Module) This property includes the collection of buckets. ## Syntax ```text public var buckets: Array { get {...} } ``` ## Default Value "" ## Remarks This collection holds a list of [S3Bucket](#s3bucket-type) items. Calling [ListBuckets](#listbuckets-method-s3-module) will populate this collection. # CompressionMethod Property ([S3](#s3-module) Module) Specifies an optional compression method. ## Syntax ```text public var compressionMethod: S3CompressionMethods { get {...} set {...} } public enum S3CompressionMethods: Int32 { case cmNone = 0 case cmDeflate = 1 case cmZlib = 2 case cmGzip = 3 } ``` ## Default Value 0 ## Remarks This property specifies an optional compression method to use when calling [CreateObject](#createobject-method-s3-module) or [GetObject](#getobject-method-s3-module). When set, the object data will be compressed or decompressed using the specified method. Possible values are: - 0 (cmNone - default) - 1 (cmDeflate) - 2 (cmZlib) - 3 (cmGzip) # ContentDisposition Property ([S3](#s3-module) Module) This property includes content disposition to send for an object. ## Syntax ```text public var contentDisposition: String { get {...} set {...} } ``` ## Default Value "" ## Remarks This property can be set before calling [CreateObject](#createobject-method-s3-module) to have its value submitted as the object's *Content-Disposition* header value. This same value will then be returned in the *Content-Disposition* header by the server any time the object is downloaded. # ContentType Property ([S3](#s3-module) Module) This property includes the content type to send for an object. ## Syntax ```text public var contentType: String { get {...} set {...} } ``` ## Default Value "" ## Remarks This property can be set before calling [CreateObject](#createobject-method-s3-module) to have its value submitted as the object's *Content-Type* header value. This same value will then be returned in the *Content-Type* header by the server any time the object is downloaded. # EncryptionAlgorithm Property ([S3](#s3-module) Module) This property includes the encryption algorithm. ## Syntax ```text public var encryptionAlgorithm: S3EncryptionAlgorithms { get {...} set {...} } public enum S3EncryptionAlgorithms: Int32 { case eaAES = 0 case eaBlowfish = 1 case eaCAST = 2 case eaDES = 3 case eaIDEA = 4 case eaRC2 = 5 case eaRC4 = 6 case eaTEA = 7 case eaTripleDES = 8 case eaTwofish = 9 case eaRijndael = 10 case eaChaCha = 11 case eaXSalsa20 = 12 } ``` ## Default Value 0 ## Remarks This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are as follows: | Algorithm | Key Size | | --- | --- | | 0 (eaAES - default) | 256 | | 1 (eaBlowfish) | 448 | | 2 (eaCAST) | 128 | | 3 (eaDES) | 64 | | 4 (eaIDEA) | 128 | | 5 (eaRC2) | 128 | | 6 (eaRC4) | 2048 | | 7 (eaTEA) | 128 | | 8 (eaTripleDES) | 192 | | 9 (eaTwofish) | 256 | | 10 (eaRijndael) | 256 | | 11 (eaChaCha) | 256 | | 12 (eaXSalsa20) | 256 | # EncryptionPassword Property ([S3](#s3-module) Module) This property includes the encryption password. ## Syntax ```text public var encryptionPassword: String { get {...} set {...} } ``` ## Default Value "" ## Remarks If this property is populated when [CreateObject](#createobject-method-s3-module) or [GetObject](#getobject-method-s3-module) is called, the class will attempt to encrypt or decrypt the data before uploading or after downloading it. The class uses the specified value to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly. It is also possible, however, to explicitly specify the Key and IV values to use by setting the [EncryptionKey](#EncryptionKey) and [EncryptionIV](#EncryptionIV) configuration settings. This may be necessary if, for example, the data need to be encrypted or decrypted by another utility that generates Key and IV values differently. # Firewall Property ([S3](#s3-module) Module) A set of properties related to firewall access. ## Syntax ```text public var firewall: Firewall { get {...} set {...} } ``` ## Default Value "" ## Remarks This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the class will attempt to connect. # FollowRedirects Property ([S3](#s3-module) Module) This property determines what happens when the server issues a redirect. ## Syntax ```text public var followRedirects: S3FollowRedirects { get {...} set {...} } public enum S3FollowRedirects: Int32 { case frNever = 0 case frAlways = 1 case frSameScheme = 2 } ``` ## Default Value 0 ## Remarks This property specifies how the class should behave when the server returns a redirect response (e.g., "Object Moved"). Valid values are as follows: | | | | --- | --- | | frNever (0) (default) | Redirects are never followed; the class instead. | | frAlways (1) | Redirects are always followed. | | frSameScheme (2) | Redirects are followed if the new URL has the same scheme as the originally requested URL; otherwise, the class . | # Idle Property ([S3](#s3-module) Module) The current status of the module. ## Syntax ```text public var idle: Bool { get {...} } ``` ## Default Value True ## Remarks This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times. This property is read-only. # LocalFile Property ([S3](#s3-module) Module) This property includes the location of the local file. ## Syntax ```text public var localFile: String { get {...} set {...} } ``` ## Default Value "" ## Remarks This property specifies the location of a file on a disk. This is used as the source file when calling [CreateObject](#createobject-method-s3-module) or [UploadPart](#uploadpart-method-s3-module); and as the destination file when calling [GetObject](#getobject-method-s3-module). # LocalHost Property ([S3](#s3-module) Module) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax ```text public var localHost: String { get {...} set {...} } ``` ## Default Value "" ## Remarks This property contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used. If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window. # Metadata Property ([S3](#s3-module) Module) This property includes a collection of metadata items. ## Syntax ```text public var metadata: Array { get {...} } ``` ## Default Value "" ## Remarks This collection holds a list of [S3Metadata](#s3metadata-type) items. This collection is populated when [GetObjectInfo](#getobjectinfo-method-s3-module) is called; and its items are used any time [CreateObject](#createobject-method-s3-module), [CopyObject](#copyobject-method-s3-module), or [StartMultipartUpload](#startmultipartupload-method-s3-module) is called. # ObjectData Property ([S3](#s3-module) Module) This property includes the data that were downloaded or that should be uploaded. ## Syntax ```text public var objectData: String { get {...} set {...} } public var objectDataB: Data { get {...} set {...} } ``` ## Default Value "" ## Remarks This property is populated with object data after calling [GetObject](#getobject-method-s3-module) if [LocalFile](#localfile-property-s3-module) is not set. This property also can be set before calling [CreateObject](#createobject-method-s3-module) or [UploadPart](#uploadpart-method-s3-module); its data will be uploaded if [LocalFile](#localfile-property-s3-module) is not set. # ObjectDelimiter Property ([S3](#s3-module) Module) This property includes the delimiter string to use when listing objects. ## Syntax ```text public var objectDelimiter: String { get {...} set {...} } ``` ## Default Value "" ## Remarks If this property is nonempty when [ListObjects](#listobjects-method-s3-module) or [ListVersions](#listversions-method-s3-module) is called, any objects (or object versions) whose names contain the same string between the specified [ObjectPrefix](#objectprefix-property-s3-module) and the first occurrence of the specified delimiter that follow will be rolled up into a *common prefix* element, which is returned in place of the individual objects. The [PrefixList](#prefixlist-event-s3-module) event will fire once for each common prefix returned. If the [StorePrefixList](#StorePrefixList) configuration setting is enabled, the class also will populate the [PrefixCount](#PrefixCount) and [Prefix\[i\]](#Prefix[i]) configuration settings. ### Object Hierarchy Traversal By using the ObjectDelimiter and [ObjectPrefix](#objectprefix-property-s3-module) properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket: - *MyCompany/* - *MyCompany/Department1/* - *MyCompany/Department2/* - *MyCompany/Department2/EmployeeA* - *MyCompany/Department2/EmployeeB* With ObjectDelimiter set to */*, we can set [ObjectPrefix](#objectprefix-property-s3-module) to successively "deeper" values before calling [ListObjects](#listobjects-method-s3-module) or [ListVersions](#listversions-method-s3-module) for the following effect: | [ObjectPrefix](#objectprefix-property-s3-module) Value | ObjectDelimiter Value | Objects Returned | Prefixes Returned | | --- | --- | --- | --- | | (empty) | / | (none) | MyCompany/ | | MyCompany/ | / | MyCompany/ | MyCompany/Department1/ MyCompany/Department2/ | | MyCompany/Department2/ | / | MyCompany/Department2/ MyCompany/Department2/EmployeeA MyCompany/Department2/EmployeeB | (none) | # ObjectMarker Property ([S3](#s3-module) Module) This property includes a marker indicating what page of objects to return next. ## Syntax ```text public var objectMarker: String { get {...} set {...} } ``` ## Default Value "" ## Remarks This property will be populated when [ListObjects](#listobjects-method-s3-module) is called if the results are paged and there are more pages. To list all objects, continue to call [ListObjects](#listobjects-method-s3-module) until this property returns an empty string. Refer to [ListObjects](#listobjects-method-s3-module) for more information. NOTE: This property is cleared any time [ServiceProvider](#serviceprovider-property-s3-module) changes; marker values are valid only when used with the provider that generated them. # ObjectPrefix Property ([S3](#s3-module) Module) This property includes a prefix used to restrict the results returned when listing objects. ## Syntax ```text public var objectPrefix: String { get {...} set {...} } ``` ## Default Value "" ## Remarks This property, if nonempty, is used to restrict the results returned by [ListObjects](#listobjects-method-s3-module) (or [ListVersions](#listversions-method-s3-module)) to only those objects (or object versions) whose names begin with the given value. ### Object Hierarchy Traversal By using the [ObjectDelimiter](#objectdelimiter-property-s3-module) and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket: - *MyCompany/* - *MyCompany/Department1/* - *MyCompany/Department2/* - *MyCompany/Department2/EmployeeA* - *MyCompany/Department2/EmployeeB* With [ObjectDelimiter](#objectdelimiter-property-s3-module) set to */*, we can set ObjectPrefix to successively "deeper" values before calling [ListObjects](#listobjects-method-s3-module) or [ListVersions](#listversions-method-s3-module) for the following effect: | ObjectPrefix Value | [ObjectDelimiter](#objectdelimiter-property-s3-module) Value | Objects Returned | Prefixes Returned | | --- | --- | --- | --- | | (empty) | / | (none) | MyCompany/ | | MyCompany/ | / | MyCompany/ | MyCompany/Department1/ MyCompany/Department2/ | | MyCompany/Department2/ | / | MyCompany/Department2/ MyCompany/Department2/EmployeeA MyCompany/Department2/EmployeeB | (none) | # Objects Property ([S3](#s3-module) Module) This property includes a collection of objects. ## Syntax ```text public var objects: Array { get {...} } ``` ## Default Value "" ## Remarks This collection holds a list of [S3Object](#s3object-type) items. Calling [GetObjectInfo](#getobjectinfo-method-s3-module), [ListObjects](#listobjects-method-s3-module), [ListVersions](#listversions-method-s3-module), or [ListMultipartUploads](#listmultipartuploads-method-s3-module) will populate this collection. # OtherHeaders Property ([S3](#s3-module) Module) Other headers as determined by the user (optional). ## Syntax ```text public var otherHeaders: String { get {...} set {...} } ``` ## Default Value "" ## Remarks This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like [ContentType](#contenttype-property-s3-module) and From. The headers must follow the format *Header: Value* as described in the HTTP specifications. Header lines should be separated by . Use this property with caution. If this property contains invalid headers, HTTP requests may fail. This property is useful for extending the functionality of the class beyond what is provided. # Overwrite Property ([S3](#s3-module) Module) This property determines if local files are overwritten. ## Syntax ```text public var overwrite: Bool { get {...} set {...} } ``` ## Default Value False ## Remarks This property controls whether local files are overwritten when calling [GetObject](#getobject-method-s3-module). It is applicable only to local files. The default value is *false*. # ParsedHeaders Property ([S3](#s3-module) Module) This property includes a collection of headers returned from the last request. ## Syntax ```text public var parsedHeaders: Array
{ get {...} } ``` ## Default Value "" ## Remarks This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each [Header](#header-type) in this collection contains information describing that header. [MaxHeaders](#MaxHeaders) can be used to control the maximum number of headers saved. # PartMarker Property ([S3](#s3-module) Module) This property includes a marker indicating what page of parts to return next. ## Syntax ```text public var partMarker: String { get {...} set {...} } ``` ## Default Value "" ## Remarks This property will be populated when [ListParts](#listparts-method-s3-module) is called if the results are paged and there are more pages. To list all parts, continue to call [ListParts](#listparts-method-s3-module) until this property returns empty string. Refer to [ListParts](#listparts-method-s3-module) for more information. NOTE: This property is cleared any time [ServiceProvider](#serviceprovider-property-s3-module) changes; marker values are valid only when used with the provider that generated them. # Parts Property ([S3](#s3-module) Module) This property includes a collection of multipart upload parts. ## Syntax ```text public var parts: Array { get {...} } ``` ## Default Value "" ## Remarks This collection holds a list of [S3Part](#s3part-type) items. Calling [ListParts](#listparts-method-s3-module) will populate this collection. # Proxy Property ([S3](#s3-module) Module) A set of properties related to proxy access. ## Syntax ```text public var proxy: Proxy { get {...} set {...} } ``` ## Default Value "" ## Remarks This property contains fields describing the proxy through which the class will attempt to connect. # QueryParams Property ([S3](#s3-module) Module) This property includes the additional query parameters to be included in the request. ## Syntax ```text public var queryParams: Array { get {...} } ``` ## Default Value "" ## Remarks This is a collection of query parameters that will be added to the request. Parameters can be added using the [AddQueryParam](#addqueryparam-method-s3-module) method. # Range Property ([S3](#s3-module) Module) This property includes the range of bytes to request. ## Syntax ```text public var range: String { get {...} set {...} } ``` ## Default Value "" ## Remarks This property specifies the range of bytes to request from the server. If this property is nonempty when a [GetObject](#getobject-method-s3-module) request is being constructed, a header like *Range: bytes=*Range** will be added to the request, with **Range** substituted with the specified value. Following are the two valid formats for this property's value: - **StartByte*-* - **StartByte*-*EndByte** NOTE: If the [StartByte](#startbyte-property-s3-module) property is greater than zero when [GetObject](#getobject-method-s3-module) is called (i.e., when a download is being resumed), and this property is nonempty, the class will automatically advance the **StartByte** value in the specified range by [StartByte](#startbyte-property-s3-module) bytes when sending the *Range* header to the server. This ensures that the previously downloaded data at the start of the specified range are not downloaded again when the download is resumed. # Region Property ([S3](#s3-module) Module) This property includes the region the module will make requests against. ## Syntax ```text public var region: String { get {...} set {...} } ``` ## Default Value "us-east-1" ## Remarks This property controls which region the class will make requests against; it should be changed to create or access resources in other regions. Each service provider has a different default region, and the class will automatically set this property to the selected service provider's default region anytime [ServiceProvider](#serviceprovider-property-s3-module) changes. The custom service provider's "default region" is an empty string (i.e., setting [ServiceProvider](#serviceprovider-property-s3-module) to *spCustom (255)* will clear this property). NOTE: When the custom service provider is selected, the class uses the base URL specified by the [ServiceProviderURL](#ServiceProviderURL) configuration setting to generate request URLs. If the base URL contains a *%region%* token, the class will replace it with this property's value any time it generates a request URL. Refer to the [ServiceProviderURL](#ServiceProviderURL) setting's documentation for more information. ### Amazon S3 Regions | Value | Region | | --- | --- | | us-east-1 (Default) | US East (Northern Virginia) | | us-east-2 | US East (Ohio) | | us-west-1 | US West (Northern California) | | us-west-2 | US West (Oregon) | | ap-east-1 | Asia Pacific (Hong Kong) | | ap-northeast-1 | Asia Pacific (Tokyo) | | ap-northeast-2 | Asia Pacific (Seoul) | | ap-northeast-3 | Asia Pacific (Osaka-Local) | | ap-south-1 | Asia Pacific (Mumbai) | | ap-southeast-1 | Asia Pacific (Singapore) | | ap-southeast-2 | Asia Pacific (Sydney) | | ca-central-1 | Canada (Central) | | cn-north-1 | China (Beijing) | | cn-northwest-1 | China (Ningxia) | | eu-central-1 | Europe (Frankfurt) | | eu-north-1 | Europe (Stockholm) | | eu-south-1 | Europe (Milan) | | eu-west-1 | Europe (Ireland) | | eu-west-2 | Europe (London) | | eu-west-3 | Europe (Paris) | | me-south-1 | Middle East (Bahrain) | | sa-east-1 | South America (Sao Paulo) | ### Alibaba Cloud Object Storage Regions | Value | Region | | --- | --- | | oss-ap-northeast-1 | Japan (Tokyo) | | oss-ap-south-1 | India (Mumbai) | | oss-ap-southeast-1 | Singapore | | oss-ap-southeast-2 | Australia (Sydney) | | oss-ap-southeast-3 | Malaysia (Kuala Lumpur) | | oss-ap-southeast-5 | Indonesia (Jakarta) | | oss-cn-beijing (default) | China (Beijing) | | oss-cn-chengdu | China (Chengdu) | | oss-cn-hangzhou | China (Hangzhou) | | oss-cn-heyuan | China (Heyuan) | | oss-cn-hongkong | China (Hong Kong) | | oss-cn-huhehaote | China (Hohhot) | | oss-cn-qingdao | China (Qingdao) | | oss-cn-shanghai | China (Shanghai) | | oss-cn-shenzhen | China (Shenzhen) | | oss-cn-zhangjiakou | China (Zhangjiakou) | | oss-eu-central-1 | Germany (Frankfurt) | | oss-eu-west-1 | UK (London) | | oss-me-east-1 | UAE (Dubai) | | oss-us-east-1 | US (Virginia) | | oss-us-west-1 | US (Silicon Valley) | ### Backblaze B2 Regions All Backblaze B2 region strings take the form *us-west-###*, where *###* is a three-digit number. By default, the class uses *us-west-000*. To determine the exact region string, log into the Backblaze B2 web console and refer to the "S3 Endpoint" value, which corresponds to the application keypair that will be used for authentication; this endpoint value will include the region string. NOTE: The master application key for a Backblaze B2 account cannot be used with Backblaze's S3-compatible API; create a nonmaster application key if necessary. ### Cloudflare R2 Regions By default, the class uses *auto*. This is the only valid value for this service provider. ### Digital Ocean Spaces Regions | Value | Region | | --- | --- | | ams2 | Amsterdam 2 | | ams3 | Amsterdam 3 | | blr1 | Bangalore 1 | | fra1 | Frankfurt 1 | | lon1 | London 1 | | nyc1 | New York 1 | | nyc2 | New York 2 | | nyc3 (Default) | New York 3 | | sfo1 | San Francisco 1 | | sfo2 | San Francisco 2 | | sgp1 | Singapore 1 | | tor1 | Toronto 1 | ### Google Cloud Storage Regions | Value | Region | | --- | --- | | us* (Default) | Multiple U.S. data centers | | us-central1 | US Central (Iowa) | | us-east1 | US East (South Carolina) | | us-east4 | US East (Northern Virginia) | | us-west1 | US West (Oregon) | | us-west2 | US West (Los Angeles) | | asia* | Multiple Asia data centers | | asia-east1 | Asia East (Taiwan) | | asia-east2 | Asia East (Hong Kong) | | asia-northeast1 | Asia Northeast (Tokyo) | | asia-south1 | Asia South (Mumbai) | | asia-southeast1 | Asia Southeast (Singapore) | | australia-southeast1 | Australia Southeast (Sydney) | | eu* | Multiple EU data centers | | europe-north1 | Europe North (Finland) | | europe-west1 | Europe West (Belgium) | | europe-west2 | Europe West (London) | | europe-west3 | Europe West (Frankfurt) | | europe-west4 | Europe West (Netherlands) | | northamerica-northeast1 | Canada (Montreal) | | southamerica-east1 | Brazil (Sao Paulo) | *An asterisk (*) denotes a multiregional location.* ### Huawei Cloud Object Storage Regions | Value | Region | | --- | --- | | af-south-1 | Johannesburg | | ap-southeast-1 | Hong Kong | | ap-southeast-2 | Bangkok | | ap-southeast-3 | Singapore | | cn-east-2 | Shanghai | | cn-east-3 | Shanghai | | cn-north-1 (default) | Beijing | | cn-north-4 | Beijing | | cn-south-1 | Guangzhou | | la-south-2 | Santiago | | na-mexico-1 | Mexico City | | sa-argentina-1 | Buenos Aires | | sa-brazil-1 | Sao Paulo | | sa-chile-1 | Santiago | | sa-peru-1 | Lima | ### IBM Cloud Object Storage Regions | Value | Region | | --- | --- | | Cross-Region | | | us (default) | US Cross Region | | dal.us | US Cross Region (Dallas access point) | | sjc.us | US Cross Region (San Jose access point) | | wdc.us | US Cross Region (Washington, DC, access point) | | eu | EU Cross Region | | ams.eu | EU Cross Region (Amsterdam access point) | | fra.eu | EU Cross Region (Frankfurt access point) | | mil.eu | EU Cross Region (Milan access point) | | ap | Asia Pacific Cross Region | | hkg.ap | Asia Pacific Cross Region (Hong Kong access point) | | seo.ap | Asia Pacific Cross Region (Seoul access point) | | tok.ap | Asia Pacific Cross Region (Tokyo access point) | | Regional | | | au-syd | Australia (Sydney) | | eu-de | EU (Germany) | | eu-gb | EU (United Kingdom) | | jp-tok | Japan (Tokyo) | | us-east | US (East) | | us-south | US (South) | | Single-Site | | | ams03 | Netherlands (Amsterdam) | | che01 | India (Chennai) | | hkg02 | Hong Kong | | mel01 | Australia (Melbourne) | | mex01 | Mexico (Mexico City) | | mil01 | Italy (Milan) | | mon01 | Canada (Montreal) | | osl01 | Norway (Oslo) | | par01 | France (Paris) | | sao01 | Brazil (Sao Paulo) | | seo01 | South Korea (Seoul) | | sjc04 | US (San Jose) | | sng01 | Singapore | | tor01 | Canada (Toronto) | NOTE: Optionally, *private.* or *direct.* may be prepended to any of the values above; refer to IBM Cloud's Object Storage documentation for information on regions and endpoints. ### Linode Object Storage Regions | Value | Region | | --- | --- | | us-east-1 (default) | US East (Newark) | | eu-central-1 | EU Central (Frankfurt) | **Important:** Each "region" supported by Linode's Object Storage service is actually a completely standalone storage cluster. These clusters ***do not*** interact with each other in any way, which causes the following nonstandard behaviors: - Bucket names may be reused in each region (however, they must still be "globally" unique *within* each region). - The [ListBuckets](#listbuckets-method-s3-module) method will return only those buckets located in the currently selected region; there is no way to retrieve a list of all regions' buckets. - Similarly, the [BucketExists](#bucketexists-method-s3-module) and [GetBucketLocation](#getbucketlocation-method-s3-module) methods consider only those buckets located in the currently selected region. - The [CopyObject](#copyobject-method-s3-module) method cannot be used to copy objects to a bucket in another region. ### Oracle Cloud Object Storage Regions | Value | Region | | --- | --- | | Commercial Cloud Regions | | | ap-hyderabad-1 | India South (Hyderabad) | | ap-melbourne-1 | Australia Southeast (Melbourne) | | ap-mumbai-1 | India West (Mumbai) | | ap-osaka-1 | Japan Central (Osaka) | | ap-seoul-1 | South Korea Central (Seoul) | | ap-sydney-1 | Australia East (Sydney) | | ap-tokyo-1 | Japan East (Tokyo) | | ca-montreal-1 | Canada Southeast (Montreal) | | ca-toronto-1 | Canada Southeast (Toronto) | | eu-amsterdam-1 | Netherlands Northwest (Amsterdam) | | eu-frankfurt-1 | Germany Central (Frankfurt) | | eu-zurich-1 | Switzerland North (Zurich) | | me-jeddah-1 | Saudi Arabia West (Jeddah) | | sa-saopaulo-1 | Brazil East (Sao Paulo) | | uk-london-1 | UK South (London) | | us-ashburn-1 (default) | US East (Ashburn, Virginia) | | us-phoenix-1 | US West (Phoenix, Arizona) | | US Gov FedRAMP High Regions | | | us-langley-1 | US Gov East (Ashburn, Virginia) | | us-luke-1 | US Gov West (Phoenix, Arizona) | | US Gov DISA IL5 Regions | | | us-gov-ashburn-1 | US DoD East (Ashburn, Virginia) | | us-gov-chicago-1 | US DoD North (Chicago, Illinois) | | us-gov-phoenix-1 | US DoD West (Phoenix, Arizona) | ### Wasabi Regions | Value | Region | | --- | --- | | eu-central-1 | Europe (Amsterdam) | | us-east-1 (Default) | US East (Ashburn, Virginia) | | us-east-2 | US East (Manassas, Virginia) | | us-west-1 | US West (Hillsboro, Oregon) | The class will always convert this property's value to lowercase. If this property is cleared, the class will reset it to the default value for the currently selected [ServiceProvider](#serviceprovider-property-s3-module). # SecretKey Property ([S3](#s3-module) Module) This property includes the secret key to use for authentication. ## Syntax ```text public var secretKey: String { get {...} set {...} } ``` ## Default Value "" ## Remarks This property specifies the secret key that should be used for authentication. Both this property and [AccessKey](#accesskey-property-s3-module) must be set before attempting any operations that connect to the server. # ServiceProvider Property ([S3](#s3-module) Module) This property includes the S3 service provider to use. ## Syntax ```text public var serviceProvider: S3ServiceProviders { get {...} set {...} } public enum S3ServiceProviders: Int32 { case spAmazonS3 = 0 case spDigitalOcean = 1 case spGoogleStorage = 2 case spWasabi = 3 case spBackblazeB2 = 4 case spHuawei = 5 case spAlibaba = 6 case spIBM = 7 case spOracle = 8 case spLinode = 9 case spCloudflareR2 = 10 case spSeagateLyveCloud = 11 case spOortDSS = 12 case spTencent = 13 case spSupabase = 14 case spCustom = 255 } ``` ## Default Value 0 ## Remarks This property specifies the S3 service provider that the class should use. Possible values are as follows: | | | | --- | --- | | spAmazonS3 (0) (default) | Amazon S3 | | spDigitalOcean (1) | Digital Ocean Spaces | | spGoogleStorage (2) | Google Cloud Storage | | spWasabi (3) | Wasabi | | spBackblazeB2 (4) | Backblaze B2 | | spHuawei (5) | Huawei Cloud Object Storage | | spAlibaba (6) | Alibaba Cloud Object Storage | | spIBM (7) | IBM Cloud Object Storage | | spOracle (8) | Oracle Cloud Object Storage | | spLinode (9) | Linode Object Storage | | spCloudflareR2 (10) | Cloudflare R2 | | spSeagateLyveCloud (11) | Seagate Lyve Cloud | | spOortDSS (12) | Oort DSS | | spTencent (13) | Tencent Cloud Object Storage (COS) | | spSupabase (14) | Supabase Storage | | spCustom (255) | Custom service provider | NOTE: The following providers require additional configuration before requests can be made: - *spOracle (8)*: An *Object Storage Namespace* must be specified using the [OracleNamespace](#OracleNamespace) configuration setting. - *spCloudflareR2 (10)*: An *Account ID* must be specified using the [CloudflareAccountID](#CloudflareAccountID) configuration setting. - *spSupabase (14)*: A *base URL* pointing to the Supabase project's S3 endpoint must be specified using the [ServiceProviderURL](#ServiceProviderURL) configuration setting. - *spCustom (255)*: A *base URL* must be specified using the [ServiceProviderURL](#ServiceProviderURL) configuration setting. Changing this property will automatically result in the following actions: - Set the [Region](#region-property-s3-module) property to the default region for the provider (empty string for *spCustom (255)*). - Reset the [UseSSL](#usessl-property-s3-module) property to *true*. - Reset the [StartByte](#startbyte-property-s3-module) property to *0*. - Clear the [ObjectMarker](#objectmarker-property-s3-module), [PartMarker](#partmarker-property-s3-module), and [VersionMarker](#versionmarker-property-s3-module) properties, as well as the [StorageClass](#StorageClass) and [ResumableUploadState](#ResumableUploadState) configuration settings. # SSLAcceptServerCert Property ([S3](#s3-module) Module) Instructs the module to unconditionally accept the server certificate that matches the supplied certificate. ## Syntax ```text public var sslAcceptServerCert: Certificate { get {...} set {...} } ``` ## Default Value "" ## Remarks If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error. You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally. NOTE: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk. # SSLCert Property ([S3](#s3-module) Module) The certificate to be used during Secure Sockets Layer (SSL) negotiation. ## Syntax ```text public var sslCert: Certificate { get {...} set {...} } ``` ## Default Value "" ## Remarks This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields. # SSLProvider Property ([S3](#s3-module) Module) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax ```text public var sslProvider: S3SSLProviders { get {...} set {...} } public enum S3SSLProviders: Int32 { case sslpAutomatic = 0 case sslpPlatform = 1 case sslpInternal = 2 } ``` ## Default Value 0 ## Remarks This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used. Possible values are as follows: | | | | --- | --- | | 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. | | 1 (sslpPlatform) | Uses the platform/system implementation. | | 2 (sslpInternal) | Uses the internal implementation. | **Additional Notes** In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform. When Automatic is selected, the platform implementation will be used by default in all cases in the macOS edition. # SSLServerCert Property ([S3](#s3-module) Module) The server certificate for the last established connection. ## Syntax ```text public var sslServerCert: Certificate { get {...} } ``` ## Default Value "" ## Remarks This property contains the server certificate for the last established connection. SSLServerCert is reset every time a new connection is attempted. # StartByte Property ([S3](#s3-module) Module) This property includes the byte offset from which to resume the upload or download. ## Syntax ```text public var startByte: Int64 { get {...} set {...} } ``` ## Default Value 0 ## Remarks This property specifies the byte offset from which to resume an automatic multipart upload initiated by [CreateObject](#createobject-method-s3-module), or a download initiated by [GetObject](#getobject-method-s3-module). Refer to those methods' documentation for more information about resuming uploads and downloads. NOTE: This property is automatically reset to *0* anytime [ServiceProvider](#serviceprovider-property-s3-module) changes. # Timeout Property ([S3](#s3-module) Module) The timeout for the module. ## Syntax ```text public var timeout: Int32 { get {...} set {...} } ``` ## Default Value 60 ## Remarks If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered. If Timeout is set to a positive value, the class will wait for the operation to complete before returning control. The class will use [DoEvents](#doevents-method-s3-module) to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive. If Timeout expires, and the operation is not yet complete, the class . NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received. The default value for the Timeout property is 60 seconds. # UseSSL Property ([S3](#s3-module) Module) This method includes whether to use SSL/TLS when connecting. ## Syntax ```text public var useSSL: Bool { get {...} set {...} } ``` ## Default Value True ## Remarks This property specifies whether the class should use Secure Sockets Layer/Transport Layer Security (SSL/TLS) when connecting. NOTE: This property is automatically reset to *true* any time [ServiceProvider](#serviceprovider-property-s3-module) changes. The class will ignore any attempts to change this property if one of the following providers is selected, because they require SSL/TLS to be used: - *spDigitalOcean (1)* - *spBackblazeB2 (4)* - *spOracle (8)* - *spSeagateLyveCloud (11)* # UseVirtualHosting Property ([S3](#s3-module) Module) This property determines which URL style to use when making requests. ## Syntax ```text public var useVirtualHosting: Bool { get {...} set {...} } ``` ## Default Value True ## Remarks If *true* (default), virtual-hosted-style URLs will be used to make requests: *http://yourbucket.s3.amazonaws.com/yourobject*. NOTE: Hosted-style URLs impose more bucket name restrictions because of DNS server naming restrictions. Refer to Amazon's documentation for more information. If *false*, path-style URLs will be used to make requests: *http://s3.amazonaws.com/yourbucket/yourobject*. NOTE: When using the *spAmazonS3 (0)* service provider, keep in mind that Amazon has [publicly announced](https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAPI.html) that buckets created after September 30, 2020, will *only* support virtual-hosted-style URLs. Buckets created on or before September 30, 2020, will continue to support both URL styles. NOTE: This property is ignored when [ServiceProvider](#serviceprovider-property-s3-module) is set to one of the following: - *spAlibaba (6)* Alibaba does not support path-style URLs, only virtual-hosted-style URLs. - *spOracle (8)* Oracle Cloud Object Storage does not support virtual-hosted-style URLs, only path-style URLs. - *spOortDSS (12)* Oort DSS does not support virtual-hosted-style URLs, only path-style URLs. - *spSupabase (14)* Supabase Storage does not support virtual-hosted-style URLs, only path-style URLs. # VersionId Property ([S3](#s3-module) Module) This property includes the object version to make requests against. ## Syntax ```text public var versionId: String { get {...} set {...} } ``` ## Default Value "" ## Remarks This property can be set to the Id of a specific object version before calling the following methods to make requests against the specified object version instead of the base object; refer to each one's documentation for more information: - [CopyObject](#copyobject-method-s3-module) (to copy *from* a specific object version) - [DeleteObject](#deleteobject-method-s3-module) - [GetLink](#getlink-method-s3-module) (to build a link for a specific object version) - [GetObject](#getobject-method-s3-module) - [GetObjectInfo](#getobjectinfo-method-s3-module) - [SendCustomRequest](#sendcustomrequest-method-s3-module) - [UpdateObjectACL](#updateobjectacl-method-s3-module) Refer to Amazon's [Versioning](https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html) documentation for more information about versioning. # VersionMarker Property ([S3](#s3-module) Module) This property includes a marker indicating what page of object versions to return next. ## Syntax ```text public var versionMarker: String { get {...} set {...} } ``` ## Default Value "" ## Remarks This property will be populated when [ListVersions](#listversions-method-s3-module) is called if the results are paged and there are more pages. To list all object versions, continue to call [ListVersions](#listversions-method-s3-module) until this property returns empty string. Refer to [ListVersions](#listversions-method-s3-module) for more information. NOTE: This property is cleared any time [ServiceProvider](#serviceprovider-property-s3-module) changes; marker values are valid only when used with the provider that generated them. # AbortMultipartUpload Method ([S3](#s3-module) Module) This method aborts a multipart upload. ## Syntax ```text public func abortMultipartUpload(objectName: String, uploadId: String) throws -> Void ``` ## Remarks This method aborts the multipart upload of the object named *ObjectName* specified by *UploadId*. When this method is called, all parts that have been uploaded for the multipart upload are deleted from the server. NOTE: If any part of the upload is currently in progress, it may be necessary to call this method again after the upload is complete. If this method is called successfully, the specified *UploadId* will no longer be valid. # AddMetadata Method ([S3](#s3-module) Module) Adds a metadata item to the Metadata properties. ## Syntax ```text public func addMetadata(name: String, value: String) throws -> Void ``` ## Remarks This method adds a metadata item to the [Metadata](#metadata-property-s3-module) collection. *Name* specifies the name of the item, and *Value* specifies the value of the item. The server stores metadata names in lowercase. If *Name* begins with a service-specific metadata (e.g., *x-amz-meta-*, *x-goog-meta-*), it will be stripped off. The class will take care of prepending it when sending metadata to the server. # AddQueryParam Method ([S3](#s3-module) Module) This method adds a query parameter to the QueryParams properties. ## Syntax ```text public func addQueryParam(name: String, value: String) throws -> Void ``` ## Remarks This method is used to add a query parameter to the [QueryParams](#queryparams-property-s3-module) collection. *Name* specifies the name of the parameter, and *Value* specifies the value of the parameter. All specified *Values* will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters. # AppendObject Method ([S3](#s3-module) Module) This method appends data to the end of the existing object specified by ObjectName . ## Syntax ```text public func appendObject(objectName: String) throws -> Void ``` ## Remarks The data to upload are taken from either or [ObjectData](#objectdata-property-s3-module) (whichever data are found first, when checked in that order). # BucketExists Method ([S3](#s3-module) Module) This method checks whether the bucket exists. ## Syntax ```text public func bucketExists() throws -> Bool ``` ## Remarks This method checks whether the bucket specified by [Bucket](#bucket-property-s3-module) exists, returning *true* if so or *false* if not. NOTE: When [ServiceProvider](#serviceprovider-property-s3-module) is *spLinode (9)*, this method considers only buckets located in the currently selected [Region](#region-property-s3-module). Refer to the Linode section of the [Region](#region-property-s3-module) property's documentation for more information. # CheckVersioningEnabled Method ([S3](#s3-module) Module) This method checks whether versioning is enabled for the currently selected bucket. ## Syntax ```text public func checkVersioningEnabled() throws -> Bool ``` ## Remarks This method can be used to check whether the bucket currently selected by [Bucket](#bucket-property-s3-module) has versioning enabled. NOTE: If [Bucket](#bucket-property-s3-module) is empty, or refers to a bucket that does not exist, this property will always return *false* when queried, and any attempts to set it will fail. This behavior also occurs if the currently selected service provider does not support versioning at all. Refer to Amazon's [Versioning](https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html) documentation for more information about versioning. NOTE: When [ServiceProvider](#serviceprovider-property-s3-module) is *spBackblazeB2 (4)*, this property will always return *true* (assuming [Bucket](#bucket-property-s3-module) is nonempty), and any attempt to change it will fail; Backblaze B2 buckets are always versioned. # CompleteMultipartUpload Method ([S3](#s3-module) Module) This method completes a multipart upload by assembling previously uploaded parts. ## Syntax ```text public func completeMultipartUpload(objectName: String, uploadId: String) throws -> Void ``` ## Remarks This method completes the multipart upload specified by *UploadId*. The server will assemble all of the parts that have been uploaded into an object named *ObjectName*. NOTE: This method automatically calls [ListParts](#listparts-method-s3-module) internally to obtain the information needed to complete the multipart upload. This process does not alter the [Parts](#parts-property-s3-module) collection, nor does it cause the [PartList](#partlist-event-s3-module) event to fire. The *spCloudflareR2 (10)* [ServiceProvider](#serviceprovider-property-s3-module) does not support the ListParts S3 operation; thus, when that provider is selected, this method instead relies on the part information contained in the [PartInfo\[i\]](#PartInfo[i]) configuration setting. # Config Method ([S3](#s3-module) Module) Sets or retrieves a configuration setting. ## Syntax ```text public func config(configurationString: String) throws -> String ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-s3-module) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-s3-module), you must call *Config("PROPERTY")*. The value will be returned as a string. # CopyObject Method ([S3](#s3-module) Module) This method copies an object. ## Syntax ```text public func copyObject(srcObjectName: String, destBucket: String, destObjectName: String) throws -> Void ``` ## Remarks This method copies the object specified by *SrcObjectName* (in the bucket currently selected by [Bucket](#bucket-property-s3-module)) to the object specified by *DestObjectName* in *DestBucket*. If *DestBucket* is empty, the bucket specified by [Bucket](#bucket-property-s3-module) is used as the destination bucket. If the [VersionId](#versionid-property-s3-module) property is nonempty, the specified version of the source object will be used as the copy source. In this case, *DestObjectName* may be the same as *SrcObjectName* to "promote" the version, copying its contents back to the base object. If any metadata items are present in the [Metadata](#metadata-property-s3-module) collection, they will set on the destination object; otherwise, the server will copy any metadata items present on the source object to the destination object. **Notes:** - Objects may be copied only to buckets that exist within the same region. - Objects larger than 5 GB cannot be copied using this method. To copy such objects, start a new multipart upload for the destination object using [StartMultipartUpload](#startmultipartupload-method-s3-module). Then use the [CopyPart](#copypart-method-s3-module) method to create parts for that multipart upload using the source object's data. # CopyPart Method ([S3](#s3-module) Module) This method copies the specified object as a part of a multipart upload. ## Syntax ```text public func copyPart(srcObjectName: String, destBucket: String, destObjectName: String, destPartNumber: Int32, destUploadId: String) throws -> Void ``` ## Remarks This method copies data from the object specified by *SrcObjectName* (in the bucket currently selected by [Bucket](#bucket-property-s3-module)) to a new multipart upload part for *DestObjectName* in *DestBucket*. The *DestPartNumber* and *DestUploadId* parameters should be used in the same manner as the [UploadPart](#uploadpart-method-s3-module) method's *PartNumber* and *UploadId* parameters. To copy a specific range of bytes from the source object, set the [CopyPartRange](#CopyPartRange) configuration setting before calling this method. NOTE: This method is not supported when [ServiceProvider](#serviceprovider-property-s3-module) is *spGoogleStorage (2)*. # CreateBucket Method ([S3](#s3-module) Module) This method creates a new bucket. ## Syntax ```text public func createBucket() throws -> Void ``` ## Remarks This method creates a new bucket using the name specified by the [Bucket](#bucket-property-s3-module) property. The bucket is created in the region specified by the [Region](#region-property-s3-module) property. # CreateObject Method ([S3](#s3-module) Module) This method creates a new object in the currently selected bucket. ## Syntax ```text public func createObject(objectName: String) throws -> Void ``` ## Remarks This method creates a new object named *Object* in the bucket currently selected by [Bucket](#bucket-property-s3-module). If any metadata items are present in the [Metadata](#metadata-property-s3-module) collection, they will be included in the creation request. If [LocalFile](#localfile-property-s3-module) is set, the file will be uploaded from the specified path. If [LocalFile](#localfile-property-s3-module) is not set, the data in [ObjectData](#objectdata-property-s3-module) will be used. To encrypt the file before uploading it, set [EncryptionAlgorithm](#encryptionalgorithm-property-s3-module) and [EncryptionPassword](#encryptionpassword-property-s3-module). This method can automatically handle the multipart upload of objects (see below). If it is desired to manually take control of the multipart upload process, see [StartMultipartUpload](#startmultipartupload-method-s3-module). ### Automatic Multipart Uploads If more than [SimpleUploadLimit](#SimpleUploadLimit) bytes of data are provided, the class will automatically perform a multipart upload by splitting the data up into parts (sized according to the [FragmentSize](#FragmentSize) configuration setting) and uploading them individually. To accomplish this, the class automatically makes calls to [StartMultipartUpload](#startmultipartupload-method-s3-module), [UploadPart](#uploadpart-method-s3-module), and [CompleteMultipartUpload](#completemultipartupload-method-s3-module) internally; tracks the upload state information using the [ResumableUploadState](#ResumableUploadState) configuration setting; and tracks how much data have been uploaded using the [StartByte](#startbyte-property-s3-module) property. The [FragmentComplete](#fragmentcomplete-event-s3-module) event will fire after each part is uploaded. If, during an automatic multipart upload, any individual request fails, the upload can be resumed be calling this method again with the same parameters, so long as [ResumableUploadState](#ResumableUploadState) and [StartByte](#startbyte-property-s3-module) contain the same values as they did when the upload was interrupted. When an automatic multipart upload completes successfully, [ResumableUploadState](#ResumableUploadState) is cleared and [StartByte](#startbyte-property-s3-module) is reset to *0*. # DeleteBucket Method ([S3](#s3-module) Module) This method deletes a bucket. ## Syntax ```text public func deleteBucket() throws -> Void ``` ## Remarks This method deletes the bucket currently selected by [Bucket](#bucket-property-s3-module). NOTE: For some service providers, bucket names share a global namespace, and it may not be possible to recreate a deleted bucket if its name has been taken by another user in the meantime. Refer to the provider's documentation for more information. # DeleteObject Method ([S3](#s3-module) Module) This method deletes an object. ## Syntax ```text public func deleteObject(objectName: String) throws -> Void ``` ## Remarks This method deletes the object specified by *ObjectName* in the bucket currently selected by [Bucket](#bucket-property-s3-module). If the [VersionId](#versionid-property-s3-module) property is nonempty, this method deletes the specified version of the object instead. ### Deleting Versioned Objects If a bucket has versioning enabled (i.e., [CheckVersioningEnabled](#checkversioningenabled-method-s3-module) returns *true* when queried), and this method is called on an object rather than a specific object version, then instead of actually deleting any data, the server will simply create a special object version called a *delete marker*. If an object's latest version is a delete marker, then the server treats the object as if it did not exist (i.e., it does not appear when listing objects or it cannot be downloaded). If, however, all of the previous versions of the object (including the one that existed just before the delete marker was created) still exist, then they can be listed using [ListVersions](#listversions-method-s3-module) and explicitly can be interacted with by setting [VersionId](#versionid-property-s3-module) and calling an appropriate method. To *permanently* delete objects in a versioning-enabled bucket, each version of the object must be explicitly deleted by setting [VersionId](#versionid-property-s3-module) before calling this method. This includes any delete marker versions, which can be deleted like any other version. Refer to Amazon's [Deleting Object Versions](https://docs.aws.amazon.com/AmazonS3/latest/dev/DeletingObjectVersions.html), [Working with Delete Markers](https://docs.aws.amazon.com/AmazonS3/latest/dev/DeleteMarker.html), and [Removing Delete Markers](https://docs.aws.amazon.com/AmazonS3/latest/dev/RemDelMarker.html) articles for more information. # DisableVersioning Method ([S3](#s3-module) Module) This method disables versioning for the currently selected bucket. ## Syntax ```text public func disableVersioning() throws -> Void ``` ## Remarks This method can be used to disable versioning for the bucket currently selected by [Bucket](#bucket-property-s3-module). Refer to Amazon's [Versioning](https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html) documentation for more information about versioning. # DoEvents Method ([S3](#s3-module) Module) This method processes events from the internal message queue. ## Syntax ```text public func doEvents() throws -> Void ``` ## Remarks When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns. # EnableVersioning Method ([S3](#s3-module) Module) This method enables versioning for the currently selected bucket. ## Syntax ```text public func enableVersioning() throws -> Void ``` ## Remarks This method can be used to enable versioning for the bucket currently selected by [Bucket](#bucket-property-s3-module). Refer to Amazon's [Versioning](https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html) documentation for more information about versioning. # GetBucketLocation Method ([S3](#s3-module) Module) This method gets a bucket's location. ## Syntax ```text public func getBucketLocation() throws -> String ``` ## Remarks This method retrieves and returns the location (i.e., region) of the bucket currently selected by [Bucket](#bucket-property-s3-module). NOTE: When [ServiceProvider](#serviceprovider-property-s3-module) is *spLinode (9)*, this method considers only buckets located in the currently selected [Region](#region-property-s3-module). Refer to the Linode section of the [Region](#region-property-s3-module) property's documentation for more information. # GetLink Method ([S3](#s3-module) Module) This method creates a link that provides access to an object for a specified amount of time. ## Syntax ```text public func getLink(objectName: String, expires: Int32) throws -> String ``` ## Remarks This method creates and returns a preauthenticated link that provides access to the object specified by *ObjectName* in the bucket currently selected by [Bucket](#bucket-property-s3-module). If the [VersionId](#versionid-property-s3-module) property is nonempty, a link is created for the specified version of the object. The *Expires* parameter specifies how many seconds the link should be valid for. The maximum validity period is seven days. NOTE: This method is an offline method that simply generates a presigned URL; no communication with the server takes place. NOTE: This method is not supported when [ServiceProvider](#serviceprovider-property-s3-module) is set to one of the following: - *spGoogleStorage (2)* - *spOracle (8)* # GetObject Method ([S3](#s3-module) Module) This method downloads an object. ## Syntax ```text public func getObject(objectName: String) throws -> Void ``` ## Remarks This methods downloads the object specified by *ObjectName* in the bucket currently selected by [Bucket](#bucket-property-s3-module). If the [VersionId](#versionid-property-s3-module) property is nonempty, the specified version of the object is downloaded instead. The [Range](#range-property-s3-module) property can be used to download a specific range of bytes from the object. If [LocalFile](#localfile-property-s3-module) is set, the object data will be saved to the specified location; otherwise, the object data will be held by [ObjectData](#objectdata-property-s3-module). To download and decrypt an encrypted object, set [EncryptionAlgorithm](#encryptionalgorithm-property-s3-module) and [EncryptionPassword](#encryptionpassword-property-s3-module) before calling this method. ### Download Notes In the simplest use-case, downloading an object looks like this: ```text s3.LocalFile = "../MyData.zip"; s3.GetObject(s3.Objects[0].Name); ``` **Example 1. Resuming Downloads:** The class also supports resuming failed downloads by using the [StartByte](#startbyte-property-s3-module) property. If a download is interrupted, set [StartByte](#startbyte-property-s3-module) to the appropriate offset before calling this method to resume the download. ```text string downloadFile = "../MyData.zip"; s3.LocalFile = downloadFile; s3.GetObject(s3.Objects[0].Name); //The transfer is interrupted and GetObject() above fails. Later, resume the download: //Get the size of the partially downloaded file s3.StartByte = new FileInfo(downloadFile).Length; s3.GetObject(s3.Objects[0].Name); ``` **Example 2. Resuming Encrypted File Downloads:** Resuming encrypted file downloads is supported only when [LocalFile](#localfile-property-s3-module) has been set in the initial download attempt. If [LocalFile](#localfile-property-s3-module) is set when beginning an encrypted download, the class creates a temporary file in [TempPath](#TempPath) to hold the encrypted data until the download is complete. If the download is interrupted, [DownloadTempFile](#DownloadTempFile) will be populated with the path of the temporary file that holds the partial data. To resume, [DownloadTempFile](#DownloadTempFile) must be populated, along with [StartByte](#startbyte-property-s3-module), to allow the remainder of the encrypted data to be downloaded. Once the encrypted data are downloaded, it will be decrypted and written to [LocalFile](#localfile-property-s3-module). ```text s3.LocalFile = "../MyData.zip"; s3.EncryptionPassword = "password"; s3.GetObject(s3.Objects[0].Name); //The transfer is interrupted and GetObject() above fails. Later, resume the download: //Get the size of the partially downloaded temp file s3.StartByte = new FileInfo(s3.Config("DownloadTempFile")).Length; s3.GetObject(s3.Objects[0].Name); ``` # GetObjectInfo Method ([S3](#s3-module) Module) This method gets an object's information and metadata. ## Syntax ```text public func getObjectInfo(objectName: String) throws -> Void ``` ## Remarks This method gets information and metadata for the object specified by *Object* in the bucket currently selected by [Bucket](#bucket-property-s3-module). If the [VersionId](#versionid-property-s3-module) property is nonempty, information and metadata for the specified version of the object is retrieved instead. Calling this method will fire the [ObjectList](#objectlist-event-s3-module) and [MetadataList](#metadatalist-event-s3-module) events and also will repopulate the [Objects](#objects-property-s3-module) and [Metadata](#metadata-property-s3-module) collection properties. # Interrupt Method ([S3](#s3-module) Module) This method interrupts the current method. ## Syntax ```text public func interrupt() throws -> Void ``` ## Remarks If there is no method in progress, Interrupt simply returns, doing nothing. # ListBuckets Method ([S3](#s3-module) Module) This method lists all buckets in the account. ## Syntax ```text public func listBuckets() throws -> Void ``` ## Remarks This method lists all buckets in the account. Calling this method will fire the [BucketList](#bucketlist-event-s3-module) event once for each bucket and also will populate the [Buckets](#buckets-property-s3-module) collection. NOTE: When [ServiceProvider](#serviceprovider-property-s3-module) is *spLinode (9)*, this method returns only buckets located in the currently selected [Region](#region-property-s3-module), and it is not possible to retrieve a list of all regions' buckets. Refer to the Linode section of the [Region](#region-property-s3-module) property's documentation for more information. # ListMultipartUploads Method ([S3](#s3-module) Module) This method lists the current multipart uploads. ## Syntax ```text public func listMultipartUploads() throws -> Void ``` ## Remarks This method lists the current multipart uploads in the bucket currently selected by [Bucket](#bucket-property-s3-module). Before calling this method, the [ObjectPrefix](#objectprefix-property-s3-module) property may be set to restrict the results to only the multipart uploads whose names begin with a given string. The [ObjectDelimiter](#objectdelimiter-property-s3-module) property also can be used to further tune the results returned. The [MaxObjects](#MaxObjects) configuration setting may be used to limit the number of results returned. Calling this method will fire the [ObjectList](#objectlist-event-s3-module) event once for each multipart upload and also will populate the [Objects](#objects-property-s3-module) collection. If more multipart uploads are still available to list when this method returns, the [ObjectMarker](#objectmarker-property-s3-module) property will be populated. Continue to call this method until [ObjectMarker](#objectmarker-property-s3-module) is empty to accumulate all of the pages of results in the [Objects](#objects-property-s3-module) collection. NOTE: This method is not supported when [ServiceProvider](#serviceprovider-property-s3-module) is *spOortDSS (12)*. NOTE: When the [ServiceProvider](#serviceprovider-property-s3-module) is *spSeagateLyveCloud (11)* the [ObjectPrefix](#objectprefix-property-s3-module) property must be specified. # ListObjects Method ([S3](#s3-module) Module) This method lists the objects in a bucket. ## Syntax ```text public func listObjects() throws -> Void ``` ## Remarks This method lists the objects in the bucket currently selected by [Bucket](#bucket-property-s3-module). Before calling this method, the [ObjectPrefix](#objectprefix-property-s3-module) property may be set to restrict the results to only those objects whose names begin with a given string. The [ObjectDelimiter](#objectdelimiter-property-s3-module) property also can be used to further tune the results returned. The [MaxObjects](#MaxObjects) configuration setting may be used to limit the number of results returned. Calling this method will fire the [ObjectList](#objectlist-event-s3-module) event once for each object and also will populate the [Objects](#objects-property-s3-module) collection. It also may fire the [PrefixList](#prefixlist-event-s3-module) event and populate the [PrefixCount](#PrefixCount) and [Prefix\[i\]](#Prefix[i]) configuration settings, depending on how the properties discussed above are set. If more objects are still available to list when this method returns, the [ObjectMarker](#objectmarker-property-s3-module) property will be populated. Continue to call this method until [ObjectMarker](#objectmarker-property-s3-module) is empty to accumulate all of the pages of results in the [Objects](#objects-property-s3-module) collection. ### Object Hierarchy Traversal By using the [ObjectDelimiter](#objectdelimiter-property-s3-module) and [ObjectPrefix](#objectprefix-property-s3-module) properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket: - *MyCompany/* - *MyCompany/Department1/* - *MyCompany/Department2/* - *MyCompany/Department2/EmployeeA* - *MyCompany/Department2/EmployeeB* With [ObjectDelimiter](#objectdelimiter-property-s3-module) set to */*, we can set [ObjectPrefix](#objectprefix-property-s3-module) to successively "deeper" values before calling ListObjects or [ListVersions](#listversions-method-s3-module) for the following effect: | [ObjectPrefix](#objectprefix-property-s3-module) Value | [ObjectDelimiter](#objectdelimiter-property-s3-module) Value | Objects Returned | Prefixes Returned | | --- | --- | --- | --- | | (empty) | / | (none) | MyCompany/ | | MyCompany/ | / | MyCompany/ | MyCompany/Department1/ MyCompany/Department2/ | | MyCompany/Department2/ | / | MyCompany/Department2/ MyCompany/Department2/EmployeeA MyCompany/Department2/EmployeeB | (none) | # ListParts Method ([S3](#s3-module) Module) This method lists the parts in a multipart upload. ## Syntax ```text public func listParts(objectName: String, uploadId: String) throws -> Void ``` ## Remarks This method lists the parts in the multipart upload of *ObjectName* specified by *UploadId*. The [MaxParts](#MaxParts) configuration setting may be used to limit the number of results returned. Calling this method will fire the [PartList](#partlist-event-s3-module) event once for each part and also will populate the [Parts](#parts-property-s3-module) collection. If more parts are still available to list when this method returns, the [PartMarker](#partmarker-property-s3-module) property will be populated. Continue to call this method until [PartMarker](#partmarker-property-s3-module) is empty to accumulate all of the pages of results in the [Parts](#parts-property-s3-module) collection. This method *does not* need to be called before attempting to complete a multipart upload with [CompleteMultipartUpload](#completemultipartupload-method-s3-module); the class will automatically collect the necessary information internally. Refer to [CompleteMultipartUpload](#completemultipartupload-method-s3-module) for more information. NOTE: *spCloudflareR2 (10)* does not support the ListParts S3 operation. # ListVersions Method ([S3](#s3-module) Module) This method lists the object versions in a bucket. ## Syntax ```text public func listVersions() throws -> Void ``` ## Remarks This method lists the object versions in the bucket currently selected by [Bucket](#bucket-property-s3-module). Before calling this method, the [ObjectPrefix](#objectprefix-property-s3-module) property may be set to restrict the results to only the object versions whose names begin with a given string. The [ObjectDelimiter](#objectdelimiter-property-s3-module) property also can be used to further tune the results returned. The [MaxObjects](#MaxObjects) configuration setting may be used to limit the number of results returned. Calling this method will fire the [ObjectList](#objectlist-event-s3-module) event once for each object version and also will populate the [Objects](#objects-property-s3-module) collection. It also may fire the [PrefixList](#prefixlist-event-s3-module) event and populate the [PrefixCount](#PrefixCount) and [Prefix\[i\]](#Prefix[i]) configuration settings, depending on how the properties discussed above are set. If more object versions are still available to list when this method returns, the [VersionMarker](#versionmarker-property-s3-module) property will be populated. Continue to call this method until [VersionMarker](#versionmarker-property-s3-module) is empty to accumulate all pages of results in the [Objects](#objects-property-s3-module) collection. ### Object Hierarchy Traversal By using the [ObjectDelimiter](#objectdelimiter-property-s3-module) and [ObjectPrefix](#objectprefix-property-s3-module) properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket: - *MyCompany/* - *MyCompany/Department1/* - *MyCompany/Department2/* - *MyCompany/Department2/EmployeeA* - *MyCompany/Department2/EmployeeB* With [ObjectDelimiter](#objectdelimiter-property-s3-module) set to */*, we can set [ObjectPrefix](#objectprefix-property-s3-module) to successively "deeper" values before calling [ListObjects](#listobjects-method-s3-module) or ListVersions for the following effect: | [ObjectPrefix](#objectprefix-property-s3-module) Value | [ObjectDelimiter](#objectdelimiter-property-s3-module) Value | Objects Returned | Prefixes Returned | | --- | --- | --- | --- | | (empty) | / | (none) | MyCompany/ | | MyCompany/ | / | MyCompany/ | MyCompany/Department1/ MyCompany/Department2/ | | MyCompany/Department2/ | / | MyCompany/Department2/ MyCompany/Department2/EmployeeA MyCompany/Department2/EmployeeB | (none) | # Reset Method ([S3](#s3-module) Module) This method resets the component to its initial state. ## Syntax ```text public func reset() throws -> Void ``` ## Remarks This method resets the class to its initial state. # ResetHeaders Method ([S3](#s3-module) Module) This method resets all HTTP headers, cookies, and LocalFile. ## Syntax ```text public func resetHeaders() throws -> Void ``` ## Remarks This method resets all HTTP headers as well as [LocalFile](#localfile-property-s3-module) to "" (empty string), and clears the [Metadata](#metadata-property-s3-module) and [QueryParams](#queryparams-property-s3-module) collection properties. Call this method before creating a new request, so that headers and query parameters from the previous request are not carried over to the next request. # SendCustomRequest Method ([S3](#s3-module) Module) This method sends a custom request to the server. ## Syntax ```text public func sendCustomRequest(httpMethod: String, objectName: String, requestBody: String) throws -> Void ``` ## Remarks This method can be used to send arbitrary requests to the server. Valid values for *HttpMethod* are as follows: - *GET* (default if empty) - *HEAD* - *POST* - *PUT* - *DELETE* The *ObjectName* and *RequestBody* parameters may be empty if not needed. ### Usage When this method is called, the class does the following: 1. Builds a request URL, including query parameters, based on the following: - [UseSSL](#usessl-property-s3-module), [Region](#region-property-s3-module), and [UseVirtualHosting](#usevirtualhosting-property-s3-module) for the base URL. - Alternatively, if [ServiceProvider](#serviceprovider-property-s3-module) is *spCustom (255)*, the custom URL specified using the [ServiceProviderURL](#ServiceProviderURL) configuration setting is used directly, and these properties are ignored. - [Bucket](#bucket-property-s3-module) (if nonempty) - *ObjectName* (if nonempty) - [VersionId](#versionid-property-s3-module) (if both it and *ObjectName* are nonempty) - [QueryParams](#queryparams-property-s3-module) 2. Adds request headers from the following: - [ContentDisposition](#contentdisposition-property-s3-module) - [ContentType](#contenttype-property-s3-module) - [OtherHeaders](#otherheaders-property-s3-module) - [SessionToken](#SessionToken) 3. Signs the request (unless the [SignCustomRequest](#SignCustomRequest) configuration setting is disabled). 4. Sends the request, including *RequestBody* if nonempty. 5. Stores the response headers in the [ParsedHeaders](#parsedheaders-property-s3-module) collection; and the response body in the specified [LocalFile](#localfile-property-s3-module), or [ObjectData](#objectdata-property-s3-module) (using the same logic as [GetObject](#getobject-method-s3-module)). If the response body is XML data, then the [XPath](#XPath), [XText](#XText), and other **X*** configuration settings can be used to navigate and extract information from it. # StartMultipartUpload Method ([S3](#s3-module) Module) This method starts a new manual multipart upload. ## Syntax ```text public func startMultipartUpload(objectName: String) throws -> String ``` ## Remarks This method starts a new *manual* multipart upload for an object named *ObjectName*, in the bucket currently selected by [Bucket](#bucket-property-s3-module), and returns the upload Id that the server associates with it. For an *automatic* multipart upload, see the [CreateObject](#createobject-method-s3-module) method. This upload Id can then be used to call the following methods: - [UploadPart](#uploadpart-method-s3-module) - [CopyPart](#copypart-method-s3-module) - [ListParts](#listparts-method-s3-module) - [CompleteMultipartUpload](#completemultipartupload-method-s3-module) - [AbortMultipartUpload](#abortmultipartupload-method-s3-module) If any metadata items are present in the [Metadata](#metadata-property-s3-module) collection, they will be included in the creation request and will be applied to the final object after the multipart upload is completed with [CompleteMultipartUpload](#completemultipartupload-method-s3-module). Multipart uploads never expire, they must be explicitly completed or aborted using [CompleteMultipartUpload](#completemultipartupload-method-s3-module) or [AbortMultipartUpload](#abortmultipartupload-method-s3-module). The [ListMultipartUploads](#listmultipartuploads-method-s3-module) method can be used to retrieve a list of current multipart uploads. # UpdateBucketACL Method ([S3](#s3-module) Module) This method updates a bucket's canned access policy. ## Syntax ```text public func updateBucketACL() throws -> Void ``` ## Remarks This method updates the canned access policy of the bucket selected by [Bucket](#bucket-property-s3-module) to the value specified by [AccessPolicy](#accesspolicy-property-s3-module) # UpdateObjectACL Method ([S3](#s3-module) Module) This method updates an object's canned access policy. ## Syntax ```text public func updateObjectACL(objectName: String) throws -> Void ``` ## Remarks This method updates the caned access policy of the objects specified by *ObjectName*, in the bucket currently selected by [Bucket](#bucket-property-s3-module), to the value specified by [AccessPolicy](#accesspolicy-property-s3-module). If the [VersionId](#versionid-property-s3-module) property is nonempty, the canned access policy of the specified version of the object is updated instead. # UploadPart Method ([S3](#s3-module) Module) This method uploads a multipart upload part. ## Syntax ```text public func uploadPart(objectName: String, partNumber: Int32, uploadId: String) throws -> Void ``` ## Remarks This method uploads a part for the multipart upload of the object named *ObjectName* specified by *UploadId*. *PartNumber* specifies the part's number; it must be a value in the range *1* to *10000*, inclusive. If a part with the given number already exists in the specified multipart upload, it is replaced with the newly uploaded part. The data to upload are taken from either [LocalFile](#localfile-property-s3-module) or [ObjectData](#objectdata-property-s3-module) (whichever data are found first, when checked in that order). Each part must be at least 5 MB in size, except for the last part in the overall multipart upload, which can be any non-zero size. If the [IncludePartMD5](#IncludePartMD5) configuration setting is *true*, the class will include an MD5 digest of its data when sending it to the server. The server then will verify that the data were received without corruption. # BucketList Event ([S3](#s3-module) Module) This event fires once for each bucket returned when listing buckets. ## Syntax ```text func onBucketList(bucketName: String, creationDate: String, ownerId: String, ownerName: String) ``` ## Remarks This event fires once for each bucket returned when [ListBuckets](#listbuckets-method-s3-module) is called. *BucketName* reflects the name of the bucket. *CreationDate* reflects the bucket's creation date. *OwnerId* and *OwnerName* reflect the Id and display the name of the bucket's owner, respectively. # EndTransfer Event ([S3](#s3-module) Module) This event fires when a document finishes transferring. ## Syntax ```text func onEndTransfer(direction: Int32) ``` ## Remarks The EndTransfer event is fired when the document text finishes transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # Error Event ([S3](#s3-module) Module) Fired when information is available about errors during data delivery. ## Syntax ```text func onError(errorCode: Int32, description: String) ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the class . The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-s3-module) section. # FragmentComplete Event ([S3](#s3-module) Module) This event fires after each part in an automatic multipart upload is complete. ## Syntax ```text func onFragmentComplete(fragmentNumber: Int32, fragmentCount: Int32, interrupt: inout Bool) ``` ## Remarks If, when [CreateObject](#createobject-method-s3-module) is called, more than [SimpleUploadLimit](#SimpleUploadLimit) bytes of upload data are present, the class will automatically divide the upload data into parts and perform a multipart upload. During the overall upload process, this event will fire after each part is uploaded, providing an indication of overall upload progress. *FragmentNumber* is the number of the current part of the upload that has been completed. This value starts at *1*. *FragmentCount* is the total number of parts that will be uploaded. *Interrupt* can be set to *true* to interrupt the upload. The upload may be resumed later. Refer to [CreateObject](#createobject-method-s3-module) for more information. # Header Event ([S3](#s3-module) Module) Fired every time a header line comes in. ## Syntax ```text func onHeader(field: String, value: String) ``` ## Remarks The *Field* parameter contains the name of the HTTP header (which is the same as it is delivered). The *Value* parameter contains the header contents. If the header line being retrieved is a continuation header line, then the *Field* parameter contains "" (empty string). # Log Event ([S3](#s3-module) Module) Fired once for each log message. ## Syntax ```text func onLog(logLevel: Int32, message: String, logType: String) ``` ## Remarks This event is fired once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *LogLevel* indicates the level of message. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). *Message* is the log entry. *LogType* identifies the type of log entry. Possible values are as follows: - "Info" - "RequestHeaders" - "ResponseHeaders" - "RequestBody" - "ResponseBody" - "ProxyRequest" - "ProxyResponse" - "FirewallRequest" - "FirewallResponse" # MetadataList Event ([S3](#s3-module) Module) This event fires once for each metadata item returned when object information and metadata are retrieved. ## Syntax ```text func onMetadataList(name: String, value: String) ``` ## Remarks This event fires once for each metadata item returned when [GetObjectInfo](#getobjectinfo-method-s3-module) is called. *Name* is the name of the metadata item, *without* the service-specific prefix (e.g., *x-amz-meta-*, *x-goog-meta-*). NOTE: The server stores metadata names in lowercase. *Value* is the metadata item's value. # ObjectList Event ([S3](#s3-module) Module) This event fires once for each object, object version, or multipart upload returned when listing such items. ## Syntax ```text func onObjectList(bucketName: String, objectName: String, lastModified: String, size: Int64, eTag: String, ownerId: String, ownerName: String, uploadId: String, versionId: String, latestVersion: Bool, deleted: Bool) ``` ## Remarks This event fires once for each object, object version, or multipart upload returned when [GetObjectInfo](#getobjectinfo-method-s3-module), [ListObjects](#listobjects-method-s3-module), [ListVersions](#listversions-method-s3-module), or [ListMultipartUploads](#listmultipartuploads-method-s3-module) is called. *BucketName* reflects the name of the bucket that the object is in. *ObjectName* reflects the name of the object. *LastModified* reflects the last modified time of the object. This is not applicable when [ListMultipartUploads](#listmultipartuploads-method-s3-module) is called. *Size* reflects the size, in bytes, of the object. This is not applicable when [ListMultipartUploads](#listmultipartuploads-method-s3-module) is called. *ETag* reflects the object's ETag. This is not applicable when [ListMultipartUploads](#listmultipartuploads-method-s3-module) is called. *OwnerId* and *OwnerName* reflect the Id and display name of the object's owner, respectively. This is not applicable when [GetObjectInfo](#getobjectinfo-method-s3-module) is called. *UploadId* reflects the Id of the multipart upload. This is applicable only when [ListMultipartUploads](#listmultipartuploads-method-s3-module) is called. *VersionId* reflects the Id of the object version (note that the string *null* is a valid version Id). This is applicable only when [ListVersions](#listversions-method-s3-module) is called, or when [GetObjectInfo](#getobjectinfo-method-s3-module) is called while [VersionId](#versionid-property-s3-module) is nonempty.; is empty in all other cases. *LatestVersion* indicates whether this is the latest object version. This is applicable only when [ListVersions](#listversions-method-s3-module) is called.; is *true* in all other cases. *Deleted* indicates whether this object version is a delete marker (refer to [DeleteObject](#deleteobject-method-s3-module) for more information). This is applicable only when [ListVersions](#listversions-method-s3-module) is called, or when [GetObjectInfo](#getobjectinfo-method-s3-module) is called while [VersionId](#versionid-property-s3-module) is nonempty.; is *false* in all other cases. # PartList Event ([S3](#s3-module) Module) This event fires once for every part returned when listing a multipart upload's parts. ## Syntax ```text func onPartList(partNumber: Int32, objectName: String, lastModified: String, size: Int64, eTag: String, ownerId: String, ownerName: String) ``` ## Remarks This event fires once for each part of a multipart upload that is returned when [ListParts](#listparts-method-s3-module) is called. *PartNumber* reflects the part's number. *ObjectName* reflects the name of the object the multipart upload is for. *LastModified* reflects the last modified time of the part. *Size* reflects the size, in bytes, of the part. *ETag* reflects the part's ETag of the part. *OwnerId* and *OwnerName* reflect the Id and display name of the part's owner, respectively. # PrefixList Event ([S3](#s3-module) Module) This event fires once for each common prefix returned when listing objects. ## Syntax ```text func onPrefixList(bucketName: String, prefix: String) ``` ## Remarks This event fires once for each common prefix returned when [ListObjects](#listobjects-method-s3-module) or [ListVersions](#listversions-method-s3-module) is called when [ObjectDelimiter](#objectdelimiter-property-s3-module) is nonempty. Refer to [ObjectDelimiter](#objectdelimiter-property-s3-module) for more information. *BucketName* reflects the name of the bucket that the prefix is in. *Prefix* is the common prefix. # Progress Event ([S3](#s3-module) Module) This event fires during an upload or download to indicate transfer progress. ## Syntax ```text func onProgress(direction: Int32, bytesTransferred: Int64, totalBytes: Int64, percentDone: Int32) ``` ## Remarks This event fires during an upload or download to indicate the progress of the transfer. By default, this event will fire each time *PercentDone* increases by 1 percent; the [ProgressStep](#ProgressStep) configuration setting can be used to alter this behavior. *Direction* indicates whether the transfer is an upload (*0*) or a download (*1*). *BytesTransferred* reflects the number of bytes that have been transferred so far, or *0* if the transfer is starting (however, see the note below). *TotalBytes* reflects the total number of bytes that are to be transferred, or *-1* if the total is unknown. *PercentDone* reflects the overall progress of the transfer, or *-1* if the progress cannot be calculated. NOTE: By default, the class tracks transfer progress *absolutely*. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that were transferred *before* the interruption. For example, if 10 MB of data were successfully transferred before the interruption, then this event will fire with a *BytesTransferred* value of *10485760* (10 MB) when the transfer is first resumed, and then will continue to fire with successively greater values as usual. This behavior can be changed by disabling the [ProgressAbsolute](#ProgressAbsolute) configuration setting, in which case the class will treat resumed transfers as "new" transfers. In this case, the *BytesTransferred* parameter will always be *0* the first time this event fires, regardless of whether the transfer is new or being resumed. # SSLServerAuthentication Event ([S3](#s3-module) Module) Fired after the server presents its certificate to the client. ## Syntax ```text func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool) ``` ## Remarks During this event, the client can decide whether or not to continue with the connection process. The *Accept* parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue. When *Accept* is False, *Status* shows why the verification failed (otherwise, *Status* contains the string *OK*). If it is decided to continue, you can override and accept the certificate by setting the *Accept* parameter to True. # SSLStatus Event ([S3](#s3-module) Module) Fired when secure connection progress messages are available. ## Syntax ```text func onSSLStatus(message: String) ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # StartTransfer Event ([S3](#s3-module) Module) This event fires when a document starts transferring (after the headers). ## Syntax ```text func onStartTransfer(direction: Int32) ``` ## Remarks The StartTransfer event is fired when the document text starts transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # Transfer Event ([S3](#s3-module) Module) Fired while a document transfers (delivers document). ## Syntax ```text func onTransfer(direction: Int32, bytesTransferred: Int64, percentDone: Int32, text: Data) ``` ## Remarks The *Text* parameter contains the portion of the document text being received. It is empty if data are being posted to the server. The *BytesTransferred* parameter contains the number of bytes transferred in this *Direction* since the beginning of the document text (excluding HTTP response headers). The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. The *PercentDone* parameter shows the progress of the transfer in the corresponding direction. If *PercentDone* can not be calculated the value will be -1. NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance. # Certificate Type This is the digital certificate being used. ## Remarks This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) - [Subject](#Certificate_f_Subject) - [Encoded](#Certificate_f_Encoded) ## Fields **effectiveDate** *String (read-only)* *Default Value: ""* The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. **expirationDate** *String (read-only)* *Default Value: ""* The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. **extendedKeyUsage** *String (read-only)* *Default Value: ""* A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **fingerprint** *String (read-only)* *Default Value: ""* The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* **fingerprintSHA1** *String (read-only)* *Default Value: ""* The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* **fingerprintSHA256** *String (read-only)* *Default Value: ""* The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* **issuer** *String (read-only)* *Default Value: ""* The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. **privateKey** *String (read-only)* *Default Value: ""* The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The may be available but not exportable. In this case, returns an empty string. **privateKeyAvailable** *Bool (read-only)* *Default Value: False* Whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication). **privateKeyContainer** *String (read-only)* *Default Value: ""* The name of the container for the certificate (if available). This functionality is available only on Windows platforms. **publicKey** *String (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **publicKeyAlgorithm** *String (read-only)* *Default Value: ""* The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. **publicKeyLength** *Int32 (read-only)* *Default Value: 0* The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **serialNumber** *String (read-only)* *Default Value: ""* The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. **signatureAlgorithm** *String (read-only)* *Default Value: ""* The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. **storeB** *Data* *Default Value: "MY"* The name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **store** *String* *Default Value: "MY"* The name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **storePassword** *String* *Default Value: ""* If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. **storeType** *CertStoreTypes* *Default Value: 0* The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the CertMgr class by calling the ListStoreCertificates method after setting the corresponding properties accordingly. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [](#f_Store) and set [](#f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | **subjectAltNames** *String (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **thumbprintMD5** *String (read-only)* *Default Value: ""* The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **thumbprintSHA1** *String (read-only)* *Default Value: ""* The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **thumbprintSHA256** *String (read-only)* *Default Value: ""* The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **usage** *String (read-only)* *Default Value: ""* The text description of . This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. **usageFlags** *Int32 (read-only)* *Default Value: 0* The flags that show intended use for the certificate. The value of is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the property for a text representation of . This functionality currently is not available when the provider is OpenSSL. **version** *String (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". **subject** *String* *Default Value: ""* The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. **encodedB** *Data* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string. **encoded** *String* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string. ## Constructors *Swift Syntax* ```text public init() ``` Creates a instance whose properties can be set. *Swift Syntax* ```text public init(encoded: ) ``` Parses * Encoded * as an X.509 public key. *Swift Syntax* ```text public init(storeType: , store: , storePassword: , subject: ) ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. *Swift Syntax* ```text public init(storeType: , store: , storePassword: , subject: ) ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. # Firewall Type The firewall the component will connect through. ## Remarks When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the . The following fields are available: - [AutoDetect](#Firewall_f_AutoDetect) - [FirewallType](#Firewall_f_FirewallType) - [Host](#Firewall_f_Host) - [Password](#Firewall_f_Password) - [Port](#Firewall_f_Port) - [User](#Firewall_f_User) ## Fields **autoDetect** *Bool* *Default Value: False* Whether to automatically detect and use firewall system settings, if available. **firewallType** *FirewallTypes* *Default Value: 0* The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [](#f_Port) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [](#f_Port) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [](#f_Port) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [](#f_Port) is set to 1080. | **host** *String* *Default Value: ""* The name or IP address of the firewall (optional). If a is given, the requested connections will be authenticated through the specified firewall when connecting. If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class . **password** *String* *Default Value: ""* A password if authentication is to be used when connecting through the firewall. If is specified, the and properties are used to connect and authenticate to the given firewall. If the authentication fails, the class . **port** *Int32* *Default Value: 0* The Transmission Control Protocol (TCP) port for the firewall . See the description of the property for details. NOTE: This property is set automatically when is set to a valid value. See the description of the property for details. **user** *String* *Default Value: ""* A username if authentication is to be used when connecting through a firewall. If is specified, this property and the property are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the class . ## Constructors *Swift Syntax* ```text public init() ``` # Header Type This is an HTTP header as it is received from the server. ## Remarks When a header is received through a Header event, it is parsed into a [Header](#header-type) type. This type contains a , and its corresponding . The following fields are available: - [Field](#Header_f_Field) - [Value](#Header_f_Value) ## Fields **field** *String* *Default Value: ""* This property contains the name of the HTTP [Header](#header-type) (this is the same case as it is delivered). **value** *String* *Default Value: ""* This property contains the [Header](#header-type) contents. ## Constructors *Swift Syntax* ```text public init() ``` *Swift Syntax* ```text public init(field: , value: ) ``` # Proxy Type The proxy the component will connect to. ## Remarks When connecting through a proxy, this type is used to specify different properties of the proxy, such as the and the . The following fields are available: - [AuthScheme](#Proxy_f_AuthScheme) - [AutoDetect](#Proxy_f_AutoDetect) - [Password](#Proxy_f_Password) - [Port](#Proxy_f_Port) - [Server](#Proxy_f_Server) - [SSL](#Proxy_f_SSL) - [User](#Proxy_f_User) ## Fields **authScheme** *ProxyAuthSchemes* *Default Value: 0* The type of authorization to perform when connecting to the proxy. This is used only when the and properties are set. should be set to authNone (3) when no authentication is expected. By default, is authBasic (0), and if the and properties are set, the class will attempt basic authentication. If is set to authDigest (1), digest authentication will be attempted instead. If is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token. If is set to authNtlm (4), NTLM authentication will be used. For security reasons, setting this property will clear the values of and . **autoDetect** *Bool* *Default Value: False* Whether to automatically detect and use proxy system settings, if available. The default value is *false*. **password** *String* *Default Value: ""* A password if authentication is to be used for the proxy. If is set to Basic Authentication, the and properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server. If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation. **port** *Int32* *Default Value: 80* The Transmission Control Protocol (TCP) port for the proxy (default 80). See the description of the property for details. **server** *String* *Default Value: ""* If a proxy is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the property is set to the corresponding address. If the search is not successful, an error is returned. **ssl** *ProxySSLTypes* *Default Value: 0* When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows: | | | | --- | --- | | psAutomatic (0) | Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. | | psAlways (1) | The connection is always SSL-enabled. | | psNever (2) | The connection is not SSL-enabled. | | psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. | **user** *String* *Default Value: ""* A username if authentication is to be used for the proxy. If is set to Basic Authentication, the and properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server. If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation. ## Constructors *Swift Syntax* ```text public init() ``` *Swift Syntax* ```text public init(server: , port: ) ``` *Swift Syntax* ```text public init(server: , port: , user: , password: ) ``` # S3Bucket Type This type represents a bucket. ## Remarks This type represents a bucket. The following fields are available: - [CreationDate](#S3Bucket_f_CreationDate) - [Name](#S3Bucket_f_Name) - [OwnerDisplayName](#S3Bucket_f_OwnerDisplayName) - [OwnerId](#S3Bucket_f_OwnerId) ## Fields **creationDate** *String (read-only)* *Default Value: ""* The property includes the creation date of the bucket. This property reflects the creation date of the bucket. **name** *String (read-only)* *Default Value: ""* The property contains the name of the bucket. This property reflects the name of the bucket. **ownerDisplayName** *String (read-only)* *Default Value: ""* The property contains the display name of the bucket's owner. This property reflects the display name of the bucket's owner. **ownerId** *String (read-only)* *Default Value: ""* The property contains the Id of the bucket's owner. This property reflects the Id of the bucket's owner. ## Constructors *Swift Syntax* ```text public init() ``` *Swift Syntax* ```text public init(name: , creationDate: , ownerId: , ownerDisplayName: ) ``` # S3Metadata Type This type represents Amazon's Simple Storage Service (S3) metadata item. ## Remarks This type represents an S3 metadata item. The following fields are available: - [Name](#S3Metadata_f_Name) - [Value](#S3Metadata_f_Value) ## Fields **name** *String* *Default Value: ""* The property contains the name of the metadata item. This property specifies the name of the metadata item. The server stores metadata names in lowercase. NOTE: The class will automatically prepend the service-appropriate prefix (e.g., *x-amz-meta-*, *x-goog-meta-*) to this value when submitting metadata items to the server and will automatically strip that prefix from this value when this property is populated. **value** *String* *Default Value: ""* This property contains the value of the metadata item. This property specifies the value of the metadata item. ## Constructors *Swift Syntax* ```text public init() ``` *Swift Syntax* ```text public init(name: , value: ) ``` # S3Object Type This type represents an object. ## Remarks This type represents an object. The following fields are available: - [Deleted](#S3Object_f_Deleted) - [ETag](#S3Object_f_ETag) - [LastModified](#S3Object_f_LastModified) - [LatestVersion](#S3Object_f_LatestVersion) - [Name](#S3Object_f_Name) - [OwnerDisplayName](#S3Object_f_OwnerDisplayName) - [OwnerId](#S3Object_f_OwnerId) - [Size](#S3Object_f_Size) - [StorageClass](#S3Object_f_StorageClass) - [UploadId](#S3Object_f_UploadId) - [VersionId](#S3Object_f_VersionId) ## Fields **deleted** *Bool (read-only)* *Default Value: False* This property specifies whether this object version is a delete marker. This property indicates whether this object version is a delete marker. Delete markers are created when an object in a versioning-enabled bucket is "deleted" (i.e., instead of actually deleting any data); refer to DeleteObject for more information. This is applicable only when ListVersions is called, or when GetObjectInfo is called while VersionId is nonempty.; *false* in all other cases. **eTag** *String (read-only)* *Default Value: ""* This property contains the ETag of the object. This property reflects the ETag of the object. An object's ETag is an MD5 hash of its contents, and as such, it can be used to determine whether its contents have been modified. This is not applicable when ListMultipartUploads is called. **lastModified** *String (read-only)* *Default Value: ""* This property contains the last modified time of the object. This property reflects the last modified time of the object. This is not applicable when ListMultipartUploads is called. **latestVersion** *Bool (read-only)* *Default Value: True* This property specifies whether this is the latest object version. This property indicates whether this object version is the latest version available. This is applicable only when ListVersions is called.; *true* in all other cases. **name** *String (read-only)* *Default Value: ""* This property contains the name (key) of the object. This property reflects the name (key) of the object. **ownerDisplayName** *String (read-only)* *Default Value: ""* This property contains the display name of the object's owner. This property reflects the display name of the object's owner. This is not applicable when GetObjectInfo is called. **ownerId** *String (read-only)* *Default Value: ""* This property contains the Id of the object's owner. This property reflects the Id of the object's owner. This is not applicable when GetObjectInfo is called. **size** *Int64 (read-only)* *Default Value: 0* This property contains the size of the object. This property reflects the size of the object in bytes. This is not applicable when ListMultipartUploads is called. **storageClass** *String (read-only)* *Default Value: ""* This property contains the storage class of the object. This property reflects the storage class of the object. **uploadId** *String (read-only)* *Default Value: ""* This property contains the upload Id of the multipart upload. This property reflects the upload Id of the multipart upload. It is applicable only when ListMultipartUploads is called. **versionId** *String (read-only)* *Default Value: ""* This property contains the Id of the object version. This property reflects the Id of the object version. NOTE: The string *null* is a valid version Id. This is applicable only when ListVersions is called, or when GetObjectInfo is called while VersionId is nonempty.; empty in all other cases. ## Constructors *Swift Syntax* ```text public init() ``` *Swift Syntax* ```text public init(name: , lastModified: , size: , storageClass: , eTag: , ownerId: , ownerDisplayName: , uploadId: ) ``` # S3Part Type This type represents a multipart upload part. ## Remarks This type represents a multipart upload part. The following fields are available: - [ETag](#S3Part_f_ETag) - [LastModified](#S3Part_f_LastModified) - [ObjectName](#S3Part_f_ObjectName) - [OwnerDisplayName](#S3Part_f_OwnerDisplayName) - [OwnerId](#S3Part_f_OwnerId) - [PartNumber](#S3Part_f_PartNumber) - [Size](#S3Part_f_Size) ## Fields **eTag** *String (read-only)* *Default Value: ""* This property contains the ETag of the part. This property reflects the ETag of the part. **lastModified** *String (read-only)* *Default Value: ""* This property contains the last modified time of the part. This property reflects the last modified time of the part. **objectName** *String (read-only)* *Default Value: ""* This property contains the name (key) of the object that the part was uploaded for. This property reflects the name (key) of the object that the part was uploaded for. **ownerDisplayName** *String (read-only)* *Default Value: ""* This property contains the display name of the part's owner. This property reflects the display name of the part's owner. **ownerId** *String (read-only)* *Default Value: ""* This property contains the Id of the part's owner. This property reflects the Id of the part's owner. **partNumber** *Int32 (read-only)* *Default Value: 0* This property contains the number of the part. This property reflects the number of the part. **size** *Int64 (read-only)* *Default Value: 0* This property contains the size of the part. This property reflects the size of the part in bytes. ## Constructors *Swift Syntax* ```text public init() ``` *Swift Syntax* ```text public init(partNumber: , objectName: , lastModified: , size: , eTag: , ownerId: , ownerDisplayName: ) ``` # S3QueryParam Type This type represents a query parameter to send in the request. ## Remarks This type represents a query parameter to send in the request. The following fields are available: - [Name](#S3QueryParam_f_Name) - [Value](#S3QueryParam_f_Value) ## Fields **name** *String* *Default Value: ""* This property specifies the name of the query parameter. This property specifies the name of the query parameter. **value** *String* *Default Value: ""* This property contains the value of the query parameter. This property specifies the value of the query parameter. The class will automatically URL encode this value when sending the request. ## Constructors *Swift Syntax* ```text public init() ``` *Swift Syntax* ```text public init(name: , value: ) ``` # Config Settings ([S3](#s3-module) Module) The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#config-method-s3-module) method. ### S3 Config Settings **AccumulatePages**: Whether the class should accumulate subsequent pages of results when listing them.This configuration setting controls how the class behaves when listing multiple pages of results. If this setting is enabled, each successive page of results will be appended to the appropriate collection properties until the last page of results has been listed (at which point the next list call will cause said collection to be cleared first). If this setting is disabled, the collection will be cleared every time a page of results is returned. By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection properties. **ADFSAuthScheme**: The authentication scheme to use with the ADFS STS endpoint.This property will tell the class which type of authorization to perform when making the *GET* request to the [ADFSSTSEndpoint](#ADFSSTSEndpoint). By default, this property is set to 5 (Negotiate), which will use Windows Negotiate (Kerberos) authentication when making the *GET* request. This configuration setting also can be set to 4 (NTLM), which will use NTLM authentication to attempt authentication with the [ADFSSTSEndpoint](#ADFSSTSEndpoint). If the [ADFSUser](#ADFSUser) and [ADFSPassword](#ADFSPassword) configuration settings are empty, it will use the current user's credentials. **ADFSPassword**: The password to use if the auth scheme is set to NTLM.This is the password to use if the [ADFSAuthScheme](#ADFSAuthScheme) configuration setting is set to 4 (NTLM). **ADFSRelyingParty**: The endpoint to request the SAML Response from.This configuration setting should be set to the Relying Party identity that has been set up in Active Directory Federation Services (ADFS) for SAML authentication with AWS. This will be used only when the class is making the *GET* request to the [ADFSSTSEndpoint](#ADFSSTSEndpoint) configuration setting when trying to assume a role with SAML. This must be set alongside the [AssumeRoleARN](#AssumeRoleARN) and [ADFSSTSEndpoint](#ADFSSTSEndpoint) configuration settings. **ADFSSTSEndpoint**: The endpoint to request the SAML Response from.This endpoint should point to the ADFS endpoint to make the SAML request. Typically, this endpoint will look something like *https://{DOMAIN}/adfs/ls/IdpInitiatedSignOn.aspx*. When set, the class will try to make a *GET* request to this endpoint to get a SAML response. It will then use the SAML response to assume the role defined in the [AssumeRoleARN](#AssumeRoleARN) configuration setting using the acquired SAML response. This must be set alongside the [AssumeRoleARN](#AssumeRoleARN) and [ADFSRelyingParty](#ADFSRelyingParty) configuration settings. **ADFSUser**: The username to use if the auth scheme is set to NTLM.This is the username to use if the [ADFSAuthScheme](#ADFSAuthScheme) configuration setting is set to 4 (NTLM). **AssumeRoleARN**: Amazon Resource Name used when assuming a role for authentication.The Amazon Resource Name (ARN) that will be assumed by the class. This must be set alongside [AssumeRoleSessionName](#AssumeRoleSessionName). **AssumeRoleDuration**: The duration for role session in seconds.The duration of the role session in seconds. The minimum is 900 seconds (15 minutes) and the maximum is 43200 (12 hours). As a note, the maximum value may be lower based on restrictions placed by the role administrator. If the duration is outside of the range, the request will fail. This setting is optional, but [AssumeRoleARN](#AssumeRoleARN) and [AssumeRoleSessionName](#AssumeRoleSessionName) are required for assuming a role. **AssumeRolePrincipalARN**: The Amazon Resource Name of the SAML provider.The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP. This is used when AssumeRole with SAML rather than using an [AccessKey](#accesskey-property-s3-module) and [SecretKey](#secretkey-property-s3-module). **AssumeRoleSessionName**: Unique name for current role session.The unique session name to identify a session within a role. Must be set alongside [AssumeRoleARN](#AssumeRoleARN). **AutoDetectSigningRegion**: Whether or not to automatically detect the region from the base URL in order to use it for the HMAC signing process.When set to *true* (default), the class will automatically try to extract the region from the base URL. When set to *false*, the region provided in the [Region](#region-property-s3-module) property will be used in the signed header for the hash-based message authentication code (HMAC) signature. **AWSProfile**: The name of the AWS CLI profile that the class should use to obtain authentication and region information.This configuration setting, if nonempty, must contain the name of the AWS Command Line Interface (CLI) profile whose authentication and, optionally, regional information the class should use to communicate with the server. To use the default profile, set this configuration setting to *default*. Refer to the following pages of the AWS CLI documentation for more information about AWS profiles, and the *credentials* and *config* files used to store them: - [Configuration and Credential File Settings](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html) - [Named Profiles](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html) - [Using an IAM Role](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-role.html) The class supports key-based credential profiles, that is, those that include the *aws_access_key_id*, *aws_secret_access_key*, and (optionally) *aws_session_token* elements. Role-based profiles are not supported at this time. In addition to the authentication-related elements mentioned previously, the class also supports the *region* element, if it is present in the specified profile. The class searches for the specified profile's information in the *credentials* and *config* files. The [AWSProfileDir](#AWSProfileDir) setting can be used to configure the directory where the class looks for these files. If the aforementioned files do not exist, or the specified profile cannot be found or is missing information, an error will occur. **AWSProfileDir**: The location of the AWS CLI credentials and config files.This configuration setting specifies the directory that the class should check when attempting to locate the AWS CLI *credentials* and *config* files. This setting is used only if the [AWSProfile](#AWSProfile) setting is nonempty. By default, this setting is empty, which will cause the class to check the default location used by the AWS CLI: an *.aws* directory in the current user's home directory, that is, *%UserProfile%\.aws* (Windows) or *~/.aws* (Linux/macOS). **CloudflareAccountID**: The Cloudflare R2 account ID to use.When the [ServiceProvider](#serviceprovider-property-s3-module) property is set to *spCloudflareR2 (10)*, this configuration setting must be set before any requests can be made. This configuration setting is not applicable when [ServiceProvider](#serviceprovider-property-s3-module) is set to any other value. Refer to the [find zone and account IDs](https://developers.cloudflare.com/fundamentals/get-started/basic-tasks/find-account-and-zone-ids/) page of the Cloudflare R2 documentation for instructions on how to find your account Id. **ContentRange**: This contains the range of bytes of the current object that are being returned.When implementing chunked and resumable object downloads by setting the [Range](#range-property-s3-module) property, this configuration setting will contain the returned range of bytes and the total count of bytes for the specified object. This configuration setting will be populated after a call to [GetObject](#getobject-method-s3-module) **CopyPartRange**: Specifies the range of bytes to copy when calling CopyPart.This configuration setting optionally specifies the range of bytes to copy from the source object when calling [CopyPart](#copypart-method-s3-module). By default, the entire object is copied as the new part. When set, this configuration setting dictates the zero-based range of bytes to copy in the format *[first]-[last]*, as follows: *2048-4096*. NOTE: This setting is ignored when [ServiceProvider](#serviceprovider-property-s3-module) is *spGoogleStorage (2)*. **DownloadTempFile**: The temporary file used when downloading encrypted data.This configuration setting specifies the temporary file used when downloading encrypted data. When downloading encrypted data with [LocalFile](#localfile-property-s3-module) set, the class will automatically create a temporary file at [TempPath](#TempPath) to hold the encrypted file contents. When the download is complete, the data are decrypted to [LocalFile](#localfile-property-s3-module). If the download is interrupted, the specified file will hold the partially downloaded encrypted file contents. Before resuming the download, this setting must be set to a valid file containing the partially encrypted file contents. See [GetObject](#getobject-method-s3-module) for details. **EncodeSlashInObjectName**: Whether or not to encode slashes in an object name.When set to *true* (default), the class will URL encode any slashes in an object name when signing a request. This is what Amazon's S3 service expects. Other S3 clones may vary slightly from this rule, requiring that slashes are not encoded. Set this to *false*, to accommodate this rule. **EncryptionIV**: The initialization vector to be used for encryption/decryption.When encrypting or decrypting a file, this setting may be set to specify the initialization vector. Normally, the class will derive this value automatically from [EncryptionPassword](#encryptionpassword-property-s3-module). This setting accepts a hex-encoded value. **EncryptionKey**: The key to use during encryption/decryption.When encrypting or decrypting a file, this setting may be set to specify the key to use. Normally, the class will derive this value automatically from [EncryptionPassword](#encryptionpassword-property-s3-module). This setting accepts a hex-encoded value. **EncryptionPasswordKDF**: The KDF algorithm to use during password based encryption and decryption.This setting specified the Key Derivation Function (KDF) used to derive a key from the specified [EncryptionPassword](#encryptionpassword-property-s3-module). Possible values are as follows: - 0 (default) - PBKDF1 - 1 - PBKDF2 NOTE: PBKDF1 is not Federal Information Processing Standards (FIPS) compliant. When operating in FIPS mode, PBKDF2 should be used. **EnforceBucketNameRestrictions**: Whether or not to enforce bucket naming conventions.When set to *false* (default), the class will not enforce the bucket-naming restrictions. US-based buckets are not subject to the same name restrictions as other locations. When set to *true*, the class will enforce the following restrictions: - Bucket names can contain lowercase letters, numbers, periods, underscores, and dashes. - Bucket names must start with a number or letter. - Bucket names must be between 3 and 63 characters long. - Bucket names should not end with a dash. - Bucket names cannot contain two adjacent periods. - Bucket names cannot contain dashes next to periods. - Bucket names must not be formatted as an IP address (e.g., 192.168.5.4). **ETag**: The ETag for the object returned by the server.This configuration setting contains the ETag for the object returned after [GetObject](#getobject-method-s3-module), [CreateObject](#createobject-method-s3-module), or [CompleteMultipartUpload](#completemultipartupload-method-s3-module) is called. The [ETag](#ETag) is used to determine if the object has changed since the last operation on the file. Set the [IfMatch](#IfMatch) configuration setting to the [ETag](#ETag) to ensure that a new version of the object does not already exist on the server. **ForceDeleteNonEmptyBuckets**: Forces buckets to be deleted even if they aren't empty.When [DeleteBucket](#deletebucket-method-s3-module) is called, if this is set to *true* (default), the bucket will be deleted whether or not it is empty. NOTE: This configuration setting is applicable only when [ServiceProvider](#serviceprovider-property-s3-module) is *spWasabi (3)*; other providers do not support deleting nonempty buckets. **FragmentSize**: The part size to use when uploading a new object.If, when [CreateObject](#createobject-method-s3-module) is called, more than [SimpleUploadLimit](#SimpleUploadLimit) bytes of upload data are present, the class will automatically split up the upload data into parts and perform a multipart upload. This setting specifies the part size to use. Valid values are *5242880* (5MB) to *2147483647* (2GB). The default is *26214400* (25 MB). NOTE: Applications may need to increase this setting's value to upload very large objects; Amazon only allows 10,000 parts to be uploaded for any given multipart upload. If the amount of upload data provided when creating an object is less than [SimpleUploadLimit](#SimpleUploadLimit) bytes, it will be uploaded directly, and thus this setting will not apply. **GoogleProjectId**: The Google project Id to send when using OAuth 2.0 to authenticate to Google Storage.When the [ServiceProvider](#serviceprovider-property-s3-module) property is set to *spGoogleStorage (2)*, and the [OAuthAuthorization](#OAuthAuthorization) configuration setting is populated, this setting also must be set to use OAuth 2.0 to authenticate to Google Storage. **IfMatch**: Check to make sure the object has not been modified since the last request.When implementing chunked and resumable object downloads, the [IfMatch](#IfMatch) configuration setting is used to determine if the object has changed since the last chunk was downloaded. Set the [IfMatch](#IfMatch) configuration setting to the [ETag](#ETag) of the previous request to tell the class to ensure that the object has not changed before a call to [GetObject](#getobject-method-s3-module). **IncludeContentMD5**: Whether an MD5 digest of a custom request's data should be included.If set to *true*, the class will include an MD5 digest of the *RequestBody* passed to [SendCustomRequest](#sendcustomrequest-method-s3-module) when the request is submitted. The default value is *false*. NOTE: This configuration setting is applicable only if the [SignCustomRequest](#SignCustomRequest) setting is *true*; otherwise, it is ignored. **IncludeObjectMD5**: Whether an MD5 digest of a object's data should be included.If set to *true*, the class will include an MD5 digest of an object's data when it is created using [CreateObject](#createobject-method-s3-module). (If the class performs an automatic multipart upload, MD5 digests of the individual parts' data will be sent instead, even if [IncludePartMD5](#IncludePartMD5) is *false*.) The default value is *false*. **IncludePartMD5**: Whether an MD5 digest of a part's data should be included.If set to *true*, the class will include an MD5 digest of a part's data when it is uploaded using [UploadPart](#uploadpart-method-s3-module). The default value is *false*. **LastPartInfo**: The part number and part ETag of the last CopyPart or UploadPart request.This setting contains the part number and part ETag corresponding to the last [CopyPart](#copypart-method-s3-module) or [UploadPart](#uploadpart-method-s3-module) request made while performing a multipart upload. The part number is specified by each method's *partNumber* parameter while the part ETag is parsed from the response. The part's number and ETag are separated by the *;* character (e.g., *part_number;part_etag*). This configuration setting can be used to retrieve part information that can then be stored in [PartInfo\[i\]](#PartInfo[i]). Doing so makes the [CompleteMultipartUpload](#completemultipartupload-method-s3-module) method assemble these specific parts instead of calling [ListParts](#listparts-method-s3-module) internally. If the [ServiceProvider](#serviceprovider-property-s3-module) property is set to *spCloudflareR2 (10)*, this setting will automatically be updated after calling [CopyPart](#copypart-method-s3-module) or [UploadPart](#uploadpart-method-s3-module). This configuration setting is read-only. NOTE: This configuration setting typically is used only when working with multiple class instances in which the desired provider does not support the ListParts S3 operation, such as Cloudflare R2. **MaskSensitiveData**: Whether sensitive data is masked in the Log event.This configuration setting controls whether sensitive information is masked when the [Log](#log-event-s3-module) event fires. For instance, the authorization header in the request contains the access key Id. The default value is *true*. **MaxObjects**: The maximum number of results to return when listing objects.This configuration setting specifies the maximum number of results that should be returned by a call to [ListObjects](#listobjects-method-s3-module) or [ListMultipartUploads](#listmultipartuploads-method-s3-module). If this setting is *-1* (default), the server's default is used. Acceptable values vary by provider. **MaxParts**: The maximum number of results to return when listing parts.This configuration setting specifies the maximum number of results that should be returned by a call to [ListParts](#listparts-method-s3-module). If this configuration setting is *-1* (default), the server's default is used. Acceptable values vary by provider. **OAuthAuthorization**: The OAuth 2.0 authorization token to use to authenticate to Google Storage.When the [ServiceProvider](#serviceprovider-property-s3-module) property is set to *spGoogleStorage (2)*, this setting (along with the [GoogleProjectId](#GoogleProjectId) configuration setting) can be set to use OAuth 2.0 to authenticate to Google Storage instead of an [AccessKey](#accesskey-property-s3-module) and [SecretKey](#secretkey-property-s3-module). **OracleNamespace**: The Oracle Cloud Object Storage namespace to use.When the [ServiceProvider](#serviceprovider-property-s3-module) property is set to *spOracle (8)*, this configuration setting must be set to the Oracle Cloud Object Storage namespace associated with the Oracle Cloud account before any requests can be made. This configuration setting is not applicable when [ServiceProvider](#serviceprovider-property-s3-module) is set to any other value. Refer to the [Understanding Object Storage Namespaces](https://docs.cloud.oracle.com/en-us/iaas/Content/Object/Tasks/understandingnamespaces.htm) page of the Oracle Cloud documentation for instructions on how to find your account's Object Storage namespace. **OverwriteRemote**: Whether to allow overwrites of existing remote data.When the [ServiceProvider](#serviceprovider-property-s3-module) property is set to *spAmazonS3 (0)*, this configuration setting controls whether the existence of an object is checked before it is created by either calling the [CreateObject](#createobject-method-s3-module) or [CompleteMultipartUpload](#completemultipartupload-method-s3-module) methods. When disabled, the *If-None-Match* conditional HTTP header is added to the request, and an object will only be created if it does not already exist. By default, this setting is enabled, and overwrites are allowed. **PartInfo[i]**: The i'th part number and part ETag corresponding to a part of a multipart upload.When populated, this configuration setting is used by the [CompleteMultipartUpload](#completemultipartupload-method-s3-module) method to assemble these specific parts for a multipart upload instead of calling [ListParts](#listparts-method-s3-module) internally. The part number and ETag of the most recent multipart upload can be retrieved with the [LastPartInfo](#LastPartInfo) setting. Each pairing's part number and ETag are separated by the *;* character (e.g., *part_number;part_etag*). If the [ServiceProvider](#serviceprovider-property-s3-module) property is set to *spCloudflareR2 (10)*, this collection automatically will be updated to include the [LastPartInfo](#LastPartInfo) after calling [CopyPart](#copypart-method-s3-module) or [UploadPart](#uploadpart-method-s3-module). Valid values for *i* are from *0* to *([PartInfoCount](#PartInfoCount) -1)*. NOTE: This configuration setting typically is used only when working with multiple class instances in which the desired provider does not support the ListParts S3 operation, such as Cloudflare R2. ```text string uploadID = s3.StartMultipartUpload("objectName"); s3.UploadPart("objectName", 1, uploadID); string part1 = s3.Config("LastPartInfo"); s3.UploadPart("objectName", 2, uploadID); string part2 = s3.Config("LastPartInfo"); s3.Config("PartInfoCount=2"); s3.Config("PartInfo[0]=" + part1); s3.Config("PartInfo[1]=" + part2); s3.CompleteMultipartUpload("objectName", uploadID); ``` **PartInfoCount**: The number of items in the PartInfo collection.This configuration setting reflects the number of parts in the [PartInfo\[i\]](#PartInfo[i]) collection. See [PartInfo\[i\]](#PartInfo[i]) for more information. If the [ServiceProvider](#serviceprovider-property-s3-module) property is set to *spCloudflareR2 (10)*, this setting will automatically be updated after calling [CopyPart](#copypart-method-s3-module) or [UploadPart](#uploadpart-method-s3-module). NOTE: This configuration setting typically is used only when working with multiple class instances in which the desired provider does not support the ListParts S3 operation, such as Cloudflare R2. **Prefix[i]**: The i'th common prefix returned.When [StorePrefixList](#StorePrefixList) is enabled, this configuration setting can be used to retrieve the common prefixes returned by the most recent [ListObjects](#listobjects-method-s3-module) request. Refer to that method, as well as the [ObjectDelimiter](#objectdelimiter-property-s3-module) property, for more information. Valid values for *i* are from *0* to *([PrefixCount](#PrefixCount) -1)*. **PrefixCount**: The number of common prefixes returned.When [StorePrefixList](#StorePrefixList) is enabled, this configuration setting reflects the number of common prefixes returned by the most recent [ListObjects](#listobjects-method-s3-module) request. This configuration setting is always *-1* when [StorePrefixList](#StorePrefixList) is disabled. **ProgressAbsolute**: Whether the class should track transfer progress absolutely.This configuration setting controls whether the class tracks upload and download progress absolutely or relatively, with regards to the values reported via the [Progress](#progress-event-s3-module) event when an interrupted transfer is resumed. If this configuration setting is enabled (default), then when a transfer is interrupted and later resumed, the values reported by the [Progress](#progress-event-s3-module) event will account for the data that were successfully transferred before the interruption. If this configuration setting is disabled, then the class will treat resumed transfers as "new" transfers, and the values reported by the [Progress](#progress-event-s3-module) event will start at *0* rather than from the number of bytes already transferred. Refer to the [Progress](#progress-event-s3-module) event for more information. **ProgressStep**: How often the progress event should be fired, in terms of percentage.This configuration setting controls how often the class will fire the [Progress](#progress-event-s3-module) event during an upload or download, in terms of percentage. Valid values are *0* to *99*, inclusive. The default value, *1*, will cause the [Progress](#progress-event-s3-module) event to fire each time the event's *PercentDone* parameter value increases by 1 percent. Setting this setting to *0* will cause the [Progress](#progress-event-s3-module) event to fire *every* time data are transferred. NOTE: The [Progress](#progress-event-s3-module) event will *always* fire once at the beginning and end of a transfer, regardless of this setting's value. Also, if *PercentDone* cannot be calculated for a particular transfer (e.g., for downloads that use chunked transfer encoding), then the class will behave as if this setting were *0* for the duration of the transfer. **RawRequest**: Returns the data that was sent to the server.This configuration setting may be queried after calling any method that sends data to the server to obtain the request data that were transmitted. Such data may be useful for troubleshooting purposes. **RawResponse**: Returns the data that was received from the server.This configuration setting may be queried after calling any method that sends data to the server to obtain the response data that were received. Such data may be useful for troubleshooting purposes. **ResponseCacheControl**: Sets the Cache-Control header of the response.If specified, this configuration setting determines the *Cache-Control* header returned by the server. NOTE: This is applicable only when calling [GetLink](#getlink-method-s3-module). **ResponseContentDisposition**: Sets the Content-Disposition header of the response.If specified, this determines the *Content-Disposition* header returned by the server. NOTE: This is applicable only when calling [GetLink](#getlink-method-s3-module). **ResponseContentEncoding**: Sets the Content-Encoding header of the response.If specified, this configuration setting determines the *Content-Encoding* header returned by the server. NOTE: This is applicable only when calling [GetLink](#getlink-method-s3-module). **ResponseContentLanguage**: Sets the Content-Language header of the response.If specified, this configuration setting determines the *Content-Language* header returned by the server. NOTE: This is applicable only when calling [GetLink](#getlink-method-s3-module). **ResponseContentType**: Sets the Content-Type header of the response.If specified, this configuration setting determines the *Content-Type* header returned by the server. NOTE: This is applicable only when calling [GetLink](#getlink-method-s3-module). **ResponseExpires**: Sets the Expires header of the response.If specified, this configuration setting determines the *Expires* header returned by the server. NOTE: This is applicable only when calling [GetLink](#getlink-method-s3-module). **ResumableUploadState**: Tracks upload state information during an automatic multipart upload.If, when [CreateObject](#createobject-method-s3-module) is called, more than [SimpleUploadLimit](#SimpleUploadLimit) bytes of upload data are present, then the class will automatically split up the upload data into parts and perform a multipart upload. This configuration setting keeps track of upload state information needed to resume the upload if it is interrupted. Refer to [CreateObject](#createobject-method-s3-module) for more information. NOTE: This setting is automatically cleared any time [ServiceProvider](#serviceprovider-property-s3-module) changes. **SendObjectACLs**: Whether to include object-level ACL headers when making requests.This configuration setting controls whether object-level access control list (ACL) headers are included when making applicable requests (e.g., [CreateObject](#createobject-method-s3-module)). When the [ServiceProvider](#serviceprovider-property-s3-module) property is set to *spGoogleStorage (2)*, it may be necessary to disable this configuration setting if uniform bucket-level access is being used. By default, this setting is enabled, and object-level ACL headers are included. **ServiceProviderURL**: The base URL to use when communicating with a service provider.This configuration setting can be used to override the URL that will be used when communicating with a service provider. When the [ServiceProvider](#serviceprovider-property-s3-module) property is set to *spCustom (255)*, this configuration setting must be set to the custom service provider's base URL before any requests can be made. When the [ServiceProvider](#serviceprovider-property-s3-module) property is set to *spSupabase (14)*, this configuration setting must be set to the Supabase project's S3 endpoint URL (e.g., *https://.supabase.co/storage/v1/s3*) before any requests can be made. When the class uses the specified base URL to generate a request URL, it performs the following transformations (if necessary): - If the base URL includes an *http[s]://* prefix, it is ignored; the [UseSSL](#usessl-property-s3-module) property controls whether the class makes secure or plaintext connections. - If the base URL contains a *%region%* token, it is replaced with the [Region](#region-property-s3-module) property's current value. For example, if this setting is set to *http://s3.%region%.myservice.com*, [UseSSL](#usessl-property-s3-module) is *true*, and [Region](#region-property-s3-module) is *region-1*, then the class will generate request URLs like *https://s3.region-1.myservice.com/bucket/...* (or like *https://bucket.s3.region-1.myservice.com/...*, if the [UseVirtualHosting](#usevirtualhosting-property-s3-module) property is *true*). **SessionToken**: The session token to send in the request when using temporary credentials.When using temporary credentials, AWS requires that you to send the session token provided with the temporary access and secret key in every request. **SignCustomRequest**: Tells the class to sign the outgoing request.By default, this configuration setting is *true*, and when [SendCustomRequest](#sendcustomrequest-method-s3-module) is called, then the class will sign the specified request to authenticate with the service. If set to *false*, the request will be sent as is, without signing. **SigningTime**: A custom date to send to the class to use while signing all requests.The SigningTime configuration setting can be used to send a custom value for the signature date that are used while signing all requests. This is often used if a machine has not been patched or is sending incorrect date values while attempting to connect. This value must be provided as a traditional Unix timestamp. A Unix timestamp is the number of seconds since the Unix Epoch (00:00:00 January 1, 1970 UTC). An example value for the timestamp would be *1236626334*. **SimpleUploadLimit**: The maximum data size the class should attempt to upload directly when creating an object.When [CreateObject](#createobject-method-s3-module) is called, the class will automatically split up the upload data into parts and perform a multipart upload if its size is greater than the amount specified by this setting. If the upload data size is less than or equal to the amount specified by this setting, it will be uploaded directly in the object creation request. Valid values are *-1* to *5368709120* (5 GB), inclusive. The default is *104857600* (100 MB). If this configuration setting is set to *0*, the class will *always* perform a multipart upload when creating an object; if it is set to *-1*, the class will *never* perform a multipart upload. **StorageClass**: Specifies the storage class to be used for the uploaded object.This configuration setting specifies the storage class to use for newly created objects; it is used when constructing [CreateObject](#createobject-method-s3-module), [StartMultipartUpload](#startmultipartupload-method-s3-module), and [CopyObject](#copyobject-method-s3-module) requests. By default, this setting is empty, causing new objects to be created with a provider's default storage class (usually *STANDARD*, but refer to the provider's documentation for more information). This setting is cleared any time [ServiceProvider](#serviceprovider-property-s3-module) changes. NOTE: The IBM Cloud Object Storage provider assigns storage classes to buckets rather than to individual objects. When [ServiceProvider](#serviceprovider-property-s3-module) is *spIBM (7)*, this setting can be set to a valid IBM storage class string before calling [CreateBucket](#createbucket-method-s3-module) to create a bucket with the specified storage class. Buckets are created with the *standard* storage class by default. **StoreObjectData**: Whether class stores object data or not.This configuration setting can be used to instruct the class whether or not to create a local copy of the data to upload when setting the [ObjectData](#objectdata-property-s3-module) property. When set to *false*, the class will store the data address and length only. This cuts down on the memory usage of the class when uploading files. The default value for this setting is *true*. **StorePrefixList**: Whether to store the common prefixes returned when listing objects.If this configuration setting is enabled, the class will populate the [PrefixCount](#PrefixCount) and [Prefix\[i\]](#Prefix[i]) settings any time [ListObjects](#listobjects-method-s3-module) is called. By default, this setting is disabled. **SupabaseProjectId**: The project reference ID to use when communicating with the Supabase provider. When the [ServiceProvider](#serviceprovider-property-s3-module) property is set to *spSupabase (14)*, this configuration setting can be used to automatically generate the S3 endpoint URL. The generated endpoint will use the following format: *https://.storage.supabase.co/storage/v1/s3* For example, if this setting is set to *00000011111122222233*, the generated S3 endpoint URL will be: *https://00000011111122222233.storage.supabase.co/storage/v1/s3* You can find your project's reference ID in the Supabase Dashboard under *Project Settings > General > Project ID*, or in your project's URL (*https://supabase.com/dashboard/project/*). If the [ServiceProviderURL](#ServiceProviderURL) configuration setting is explicitly set, it takes precedence over this setting and will be used as the service provider endpoint instead. In this case, the value specified by this setting will not be used to generate the endpoint URL. This setting is only used with the *spSupabase (14)* service provider and is ignored for other service providers. **TempPath**: The path to the directory where temporary files are created.This configuration setting specifies the path where temporary files are created when downloading encrypted files. If not specified, the system's temporary directory is used. Refer to [DownloadTempFile](#DownloadTempFile) and [GetObject](#getobject-method-s3-module) for more information. **UseEC2RoleCredentials**: Whether to authenticate requests with credentials obtained from the IAM role attached to the EC2 instance.When the class is running within an Amazon EC2 instance, this setting can be set to authenticate requests using the Identity and Access Management (IAM) role attached to the instance using temporary credentials obtained from the instance metadata service. The IMDSv1 protocol is used by default. Please see the [IMDSVersion](#IMDSVersion) configuration setting for more information. For the class to be able to auto-obtain authentication credentials, the EC2 instance must have an "instance profile" with an appropriate IAM role attached to it. Refer to the "[Using an IAM Role to Grant Permissions to Applications Running on Amazon EC2 Instances](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html)" page in the Amazon IAM documentation for more information. By default, this setting is *false*. When set to *true*, the class will do the following before each request: 1. Make a request against the EC2 instance to get the name of the role attached to it. 2. Make a request against the metadata service to obtain temporary security credentials for the IAM role returned in the previous call. 3. Parse the response, automatically populating the [AccessKey](#accesskey-property-s3-module) and [SecretKey](#secretkey-property-s3-module) properties and the [SessionToken](#SessionToken) configuration setting. 4. Execute the original request using the temporary security credentials that were acquired. NOTE: This setting is ignored if the [AWSProfile](#AWSProfile) setting is set to a profile that includes credential information. **XChildCount**: The number of child elements of the current element.This configuration settings specifies the number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to ([XChildCount](#XChildCount) - 1). The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XChildName[i]**: The name of the child element.This configuration setting provides the name of the i-th child element of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XChildXText[i]**: The inner text of the child element.This configuration setting provides the inner text of the i-th child element of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XElement**: The name of the current element.This configuration setting provides the name of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XParent**: The parent of the current element.This configuration setting provides the parent of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XPath**: Provides a way to point to a specific element in the returned XML or JSON response.The [XPath](#XPath) setting allows you to point to specific elements in the XML or JSON response. When [XPath](#XPath) is set to a valid path, [XElement](#XElement) points to the name of the element, with [XText](#XText), [XParent](#XParent), [XSubTree](#XSubTree), [XChildCount](#XChildCount), [XChildName\[i\]](#XChildName[i]), and [XChildXText\[i\]](#XChildXText[i]) providing other properties of the element. XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the */* character, for example, */A/B/C/D*. An XPath can be absolute (i.e., it starts with */*), or it can be relative to the current [XPath](#XPath) location. The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors, which proceed it in the overall XPath string: | Accessor | Description | | --- | --- | | name | The first element with a particular name. Can be *. | | [i] | The i-th element. | | name[i] | The i-th element with a particular name. | | [last()] | The last element. | | [last()-i] | The element i before the last element. | | name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair. Supports single and double quotes. (XML Only) | | . | The current element. | | .. | The parent element. | NOTE: XPath indices are *1-based*. For example, assume the following XML and JSON responses. XML: ```text value first second value three ``` JSON: ```text { "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } } ``` The following are examples of valid XPaths for these responses: | Description | XML XPath | JSON XPath | | --- | --- | --- | | Document root | / | /json | | Specific element | /firstlevel/one | /json/firstlevel/one | | i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] | This list is not exhaustive, but it provides a general idea of the possibilities. **XSubTree**: A snapshot of the current element in the document.This configuration setting provides the entirety of the current element (including its subelements). The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XText**: The text of the current element.This configuration setting provides the inner text of the current element. The current element is specified in the [XPath](#XPath) configuration setting. This configuration setting is read-only. ### HTTP Config Settings **AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the class adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The class only supports gzip and deflate decompression algorithms. **AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms. When True, the class adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate". The default value is True. **AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0". If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class if the server does not support HTTP/2. The default value is True. **Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to [LocalFile](#localfile-property-s3-module). When set to True, downloaded data will be appended to [LocalFile](#localfile-property-s3-module). This may be used in conjunction with [Range](#range-property-s3-module) to resume a failed download. This is applicable only when [LocalFile](#localfile-property-s3-module) is set. The default value is False. **Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server. This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class. The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]". **BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [Transfer](#transfer-event-s3-module) event, by [BytesTransferred](#BytesTransferred). **ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384. **CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request. The default value is False. **EncodeURL**: If set to True the URL will be encoded by the class.If set to True, the URL passed to the class will be URL encoded. The default value is False. **FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time. If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class . **Note:** Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for *GET* or *HEAD* requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities. Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server. A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters). The default value is 0 (Never). In this case, redirects are never followed, and the class instead. Following are the valid options: - 0 - Never - 1 - Always - 2 - Same Scheme **GetOn302Redirect**: If set to True the class will perform a GET on the new location.The default value is False. If set to True, the class will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again. **HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names. **HTTPVersion**: The version of HTTP used by the class.This property specifies the HTTP version used by the class. Possible values are as follows: - "1.0" - "1.1" (default) - "2.0" - "3.0" When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details. **HTTP/2 Notes** When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error. If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed. **HTTP/3 Notes** HTTP/3 is supported only in .NET and Java. When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error. **IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: ```text Sat, 29 Oct 2017 19:43:31 GMT. ``` **KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *true*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *false*, the connection will be closed immediately after the server response is received. The default value for [KeepAlive](#KeepAlive) is *false*. **KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here. **LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [Log](#log-event-s3-module) event. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). **MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When [FollowRedirects](#followredirects-property-s3-module) is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20. **NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used. **OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers. The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by . Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail. This configuration setting is useful for extending the functionality of the class beyond what is provided. **ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme. **ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client. **StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server. **StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*. **TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server. **TransferredDataLimit**: The maximum number of incoming bytes to be stored by the class.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class. **TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server. **TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request: .NET ```text Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); ``` C++ ```text HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest")); ``` **UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False. NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding. **UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name). The default value is False and the hostname will always be used exactly as specified. NOTE: The [CodePage](#CodePage) setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set [CodePage](#CodePage) to *65001*. **UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and ProxyAutoDetect is set to *True*. When *True* (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use. **UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com". Override the default with the name and version of your software. ### TCPClient Config Settings **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use [Timeout](#timeout-property-s3-module) for establishing a connection and transmitting/receiving data. **FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the class . NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the class . NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-s3-module) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface. If the class is connected, the [LocalHost](#localhost-property-s3-module) setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). **LocalPort**: The port in the local host where the class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string. If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset. If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the class will use IPv4 exclusively. When set to *1*, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-s3-module) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-s3-module) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-s3-module) is set to *Platform*. **OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL. The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL. The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences: -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL. The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". **OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL. By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the class will reuse the context if and only if the following criteria are met: - The target host name is the same. - The system cache entry has not expired (default timeout is 10 hours). - The application process that calls the function is the same. - The logon session is the same. - The instance of the class is the same. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-s3-module) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#sslcert-property-s3-module) property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the class will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class . When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the class . When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-s3-module) event. Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the class will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when [SSLProvider](#sslprovider-property-s3-module) is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when [SSLProvider](#sslprovider-property-s3-module) is set to *Platform* include the following: - CALG_3DES - CALG_3DES_112 - CALG_AES - CALG_AES_128 - CALG_AES_192 - CALG_AES_256 - CALG_AGREEDKEY_ANY - CALG_CYLINK_MEK - CALG_DES - CALG_DESX - CALG_DH_EPHEM - CALG_DH_SF - CALG_DSS_SIGN - CALG_ECDH - CALG_ECDH_EPHEM - CALG_ECDSA - CALG_ECMQV - CALG_HASH_REPLACE_OWF - CALG_HUGHES_MD5 - CALG_HMAC - CALG_KEA_KEYX - CALG_MAC - CALG_MD2 - CALG_MD4 - CALG_MD5 - CALG_NO_SIGN - CALG_OID_INFO_CNG_ONLY - CALG_OID_INFO_PARAMETERS - CALG_PCT1_MASTER - CALG_RC2 - CALG_RC4 - CALG_RC5 - CALG_RSA_KEYX - CALG_RSA_SIGN - CALG_SCHANNEL_ENC_KEY - CALG_SCHANNEL_MAC_KEY - CALG_SCHANNEL_MASTER_HASH - CALG_SEAL - CALG_SHA - CALG_SHA1 - CALG_SHA_256 - CALG_SHA_384 - CALG_SHA_512 - CALG_SKIPJACK - CALG_SSL2_MASTER - CALG_SSL3_MASTER - CALG_SSL3_SHAMD5 - CALG_TEK - CALG_TLS1_MASTER - CALG_TLS1PRF Example values when [SSLProvider](#sslprovider-property-s3-module) is set to *Internal*include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); ``` Possible values when [SSLProvider](#sslprovider-property-s3-module) is set to *Internal* include the following: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_DES_CBC_SHA - TLS_DHE_RSA_WITH_DES_CBC_SHA - TLS_DHE_DSS_WITH_DES_CBC_SHA - TLS_RSA_WITH_RC4_128_MD5 - TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.3 | 12288 (Hex 3000) | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | | TLS1.1 | 768 (Hex 300) (Default - Client) | | TLS1 | 192 (Hex C0) (Default - Client) | | SSL3 | 48 (Hex 30) | | SSL2 | 12 (Hex 0C) | Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases. **SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:** By default when TLS 1.3 is enabled, the class will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-s3-module) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-s3-module) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to *1* (Platform provider), please be aware of the following notes: - The platform provider is available only on Windows 11/Windows Server 2022 and up. - [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions. **SSLEnabledProtocols: SSL2 and SSL3 Notes: ** SSL 2.0 and 3.0 are not supported by the class when the [SSLProvider](#sslprovider-property-s3-module) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-s3-module) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension. This configuration setting is applicable only when [SSLProvider](#sslprovider-property-s3-module) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-s3-module) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-s3-module) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-s3-module) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-s3-module) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 0x00000001 | Ignore time validity status of certificate. | | 0x00000002 | Ignore time validity status of CTL. | | 0x00000004 | Ignore non-nested certificate times. | | 0x00000010 | Allow unknown certificate authority. | | 0x00000020 | Ignore wrong certificate usage. | | 0x00000100 | Ignore unknown certificate revocation status. | | 0x00000200 | Ignore unknown CTL signer revocation status. | | 0x00000400 | Ignore unknown certificate authority revocation status. | | 0x00000800 | Ignore unknown root revocation status. | | 0x00008000 | Allow test root certificate. | | 0x00004000 | Trust test root certificate. | | 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). | This functionality is currently not available when the provider is OpenSSL. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-s3-module) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class . The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [SSLProvider](#sslprovider-property-s3-module) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting. NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group. In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" - "ffdhe_6144" - "ffdhe_8192" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "ed25519" (default) - "ed448" (default) - "ecdsa_secp256r1_sha256" (default) - "ecdsa_secp384r1_sha384" (default) - "ecdsa_secp521r1_sha512" (default) - "rsa_pkcs1_sha256" (default) - "rsa_pkcs1_sha384" (default) - "rsa_pkcs1_sha512" (default) - "rsa_pss_sha256" (default) - "rsa_pss_sha384" (default) - "rsa_pss_sha512" (default) The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" (default) - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" (default) - "ffdhe_6144" (default) - "ffdhe_8192" (default) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-s3-module) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries. This setting is set to *false* by default on all platforms. # Trappable Errors ([S3](#s3-module) Module) ### Common Errors | | | | --- | --- | | 600 | A server error occurred or the class was not able to process the server's response. Please refer to the error message for more information. | | 601 | An unsupported operation or action was attempted. | | 602 | The [RawRequest](#RawRequest) or [RawResponse](#RawResponse) configuration setting was queried without first setting the TransferredRequest configuration setting to ON. | | 603 | The login credentials specified were invalid. Please refer to the error message for more information. | | 604 | An invalid remote resource identifier (e.g., a name, path, Id) was specified. | | 605 | An invalid index was specified. | | 606 | An upload was aborted by the user before it could finish. | | 607 | The specified resource is a folder and cannot be downloaded. | | 608 | A download failed because the specified [LocalFile](#localfile-property-s3-module) already exists and [Overwrite](#overwrite-property-s3-module) is false. | | 609 | The class could not resume a download or upload. Please refer to the error message for more information. | | 610 | An encrypted download could not be resumed because the [DownloadTempFile](#DownloadTempFile) configuration setting is not set. | | 611 | An exception occurred while working with the specified [LocalFile](#localfile-property-s3-module) (or the current value of [LocalFile](#localfile-property-s3-module) is invalid). Please refer to the error message for more information. | | 612 | An exception occurred while working with the specified upload or download stream. Please refer to the error message for more information. | ### HTTP Errors | | | | --- | --- | | 118 | Firewall error. The error description contains the detailed message. | | 143 | Busy executing current method. | | 151 | HTTP protocol error. The error message has the server response. | | 152 | No server specified in URL. | | 153 | Specified URLScheme is invalid. | | 155 | Range operation is not supported by server. | | 156 | Invalid cookie index (out of range). | | 301 | Interrupted. | | 302 | Cannot open AttachedFile. | ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the RemotePort at this time. A connection is in progress. | | 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. | | 102 | The RemoteHost address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the LocalPort at this time. A connection is in progress. | | 107 | You cannot change the [LocalHost](#localhost-property-s3-module) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | RemotePort cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the class is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 302 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### SSL Errors | | | | --- | --- | | 270 | Cannot load specified security library. | | 271 | Cannot open certificate store. | | 272 | Cannot find specified certificate. | | 273 | Cannot acquire security credentials. | | 274 | Cannot find certificate chain. | | 275 | Cannot verify certificate chain. | | 276 | Error during handshake. | | 280 | Error verifying certificate. | | 281 | Could not find client certificate. | | 282 | Could not find server certificate. | | 283 | Error encrypting data. | | 284 | Error decrypting data. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). |