Index

A B C D E F G H I J L M N O P Q R S T U V W X Z
All Classes|All Packages|Constant Field Values|Serialized Form

A

abortCheck() - Method in interface com.chilkatsoft.chilkat2.ProgressListener

Called periodically (every HeartbeatMs milliseconds on the classes that have that property) during a long-running method.

abortUpload() - Method in class com.chilkatsoft.chilkat2.Upload

May be called during an asynchronous upload to abort.

acceptNext(int, Socket) - Method in class com.chilkatsoft.chilkat2.Socket

Waits for and accepts the next incoming connection on a socket previously configured by BindAndListen or BindAndListenPortRange.

access() - Method in class com.chilkatsoft.chilkat2.SecureString

Returns the clear-text string value.

accumulateTagContent(String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Traverses the subtree rooted at the calling element and concatenates the text content of all elements whose tag equals tag.

acquireContext(String) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Initializes communication with the card inserted in the given reader.

activate() - Method in class com.chilkatsoft.chilkat2.TrustedRoots

Activates this object's trust configuration for Chilkat-wide certificate validation.

addArray(Xml, String, String, StringArray) - Method in class com.chilkatsoft.chilkat2.Xmp

Adds or replaces an XMP property array.

addArrayAt(int) - Method in class com.chilkatsoft.chilkat2.JsonArray

Inserts a new, empty JSON array at zero-based position index.

addArrayAt(int, String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Inserts a new JSON array member named name at the zero-based member position index.

addArrayAt2(int, JsonArray) - Method in class com.chilkatsoft.chilkat2.JsonArray

Inserts a new, empty JSON array at zero-based position index and updates jarr to reference the newly inserted array.

addArrayCopyAt(int, String, JsonArray) - Method in class com.chilkatsoft.chilkat2.JsonObject

Inserts a new JSON array member named name at the zero-based member position index.

addAttachmentBd(String, BinData, String) - Method in class com.chilkatsoft.chilkat2.Email

Adds an attachment using the contents of a BinData object.

addAttachmentHeader(int, String, String) - Method in class com.chilkatsoft.chilkat2.Email

Adds or replaces a MIME header field in one of the email attachments.

addAttribute(String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Adds an attribute named name with the specified string value to the calling element.

addAttributeInt(String, int) - Method in class com.chilkatsoft.chilkat2.Xml

Adds an attribute named name whose value is the decimal representation of value.

addAuthQueryParam(String, String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Adds a name/value query parameter to the authorization URL produced by OAuth2.startAuth().

addAvoidOutboundLinkPattern(String) - Method in class com.chilkatsoft.chilkat2.Spider

Adds a wildcarded pattern to prevent collecting matching outbound link URLs.

addAvoidPattern(String) - Method in class com.chilkatsoft.chilkat2.Spider

Adds a wildcarded pattern to prevent spidering matching URLs.

addBcc(String, String) - Method in class com.chilkatsoft.chilkat2.Email

Adds a recipient to the blind carbon-copy (BCC) list.

addBd(String, BinData) - Method in class com.chilkatsoft.chilkat2.Zip

Adds the contents of a BinData object as a new entry in the ZIP archive.

addBdForUpload(String, String, BinData, String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Adds a file to an upload request where the contents of the file come from byteData.

addBoolAt(int, boolean) - Method in class com.chilkatsoft.chilkat2.JsonArray

Inserts a new JSON boolean value at zero-based position index.

addBoolAt(int, String, boolean) - Method in class com.chilkatsoft.chilkat2.JsonObject

Inserts a new JSON boolean member named name at the zero-based member position index.

addCacheRoot(String) - Method in class com.chilkatsoft.chilkat2.Http

Disk caching operates similarly to browser caching of web pages, but it focuses on downloading web pages rather than handling HTTP requests to a REST API.

addCacheRoot(String) - Method in class com.chilkatsoft.chilkat2.Mht

Adds dir as a persistent root directory for the disk cache.

addCC(String, String) - Method in class com.chilkatsoft.chilkat2.Email

Adds a recipient to the carbon-copy list.

addCert(Cert) - Method in class com.chilkatsoft.chilkat2.TrustedRoots

Adds the certificate in cert to this object's explicit trusted-certificate collection.

addCert(Cert) - Method in class com.chilkatsoft.chilkat2.XmlCertVault

Adds a certificate to the XML vault.

addCert(Cert, boolean) - Method in class com.chilkatsoft.chilkat2.Pem

Adds a certificate, and potentially the certs in its chain of authentication to the PEM.

addCert(Cert, boolean) - Method in class com.chilkatsoft.chilkat2.Pfx

Adds cert to this PFX as an identity.

addCertChain(CertChain) - Method in class com.chilkatsoft.chilkat2.XmlCertVault

Adds a chain of certificates to the XML vault.

addCertEncoded(String, String) - Method in class com.chilkatsoft.chilkat2.XmlCertVault

Adds a certificate to the XML vault where certificate is passed directly from encoded bytes (such as Base64, Hex, etc.).

addCertFile(String) - Method in class com.chilkatsoft.chilkat2.XmlCertVault

Adds a certificate to the XML vault.

addCertificate(Cert) - Method in class com.chilkatsoft.chilkat2.CertStore

On Windows, this updates or adds cert to the open Windows certificate store.

addCertString(String) - Method in class com.chilkatsoft.chilkat2.XmlCertVault

Adds a certificate from any string representation format such as PEM.

addChildTree(Xml) - Method in class com.chilkatsoft.chilkat2.Xml

Adds the entire XML subtree referenced by tree as a new direct child of the calling element.

addClaims(JsonObject) - Method in class com.chilkatsoft.chilkat2.AuthGoogle

Adds additional custom claims to the JWT claims set.

addClientHeaders() - Method in class com.chilkatsoft.chilkat2.WebSocket

Adds the standard client opening-handshake headers to the Rest object supplied to UseConnection:

addContentLength() - Method in class com.chilkatsoft.chilkat2.Mime

Computes the byte length of the current entity's serialized MIME body and adds or updates its Content-Length header.

addCustomHeader(String, String) - Method in class com.chilkatsoft.chilkat2.Mht

Adds an HTTP request header to the persistent custom-header collection used for the main page, redirect targets, and every HTTP/HTTPS dependent-resource request, including requests to third-party hosts.

addCustomHeader(String, String) - Method in class com.chilkatsoft.chilkat2.Upload

Adds a custom HTTP header to the HTTP upload.

addDays(int) - Method in class com.chilkatsoft.chilkat2.DateTime

Adds an integer number of days to the date/time.

addDecryptCert(Cert) - Method in class com.chilkatsoft.chilkat2.Mime

Adds cert to the internal collection of certificates available for S/MIME decryption.

addDefaultNameservers() - Method in class com.chilkatsoft.chilkat2.Dns

Adds the default (auto-assigned) nameservers to the collection of nameservers used by Chilkat for DNS queries and domain to IP address lookups.

addDetachedSignature(Cert) - Method in class com.chilkatsoft.chilkat2.Mime

Creates an S/MIME detached signature using cert.

addDetachedSignature2(Cert, boolean) - Method in class com.chilkatsoft.chilkat2.Mime

Creates the same detached multipart/signed structure as Mime.addDetachedSignature(Cert).

addDetachedSignaturePk(Cert, PrivateKey) - Method in class com.chilkatsoft.chilkat2.Mime

Creates a detached S/MIME signature using cert as the signer certificate and privateKey as its associated private key.

addDetachedSignaturePk2(Cert, PrivateKey, boolean) - Method in class com.chilkatsoft.chilkat2.Mime

Creates a detached S/MIME signature using the certificate in cert and the corresponding private key in privateKey.

addDirRoot(String) - Method in class com.chilkatsoft.chilkat2.Tar

Adds the directory tree at dirPath to the set of sources used by the next WriteTar* operation.

addDirRoot2(String, String) - Method in class com.chilkatsoft.chilkat2.Tar

Adds the directory tree at rootPath to the archive-creation source list and stores its entries beneath the archive prefix supplied in rootPrefix.

addEmail(Email) - Method in class com.chilkatsoft.chilkat2.EmailBundle

Adds an independent copy of the Email object in email to the end of this in-memory bundle.

addEmbeddedFiles(JsonObject, String) - Method in class com.chilkatsoft.chilkat2.Pdf

Embeds one or more files in a PDF.

addEmbeddedFiles2(JsonObject) - Method in class com.chilkatsoft.chilkat2.Pdf

The same as Pdf.addEmbeddedFiles(JsonObject, String), except that the updated PDF stays in memory instead of being written to a file.

addEmbeddedFilesBd(JsonObject, BinData) - Method in class com.chilkatsoft.chilkat2.Pdf

The same as AddEmbeddedFiles, but writes the resultant PDF to the bd.

addEmpty(boolean, String) - Method in class com.chilkatsoft.chilkat2.Zip

Adds an empty file or directory entry to the ZIP archive.

addEncapsulatedTimeStamp(JsonObject, StringBuilder) - Method in class com.chilkatsoft.chilkat2.XmlDSig

Adds an EncapsulatedTimeStamp to the signature indicated by the Selector property.

addEncoded(String, String, String) - Method in class com.chilkatsoft.chilkat2.Zip

Adds encoded binary data as a ZIP entry.

addEncryptCert(Cert) - Method in class com.chilkatsoft.chilkat2.Crypt2

Adds a certificate for public-key encryption.

addEncryptCert(Cert) - Method in class com.chilkatsoft.chilkat2.Email

Allows for certificates to be explicitly specified for sending encrypted email to one or more recipients.

addEncryptCert(Cert) - Method in class com.chilkatsoft.chilkat2.Mime

Adds cert to the internal recipient-certificate list used by Mime.encryptN().

addEncryptCert(Cert) - Method in class com.chilkatsoft.chilkat2.Pdf

Adds a recipient certificate for certificate-based encryption.

addEntropy(String, String) - Method in class com.chilkatsoft.chilkat2.Prng

Adds caller-supplied seed material to the PRNG.

addEnvelopedRef(String, StringBuilder, String, String, String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Specifies an enveloped Reference to be added to the Signature when generated.

addExternalBinaryRef(String, BinData, String, String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Specifies an external non-XML binary data Reference to be added to the Signature when generated.

addExternalFileRef(String, String, String, String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Specifies an external file Reference to be added to the Signature when generated.

addExternalStyleSheet(String) - Method in class com.chilkatsoft.chilkat2.Mht

Adds the style-sheet URL in url to the persistent list of external CSS resources downloaded and embedded during conversion.

addExternalTextRef(String, StringBuilder, String, boolean, String, String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Specifies an external non-XML text data Reference to be added to the Signature when generated.

addExternalXmlRef(String, StringBuilder, String, String, String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Specifies an external XML Reference to be added to the Signature when generated.

addFile(String) - Method in class com.chilkatsoft.chilkat2.Tar

Adds the local file at path to the set of sources used by the next WriteTar* operation.

addFile(String, boolean) - Method in class com.chilkatsoft.chilkat2.Zip

Adds a file or directory from the local filesystem to the ZIP archive.

addFile2(String, String) - Method in class com.chilkatsoft.chilkat2.Tar

Adds the local file at filePath to the archive-creation source list and stores it using the exact archive path supplied in pathWithinTar.

addFileAttachment(String) - Method in class com.chilkatsoft.chilkat2.Email

Adds a file as an attachment to the email.

addFileAttachment2(String, String) - Method in class com.chilkatsoft.chilkat2.Email

Same as Email.addFileAttachment(String), but the content type can be explicitly specified.

addFileForUpload(String, String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Adds a file to an upload request.

addFileForUpload2(String, String, String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Same as AddFileForUpload, but allows the Content-Type header field to be directly specified.

addFileReference(String, String) - Method in class com.chilkatsoft.chilkat2.Upload

Adds a file to the list of files to be uploaded in the next call to BlockingUpload, BeginUpload, or UploadToMemory.

addFromXmlSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Hashtable

Reads hashtable XML previously produced by ToXmlSb from the StringBuilder passed in sbXml and adds the entries to this table.

addFunction(String, String) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Adds a named curl function that can be used in dependency resolution.

addHeader(String, String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Adds a request header to the HTTP request.

addHeader(String, String) - Method in class com.chilkatsoft.chilkat2.Rest

Adds an HTTP request header using name as the field name and value as the field value.

addHeaderField(String, String) - Method in class com.chilkatsoft.chilkat2.Email

Any standard or non-standard (custom) header field can be added to the email with this method.

addHeaderField(String, String) - Method in class com.chilkatsoft.chilkat2.Mime

Appends a new header field named by name with the value in value.

addHeaderField2(String, String) - Method in class com.chilkatsoft.chilkat2.Email

This method is the same as Email.addHeaderField(String, String), except that if the header field already exists, it is not replaced.

addHtmlAlternativeBody(String) - Method in class com.chilkatsoft.chilkat2.Email

Adds or replaces the HTML body representation of the email.

addiCalendarAlternativeBody(String, String) - Method in class com.chilkatsoft.chilkat2.Email

Adds or replaces an iCalendar body as a text/calendar alternative.

addInt(String, int) - Method in class com.chilkatsoft.chilkat2.Hashtable

Adds an entry whose string key is key and whose value is the integer value.

addIntAt(int, int) - Method in class com.chilkatsoft.chilkat2.JsonArray

Inserts a new JSON integer value at zero-based position index.

addIntAt(int, String, int) - Method in class com.chilkatsoft.chilkat2.JsonObject

Inserts a new JSON number member named name at the zero-based member position index.

addItem(String, String, String) - Method in class com.chilkatsoft.chilkat2.Pem

Adds a certificate, private key, public key, or csr to the PEM.

addJavaKeyStore(JavaKeyStore) - Method in class com.chilkatsoft.chilkat2.TrustedRoots

Adds the certificates designated as trusted entries in the keystore JavaKeyStore to this object's explicit trusted-certificate collection.

addMultipleBcc(String) - Method in class com.chilkatsoft.chilkat2.Email

Parses the mailbox list in commaSeparatedAddresses and appends the results to the blind carbon-copy (Bcc) recipient list.

addMultipleCC(String) - Method in class com.chilkatsoft.chilkat2.Email

Parses the mailbox list in commaSeparatedAddresses and appends the results to the carbon-copy (Cc) recipient list.

addMultipleTo(String) - Method in class com.chilkatsoft.chilkat2.Email

Parses the mailbox list in commaSeparatedAddresses and appends the results to the direct-recipient (To) list.

addMustMatchPattern(String) - Method in class com.chilkatsoft.chilkat2.Spider

Adds a wildcarded pattern to limit spidering to only URLs that match the pattern.

addMwsSignature(String, String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Computes the Amazon MWS signature using the mwsSecretKey and adds the Signature parameter to the request.

addMwsSignature(String, String, String, String) - Method in class com.chilkatsoft.chilkat2.Rest

Computes the Amazon Marketplace Web Service (MWS) request signature using the secret key in mwsSecretKey and adds or replaces the Signature query parameter.

addNameserver(String, boolean) - Method in class com.chilkatsoft.chilkat2.Dns

Adds a new nameserver to the collection of nameservers used by Chilkat for DNS queries and domain to IP address lookups.

addNoCompressExtension(String) - Method in class com.chilkatsoft.chilkat2.Zip

Adds a file extension to the internal "no-compression" list.

addNsMapping(String, String) - Method in class com.chilkatsoft.chilkat2.Xmp

Adds a namespace to URI mapping.

addNullAt(int) - Method in class com.chilkatsoft.chilkat2.JsonArray

Inserts a JSON null value at zero-based position index.

addNullAt(int, String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Inserts a new JSON null member named name at the zero-based member position index.

addNumberAt(int, String) - Method in class com.chilkatsoft.chilkat2.JsonArray

Inserts a JSON number at zero-based position index.

addNumberAt(int, String, String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Inserts a new JSON number member named name at the zero-based member position index.

addObject(String, String, String, String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Specifies an Object to be added to the Signature.

addObjectAt(int) - Method in class com.chilkatsoft.chilkat2.JsonArray

Inserts a new, empty JSON object at zero-based position index.

addObjectAt(int, String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Inserts a new JSON object member named name at the zero-based member position index.

addObjectAt2(int, JsonObject) - Method in class com.chilkatsoft.chilkat2.JsonArray

Inserts a new, empty JSON object at zero-based position index and updates json to reference the newly inserted object.

addObjectCopyAt(int, JsonObject) - Method in class com.chilkatsoft.chilkat2.JsonArray

Inserts an independent copy of jsonObj at zero-based position index.

addObjectCopyAt(int, String, JsonObject) - Method in class com.chilkatsoft.chilkat2.JsonObject

Inserts a new JSON object member named name at the zero-based member position index.

addObjectRef(String, String, String, String, String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

This is the same as the AddSameDocRef method, except the reference is to content within an Object previously added via the AddObject method.

addObjectRef2(String, String, Xml, String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

This method is the same as AddObjectRef, except it allows the Transforms to be specified exactly with a fragment of XML.

addOrUpdateAttribute(String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the string value of an attribute on the calling element.

addOrUpdateAttributeI(String, int) - Method in class com.chilkatsoft.chilkat2.Xml

Sets an integer-valued attribute on the calling element.

addOutput(String, String, String) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Adds or updates a defined output for a dependency resolution curl function previously defined by calling HttpCurl.addFunction(String, String).

addOutput2(String, String, String, String, boolean, String, String) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Adds or updates an output variable definition for a dependency-resolution curl function previously created by calling AddFunction.

addP7b(BinData) - Method in class com.chilkatsoft.chilkat2.Pem

Loads the PEM from the contents of an PKCS7 container (.p7b) contained in bd.

addParam(String, String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Adds a request query parameter (name/value pair) to the HTTP request.

addParam(String, String) - Method in class com.chilkatsoft.chilkat2.OAuth1

Adds an extra name/value parameter to the OAuth1 signature.

addParam(String, String) - Method in class com.chilkatsoft.chilkat2.Upload

Adds a custom HTTP request parameter to the upload.

addPathParam(String, String) - Method in class com.chilkatsoft.chilkat2.Rest

Adds or replaces a path-substitution parameter.

addPemFile(String, String) - Method in class com.chilkatsoft.chilkat2.XmlCertVault

Adds the contents of a PEM file to the XML vault.

addPfx(Pfx) - Method in class com.chilkatsoft.chilkat2.XmlCertVault

Adds a PFX (PKCS12) to the XML vault.

addPfx(Pfx, String, String) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Imports the private-key entries found in the Pfx object supplied in pfx.

addPfxEncoded(String, String, String) - Method in class com.chilkatsoft.chilkat2.XmlCertVault

Adds a PFX to the XML vault where PFX is passed directly from encoded bytes (such as Base64, Hex, etc.).

addPfxFile(String, String) - Method in class com.chilkatsoft.chilkat2.XmlCertVault

Adds a PFX file to the XML vault.

addPfxSourceBd(BinData, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Adds a PFX file to the object's list of sources for locating certificates and private keys during public-key decryption or signing.

addPfxSourceBd(BinData, String) - Method in class com.chilkatsoft.chilkat2.Email

Adds the PFX data in bd to the list of certificate and private-key sources used during decryption or signing.

addPfxSourceBd(BinData, String) - Method in class com.chilkatsoft.chilkat2.Imap

Adds the PKCS #12/PFX data in the BinData in bd as a source of certificates and private keys for S/MIME processing.

addPfxSourceBd(BinData, String) - Method in class com.chilkatsoft.chilkat2.MailMan

Adds a PFX/PKCS#12 certificate store to the MailMan object's internal list of sources used for locating certificates and private keys.

addPfxSourceBd(BinData, String) - Method in class com.chilkatsoft.chilkat2.Mime

Adds the PKCS #12/PFX bytes in bd to the internal collection of credential sources used by later S/MIME decryption operations.

addPfxSourceFile(String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Adds a PFX file to the object's list of sources for locating certificates and private keys during public-key decryption or signing.

addPfxSourceFile(String, String) - Method in class com.chilkatsoft.chilkat2.Email

Adds the PFX file specified by pfxFilePath to the internal list of certificate and private-key sources used during decryption.

addPfxSourceFile(String, String) - Method in class com.chilkatsoft.chilkat2.Imap

Adds a PKCS #12/PFX file that may be searched for certificates and private keys needed for S/MIME decryption or signature processing.

addPfxSourceFile(String, String) - Method in class com.chilkatsoft.chilkat2.MailMan

Adds a PFX/PKCS#12 file to the MailMan object's internal list of sources used for locating certificates and private keys.

addPfxSourceFile(String, String) - Method in class com.chilkatsoft.chilkat2.Mime

Adds the PFX/P12 file at the local filesystem path in pfxFilePath to the internal collection of credential sources used by later S/MIME decryption operations.

addPlainTextAlternativeBody(String) - Method in class com.chilkatsoft.chilkat2.Email

Adds or replaces the plain-text body representation of the email.

addPrivateKey(Cert, String, String) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Adds a private-key entry using the certificate in cert.

addPrivateKey(PrivateKey) - Method in class com.chilkatsoft.chilkat2.Pem

Adds a private key to the PEM object.

addPrivateKey(PrivateKey, CertChain) - Method in class com.chilkatsoft.chilkat2.Pfx

Adds privKey and the certificate chain in certChain to this PFX object.

addPrivateKey2(PrivateKey, CertChain) - Method in class com.chilkatsoft.chilkat2.Pem

Adds a private key and it's associated certificate chain to the PEM object.

addPublicKey(PublicKey) - Method in class com.chilkatsoft.chilkat2.Pem

Adds a public key to the PEM object.

addQueryParam(String, String) - Method in class com.chilkatsoft.chilkat2.Rest

Adds or replaces a query-string parameter using name as the parameter name and value as its value.

addQueryParams(String) - Method in class com.chilkatsoft.chilkat2.Hashtable

Parses URL query parameters from queryParams and adds them to the hashtable as string entries.

addQueryParams(String) - Method in class com.chilkatsoft.chilkat2.Rest

Adds multiple query parameters from the query-string text in queryString.

addQueryParamSb(String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Rest

Adds or replaces a query-string parameter named by name.

addRefreshQueryParam(String, String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Adds a provider-specific name/value parameter to requests sent by OAuth2.refreshAccessToken().

addRelatedBd(String, BinData) - Method in class com.chilkatsoft.chilkat2.Email

Adds a related item using the contents of a BinData object.

addRelatedBd2(BinData, String) - Method in class com.chilkatsoft.chilkat2.Email

Adds a related item using the binary data in binData.

addRelatedFile(String) - Method in class com.chilkatsoft.chilkat2.Email

Adds the contents of the local file in path as a related MIME resource and returns the generated Content-ID.

addRelatedFile2(String, String) - Method in class com.chilkatsoft.chilkat2.Email

Adds the local file in filenameOnDisk as a related MIME resource addressed by Content-Location rather than Content-ID.

addRelatedHeader(int, String, String) - Method in class com.chilkatsoft.chilkat2.Email

Adds or replaces a MIME header field in one of the email's related items.

addRelatedString(String, String, String) - Method in class com.chilkatsoft.chilkat2.Email

Adds a text-based related MIME resource, such as a style sheet, and returns the generated Content-ID.

addRelatedString2(String, String, String) - Method in class com.chilkatsoft.chilkat2.Email

Adds a related item to the email from an in-memory string.

addRoot(String) - Method in class com.chilkatsoft.chilkat2.Cache

Adds path as a root directory for the disk cache.

addSameDocRef(String, String, String, String, String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Specifies a same document Reference to be added to the Signature when generated.

addSameDocRef2(String, String, Xml, String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

This method is the same as AddSameDocRef, except it allows the Transforms to be specified exactly with a fragment of XML.

addSan(String, String) - Method in class com.chilkatsoft.chilkat2.Csr

Adds one Subject Alternative Name to the CSR that will be generated.

addSb(String, StringBuilder, String) - Method in class com.chilkatsoft.chilkat2.Zip

Adds the contents of a StringBuilder object as a text entry in the ZIP archive.

addSeconds(int) - Method in class com.chilkatsoft.chilkat2.DateTime

Adds an integer number of seconds to the date/time.

addSecretKey(String, String, String, String, String) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Adds a symmetric secret-key entry.

addSignature(String, Cert, JsonObject) - Method in class com.chilkatsoft.chilkat2.CodeSign

Adds a Microsoft Authenticode signature to the file specified by path.

addSignatureNamespace(String, String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Can be called one or more times to add additional namespaces to the Signature element.

addSigningCert(Cert) - Method in class com.chilkatsoft.chilkat2.Crypt2

Call this method once per certificate to add multiple certificates for signing.

addSigningCert(Cert) - Method in class com.chilkatsoft.chilkat2.Pdf

Adds a certificate to be used for PDF signing.

addSimpleInt(Xml, String, int) - Method in class com.chilkatsoft.chilkat2.Xmp

Adds or updates an XMP integer property.

addSimpleStr(Xml, String, String) - Method in class com.chilkatsoft.chilkat2.Xmp

Adds or updates a simple XMP string property.

addSslAcceptableClientCaDn(String) - Method in class com.chilkatsoft.chilkat2.Socket

Adds a certificate-authority distinguished name to the list advertised by a TLS server when requesting a client certificate for mutual TLS.

addSslServerCert(Cert, String) - Method in class com.chilkatsoft.chilkat2.Socket

Adds a server certificate to be presented when a TLS client's SNI (Server Name Indication) hostname matches hostname.

addStr(String, String) - Method in class com.chilkatsoft.chilkat2.Hashtable

Adds an entry whose string key is key and whose value is the string value.

addString(String, String, String) - Method in class com.chilkatsoft.chilkat2.Zip

Adds a string as a text file entry in the ZIP archive.

addStringAt(int, String) - Method in class com.chilkatsoft.chilkat2.JsonArray

Inserts a new JSON string value at zero-based position index.

addStringAt(int, String, String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Inserts a new JSON string member named name at the zero-based member position index.

addStringAttachment(String, String) - Method in class com.chilkatsoft.chilkat2.Email

Adds an attachment directly from a string in memory to the email.

addStringAttachment2(String, String, String) - Method in class com.chilkatsoft.chilkat2.Email

Adds a text attachment using the in-memory string in content.

addStringForUpload(String, String, String, String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Same as AddFileForUpload, but the upload data comes from an in-memory string instead of a file.

addStringForUpload2(String, String, String, String, String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Same as AddStringForUpload, but allows the Content-Type header field to be directly specified.

addStructProp(Xml, String, String, String) - Method in class com.chilkatsoft.chilkat2.Xmp

Adds or updates an XMP structured property value.

addStyleSheet(String) - Method in class com.chilkatsoft.chilkat2.Xml

Adds an XML stylesheet processing instruction to the document.

addSubHeader(int, String, String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Adds a request header to the Nth sub-header of the HTTP request.

addTargetOutput(String, String) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Adds an automatically mapped variable for the target curl command.

addTo(String, String) - Method in class com.chilkatsoft.chilkat2.Email

Adds a recipient to the to list.

addToAttribute(String, int) - Method in class com.chilkatsoft.chilkat2.Xml

Treats the named attribute value as an integer, adds amount, and stores the resulting integer back in the attribute.

addToChildContent(String, int) - Method in class com.chilkatsoft.chilkat2.Xml

Finds the child identified by tag, interprets its content as an integer, adds amount, and stores the resulting integer as the child's new content.

addToContent(int) - Method in class com.chilkatsoft.chilkat2.Xml

Interprets this element's content as an integer, adds amount, and stores the resulting integer as the new content.

addTokenQueryParam(String, String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Adds a provider-specific name/value parameter to the authorization-code token request that Chilkat sends after receiving the browser redirect.

addTrustedCert(Cert, String) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Adds cert as a trusted-certificate entry under the alias supplied in aliasName.

addUIntAt(int, long) - Method in class com.chilkatsoft.chilkat2.JsonArray

Inserts a new JSON unsigned integer value at zero-based position index.

addUnspidered(String) - Method in class com.chilkatsoft.chilkat2.Spider

To begin spidering you must call this method one or more times to provide starting points.

addVerificationInfo(JsonObject, String) - Method in class com.chilkatsoft.chilkat2.Pdf

Adds LTV verification information to the PDF, and saves the updated PDF to outFilePath.

addVerificationInfo2(JsonObject) - Method in class com.chilkatsoft.chilkat2.Pdf

The same as Pdf.addVerificationInfo(JsonObject, String), except that the updated PDF stays in memory instead of being written to a file.

advancePosition() - Method in class com.chilkatsoft.chilkat2.DirTree

Advances the traversal from the current item to the next file or subdirectory.

aesDecrypt(String) - Method in class com.chilkatsoft.chilkat2.Email

Decrypts and restores an email message that was previously encrypted using Email.aesEncrypt(String).

aesEncrypt(String) - Method in class com.chilkatsoft.chilkat2.Email

Encrypts the email body, all alternative bodies, all message sub-parts, and attachments using 128-bit AES CBC encryption.

aesKeyUnwrap(String, String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Implements the AES Key Wrap Algorithm (RFC 3394) for unwrapping.

aesKeyUnwrapWithPadding(String, String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Implements the AES Key Wrap with Padding Algorithm (RFC 5649) for unwrapping.

aesKeyWrap(String, String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Implements the AES Key Wrap Algorithm (RFC 3394).

aesKeyWrapWithPadding(String, String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Implements the AES Key Wrap with Padding Algorithm (RFC 5649).

Ai - Class in com.chilkatsoft.chilkat2

<section class="ai-summary">

Ai() - Constructor for class com.chilkatsoft.chilkat2.Ai

Creates a new Ai object.

append(Xml) - Method in class com.chilkatsoft.chilkat2.Xmp

Appends a new XMP metadata file to the XMP object.

append(String) - Method in class com.chilkatsoft.chilkat2.SecureString

Appends a clear-text string to this secure string.

append(String) - Method in class com.chilkatsoft.chilkat2.StringArray

Appends a string to the end of the internal ordered collection.

append(String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Appends a copy of the specified string to this instance.

append(String) - Method in class com.chilkatsoft.chilkat2.StringTable

Appends a string to the table.

appendAnsi(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Appends text to the currently open file after converting the string to the legacy ANSI character encoding used by Chilkat for the platform.

appendArray(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Appends a new JSON array member named name to this object.

appendArray2(String, JsonArray) - Method in class com.chilkatsoft.chilkat2.JsonObject

Appends a new JSON array member named name to this object.

appendArrayCopy(String, JsonArray) - Method in class com.chilkatsoft.chilkat2.JsonObject

Appends a new JSON array member named name to this object.

appendArrayItems(JsonArray) - Method in class com.chilkatsoft.chilkat2.JsonArray

Appends copies of all values from jarr to the end of this array, preserving their order.

appendBd(BinData) - Method in class com.chilkatsoft.chilkat2.BinData

Appends the contents of another BinData to this object.

appendBd(BinData) - Method in class com.chilkatsoft.chilkat2.FileAccess

Appends all bytes contained in bd to the currently open file without text conversion.

appendBd(BinData, String, int, int) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Appends the contents of binData.

appendBigInt(String, String) - Method in class com.chilkatsoft.chilkat2.Asn

Appends an ASN.1 integer, but one that is a big (huge) integer that is too large to be represented by an integer variable.

appendBits(String, String) - Method in class com.chilkatsoft.chilkat2.Asn

Appends an ASN.1 bit string to the caller's sub-items.

appendBom(String) - Method in class com.chilkatsoft.chilkat2.BinData

Appends the appropriate BOM (byte order mark), also known as a preamble, for the given charset.

appendBool(boolean) - Method in class com.chilkatsoft.chilkat2.Asn

Appends an ASN.1 boolean item to the caller's sub-items.

appendBool(String, boolean) - Method in class com.chilkatsoft.chilkat2.JsonObject

Appends a new JSON boolean member named name to this object.

appendByte(int) - Method in class com.chilkatsoft.chilkat2.BinData

Appends a single byte.

appendContextConstructed(int) - Method in class com.chilkatsoft.chilkat2.Asn

Appends an ASN.1 context-specific constructed item to the caller's sub-items.

appendContextPrimitive(int, String, String) - Method in class com.chilkatsoft.chilkat2.Asn

Appends an ASN.1 context-specific primitive item to the caller's sub-items.

appendCountedString(int, boolean, String, String) - Method in class com.chilkatsoft.chilkat2.BinData

Appends a byte count followed by the string in the desired character encoding, such as utf-8.

appendData(byte[]) - Method in class com.chilkatsoft.chilkat2.BinData

Appends binary data to the current contents.

appendEncoded(String, String) - Method in class com.chilkatsoft.chilkat2.BinData

Appends encoded binary data to the current data.

appendEncodedSb(StringBuilder, String) - Method in class com.chilkatsoft.chilkat2.BinData

Decodes the contents of sb and appends the decoded bytes to this object.

appendFile(String, String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Appends the contents of the local file at localFilePath to the remote file at remoteFilePath.

appendFileBd(String, BinData) - Method in class com.chilkatsoft.chilkat2.Ftp2

Appends the bytes in the BinData object bd to the remote file at remoteFilename.

appendFileFromTextData(String, String, String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Encodes the text in textData using the character encoding named by charset and appends the resulting bytes to the remote file at remoteFilename.

appendFiles(String, boolean) - Method in class com.chilkatsoft.chilkat2.Zip

Adds one or more files matching a wildcard pattern.

appendFileSb(String, StringBuilder, String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Encodes the text in the StringBuilder sb using the charset named by charset and appends the resulting bytes to the remote file at remoteFilename.

appendFilesEx(String, boolean, boolean, boolean, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.Zip

Advanced version of AppendFiles with additional filtering and path options.

appendFromFile(int, String, String) - Method in class com.chilkatsoft.chilkat2.StringTable

Appends strings, one per line, from a file.

appendFromSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.StringTable

Appends strings, one per line, from the contents of a StringBuilder object.

appendInt(int) - Method in class com.chilkatsoft.chilkat2.Asn

Appends an ASN.1 integer item to the caller's sub-items.

appendInt(int) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Appends the string representation of a specified 32-bit signed integer to this instance.

appendInt(String, int) - Method in class com.chilkatsoft.chilkat2.JsonObject

Appends a new JSON number member named name to this object.

appendInt2(int, boolean) - Method in class com.chilkatsoft.chilkat2.BinData

Appends a 16-bit integer (2 bytes).

appendInt4(int, boolean) - Method in class com.chilkatsoft.chilkat2.BinData

Appends a 32-bit integer (4 bytes).

appendInt64(long) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Appends the string representation of a specified 64-bit signed integer to this instance.

appendLine(String, boolean) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Appends the str followed by a CRLF or LF to the end of the curent StringBuilder object.

appendLn(String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Appends the str followed by a CRLF to the end of this object.

appendMail(String, Email) - Method in class com.chilkatsoft.chilkat2.Imap

Appends the Email in email to the mailbox named by mailbox.

appendMime(String, String) - Method in class com.chilkatsoft.chilkat2.Imap

Appends the complete RFC 822/MIME message in mimeText to the mailbox named by mailbox.

appendMimeWithDateStr(String, String, String) - Method in class com.chilkatsoft.chilkat2.Imap

Appends the MIME message in mimeText to the mailbox named by mailbox while explicitly setting the server-side internal date from internalDateStr.

appendMimeWithFlags(String, String, boolean, boolean, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.Imap

Appends the MIME message in mimeText to the mailbox named by mailbox and sets its initial system flags.

appendMimeWithFlagsSb(String, StringBuilder, boolean, boolean, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.Imap

Appends the MIME contained in the StringBuilder in sbMime to mailbox mailbox and sets its initial system flags.

appendNull() - Method in class com.chilkatsoft.chilkat2.Asn

Appends an ASN.1 null item to the caller's sub-items.

appendObject(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Appends a new JSON object member named name to this object.

appendObject2(String, JsonObject) - Method in class com.chilkatsoft.chilkat2.JsonObject

Appends a new JSON object member named name to this object.

appendObjectCopy(String, JsonObject) - Method in class com.chilkatsoft.chilkat2.JsonObject

Appends a new JSON object member named name to this object.

appendOctets(String, String) - Method in class com.chilkatsoft.chilkat2.Asn

Appends an ASN.1 octet string to the caller's sub-items.

appendOid(String) - Method in class com.chilkatsoft.chilkat2.Asn

Appends an ASN.1 OID (object identifier) to the caller's sub-items.

appendPadded(String, String, boolean, int) - Method in class com.chilkatsoft.chilkat2.BinData

Appends a string to this object, padded to the fieldLen with NULL or SPACE chars.

appendPart(Mime) - Method in class com.chilkatsoft.chilkat2.Mime

Appends a copy of mime as the last direct child.

appendPartFromFile(String) - Method in class com.chilkatsoft.chilkat2.Mime

Reads the local file at filename, creates an attachment part, and appends it.

appendRandom(int, String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Append numBytes random bytes encoded according to encoding.

appendSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.SecureString

Appends a clear-text string contained in a StringBuilder to this secure string.

appendSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Appends the contents of another StringBuilder to this instance.

appendSb(StringBuilder, String) - Method in class com.chilkatsoft.chilkat2.BinData

Appends the contents of a StringBuilder to this object.

appendSb(StringBuilder, String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Appends the text contained in sb to the currently open file using the character encoding specified by charset.

appendSecure(SecureString) - Method in class com.chilkatsoft.chilkat2.SecureString

Appends the contents of a secure string to this secure string.

appendSequence() - Method in class com.chilkatsoft.chilkat2.Asn

Appends an ASN.1 sequence item to the caller's sub-items.

appendSequence2() - Method in class com.chilkatsoft.chilkat2.Asn

Appends an ASN.1 sequence item to the caller's sub-items, and updates the internal reference to point to the newly appended sequence item.

appendSequenceR() - Method in class com.chilkatsoft.chilkat2.Asn

Appends an ASN.1 sequence item to the caller's sub-items, and returns the newly appended sequence item.

appendSerialized(String) - Method in class com.chilkatsoft.chilkat2.StringArray

Appends multiple strings to the end of the internal ordered collection.

appendSet() - Method in class com.chilkatsoft.chilkat2.Asn

Appends an ASN.1 set item to the caller's sub-items.

appendSet2() - Method in class com.chilkatsoft.chilkat2.Asn

Appends an ASN.1 set item to the caller's sub-items, and updates the internal reference to point to the newly appended set item.

appendSetR() - Method in class com.chilkatsoft.chilkat2.Asn

Appends an ASN.1 set item to the caller's sub-items, and returns the newly appended set item.

appendString(String, String) - Method in class com.chilkatsoft.chilkat2.Asn

Appends a string item to the caller's sub-items.

appendString(String, String) - Method in class com.chilkatsoft.chilkat2.BinData

Appends a string to this object.

appendString(String, String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Appends a new JSON string member named name to this object.

appendString(String, String) - Method in class com.chilkatsoft.chilkat2.ZipEntry

Appends text data to this ZIP entry's file contents.

appendStringArray(String, StringTable) - Method in class com.chilkatsoft.chilkat2.JsonObject

Appends a new JSON array member named name to this object.

appendText(String, String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Appends str to the currently open file after encoding the text with the character set named by charset, such as utf-8 or iso-8859-1.

appendTime(String, String) - Method in class com.chilkatsoft.chilkat2.Asn

Appends a UTCTime item to the caller's sub-items.

appendToBody(String) - Method in class com.chilkatsoft.chilkat2.Email

Appends a string to the plain-text body.

appendToContent(String) - Method in class com.chilkatsoft.chilkat2.Xml

Appends str to the existing text content of the calling element without replacing its child elements.

appendUnicodeBOM() - Method in class com.chilkatsoft.chilkat2.FileAccess

Appends the UTF-16 little-endian byte-order mark to the currently open file.

appendUtf8BOM() - Method in class com.chilkatsoft.chilkat2.FileAccess

Appends the UTF-8 byte-order mark to the currently open file.

appendUuid(boolean) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Generates and appends a random GUID/UUID such as 63c35f38-2b5f-4600-b3da-3ddee86d62b3.

appendUuid7(boolean) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Generates and appends a random version 7 UUID.

appendZip(String) - Method in class com.chilkatsoft.chilkat2.Zip

Note: This method is currently not working and will be fixed in v11.5.0

applyFixups(String) - Method in class com.chilkatsoft.chilkat2.Email

Repairs selected MIME-formatting problems commonly found in email produced by other software.

argon2DeriveKey(String, String, BinData) - Method in class com.chilkatsoft.chilkat2.Crypt2

Derives a key from a password using Argon2, the memory-hard key derivation function specified in RFC 9106.

argon2HashPassword(String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Hashes a password using Argon2 (RFC 9106) and returns the result as a PHC format string, such as

argon2VerifyPassword(String, String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Verifies password against a PHC format Argon2 hash string previously produced by Crypt2.argon2HashPassword(String, String) (or by any other RFC 9106 implementation).

arrayAt(int) - Method in class com.chilkatsoft.chilkat2.JsonArray

Returns the nested JSON array stored at zero-based position index.

arrayAt(int) - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns the JSON array stored in the member at zero-based position index.

arrayAt2(int, JsonArray) - Method in class com.chilkatsoft.chilkat2.JsonArray

Updates jarr so that it references the nested JSON array stored at zero-based position index.

arrayAt2(int, JsonArray) - Method in class com.chilkatsoft.chilkat2.JsonObject

Updates jarr to reference the JSON array stored at zero-based member position index and returns true on success.

arrayOf(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns the JSON array at jsonPath.

arrayOf2(String, JsonArray) - Method in class com.chilkatsoft.chilkat2.JsonObject

Updates jarr to reference the JSON array at jsonPath and returns true on success.

ask(String) - Method in class com.chilkatsoft.chilkat2.Ai

Sends the current potentially multimodal input within the context of the selected conversation and receives the model's output.

Asn - Class in com.chilkatsoft.chilkat2

<section class="asn-summary">

Asn() - Constructor for class com.chilkatsoft.chilkat2.Asn

Creates a new Asn object.

asnBodyToXml() - Method in class com.chilkatsoft.chilkat2.Mime

Parses the current part's decoded body as ASN.1 DER and returns an XML representation of the ASN.1 structure.

asnToXml() - Method in class com.chilkatsoft.chilkat2.Asn

Converts ASN.1 to XML and returns the XML string.

aspUnpack(String, String, String, boolean) - Method in class com.chilkatsoft.chilkat2.Email

Unpacks an HTML email's body and its related items (images, style sheets, and the like) to the filesystem: each related part is written as a separate file, and the HTML is rewritten so those parts load as ordinary files instead of cid: references.

attachEmail(Email) - Method in class com.chilkatsoft.chilkat2.Email

Attaches a copy of email to this email object.

AuthAws - Class in com.chilkatsoft.chilkat2

<section class="authaws-summary">

AuthAws() - Constructor for class com.chilkatsoft.chilkat2.AuthAws

Creates a new AuthAws object.

AuthAzureSAS - Class in com.chilkatsoft.chilkat2

<section class="authazuresas-summary">

AuthAzureSAS() - Constructor for class com.chilkatsoft.chilkat2.AuthAzureSAS

Creates a new AuthAzureSAS object.

AuthAzureStorage - Class in com.chilkatsoft.chilkat2

<section class="authazurestorage-summary">

AuthAzureStorage() - Constructor for class com.chilkatsoft.chilkat2.AuthAzureStorage

Creates a new AuthAzureStorage object.

authenticatePk(String, SshKey) - Method in class com.chilkatsoft.chilkat2.SFtp

Authenticates the connected SSH session using public-key authentication.

authenticatePk(String, SshKey) - Method in class com.chilkatsoft.chilkat2.Ssh

Authenticates an active, unauthenticated SSH connection using public-key authentication.

authenticatePk(String, SshKey) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Authenticates with the SSH server using public-key authentication.

authenticatePw(String, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Authenticates the connected SSH session using login and password.

authenticatePw(String, String) - Method in class com.chilkatsoft.chilkat2.Ssh

Authenticates an active, unauthenticated SSH connection using login and password.

authenticatePw(String, String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Authenticates with the SSH server using login and password.

authenticatePwPk(String, String, SshKey) - Method in class com.chilkatsoft.chilkat2.SFtp

Authenticates with a server that requires both a password and a private key.

authenticatePwPk(String, String, SshKey) - Method in class com.chilkatsoft.chilkat2.Ssh

Authenticates with a server that requires both a password and a private key.

authenticatePwPk(String, String, SshKey) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Authenticates with an SSH server that requires both a password and a private key.

authenticateSecPw(SecureString, SecureString) - Method in class com.chilkatsoft.chilkat2.SFtp

Works like SFtp.authenticatePw(String, String), but receives login and password in SecureString objects.

authenticateSecPw(SecureString, SecureString) - Method in class com.chilkatsoft.chilkat2.Ssh

Performs the same authentication as Ssh.authenticatePw(String, String), but receives the login and password in SecureString objects.

authenticateSecPw(SecureString, SecureString) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Performs the same password authentication as SshTunnel.authenticatePw(String, String), but receives the login and password in SecureString objects.

authenticateSecPwPk(SecureString, SecureString, SshKey) - Method in class com.chilkatsoft.chilkat2.SFtp

Works like SFtp.authenticatePwPk(String, String, SshKey), but receives username and password in SecureString objects.

authenticateSecPwPk(SecureString, SecureString, SshKey) - Method in class com.chilkatsoft.chilkat2.Ssh

Performs the same combined password/private-key authentication as Ssh.authenticatePwPk(String, String, SshKey), but receives the username and password in SecureString objects.

authenticateSecPwPk(SecureString, SecureString, SshKey) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Performs the same combined password-and-private-key authentication as SshTunnel.authenticatePwPk(String, String, SshKey), but receives the username and password in SecureString objects.

AuthGoogle - Class in com.chilkatsoft.chilkat2

<section class="authgoogle-summary">

AuthGoogle() - Constructor for class com.chilkatsoft.chilkat2.AuthGoogle

Creates a new AuthGoogle object.

B

barcode(String, JsonObject, JsonObject) - Method in class com.chilkatsoft.chilkat2.Formats

Runs one barcode operation and returns the result as JSON.

bCryptHash(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Computes and returns a bcrypt hash of the password.

bCryptVerify(String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Verifies the password against a previously computed BCrypt hash.

beginAccepting(int) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Creates and starts the local listener on listenPort.

beginIterate() - Method in class com.chilkatsoft.chilkat2.DirTree

Initializes a new traversal using the current BaseDir and Recurse settings.

beginStream() - Method in class com.chilkatsoft.chilkat2.ZipCrc

Provides a way to calculate a CRC by streaming the data a chunk at a time.

beginTransaction() - Method in class com.chilkatsoft.chilkat2.SCard

Establishes a temporary exclusive access mode for doing a series of commands in a transaction.

beginUpload() - Method in class com.chilkatsoft.chilkat2.Upload

Starts an asynchronous upload.

bEncodeString(String, String) - Method in class com.chilkatsoft.chilkat2.Email

Converts the Unicode string in str to the charset specified by charset, B-encodes the resulting multibyte data, and returns the encoded string.

bindAndListen(int, int) - Method in class com.chilkatsoft.chilkat2.Socket

Binds a TCP listener to port and places it into listening mode.

bindAndListenPortRange(int, int, int) - Method in class com.chilkatsoft.chilkat2.Socket

Searches the inclusive range beginPort through endPort for an available TCP port, binds it, and begins listening.

BinData - Class in com.chilkatsoft.chilkat2

<section class="bindata-summary">

BinData() - Constructor for class com.chilkatsoft.chilkat2.BinData

Creates a new BinData object.

blockingUpload() - Method in class com.chilkatsoft.chilkat2.Upload

Uploads files to a web server using HTTP.

boolAt(int) - Method in class com.chilkatsoft.chilkat2.JsonArray

Returns the boolean value stored at zero-based position index.

boolAt(int) - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns the boolean value of the member at zero-based position index.

boolOf(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns the boolean value at jsonPath.

buildCertChain(CertChain) - Method in class com.chilkatsoft.chilkat2.Cert

Builds the certificate chain in certChain containing all the certificates (including this one), in the chain of authentication to the trusted root (if possible).

buildHttpGetRequest(String) - Method in class com.chilkatsoft.chilkat2.Socket

Builds and returns a simple HTTP GET request for url.

bytesOf(String, String, BinData) - Method in class com.chilkatsoft.chilkat2.JsonObject

Reads the string value at jsonPath, decodes it using encoding (for example, base64 or hex), and appends the resulting bytes to bd.

byteSwap(int) - Method in class com.chilkatsoft.chilkat2.BinData

Does either 16-bit or 32-bit byte swapping of the entire contents.

Bz2 - Class in com.chilkatsoft.chilkat2

Chilkat.Bz2 provides BZip2 compression and decompression for files, memory buffers, and BinData.

Bz2() - Constructor for class com.chilkatsoft.chilkat2.Bz2

Creates a new Bz2 object.

C

Cache - Class in com.chilkatsoft.chilkat2

<section class="cache-summary">

Cache() - Constructor for class com.chilkatsoft.chilkat2.Cache

Creates a new Cache object.

callFunction(JsonObject, JsonObject) - Method in class com.chilkatsoft.chilkat2.Js

Calls a JavaScript function.

callTool(String, JsonObject, JsonObject) - Method in class com.chilkatsoft.chilkat2.Mcp

Calls the MCP tools/call method for the tool named name, passing the JSON arguments object in argsJson.

cancel() - Method in class com.chilkatsoft.chilkat2.OAuth2

Requests cancellation of the authorization flow currently running in the background thread.

canonicalizeFragment(String, String, String, String, boolean) - Method in class com.chilkatsoft.chilkat2.XmlDSig

Applies XML canonicalization to a fragment of the passed-in XML, and returns the canonicalized XML string.

canonicalizeUrl(String) - Method in class com.chilkatsoft.chilkat2.Spider

Canonicalizes a URL by doing the following: Drops username/password if present.

canonicalizeXml(String, String, boolean) - Method in class com.chilkatsoft.chilkat2.XmlDSig

Applies XML canonicalization to the passed-in XML, and returns the canonicalized XML string.

capability() - Method in class com.chilkatsoft.chilkat2.Imap

Sends the IMAP CAPABILITY command and returns the server's raw capability response.

cardDeleteFile(String, String) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Deletes the file specified by dirName and fileName.

Cert - Class in com.chilkatsoft.chilkat2

<section class="cert-summary">

Cert() - Constructor for class com.chilkatsoft.chilkat2.Cert

Creates a new Cert object.

certAt(int, Cert) - Method in class com.chilkatsoft.chilkat2.CertChain

Populates cert with the certificate at the specified zero-based index.

certAt(int, Cert) - Method in class com.chilkatsoft.chilkat2.Pem

Returns in cert the Nth certificate from the PEM.

certAt(int, Cert) - Method in class com.chilkatsoft.chilkat2.Pfx

Copies the certificate at the zero-based index index into cert.

certAt(int, Cert) - Method in class com.chilkatsoft.chilkat2.TrustedRoots

Copies the certificate at zero-based index into the caller-supplied Cert object in cert.

certByLocalKeyId(String, String, Cert) - Method in class com.chilkatsoft.chilkat2.Pfx

Searches for a certificate whose certificate-bag localKeyId attribute matches localKeyId and copies it into cert.

CertChain - Class in com.chilkatsoft.chilkat2

<section class="certchain-summary">

CertChain() - Constructor for class com.chilkatsoft.chilkat2.CertChain

Creates a new CertChain object.

certChainAt(int, CertChain) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Loads certChain with the certificate chain belonging to the private-key entry at zero-based index index.

certChainOf(String, boolean, CertChain) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Searches the private-key entries for an alias equal to aliasName and loads the matching certificate chain into certChain.

CertStore - Class in com.chilkatsoft.chilkat2

<section class="certstore-summary">

CertStore() - Constructor for class com.chilkatsoft.chilkat2.CertStore

Creates a new CertStore object.

changePassword(int, String, String) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Changes the password protecting the private-key entry at index.

changeRemoteDir(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Changes the current working directory on the FTP server to remoteDirPath.

channelIsOpen(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Returns true when channelNum identifies a channel that Chilkat currently considers open for application I/O; otherwise returns false.

channelPoll(int, int) - Method in class com.chilkatsoft.chilkat2.Ssh

Polls channelNum for incoming SSH channel messages, waiting at most pollTimeoutMs milliseconds.

channelRead(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Reads incoming SSH channel messages for channelNum.

channelReadAndPoll(int, int) - Method in class com.chilkatsoft.chilkat2.Ssh

Reads channelNum in two phases: Waits for the first applicable channel message.

channelReadAndPoll2(int, int, int) - Method in class com.chilkatsoft.chilkat2.Ssh

Works like Ssh.channelReadAndPoll(int, int), but also returns after newly processed data causes the total buffered channel data to reach or exceed maxNumBytes.

channelReceivedClose(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Returns true if an SSH CLOSE message has been received for channelNum.

channelReceivedEof(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Returns true if an SSH EOF message has been received for channelNum.

channelReceivedExitStatus(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Returns true if the server supplied an exit-status value for channelNum.

channelReceiveToClose(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Receives data on channelNum until the server sends and Chilkat processes channel CLOSE.

channelReceiveUntilMatch(int, String, String, boolean) - Method in class com.chilkatsoft.chilkat2.Ssh

Receives text on channelNum until the accumulated text matches matchPattern.

channelReceiveUntilMatchN(int, StringArray, String, boolean) - Method in class com.chilkatsoft.chilkat2.Ssh

Works like Ssh.channelReceiveUntilMatch(int, String, String, boolean), but returns when any pattern in matchPatterns is matched.

channelRelease(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Releases Chilkat’s retained local resources for channelNum after all required output and exit information has been retrieved.

channelSendClose(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Sends an SSH CLOSE message for channelNum and immediately marks the channel locally closed.

channelSendEof(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Sends an SSH EOF message on channelNum.

channelSendString(int, String, String) - Method in class com.chilkatsoft.chilkat2.Ssh

Encodes textData using charset, then sends the resulting bytes on channelNum.

Charset - Class in com.chilkatsoft.chilkat2

<section class="charset-summary">

Charset() - Constructor for class com.chilkatsoft.chilkat2.Charset

Creates a new Charset object.

charsetConvert(String, String, boolean) - Method in class com.chilkatsoft.chilkat2.BinData

This method converts the character encoding of an object's contents from one format to another, such as from Windows-1252 to UTF-8.

charsetToCodePage(String) - Method in class com.chilkatsoft.chilkat2.Charset

Returns the numeric Windows code-page identifier corresponding to charsetName.

checkConnection() - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns whether Chilkat currently considers the FTP control connection to be open.

checkConnection() - Method in class com.chilkatsoft.chilkat2.Imap

Checks whether the underlying TCP socket is currently connected to the IMAP server.

checkConnection() - Method in class com.chilkatsoft.chilkat2.Ssh

Returns true when the underlying SSH transport currently appears connected, and false when the object is unconnected, has been disconnected, a connection attempt failed, or transport loss has already been detected.

checkMail() - Method in class com.chilkatsoft.chilkat2.MailMan

Returns the number of messages currently available in the POP3 mailbox.

checkRevoked() - Method in class com.chilkatsoft.chilkat2.Cert

Returns 1 if the certificate has been revoked, 0 if not revoked, and -1 if unable to check the revocation status.

checkSmartCardPin() - Method in class com.chilkatsoft.chilkat2.Cert

Verifies that the SmartCardPin property setting is correct.

checkStatus() - Method in class com.chilkatsoft.chilkat2.SCard

Check the current status of the currently connected reader.

checkWriteable(int) - Method in class com.chilkatsoft.chilkat2.Socket

Waits for the connected socket to become writable.

childContentMatches(String, String, boolean) - Method in class com.chilkatsoft.chilkat2.Xml

Returns true if the child identified by tagPath has content matching pattern; otherwise returns false.

Chilkat2Native - Class in com.chilkatsoft.chilkat2

Loads the native library (chilkat2java) once per JVM.

ChilkatException - Exception in com.chilkatsoft.chilkat2

Thrown when a Chilkat method fails: a status method that returned false, or a string- or object-returning method that returned nothing (except the methods documented as returning null when not found, which do not throw).

ChilkatObject - Class in com.chilkatsoft.chilkat2

The base class of every Chilkat2 Java class.

chilkatPath(String) - Method in class com.chilkatsoft.chilkat2.Xml

Evaluates a Chilkat-specific path command that can navigate from the current element, return element content or an attribute value, or move the caller's internal element reference.

ckDecryptFile(String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

File-to-file decryption that supports files of any size by using internal streaming mode.

ckEncryptFile(String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Encrypts a file to another file using streaming mode, allowing files of virtually any size to be processed without loading the entire file into memory.

clear() - Method in class com.chilkatsoft.chilkat2.AuthAzureSAS

Clears all params set by the methods SetNonTokenParam and SetTokenParam.

clear() - Method in class com.chilkatsoft.chilkat2.BinData

Clears the contents.

clear() - Method in class com.chilkatsoft.chilkat2.Email

Removes the current message content, including recipients, headers, body representations, attachments, related items, and embedded messages.

clear() - Method in class com.chilkatsoft.chilkat2.EmailBundle

Removes and discards all emails from this in-memory bundle.

clear() - Method in class com.chilkatsoft.chilkat2.Hashtable

Removes every entry from the hashtable.

clear() - Method in class com.chilkatsoft.chilkat2.JsonArray

Removes all values from the array, leaving an empty JSON array ([]).

clear() - Method in class com.chilkatsoft.chilkat2.JsonObject

Removes all members from this JSON object, leaving an empty object equivalent to {}.

clear() - Method in class com.chilkatsoft.chilkat2.Pem

Removes all content from this PEM object.

clear() - Method in class com.chilkatsoft.chilkat2.StringArray

Remove all strings from the internal collection.

clear() - Method in class com.chilkatsoft.chilkat2.StringBuilder

Removes all characters from the current StringBuilder instance.

clear() - Method in class com.chilkatsoft.chilkat2.StringTable

Removes all the strings from the table.

clear() - Method in class com.chilkatsoft.chilkat2.Xml

Clears the calling element by removing all child elements, attributes, and text content, and resets its tag name to unnamed.

clear(String) - Method in class com.chilkatsoft.chilkat2.Log

Clears all existing log entries and starts a new log whose top-level context is named initialTag.

clearAllHeaders() - Method in class com.chilkatsoft.chilkat2.Rest

Removes all HTTP request headers previously added to this object.

clearAllParts() - Method in class com.chilkatsoft.chilkat2.Rest

Removes all multipart subparts from the request under construction.

clearAllPathParams() - Method in class com.chilkatsoft.chilkat2.Rest

Removes all path-substitution parameters previously added with Rest.addPathParam(String, String).

clearAllQueryParams() - Method in class com.chilkatsoft.chilkat2.Rest

Removes all query parameters previously added to this object.

clearAuth() - Method in class com.chilkatsoft.chilkat2.Rest

Clears authentication providers and credentials previously configured through this class's SetAuth* methods.

clearBcc() - Method in class com.chilkatsoft.chilkat2.Email

Clears the list of blind carbon-copy recipients.

clearCache() - Method in class com.chilkatsoft.chilkat2.SFtp

Clears the internal remote file-attribute cache used when SFtp.getEnableCache() is true.

clearCC() - Method in class com.chilkatsoft.chilkat2.Email

Clears the list of carbon-copy recipients.

clearControlChannel() - Method in class com.chilkatsoft.chilkat2.Ftp2

Requests that an explicit-FTPS control connection return to clear text after authentication.

clearCustomHeaders() - Method in class com.chilkatsoft.chilkat2.Mht

Removes all HTTP request headers previously added with Mht.addCustomHeader(String, String).

clearDirCache() - Method in class com.chilkatsoft.chilkat2.Ftp2

Clears the cached listing for the current remote directory.

clearDirRootsAndFiles() - Method in class com.chilkatsoft.chilkat2.Tar

Removes all files and directory roots previously registered by Tar.addDirRoot(String), Tar.addDirRoot2(String, String), Tar.addFile(String), and Tar.addFile2(String, String).

clearEncryptCerts() - Method in class com.chilkatsoft.chilkat2.Crypt2

Clears the internal list of digital certificates to be used for public-key encryption.

clearEncryptCerts() - Method in class com.chilkatsoft.chilkat2.Email

Clears the internal list of explicitly specified certificates to be used for this encrypted email.

clearEncryptCerts() - Method in class com.chilkatsoft.chilkat2.Mime

Clears the internal recipient-certificate list populated by Mime.addEncryptCert(Cert).

clearEncryptCerts() - Method in class com.chilkatsoft.chilkat2.Pdf

Removes every recipient certificate added with Pdf.addEncryptCert(Cert).

clearFailedUrls() - Method in class com.chilkatsoft.chilkat2.Spider

Clears the object's internal list of URLs that could not be downloaded.

clearFileReferences() - Method in class com.chilkatsoft.chilkat2.Upload

Clears the internal list of files created by calls to AddFileReference.

clearHeaders() - Method in class com.chilkatsoft.chilkat2.Http

Removes all headers set by the Http.setRequestHeader(String, String) method.

clearInMemoryCookies() - Method in class com.chilkatsoft.chilkat2.Http

Clears all in-memory cookies accumulated while the Http.getSaveCookies() property was set to true and the Http.getCookieDir() was set to memory.

clearOutboundLinks() - Method in class com.chilkatsoft.chilkat2.Spider

Clears the object's internal list of outbound URLs that will automatically accumulate while spidering.

clearParams() - Method in class com.chilkatsoft.chilkat2.Upload

Clears the internal list of params created by calls to AddParam.

clearPop3SessionLog() - Method in class com.chilkatsoft.chilkat2.MailMan

Clears the current contents of the MailMan.getPop3SessionLog() property.

clearResponseBodyStream() - Method in class com.chilkatsoft.chilkat2.Rest

Clears the response-stream destination previously configured by Rest.setResponseBodyStream(int, boolean, Stream).

clearSessionLog() - Method in class com.chilkatsoft.chilkat2.Ftp2

Clears the in-memory FTP protocol log collected while Ftp2.getKeepSessionLog() is enabled.

clearSessionLog() - Method in class com.chilkatsoft.chilkat2.Imap

Clears the in-memory text returned by Imap.getSessionLog().

clearSessionLog() - Method in class com.chilkatsoft.chilkat2.SFtp

Clears the in-memory text stored in SFtp.getSessionLog().

clearSessionLog() - Method in class com.chilkatsoft.chilkat2.Socket

Clears the accumulated text returned by SessionLog for this wrapper.

clearSigningCerts() - Method in class com.chilkatsoft.chilkat2.Crypt2

Clears the set of certificates to be used in signing.

clearSmtpSessionLog() - Method in class com.chilkatsoft.chilkat2.MailMan

Clears the current contents of the MailMan.getSmtpSessionLog() property.

clearSpideredUrls() - Method in class com.chilkatsoft.chilkat2.Spider

Clears the object's internal list of already-spidered URLs that will automatically accumulate while spidering.

clearSslServerCerts() - Method in class com.chilkatsoft.chilkat2.Socket

Removes every certificate added by AddSslServerCert.

clearTargetOutput(String) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Clears (undefines) the target output for the specified varName.

clearTo() - Method in class com.chilkatsoft.chilkat2.Email

Clears the list of to recipients.

clearTtyModes() - Method in class com.chilkatsoft.chilkat2.Ssh

Clears all TTY mode settings previously added with Ssh.setTtyMode(String, int).

clearUrlVars() - Method in class com.chilkatsoft.chilkat2.Http

Removes all URL variable values previously set by Http.setUrlVar(String, String) .

clearVar(String) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Undefines the variable with the specified name.

clearWithNewCapacity(int) - Method in class com.chilkatsoft.chilkat2.Hashtable

Removes every entry and reinitializes the hashtable with capacity buckets.

close() - Method in class com.chilkatsoft.chilkat2.ChilkatObject

Releases the native Chilkat object.

closeAllConnections() - Method in class com.chilkatsoft.chilkat2.Http

Closes all remaining open HTTP connections.

closeCertStore() - Method in class com.chilkatsoft.chilkat2.CertStore

This method closes any open certificate stores, removes all certificates from the object, and sets the NumCertificates property back to 0.

closeConnection() - Method in class com.chilkatsoft.chilkat2.WebSocket

Immediately closes the underlying network connection without completing the WebSocket closing handshake.

closeConnection(int) - Method in class com.chilkatsoft.chilkat2.Socket

Attempts to gracefully terminate and close the current TCP, TLS, or SSH channel connection.

closeHandle(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Closes the remote file or directory handle specified by handle.

closeMailbox(String) - Method in class com.chilkatsoft.chilkat2.Imap

Closes the currently selected mailbox while keeping the authenticated IMAP connection open.

closeSession() - Method in class com.chilkatsoft.chilkat2.Mcp

Explicitly terminates the MCP session by sending an HTTP DELETE with the Mcp-Session-Id header, then releases the connection.

closeSession() - Method in class com.chilkatsoft.chilkat2.Pkcs11

Closes the session on the token (i.e.

closeSmtpConnection() - Method in class com.chilkatsoft.chilkat2.MailMan

Explicitly closes the current SMTP connection.

closeTunnel(boolean) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Disconnects active tunnel clients and stops the tunnel-manager thread.

closeZip() - Method in class com.chilkatsoft.chilkat2.Zip

Closes the currently open ZIP archive and clears all entries from the Zip object.

codePageToCharset(int) - Method in class com.chilkatsoft.chilkat2.Charset

Returns the charset name corresponding to the numeric code-page identifier in codePage.

CodeSign - Class in com.chilkatsoft.chilkat2

<section class="codesign-summary">

CodeSign() - Constructor for class com.chilkatsoft.chilkat2.CodeSign

Creates a new CodeSign object.

com.chilkatsoft.chilkat2 - package com.chilkatsoft.chilkat2

compareType3(String, String) - Method in class com.chilkatsoft.chilkat2.Ntlm

Compares two encoded Type 3 authenticate messages and returns true when their LM and NT challenge-response fields match.

compressBd(BinData) - Method in class com.chilkatsoft.chilkat2.Bz2

Compresses the current contents of bd in place.

compressBd(BinData) - Method in class com.chilkatsoft.chilkat2.Compression

Compresses the data contained in a BinData object.

compressBd(BinData) - Method in class com.chilkatsoft.chilkat2.Gzip

Compresses the contents of a BinData object in place, replacing the original data with Gzip-compressed data.

compressBd2(BinData, BinData) - Method in class com.chilkatsoft.chilkat2.Compression

Compresses the data in one BinData object and appends the compressed output to another BinData object.

compressEncryptFile(JsonObject, String, String) - Method in class com.chilkatsoft.chilkat2.Compression

Compresses and encrypts a file, writing the result to a destination file.

compressFile(String, String) - Method in class com.chilkatsoft.chilkat2.Bz2

Reads the file at inFilename and writes its compressed bytes as a standard BZip2 stream to the file at toPath.

compressFile(String, String) - Method in class com.chilkatsoft.chilkat2.Compression

Compresses a source file and writes the compressed data to a destination file.

compressFile(String, String) - Method in class com.chilkatsoft.chilkat2.Gzip

Compresses a file and writes the result as a Gzip file, typically with a .gz extension.

compressFile(String, String) - Method in class com.chilkatsoft.chilkat2.UnixCompress

Compresses a file to create a UNIX compressed file (.Z).

compressFile2(String, String, String) - Method in class com.chilkatsoft.chilkat2.Gzip

Compresses a file and writes the result as a Gzip file, while allowing a different filename to be embedded inside the Gzip data.

compressFileBd(String, BinData) - Method in class com.chilkatsoft.chilkat2.Gzip

Compresses a file and stores the resulting Gzip data in a BinData object.

Compression - Class in com.chilkatsoft.chilkat2

<section class="compression-summary">

Compression() - Constructor for class com.chilkatsoft.chilkat2.Compression

Creates a new Compression object.

compressSb(StringBuilder, BinData) - Method in class com.chilkatsoft.chilkat2.Compression

Compresses the text contained in a StringBuilder and appends the compressed bytes to a BinData object.

compressSb(StringBuilder, String, BinData) - Method in class com.chilkatsoft.chilkat2.Gzip

Compresses the text contained in a StringBuilder and writes the Gzip-compressed result to a BinData object.

compressStream(Stream) - Method in class com.chilkatsoft.chilkat2.Compression

Compresses data from a stream source and writes the compressed data to the stream sink.

compressStringENC(String) - Method in class com.chilkatsoft.chilkat2.Compression

Compresses a string and returns the compressed result as an encoded string.

compressStringENC(String, String, String) - Method in class com.chilkatsoft.chilkat2.Gzip

Compresses a string and returns the Gzip-compressed data as an encoded string.

compressStringToFile(String, String, String) - Method in class com.chilkatsoft.chilkat2.Gzip

Compresses a string and writes the resulting Gzip data to a file.

compressStringToFile(String, String, String) - Method in class com.chilkatsoft.chilkat2.UnixCompress

Unix compresses and creates a .Z file from string data.

computeGlobalKey2(String, boolean) - Method in class com.chilkatsoft.chilkat2.Email

Computes a global unique key for the email.

connect() - Method in class com.chilkatsoft.chilkat2.Ftp2

Connects to the server specified by Ftp2.getHostname() and Ftp2.getPort(), negotiates any configured proxy and TLS layer, receives the FTP greeting, and authenticates using Ftp2.getUsername(), Ftp2.getPassword(), and Ftp2.getAccount().

connect(String) - Method in class com.chilkatsoft.chilkat2.Imap

Establishes a TCP connection to the IMAP server identified by domainName but does not authenticate.

connect(String) - Method in class com.chilkatsoft.chilkat2.Mcp

Connects to the MCP (Model Context Protocol) server at the Streamable HTTP endpoint URL in url (for example https://example.com/mcp) and performs the MCP initialize handshake.

connect(String, int) - Method in class com.chilkatsoft.chilkat2.SFtp

Establishes an SSH connection to domainName on TCP port port.

connect(String, int) - Method in class com.chilkatsoft.chilkat2.Ssh

Establishes an SSH connection to domainName on the TCP port specified by port.

connect(String, int) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Establishes the SSH connection that will carry tunneled traffic.

connect(String, int, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.Rest

Establishes the initial TCP connection to the REST server.

connect(String, int, boolean, int) - Method in class com.chilkatsoft.chilkat2.Socket

Establishes a TCP connection to hostname:port.

connect(String, String, String) - Method in class com.chilkatsoft.chilkat2.SCard

Establish a connection to a reader.

connectOnly() - Method in class com.chilkatsoft.chilkat2.Ftp2

Establishes the configured proxy and TCP connection, performs any configured implicit or explicit TLS setup, and receives the FTP server greeting, but does not send USER or PASS.

connectThroughSsh(Ssh, String, int) - Method in class com.chilkatsoft.chilkat2.SFtp

Connects to hostname on port through the already connected and authenticated Ssh object in sshConn.

connectThroughSsh(Ssh, String, int) - Method in class com.chilkatsoft.chilkat2.Ssh

Connects to another SSH server through the already connected and authenticated Ssh object in ssh.

connectThroughSsh(Ssh, String, int) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Connects to a second SSH server through the existing connected and authenticated Ssh object supplied in ssh.

consoleOutputSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Js

Returns the console output in sb from the last call to Js.eval(StringBuilder, JsonObject) .

constructSignedInfo(StringBuilder) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

This method will construct and return the canonicalized SignedInfo XML.

contains(String) - Method in class com.chilkatsoft.chilkat2.Hashtable

Returns true if the hashtable contains the string key key; otherwise returns false.

contains(String) - Method in class com.chilkatsoft.chilkat2.StringArray

Returns true if the string is present in the internal collection.

contains(String, boolean) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Returns true if the str is contained within this object.

containsEncryptedParts() - Method in class com.chilkatsoft.chilkat2.Mime

Returns true if the currently visible MIME tree contains a CMS/PKCS #7 encrypted entity.

containsId(long) - Method in class com.chilkatsoft.chilkat2.MessageSet

Returns true if the raw numeric value in msgId is present in the message set; otherwise, returns false.

containsIntKey(int) - Method in class com.chilkatsoft.chilkat2.Hashtable

Returns true if the hashtable contains the integer key key; otherwise returns false.

containsSignedParts() - Method in class com.chilkatsoft.chilkat2.Mime

Returns true if the currently visible MIME tree contains a complete detached or opaque CMS/PKCS #7 signed entity.

containsWord(String, boolean) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Returns true if the word is contained within this object, but only if it is a whole word.

contentMatches(String, boolean) - Method in class com.chilkatsoft.chilkat2.Xml

Returns true if this element's content matches pattern; otherwise returns false.

contentsEqual(BinData) - Method in class com.chilkatsoft.chilkat2.BinData

Return true if the contents of this object equals the contents of binData.

contentsEqual(String, boolean) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Returns true if the contents of this object equals the str.

contentsEqualSb(StringBuilder, boolean) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Returns true if the contents of this object equals the sb.

continueKeyboardAuth(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Continues keyboard-interactive authentication by submitting response for the prompts returned by SFtp.startKeyboardAuth(String).

continueKeyboardAuth(String) - Method in class com.chilkatsoft.chilkat2.Ssh

Continues keyboard-interactive authentication by submitting the response in response.

continueKeyboardAuth(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Continues a keyboard-interactive authentication exchange started by SshTunnel.startKeyboardAuth(String).

convert8Bit() - Method in class com.chilkatsoft.chilkat2.Mime

Recursively converts every part whose Content-Transfer-Encoding is 8bit or binary to base64.

convertFile(String, String) - Method in class com.chilkatsoft.chilkat2.Charset

Reads the file at inPath, converts its text from Charset.getFromCharset() to Charset.getToCharset(), and writes the converted bytes to the file at destPath.

convertFile(String, String) - Method in class com.chilkatsoft.chilkat2.HtmlToXml

Converts the HTML file at inHtmlPath to a well-formed XML file at destXmlPath.

convertFileNoPreamble(String, String) - Method in class com.chilkatsoft.chilkat2.Charset

Reads the file at inPath, converts its text from Charset.getFromCharset() to Charset.getToCharset(), and writes the converted bytes to destPath without adding a byte-order mark or other encoding preamble.

convertFromSsl() - Method in class com.chilkatsoft.chilkat2.Socket

Ends the TLS layer while leaving the underlying TCP connection open for subsequent unencrypted communication.

convertHtmlFile(String, String) - Method in class com.chilkatsoft.chilkat2.Charset

Converts the HTML file at inPath to Charset.getToCharset() and writes the result to destPath.

convertInlineImages() - Method in class com.chilkatsoft.chilkat2.Email

Converts images embedded inline within HTML to multipart/related MIME parts referenced from the HTML by CID.

convertToMultipartAlt() - Method in class com.chilkatsoft.chilkat2.Mime

Wraps the current entity in a new outer multipart/alternative entity.

convertToMultipartMixed() - Method in class com.chilkatsoft.chilkat2.Mime

Wraps the current entity in a new outer multipart/mixed entity.

convertToSigned(Cert) - Method in class com.chilkatsoft.chilkat2.Mime

Creates an opaque (attached) S/MIME signature using cert.

convertToSignedPk(Cert, PrivateKey) - Method in class com.chilkatsoft.chilkat2.Mime

Creates an opaque (attached) S/MIME signature using cert as the signer certificate and privateKey as its associated private key.

convertToSsl() - Method in class com.chilkatsoft.chilkat2.Socket

Upgrades an already connected plain TCP socket to TLS by performing a client-side TLS handshake over the existing connection.

convertToTls() - Method in class com.chilkatsoft.chilkat2.Ftp2

Upgrades an already-connected clear FTP control channel to explicit TLS.

copy(long, boolean, String) - Method in class com.chilkatsoft.chilkat2.Imap

Copies one message from the currently selected mailbox to the destination mailbox in copyToMailbox.

copy(Xml) - Method in class com.chilkatsoft.chilkat2.Xml

Copies the Tag, Content, and attributes from node to the calling element.

copyFileAttr(String, String, boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Copies supported timestamps and attributes from the local file at localFilename to the remote item identified by remoteFilename.

copyMultiple(MessageSet, String) - Method in class com.chilkatsoft.chilkat2.Imap

Copies the messages identified by the MessageSet in messageSet from the selected mailbox to destination mailbox copyToMailbox using one IMAP command.

copyRef(JsonObject) - Method in class com.chilkatsoft.chilkat2.JsonObject

Updates jsonObj so that it references the same JSON object as the caller.

copyRef(Xml) - Method in class com.chilkatsoft.chilkat2.Xml

Changes this Xml object so that it references the same underlying XML element as copyFromNode.

copySequence(int, int, String) - Method in class com.chilkatsoft.chilkat2.Imap

Copies a contiguous range of messages, identified by sequence number, from the selected mailbox to the destination mailbox in copyToMailbox.

copyToBase64() - Method in class com.chilkatsoft.chilkat2.ZipEntry

Returns the compressed data for this ZIP entry as a Base64-encoded string.

copyToHex() - Method in class com.chilkatsoft.chilkat2.ZipEntry

Returns the compressed data for this ZIP entry as a hexadecimal encoded string.

coSign(BinData, Cert, BinData) - Method in class com.chilkatsoft.chilkat2.Crypt2

Co-sign's an existing CMS signature.

crawlNext() - Method in class com.chilkatsoft.chilkat2.Spider

Crawls the next URL in the internal list of unspidered URLs.

crcBd(BinData) - Method in class com.chilkatsoft.chilkat2.ZipCrc

Calculates a CRC32 for the bytes contained in bd.

crcBd(String, BinData) - Method in class com.chilkatsoft.chilkat2.Crypt2

Computes a CRC for data contained in crcAlg, which can be either crc-32 used in the Zip file format, or crc8 for the CRC8 algorithm.

crcFile(String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Calculates the CRC for a file's contents using the CRC algorithm specified by crcAlg.

crcSb(StringBuilder, String) - Method in class com.chilkatsoft.chilkat2.ZipCrc

Calculates a CRC32 for the string contained in sb.

crcString(String, String) - Method in class com.chilkatsoft.chilkat2.ZipCrc

Calculates a CRC32 for a string.

createDeb(String, String, String) - Method in class com.chilkatsoft.chilkat2.Tar

Creates a Debian binary package at debPath from the prepared control archive at controlPath and data archive at dataPath.

createDir(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Creates the remote directory specified by path.

createE(int) - Method in class com.chilkatsoft.chilkat2.Dh

Creates this party's public Diffie-Hellman exchange value, conventionally written as E = gx mod p.

createFileStore(String) - Method in class com.chilkatsoft.chilkat2.CertStore

This method, available only on Microsoft Windows, creates a new file-based certificate store.

createJws() - Method in class com.chilkatsoft.chilkat2.Jws

Creates and returns a JWS from the current payload, headers, and signing keys.

createJwsSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Jws

Creates a JWS using the same rules as Jws.createJws() and writes it to sbJws.

createJwt(String, String, String) - Method in class com.chilkatsoft.chilkat2.Jwt

Creates a signed JWT using an HMAC shared secret.

createJwtCert(String, String, Cert) - Method in class com.chilkatsoft.chilkat2.Jwt

Creates a signed JWT using the private key associated with cert.

createJwtPk(String, String, PrivateKey) - Method in class com.chilkatsoft.chilkat2.Jwt

Creates a signed JWT using an asymmetric private key.

createMailbox(String) - Method in class com.chilkatsoft.chilkat2.Imap

Creates the mailbox named by mailbox on the IMAP server.

createMemoryStore() - Method in class com.chilkatsoft.chilkat2.CertStore

This method, available only on Microsoft Windows, creates an in-memory certificate store.

createOcspRequest(JsonObject, BinData) - Method in class com.chilkatsoft.chilkat2.Http

Generates an OCSP request for one or more certificates using JSON (requestDetails) that specifies the request details.

createP7M(String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Signs the contents of inFilename and writes the enveloping (i.e.

createP7S(String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Signs the contents of inFilename and writes the detached PKCS7 signature (.p7s) to p7sPath.

createPkcs11Object(JsonObject) - Method in class com.chilkatsoft.chilkat2.Pkcs11

Creates an object and returns the handle.

createPlan(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Creates and returns a textual upload plan for the local directory at localDir.

createRegistryStore(String, String) - Method in class com.chilkatsoft.chilkat2.CertStore

This method, available only on Microsoft Windows, creates a new registry-based certificate store.

createRemoteDir(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Creates the remote directory at remoteDirPath by sending one MKD command.

createTempMht(String) - Method in class com.chilkatsoft.chilkat2.Email

Prepares the email for display in a web browser and saves it as a temporary MHT (MIME HTML) file, returning the path to the file.

createTimestampRequest(String, String, String, boolean, boolean, BinData) - Method in class com.chilkatsoft.chilkat2.Http

Creates an RFC 3161 time-stamp request and returns the binary request token in timestampToken.

createXmlDSig(String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Creates an XML Digital Signature.

createXmlDSigSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Creates an XML Digital Signature.

Crypt2 - Class in com.chilkatsoft.chilkat2

<section class="crypt2-summary">

Crypt2() - Constructor for class com.chilkatsoft.chilkat2.Crypt2

Creates a new Crypt2 object.

Csr - Class in com.chilkatsoft.chilkat2

<section class="csr-summary">

Csr() - Constructor for class com.chilkatsoft.chilkat2.Csr

Creates a new Csr object.

Csv - Class in com.chilkatsoft.chilkat2

<section class="csv-summary">

Csv() - Constructor for class com.chilkatsoft.chilkat2.Csv

Creates a new Csv object.

D

dateAt(int, DateTime) - Method in class com.chilkatsoft.chilkat2.JsonArray

Parses the date/time value at zero-based position index and loads the result into dt.

dateOf(String, DateTime) - Method in class com.chilkatsoft.chilkat2.JsonObject

Parses the date/time value at jsonPath and loads the result into dt.

DateTime - Class in com.chilkatsoft.chilkat2

CkDateTime represents a date/time value and provides conversion methods for common date/time formats, including .NET DateTime, DateTime ticks, RFC 822, RFC 3339 / ISO 8601-style timestamps, Unix time, DOS date/time, OLE DATE, NTP time, ULID timestamps, and Chilkat DtObj.

DateTime() - Constructor for class com.chilkatsoft.chilkat2.DateTime

Creates a new DateTime object.

deactivate() - Method in class com.chilkatsoft.chilkat2.TrustedRoots

Deactivates the previously activated Chilkat-wide trusted-root configuration.

decode(String, String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Decodes and replaces the contents with the decoded string.

decodeAndAppend(String, String, String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Decodes a binary encoded string, where the binary encoding (such as url, hex, base64, etc.) is specified by encoding, and the underlying charset encoding (such as utf-8, windows-1252, etc.) is specified by charset.

decodeEntities(String) - Method in class com.chilkatsoft.chilkat2.Xml

Decodes HTML character entities found in str and returns the decoded text.

decodeString(String, String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Decodes from an encoding back to the original string.

decompressBd(BinData) - Method in class com.chilkatsoft.chilkat2.Compression

Decompresses the compressed data contained in a BinData object.

decompressBd2(BinData, BinData) - Method in class com.chilkatsoft.chilkat2.Compression

Decompresses the data in one BinData object and appends the decompressed output to another BinData object.

decompressFile(String, String) - Method in class com.chilkatsoft.chilkat2.Compression

Decompresses a source file and writes the decompressed data to a destination file.

decompressSb(BinData, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Compression

Decompresses compressed data from a BinData object and appends the resulting text to a StringBuilder.

decompressStream(Stream) - Method in class com.chilkatsoft.chilkat2.Compression

Decompresses data from a stream source and writes the decompressed data to the stream sink.

decompressStringENC(String) - Method in class com.chilkatsoft.chilkat2.Compression

Decompresses compressed data supplied as an encoded string and returns the resulting text.

decrypt() - Method in class com.chilkatsoft.chilkat2.Mime

Decrypts the current CMS/PKCS #7 encrypted MIME entity and replaces it with the recovered MIME content.

decrypt(int, String) - Method in class com.chilkatsoft.chilkat2.Jwe

Decrypts recipient index from the currently loaded JWE and returns the plaintext decoded using charset charset.

decrypt2(Cert, PrivateKey) - Method in class com.chilkatsoft.chilkat2.Mime

Decrypts the current CMS/PKCS #7 encrypted MIME entity using the certificate in cert and its associated private key in privateKey.

decryptBd(int, BinData) - Method in class com.chilkatsoft.chilkat2.Jwe

Decrypts recipient index and appends the authenticated plaintext bytes to bd.

decryptBd(BinData) - Method in class com.chilkatsoft.chilkat2.Crypt2

Decrypts the contents of bd.

decryptBd(BinData, boolean) - Method in class com.chilkatsoft.chilkat2.Rsa

RSA decrypts the contents of bd.

decryptContent(String) - Method in class com.chilkatsoft.chilkat2.Xml

Decrypts element content previously produced by EncryptContent, using the same password, and restores the original plaintext content.

decryptDecompressFile(JsonObject, String, String) - Method in class com.chilkatsoft.chilkat2.Compression

Decrypts and decompresses a file, writing the restored data to a destination file.

decryptEncoded(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Decrypts encoded encrypted data, and returns the decrypted data as a binary encoded string.

decryptSb(int, String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Jwe

Decrypts recipient index, authenticates the JWE, decodes the plaintext bytes using charset charset, and appends the resulting text to contentSb.

decryptSb(BinData, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Crypt2

This function is intended for use when the expected decrypted output is text.

decryptSecureENC(String, SecureString) - Method in class com.chilkatsoft.chilkat2.Crypt2

This function is intended for use when the expected decrypted output is text.

decryptStringENC(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

This function is intended for use when the expected decrypted output is text.

decryptStringENC(String, boolean) - Method in class com.chilkatsoft.chilkat2.Rsa

Decrypts str with the RSA algorithm.

decryptUsingCert(Cert) - Method in class com.chilkatsoft.chilkat2.Mime

Decrypts the current CMS/PKCS #7 encrypted MIME entity using cert.

decryptUsingPfxFile(String, String) - Method in class com.chilkatsoft.chilkat2.Mime

Decrypts the current CMS/PKCS #7 encrypted MIME entity using certificates and private keys from the PFX/P12 file at the local filesystem path in pfxFilePath.

delete(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Deletes the direct member named name from this JSON object.

deleteAll() - Method in class com.chilkatsoft.chilkat2.Cache

Deletes every cache item from all configured roots and returns the number of cache files removed.

deleteAllExpired() - Method in class com.chilkatsoft.chilkat2.Cache

Deletes all cache items whose stored expiration time is earlier than the current system time and returns the number of files removed.

deleteAt(int) - Method in class com.chilkatsoft.chilkat2.JsonArray

Deletes the value at zero-based position index.

deleteAt(int) - Method in class com.chilkatsoft.chilkat2.JsonObject

Deletes the member at zero-based position index.

deleteBundle(EmailBundle) - Method in class com.chilkatsoft.chilkat2.MailMan

Deletes POP3 messages by using the UIDLs stored in the X-UIDL headers of the Email objects in emailBundle.

deleteByMsgnum(int) - Method in class com.chilkatsoft.chilkat2.MailMan

Marks an email for deletion by its POP3 message number.

deleteByUidl(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Marks the POP3 message identified by the UIDL in uidl for deletion.

deleteCert(Cert, boolean) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Deletes a certificate and optionally its associated private key from the smart card.

deleteColumn(int) - Method in class com.chilkatsoft.chilkat2.Csv

Deletes the column at zero-based index index.

deleteColumnByName(String) - Method in class com.chilkatsoft.chilkat2.Csv

Deletes the column named by columnName.

deleteContext() - Method in class com.chilkatsoft.chilkat2.ScMinidriver

This function reverses the effect of AcquireContext and severs the communication between the Base CSP/KSP and the card minidriver.

deleteConvo(String) - Method in class com.chilkatsoft.chilkat2.Ai

Deletes the conversation by its name.

deleteEmail(Email) - Method in class com.chilkatsoft.chilkat2.MailMan

Deletes a POP3 message by using the UIDL stored in the X-UIDL header of the Email in email.

deleteEntry(ZipEntry) - Method in class com.chilkatsoft.chilkat2.Zip

Removes a ZIP entry from the current ZIP object.

deleteFromCache(String) - Method in class com.chilkatsoft.chilkat2.Cache

Deletes the cache item identified by key.

deleteKeyContainer(int) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Deletes the key container at the given containerIndex.

deleteMailbox(String) - Method in class com.chilkatsoft.chilkat2.Imap

Deletes the mailbox named by mailbox from the IMAP server.

deleteMatching(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Deletes files in the current remote directory whose names match the wildcard pattern in remotePattern.

deleteOlderDt(DateTime) - Method in class com.chilkatsoft.chilkat2.Cache

Deletes cache items older than the cutoff date and time supplied in dt.

deleteOlderStr(String) - Method in class com.chilkatsoft.chilkat2.Cache

Deletes cache items older than the cutoff date and time supplied in dateTimeStr as an RFC 822-style Internet date string.

deleteRecords(String, String, String, boolean) - Method in class com.chilkatsoft.chilkat2.JsonObject

Deletes every object record in the array at arrayPath whose value at relative path relpath equals or wildcard-matches value.

deleteRemoteFile(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Deletes the remote file at remoteFilePath.

deleteRow(int) - Method in class com.chilkatsoft.chilkat2.Csv

Deletes the data row at zero-based index index.

deleteSecret(JsonObject) - Method in class com.chilkatsoft.chilkat2.Secrets

Deletes a secret.

deleteSubItem(int) - Method in class com.chilkatsoft.chilkat2.Asn

Discards the Nth sub-item.

deleteTree() - Method in class com.chilkatsoft.chilkat2.Ftp2

Recursively deletes the files and subdirectories beneath the current remote directory.

deleteUidlSet(StringTable) - Method in class com.chilkatsoft.chilkat2.MailMan

Marks the POP3 messages whose UIDLs are listed in stUidls for deletion.

deSerialize(String) - Method in class com.chilkatsoft.chilkat2.DateTime

Loads the date/time with a string having the format as produced by the Serialize method, which is a string of SPACE separated integers containing (in this order) year, month, day, hour, minutes, seconds, and a UTC flag having the value of 1/0.

deSerialize(String) - Method in class com.chilkatsoft.chilkat2.DtObj

Loads the date/time with a string having the format as produced by the Serialize method, which is a string of SPACE separated integers containing (in this order) year, month, day, hour, minutes, seconds, and a UTC flag having the value of 1/0.

destroyObject(long) - Method in class com.chilkatsoft.chilkat2.Pkcs11

Destroys an object (deletes it from the HSM).

Dh - Class in com.chilkatsoft.chilkat2

<section class="dh-summary">

Dh() - Constructor for class com.chilkatsoft.chilkat2.Dh

Creates a new Dh object.

diffSeconds(DateTime) - Method in class com.chilkatsoft.chilkat2.DateTime

Returns the difference in seconds between the dateTimeArg and this date/time.

dirAutoCreate(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Ensures that the directory portion of filePath exists.

dirCreate(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Creates the directory specified by dirPath.

dirDelete(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Deletes the directory specified by dirPath.

dirEnsureExists(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Ensures that the complete directory path dirPath exists, creating missing directories along the path as needed.

dirExists(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Returns true if dirPath exists as a directory; otherwise returns false.

DirTree - Class in com.chilkatsoft.chilkat2

<section class="dirtree-summary">

DirTree() - Constructor for class com.chilkatsoft.chilkat2.DirTree

Creates a new DirTree object.

dirTreeXml() - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns an XML representation of the complete remote directory tree rooted at the current remote directory.

disconnect() - Method in class com.chilkatsoft.chilkat2.Ftp2

Ends the FTP session and closes the control connection.

disconnect() - Method in class com.chilkatsoft.chilkat2.Imap

Closes the connection to the IMAP server.

disconnect() - Method in class com.chilkatsoft.chilkat2.SFtp

Closes the current SSH/SFTP connection.

disconnect() - Method in class com.chilkatsoft.chilkat2.Ssh

Closes the current SSH transport.

disconnect(int) - Method in class com.chilkatsoft.chilkat2.Rest

Closes the current HTTP connection, if one is open.

disconnect(String) - Method in class com.chilkatsoft.chilkat2.SCard

Terminates a connection with a reader.

disconnectAllClients(boolean) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Disconnects all active tunnel clients while leaving the local listener and SSH connection available.

discover(boolean, JsonObject) - Method in class com.chilkatsoft.chilkat2.Pkcs11

Discovers the readers, smart cards, and USB tokens accessible via PKCS11 on the computer (using the DLL/shared lib specified by SharedLibPath).

Dkim - Class in com.chilkatsoft.chilkat2

<section class="dkim-summary">

Dkim() - Constructor for class com.chilkatsoft.chilkat2.Dkim

Creates a new Dkim object.

dkimSign(BinData) - Method in class com.chilkatsoft.chilkat2.Dkim

Creates a DKIM-Signature header and prepends it to the complete MIME message stored in mimeData.

dkimVerify(int, BinData) - Method in class com.chilkatsoft.chilkat2.Dkim

Verifies the DKIM-Signature header at zero-based sigIndex in the complete MIME message stored in mimeData.

Dns - Class in com.chilkatsoft.chilkat2

<section class="dns-summary">

Dns() - Constructor for class com.chilkatsoft.chilkat2.Dns

Creates a new Dns object.

dnsCacheClear() - Method in class com.chilkatsoft.chilkat2.Http

This function clears the Chilkat in-memory DNS cache, which stores hostname-to-IP address mappings to avoid repeated DNS lookups.

dnsCacheClear() - Method in class com.chilkatsoft.chilkat2.Socket

Clears Chilkat's process-wide in-memory DNS cache.

dnsClearCache() - Method in class com.chilkatsoft.chilkat2.Global

This function clears the Chilkat in-memory DNS cache, which stores hostname-to-IP address mappings to avoid repeated DNS lookups.

dnsLookup(String, int) - Method in class com.chilkatsoft.chilkat2.Socket

Resolves hostname and returns one numeric IP address.

download(String, String) - Method in class com.chilkatsoft.chilkat2.Http

Downloads the content at the specified url and saves to a local file at localFilePath.

downloadAppend(String, String) - Method in class com.chilkatsoft.chilkat2.Http

Downloads the content at the specified url and appends to the local file at appendToPath.

downloadBd(String, BinData) - Method in class com.chilkatsoft.chilkat2.Http

Downloads content from url to binData, clearing binData beforehand.

downloadBd(String, BinData) - Method in class com.chilkatsoft.chilkat2.Scp

Downloads the file at remotePath and appends its exact bytes to the existing contents of the BinData object in bd.

downloadBd(String, BinData) - Method in class com.chilkatsoft.chilkat2.SFtp

Downloads the remote file at remoteFilePath and appends its bytes to binData.

downloadBinaryEncoded(String, String) - Method in class com.chilkatsoft.chilkat2.Scp

Downloads the file at remotePath and returns its bytes encoded as text using the binary encoding named by encoding, such as base64 or hex.

downloadFile(String, String) - Method in class com.chilkatsoft.chilkat2.Scp

Downloads the file at remotePath from the SSH server and writes its bytes to the local filesystem path in localPath.

downloadFile(String, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Streams the remote file identified by handle to the local filesystem path toFilename.

downloadFileByName(String, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Downloads the remote file at remoteFilePath to the local filesystem path localFilePath.

downloadHash(String, String, String) - Method in class com.chilkatsoft.chilkat2.Http

Fetches the content at url and returns the encoded hash using the specified algorithm (hashAlgorithm: sha1, sha256, sha384, sha512, md2, md5, haval, ripemd128, ripemd160, ripemd256, or ripemd320), and returns the hash encoded in the specified encoding (encoding: Base64, modBase64, Base32, UU, QP for quoted-printable, URL for URL-encoding, Hex, Q, B, url_oath, url_rfc1738, url_rfc2396, or url_rfc3986).

downloadSb(String, String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Http

Downloads the content at the url into a Chilkat StringBuilder object.

downloadSb(String, String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.SFtp

Downloads the remote file at remoteFilePath, decodes it using charset, and appends the text to sb.

downloadString(String, String) - Method in class com.chilkatsoft.chilkat2.Scp

Downloads the file at remotePath, decodes its bytes using the character encoding named by charset, and returns the resulting text.

downloadTree(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Downloads all selected files and subdirectories beneath the current remote directory and recreates the tree under the local directory at localRoot.

doYourThing(String) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Runs a the targetCurl command specified in targetCurl.

dropAttachments() - Method in class com.chilkatsoft.chilkat2.Email

Removes all attachments from the email.

dropRelatedItem(int) - Method in class com.chilkatsoft.chilkat2.Email

A related item is typically an embedded image referenced from the HTML in the email via a CID hyperlink.

dropRelatedItems() - Method in class com.chilkatsoft.chilkat2.Email

A related item is typically an embedded image referenced from the HTML in the email via a CID hyperlink.

dropSingleAttachment(int) - Method in class com.chilkatsoft.chilkat2.Email

Removes the attachment at the zero-based index specified by index.

dropTagType(String) - Method in class com.chilkatsoft.chilkat2.HtmlToXml

Marks the specified HTML tag type to be dropped from the generated XML.

dropTextFormattingTags() - Method in class com.chilkatsoft.chilkat2.HtmlToXml

Configures the converter to drop common text-formatting tags from the generated XML.

Dsa - Class in com.chilkatsoft.chilkat2

<section class="dsa-summary">

Dsa() - Constructor for class com.chilkatsoft.chilkat2.Dsa

Creates a new Dsa object.

dtAt(int, boolean, DtObj) - Method in class com.chilkatsoft.chilkat2.JsonArray

Parses the date/time value at zero-based position index and loads the result into dt.

DtObj - Class in com.chilkatsoft.chilkat2

<section class="dtobj-summary">

DtObj() - Constructor for class com.chilkatsoft.chilkat2.DtObj

Creates a new DtObj object.

dtOf(String, boolean, DtObj) - Method in class com.chilkatsoft.chilkat2.JsonObject

Parses the date/time value at jsonPath into dt.

dupSocket(Socket) - Method in class com.chilkatsoft.chilkat2.Socket

Populates dest with another Socket wrapper that shares this object's underlying connection.

E

Ecc - Class in com.chilkatsoft.chilkat2

<section class="ecc-summary">

Ecc() - Constructor for class com.chilkatsoft.chilkat2.Ecc

Creates a new Ecc object.

EdDSA - Class in com.chilkatsoft.chilkat2

<section class="eddsa-summary">

EdDSA() - Constructor for class com.chilkatsoft.chilkat2.EdDSA

Creates a new EdDSA object.

Email - Class in com.chilkatsoft.chilkat2

<section class="email-summary">

Email() - Constructor for class com.chilkatsoft.chilkat2.Email

Creates a new Email object.

emailAt(int, Email) - Method in class com.chilkatsoft.chilkat2.EmailBundle

Copies the email at the zero-based index in index into the Email object in email.

EmailBundle - Class in com.chilkatsoft.chilkat2

<section class="emailbundle-summary">

EmailBundle() - Constructor for class com.chilkatsoft.chilkat2.EmailBundle

Creates a new EmailBundle object.

emit() - Method in class com.chilkatsoft.chilkat2.JsonArray

Serializes this JSON array and returns the resulting JSON text.

emit() - Method in class com.chilkatsoft.chilkat2.JsonObject

Serializes the JSON document rooted at this object and returns the JSON text.

emitBd(BinData) - Method in class com.chilkatsoft.chilkat2.JsonObject

Serializes this JSON and appends the resulting bytes to bd.

emitSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.JsonArray

Serializes this JSON array into the supplied StringBuilder.

emitSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.JsonObject

Serializes this JSON and appends the resulting text to sb.

emitWithSubs(Hashtable, boolean) - Method in class com.chilkatsoft.chilkat2.JsonObject

Serializes the JSON after substituting variables from subs into template strings.

encode(String, String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Encodes to base64, hex, quoted-printable, URL encoding, etc.

encodeInt(int, int, boolean, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Encodes an integer to N bytes and returns in the specified encoding.

encodeString(String, String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Binary encodes a string.

encrypt(Cert) - Method in class com.chilkatsoft.chilkat2.Mime

Encrypts the current MIME entity for the recipient certificate in cert and replaces it with CMS/PKCS #7 encrypted S/MIME.

encrypt(String, String) - Method in class com.chilkatsoft.chilkat2.Jwe

Encrypts content and returns the resulting compact, flattened JSON, or general JSON JWE.

encryptBd(BinData) - Method in class com.chilkatsoft.chilkat2.Crypt2

Encrypts the contents of bd.

encryptBd(BinData, boolean) - Method in class com.chilkatsoft.chilkat2.Rsa

RSA encrypts the contents of bd.

encryptBd(BinData, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Jwe

Encrypts the exact bytes in contentBd and appends the resulting JWE text to jweSb.

encryptContent(String) - Method in class com.chilkatsoft.chilkat2.Xml

Encrypts the calling element's text content using Chilkat's password-based 128-bit AES-CBC format and replaces the plaintext content with Base64-encoded encrypted data.

encryptEncoded(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Encrypts binary-encoded data and returns it as a binary-encoded string.

encryptN() - Method in class com.chilkatsoft.chilkat2.Mime

Encrypts the current MIME entity for every certificate previously added with Mime.addEncryptCert(Cert).

encryptSb(StringBuilder, BinData) - Method in class com.chilkatsoft.chilkat2.Crypt2

Encrypts text and appends the encrypted bytes in bdOut.

encryptSb(StringBuilder, String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Jwe

Encodes the text in contentSb using charset charset, encrypts it, and appends the resulting JWE text to jweSb.

encryptSecureENC(SecureString) - Method in class com.chilkatsoft.chilkat2.Crypt2

Encrypts the secure string and returns the encrypted bytes as a binary encoded string.

encryptStringENC(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Encrypts the str and returns the encrypted bytes as a binary encoded string.

encryptStringENC(String, boolean) - Method in class com.chilkatsoft.chilkat2.Rsa

Encrypts str with the RSA algorithm.

endStream() - Method in class com.chilkatsoft.chilkat2.ZipCrc

Finalizes and returns the Zip CRC value calculated by calling BeginStream followed by multiple calls to MoreData.

endsWith(String, boolean) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Returns true if the string ends with substr.

endTransaction(String) - Method in class com.chilkatsoft.chilkat2.SCard

Ends a previously begun transaction.

ensureLoaded() - Static method in class com.chilkatsoft.chilkat2.Chilkat2Native

Loads the native library if it is not loaded yet.

enterContext(String) - Method in class com.chilkatsoft.chilkat2.Log

Begins a nested logging context named tag.

entityDecode() - Method in class com.chilkatsoft.chilkat2.StringBuilder

Decodes HTML entities.

entityEncodeDec(String) - Method in class com.chilkatsoft.chilkat2.Charset

Returns str with each non-US-ASCII character replaced by a decimal HTML/XML numeric character reference.

entityEncodeHex(String) - Method in class com.chilkatsoft.chilkat2.Charset

Returns str with each non-US-ASCII character replaced by a hexadecimal HTML/XML numeric character reference.

entryAt(int, ZipEntry) - Method in class com.chilkatsoft.chilkat2.Zip

Retrieves the ZIP entry at the specified zero-based index.

entryById(int, ZipEntry) - Method in class com.chilkatsoft.chilkat2.Zip

Finds a ZIP entry by its unique EntryID.

entryMatching(String, ZipEntry) - Method in class com.chilkatsoft.chilkat2.Zip

Finds the first ZIP entry whose stored path matches a wildcard pattern.

entryOf(String, ZipEntry) - Method in class com.chilkatsoft.chilkat2.Zip

Finds a ZIP entry whose stored path exactly matches pathInZip.

enumFiles(String, StringTable) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Get the list of files in the directory specified by dirName.

eof(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Returns true when the most recent read for handle received the SFTP end-of-file status.

establishContext(String) - Method in class com.chilkatsoft.chilkat2.SCard

Creates an Application Context to the PC/SC Resource Manager.

eval(StringBuilder, JsonObject) - Method in class com.chilkatsoft.chilkat2.Js

Run jscript as a script.

examineMailbox(String) - Method in class com.chilkatsoft.chilkat2.Imap

Opens the mailbox in mailbox as read-only.

examinePlan(String, JsonObject) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Used for debugging.

exchangeCodeForToken(String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Exchanges the authorization code in code for tokens at OAuth2.getTokenEndpoint().

excludeDir(String) - Method in class com.chilkatsoft.chilkat2.Zip

Adds a directory name to the exclusion list used by recursive append operations.

excludeImagesMatching(String) - Method in class com.chilkatsoft.chilkat2.Mht

Adds pattern to the persistent list of exclusion patterns used while gathering embeddable resources.

expiresWithin(int, String) - Method in class com.chilkatsoft.chilkat2.DateTime

Returns true if the date/time is within n seconds/minutes/hours/days of the current system date/time.

exportCertDerBd(BinData) - Method in class com.chilkatsoft.chilkat2.Cert

Exports the digital certificate in ASN.1 DER format to a BinData object.

exportCertDerFile(String) - Method in class com.chilkatsoft.chilkat2.Cert

Exports the digital certificate to ASN.1 DER format binary file.

exportCertPem() - Method in class com.chilkatsoft.chilkat2.Cert

Exports the digital certificate to an unencrypted PEM formatted string.

exportCertPemFile(String) - Method in class com.chilkatsoft.chilkat2.Cert

Exports the digital certificate to an unencrypted PEM formatted file.

exportCertXml() - Method in class com.chilkatsoft.chilkat2.Cert

Exports a certificate to an XML format where the XML tags are the names of the ASN.1 objects that compose the X.509 certificate.

exportConvo(String, JsonObject) - Method in class com.chilkatsoft.chilkat2.Ai

Exports the conversation specified by name to json, replacing json's contents with the exported transcript.

exportEntropy() - Method in class com.chilkatsoft.chilkat2.Prng

Exports a Base64-encoded value derived from the PRNG's accumulated entropy pools.

exportPublicKey(long, PublicKey) - Method in class com.chilkatsoft.chilkat2.Pkcs11

Export a public key given a public or private key handle.

exportToPfxBd(String, boolean, BinData) - Method in class com.chilkatsoft.chilkat2.Cert

Exports the certificate and private key (if available) to pfxData.

exportToPfxFile(String, String, boolean) - Method in class com.chilkatsoft.chilkat2.Cert

Exports the certificate and private key (if available) to a PFX (.pfx or .p12) file.

expunge() - Method in class com.chilkatsoft.chilkat2.Imap

Permanently removes all messages marked with the \Deleted flag from the currently selected mailbox.

expungeAndClose() - Method in class com.chilkatsoft.chilkat2.Imap

Permanently removes all messages marked with \Deleted from the selected mailbox and then closes the mailbox.

extract(String) - Method in class com.chilkatsoft.chilkat2.ZipEntry

Extracts this ZIP entry beneath the specified base directory.

extractChildByIndex(int) - Method in class com.chilkatsoft.chilkat2.Xml

Removes the direct child at zero-based index from the calling element and returns an Xml object for the detached child subtree.

extractChildByName(String, String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Finds, removes, and returns the first child selected by tagPath and the optional attribute criteria.

extractExe(String, String) - Method in class com.chilkatsoft.chilkat2.Zip

Extracts files from a Chilkat-created self-extracting EXE.

extractInto(String) - Method in class com.chilkatsoft.chilkat2.ZipEntry

Extracts this entry directly into the specified directory, ignoring any path information stored in the ZIP entry.

extractMetaRefreshUrl(String) - Method in class com.chilkatsoft.chilkat2.Http

This is a convenience method for extracting the META refresh URL from HTML.

extractText(String, JsonObject, JsonObject) - Method in class com.chilkatsoft.chilkat2.Pdf

Extracts the text of the loaded PDF.

extractTextSb(String, JsonObject, StringBuilder, JsonObject) - Method in class com.chilkatsoft.chilkat2.Pdf

The same as Pdf.extractText(String, JsonObject, JsonObject), except that the joined text or Markdown is written to sbOut instead of being returned in the text or markdown member of jsonOut.

F

feat() - Method in class com.chilkatsoft.chilkat2.Ftp2

Sends FEAT and returns the server's multiline capability reply.

fetchAll(boolean, boolean, int, EmailBundle) - Method in class com.chilkatsoft.chilkat2.MailMan

Retrieves messages from the POP3 mailbox and appends them to the EmailBundle in bundle.

fetchAttachment(Email, int, String) - Method in class com.chilkatsoft.chilkat2.Imap

Obtains attachment attachmentIndex from the Email in emailObject and writes it to the filesystem path in saveToPath.

fetchAttachmentBd(Email, int, BinData) - Method in class com.chilkatsoft.chilkat2.Imap

Obtains attachment attachmentIndex from the Email in email and stores its bytes in the BinData in binData.

fetchAttachmentSb(Email, int, String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Imap

Obtains text attachment attachmentIndex from the Email in email, decodes it using the charset in charset, and stores the text in the StringBuilder in sb.

fetchAttachmentString(Email, int, String) - Method in class com.chilkatsoft.chilkat2.Imap

Obtains text attachment attachmentIndex from the Email in emailObject and decodes its bytes using the character encoding named by charset.

fetchBd(String, BinData) - Method in class com.chilkatsoft.chilkat2.Cache

Retrieves the binary item identified by key and loads its bytes into the BinData object supplied in bd.

fetchByUidl(String, boolean, int, Email) - Method in class com.chilkatsoft.chilkat2.MailMan

Retrieves one message by UIDL and stores it in the Email in email.

fetchChunk2(int, int, MessageSet, MessageSet, EmailBundle) - Method in class com.chilkatsoft.chilkat2.Imap

Attempts to download count full messages beginning with sequence number seqnum.

fetchEmail(boolean, long, boolean, Email) - Method in class com.chilkatsoft.chilkat2.Imap

Downloads one message or its headers into the Email in email.

fetchFlags(long, boolean) - Method in class com.chilkatsoft.chilkat2.Imap

Returns the space-separated IMAP flags for the message identified by msgId.

fetchFull(Email, Email) - Method in class com.chilkatsoft.chilkat2.MailMan

Downloads the complete version of the header-only or partial Email in partialEmail and stores it in fullEmail.

fetchMimeBd(String, BinData) - Method in class com.chilkatsoft.chilkat2.MailMan

Fetches an email from the POP3 server by UIDL and stores the raw MIME source bytes in mimeData.

fetchMimeByMsgnumBd(int, BinData) - Method in class com.chilkatsoft.chilkat2.MailMan

Retrieves an email by POP3 message number and stores the raw MIME source bytes in bd.

fetchMsgSet(boolean, MessageSet, EmailBundle) - Method in class com.chilkatsoft.chilkat2.Imap

Downloads the existing messages identified by the MessageSet in msgSet and appends them to the EmailBundle in bundle.

fetchOne(boolean, int, int, Email) - Method in class com.chilkatsoft.chilkat2.MailMan

Retrieves one message by POP3 message number and stores it in the Email in email.

fetchRange(boolean, boolean, int, int, int, EmailBundle) - Method in class com.chilkatsoft.chilkat2.MailMan

Retrieves a range of messages from the POP3 mailbox and appends them to the EmailBundle in bundle.

fetchRange(boolean, int, int, EmailBundle) - Method in class com.chilkatsoft.chilkat2.Imap

Downloads count messages beginning with sequence number seqnum and appends them to the EmailBundle in bundle.

fetchRobotsText() - Method in class com.chilkatsoft.chilkat2.Spider

Returns the contents of the robots.txt file from the domain being crawled.

fetchSb(String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Cache

Retrieves the text item identified by key and loads its content into the StringBuilder supplied in sb.

fetchSingleAsMime(long, boolean) - Method in class com.chilkatsoft.chilkat2.Imap

Downloads one message and returns its MIME source as a string.

fetchSingleAsMimeSb(long, boolean, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Imap

Downloads one message's MIME into the StringBuilder in sbMime.

fetchSingleBd(long, boolean, BinData) - Method in class com.chilkatsoft.chilkat2.Imap

Downloads one message's MIME bytes into the BinData in mimeData.

fetchSingleHeaderAsMime(long, boolean) - Method in class com.chilkatsoft.chilkat2.Imap

Downloads and returns the MIME header block for one message, without downloading the body.

fetchText(String) - Method in class com.chilkatsoft.chilkat2.Cache

Retrieves the text item identified by key and returns its string content.

fetchUidls(StringTable) - Method in class com.chilkatsoft.chilkat2.MailMan

Retrieves the UIDLs of the messages currently stored in the POP3 mailbox and stores them in uidls.

fetchUidlSet(StringTable, boolean, int, EmailBundle) - Method in class com.chilkatsoft.chilkat2.MailMan

Retrieves the messages whose UIDLs are listed in uidls and appends them to the EmailBundle in bundle.

FileAccess - Class in com.chilkatsoft.chilkat2

<section class="fileaccess-summary">

FileAccess() - Constructor for class com.chilkatsoft.chilkat2.FileAccess

Creates a new FileAccess object.

fileAt(int, SFtpFile) - Method in class com.chilkatsoft.chilkat2.SFtpDir

Copies the metadata for the directory entry at the zero-based index into fileObj.

fileClose() - Method in class com.chilkatsoft.chilkat2.FileAccess

Closes the currently open file and releases its operating-system file handle.

fileContentsEqual(String, String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Compares filePath1 and filePath2 byte-for-byte and returns true only when their contents are identical.

fileCopy(String, String, boolean) - Method in class com.chilkatsoft.chilkat2.FileAccess

Copies existingFilepath to newFilepath.

fileCrc(String) - Method in class com.chilkatsoft.chilkat2.ZipCrc

Calculates the CRC32 of a file.

fileDelete(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Deletes the file specified by filePath.

fileExists(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Returns true if filePath exists; otherwise returns false.

fileExists(String, boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Checks the remote item at remotePath.

fileExists3(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Checks whether path exists and returns a three-state result: 1 if it exists, 0 if it does not exist, and -1 if Chilkat could not determine the result because of permissions or another filesystem error.

fileOpen(String, long, long, long, long) - Method in class com.chilkatsoft.chilkat2.FileAccess

Windows-specific low-level open. Opens filePath using arguments modeled after the Win32 CreateFile API.

fileReadBd(int, BinData) - Method in class com.chilkatsoft.chilkat2.FileAccess

Reads up to maxNumBytes bytes from the current file position and appends the bytes to binData.

fileRename(String, String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Renames or moves existingFilepath to newFilepath using the local filesystem.

fileSeek(int, int) - Method in class com.chilkatsoft.chilkat2.FileAccess

Moves the current file position by offset bytes relative to origin.

fileSize(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Returns the file size in bytes as a signed 32-bit integer.

fileSize64(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Returns the size of filePath in bytes as a signed 64-bit integer.

fileSizeStr(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Returns the size of filePath in bytes as a decimal string.

fileType(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Examines path and classifies the filesystem entry.

fileWriteBd(BinData, int, int) - Method in class com.chilkatsoft.chilkat2.FileAccess

Writes bytes from binData to the currently open file.

finalizeThreadPool() - Method in class com.chilkatsoft.chilkat2.Global

Called to stop and finalize all threads in the thread pool, and causes the thread pool thread to exit.

find(String, int) - Method in class com.chilkatsoft.chilkat2.StringArray

Finds the index of the first string equal to findStr.

findAllCerts() - Method in class com.chilkatsoft.chilkat2.Pkcs11

Finds all certificates contained on the smart card (or USB token).

findAllKeys(String, JsonObject) - Method in class com.chilkatsoft.chilkat2.Pkcs11

Finds all keys contained on the smart card (or USB token).

findCert(JsonObject, Cert) - Method in class com.chilkatsoft.chilkat2.CertStore

Searches for a certificate using criteria from json and stores the result in cert.

findCert(String, String, Cert) - Method in class com.chilkatsoft.chilkat2.Pkcs11

Finds the certificate where the given certPart equals the partValue.

findCert(String, String, Cert) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Finds the certificate where the given certPart equals the partValue.

findChild(String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns an Xml object referencing the child selected by tagPath.

findChild2(String) - Method in class com.chilkatsoft.chilkat2.Xml

Moves the calling Xml object's internal reference to the child selected by tagPath.

findEmail(JsonObject, Email) - Method in class com.chilkatsoft.chilkat2.EmailBundle

Finds the first email in the bundle whose MIME header field matches the search criteria specified by the JsonObject in json.

findFirstMatch(String, int) - Method in class com.chilkatsoft.chilkat2.StringArray

Finds the first string that matches the matchPattern.

findIssuer() - Method in class com.chilkatsoft.chilkat2.Cert

Finds and returns the issuer certificate.

findK(String) - Method in class com.chilkatsoft.chilkat2.Dh

Computes the Diffie-Hellman shared secret from the other party's public exchange value.

findMatch(StringBuilder, boolean) - Method in class com.chilkatsoft.chilkat2.StringTable

This string table object holds strings with wildcards.

findNextRecord(String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Finds the next direct child record for which the descendant identified by tagPath has content matching contentPattern.

findObject(JsonObject) - Method in class com.chilkatsoft.chilkat2.Pkcs11

General function for finding an object such as a private key.

findObject(String, String, boolean) - Method in class com.chilkatsoft.chilkat2.JsonArray

Searches array elements that are JSON objects and returns the zero-based index of the first object whose direct member name has a value matching value.

findObjectWithMember(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Recursively searches this JSON subtree for the first JSON object containing a direct member named name.

findObjectWithMember2(String, JsonObject) - Method in class com.chilkatsoft.chilkat2.JsonObject

Recursively searches this JSON subtree for the first object containing a direct member named name.

findOrAddNewChild(String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the child selected by tagPath if it already exists.

findRecipient(String, String, boolean) - Method in class com.chilkatsoft.chilkat2.Jwe

Searches only the per-recipient unprotected headers for a member named paramName whose string value equals paramValue.

findRecord(String, String, String, boolean) - Method in class com.chilkatsoft.chilkat2.JsonObject

Searches the JSON array at arrayPath for the first object whose value at relative path relPath equals or wildcard-matches value.

findRecord2(String, String, String, boolean, JsonObject) - Method in class com.chilkatsoft.chilkat2.JsonObject

Searches the JSON array at arrayPath using the same matching rules as FindRecord.

findRecordString(String, String, String, boolean, String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Searches the JSON array at arrayPath for the first record whose relPath value equals or wildcard-matches value, then returns the value at retRelPath from that same record as a string.

findSmartcards(JsonObject) - Method in class com.chilkatsoft.chilkat2.SCard

Returns JSON containing information about the smartcards currently inserted into readers.

findString(String, boolean) - Method in class com.chilkatsoft.chilkat2.JsonArray

Searches for the first string array element matching value and returns its zero-based index, or -1 if no match is found.

findString(String, int, String) - Method in class com.chilkatsoft.chilkat2.BinData

Return the index where the first occurrence of str is found.

findSubstring(int, String, boolean) - Method in class com.chilkatsoft.chilkat2.StringTable

Return the index of the first string in the table containing substr.

firebaseApplyEvent(String, String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Applies a Firebase Realtime Database event to this JSON object.

firebasePatch(String, String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Applies Firebase-style patch semantics at jsonPath.

firebasePushId() - Method in class com.chilkatsoft.chilkat2.Prng

Generates a Firebase-compatible push ID.

firebasePut(String, String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Applies Firebase-style put semantics at jsonPath, replacing or inserting the value at that path.

firstChild() - Method in class com.chilkatsoft.chilkat2.Xml

Returns an Xml object referencing the first direct child of the calling element.

firstChild2() - Method in class com.chilkatsoft.chilkat2.Xml

Moves the calling Xml object's internal reference to its first direct child.

Formats - Class in com.chilkatsoft.chilkat2

<section class="formats-summary">

Formats() - Constructor for class com.chilkatsoft.chilkat2.Formats

Creates a new Formats object.

fromCompactString(String) - Method in class com.chilkatsoft.chilkat2.MessageSet

Clears the identifiers currently stored in this object and loads the compact message-set representation in str.

fromDerBd(BinData) - Method in class com.chilkatsoft.chilkat2.Dsa

Loads a DSA private key from the DER bytes contained in the BinData object passed in bd.

fromDerFile(String) - Method in class com.chilkatsoft.chilkat2.Dsa

Loads a DSA private key from the DER-encoded file specified by path.

fromEncryptedPem(String, String) - Method in class com.chilkatsoft.chilkat2.Dsa

Loads a DSA private key from the PEM text in pemData.

fromOpenSshPrivateKey(String) - Method in class com.chilkatsoft.chilkat2.SshKey

Loads a private key from an OpenSSH-compatible, PEM, PKCS #8, or PuTTY private-key string.

fromOpenSshPublicKey(String) - Method in class com.chilkatsoft.chilkat2.SshKey

Loads an SSH public key from a string.

fromPem(String) - Method in class com.chilkatsoft.chilkat2.Dsa

Loads an unencrypted DSA private key from the PEM text in pemData.

fromPublicDerBd(BinData) - Method in class com.chilkatsoft.chilkat2.Dsa

Loads a DSA public key from the DER bytes contained in the BinData object passed in bd.

fromPublicDerFile(String) - Method in class com.chilkatsoft.chilkat2.Dsa

Loads a DSA public key from the DER-encoded file specified by path.

fromPublicPem(String) - Method in class com.chilkatsoft.chilkat2.Dsa

Loads a DSA public key from the PEM text in pemData.

fromPuttyPrivateKey(String) - Method in class com.chilkatsoft.chilkat2.SshKey

Loads a private key from PuTTY PPK format.

fromRfc4716PublicKey(String) - Method in class com.chilkatsoft.chilkat2.SshKey

Loads a public key from RFC 4716 SSH2 public-key format.

fromXml(String) - Method in class com.chilkatsoft.chilkat2.Dsa

Loads a DSA public or private key from the XML text in xmlKey.

fromXml(String) - Method in class com.chilkatsoft.chilkat2.SshKey

Loads an SSH public or private key from an XML string.

fsync(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Requests that the server flush pending data for the open file identified by handle to stable storage.

Ftp2 - Class in com.chilkatsoft.chilkat2

<section class="ftp2-summary">

Ftp2() - Constructor for class com.chilkatsoft.chilkat2.Ftp2

Creates a new Ftp2 object.

fullRequestBd(String, String, BinData, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Rest

Sends a complete request whose binary body is read from the BinData in binData.

fullRequestFormUrlEncoded(String, String) - Method in class com.chilkatsoft.chilkat2.Rest

Sends a complete application/x-www-form-urlencoded request.

fullRequestMultipart(String, String) - Method in class com.chilkatsoft.chilkat2.Rest

Sends a complete multipart request using the parts and part headers configured through Rest.getPartSelector(), Rest.addHeader(String, String), and the multipart-body methods.

fullRequestNoBody(String, String) - Method in class com.chilkatsoft.chilkat2.Rest

Sends a complete request with no request body.

fullRequestNoBodyBd(String, String, BinData) - Method in class com.chilkatsoft.chilkat2.Rest

Sends a complete request without a request body and stores the binary response body in the BinData in binData, replacing its previous contents.

fullRequestNoBodySb(String, String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Rest

Sends a complete request without a request body and stores the text response body in the StringBuilder in sb, replacing its previous contents.

fullRequestSb(String, String, StringBuilder, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Rest

Sends a complete request whose text body is read from the StringBuilder in requestBody.

fullRequestStream(String, String, Stream) - Method in class com.chilkatsoft.chilkat2.Rest

Sends a complete request whose body is read from the Stream in stream.

fullRequestString(String, String, String) - Method in class com.chilkatsoft.chilkat2.Rest

Sends a complete request whose text body is supplied in bodyText, such as JSON, XML, or plain text.

G

genBlockId(int, int, String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Generates a fixed-width decimal block identifier from index, padded to length characters, and then encodes those bytes using encoding (for example base64, hex, or ascii).

genCsrBd(PrivateKey, BinData) - Method in class com.chilkatsoft.chilkat2.Csr

Generates a PKCS #10 Certificate Signing Request using the supplied RSA or elliptic-curve private key and writes the binary DER representation to csrData.

genCsrPem(PrivateKey) - Method in class com.chilkatsoft.chilkat2.Csr

Generates a PKCS #10 Certificate Signing Request using the supplied PrivateKey and the subject fields, Subject Alternative Names, extension request, and signature settings currently configured on this object.

genEcKey(JsonObject, JsonObject, JsonObject, PublicKey) - Method in class com.chilkatsoft.chilkat2.Pkcs11

Generate an EC key pair suitable for signing data and verifying signatures.

genEd25519Key(Prng, PrivateKey) - Method in class com.chilkatsoft.chilkat2.EdDSA

Generates a new Ed25519 key pair using prng as the source of cryptographically secure random bytes.

generate() - Method in class com.chilkatsoft.chilkat2.OAuth1

Generate the signature based on the property settings.

generateDsaKey(int) - Method in class com.chilkatsoft.chilkat2.SshKey

Generates a new DSA public/private key pair.

generateEcdsaKey(String) - Method in class com.chilkatsoft.chilkat2.SshKey

Generates a new ECDSA public/private key pair.

generateEd25519Key() - Method in class com.chilkatsoft.chilkat2.SshKey

Generates a new Ed25519 public/private key pair.

generateFilename() - Method in class com.chilkatsoft.chilkat2.Email

Generates a unique filename for this email.

generateKey(int, String, String, int, String) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Generates a key to be stored in either the signature or key exchange location within a key container.

generateRequestFile(String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

The same as GenerateRequestText, except the generated request is written to the file specified by path.

generateRequestText() - Method in class com.chilkatsoft.chilkat2.HttpRequest

Returns the request text that would be sent if Http.SynchronousRequest was called.

generateRsaKey(int, int) - Method in class com.chilkatsoft.chilkat2.SshKey

Generates a new RSA public/private key pair.

generateToken() - Method in class com.chilkatsoft.chilkat2.AuthAzureSAS

Generates and returns the SAS token based on the defined AuthAzureSAS.getStringToSign() and params.

generateUuid() - Method in class com.chilkatsoft.chilkat2.Crypt2

Generates a random UUID string having standard UUID format, such as de305d54-75b4-431b-adb2-eb6b9e546014.

genFingerprint() - Method in class com.chilkatsoft.chilkat2.SshKey

Returns a printable fingerprint for the key currently held by this object.

genKey(int) - Method in class com.chilkatsoft.chilkat2.Dsa

Generates a new DSA key pair with a P size of numBits bits.

genKey(int, PrivateKey) - Method in class com.chilkatsoft.chilkat2.Rsa

Generates a new RSA key and stores it in privKey.

genKey(String, Prng, PrivateKey) - Method in class com.chilkatsoft.chilkat2.Ecc

Generates a new elliptic-curve private key and stores it in privKey.

genKey2(int, int) - Method in class com.chilkatsoft.chilkat2.Dsa

Generates a new DSA key pair using an explicit (L, N) parameter-size combination.

genKey2(String, String, String, PrivateKey) - Method in class com.chilkatsoft.chilkat2.Ecc

Constructs an elliptic-curve private key in privKey from a caller-supplied private scalar.

genKeyFromParamsDerBd(BinData) - Method in class com.chilkatsoft.chilkat2.Dsa

Generates a new DSA key pair from OpenSSL-style DSA parameters stored as DER bytes in the BinData object passed in bd.

genKeyFromParamsDerFile(String) - Method in class com.chilkatsoft.chilkat2.Dsa

Generates a new DSA key pair from the OpenSSL-style DER DSA-parameters file specified by path.

genKeyFromParamsPem(String) - Method in class com.chilkatsoft.chilkat2.Dsa

Generates a new DSA key pair from OpenSSL-style DSA parameters supplied as PEM text in pem.

genKeyFromParamsPemFile(String) - Method in class com.chilkatsoft.chilkat2.Dsa

Generates a new DSA key pair from the OpenSSL-style PEM DSA-parameters file specified by path.

genKeyFromPQG(String, String, String) - Method in class com.chilkatsoft.chilkat2.Dsa

Generates a new DSA private/public key pair using the preselected domain parameters P, Q, and G supplied in pHex, qHex, and gHex.

genNonce(int) - Method in class com.chilkatsoft.chilkat2.OAuth1

Generates a random nonce numBytes in length and sets the Nonce property to the hex encoded value.

genNumericDate(int) - Method in class com.chilkatsoft.chilkat2.Jwt

Returns a JWT NumericDate equal to the current system time plus numSecOffset.

genPG(int, int) - Method in class com.chilkatsoft.chilkat2.Dh

Generates new finite-field Diffie-Hellman parameters and stores them in this object.

genPresignedUrl(String, boolean, String, String, int, String) - Method in class com.chilkatsoft.chilkat2.AuthAws

Generates a temporary pre-signed URL for an Amazon AWS service using AWS Signature V4.

genRandom(int, String) - Method in class com.chilkatsoft.chilkat2.Prng

Generates numBytes random bytes and returns those bytes as text using the encoding named by encoding, such as hex, base64, or base64url.

genRandomBd(int, BinData) - Method in class com.chilkatsoft.chilkat2.Prng

Generates numBytes random bytes and appends them to the existing contents of the BinData object passed in bd.

genRandomBytesENC(int) - Method in class com.chilkatsoft.chilkat2.Crypt2

Generates numBytes random bytes and returns them as an encoded string.

genRsaKey(JsonObject, JsonObject, JsonObject, PublicKey) - Method in class com.chilkatsoft.chilkat2.Pkcs11

Generate an RSA key pair suitable for signing data and verifying signatures.

genSecretKey(String, JsonObject) - Method in class com.chilkatsoft.chilkat2.Pkcs11

Generates a symmetric encryption key.

genTimestamp() - Method in class com.chilkatsoft.chilkat2.OAuth1

Sets the Timestamp property to the current date/time.

genTimeStamp() - Method in class com.chilkatsoft.chilkat2.Http

Returns the current date and time in GMT (UTC) as a string formatted according to RFC 2616: Day, DD Mon YYYY HH:MM:SS GMT.

genType1() - Method in class com.chilkatsoft.chilkat2.Ntlm

Generates the client-to-server Type 1 Negotiate message that starts an NTLM authentication exchange.

genType2(String) - Method in class com.chilkatsoft.chilkat2.Ntlm

Generates the server-to-client Type 2 Challenge message from the encoded Type 1 message in type1Msg.

genType3(String) - Method in class com.chilkatsoft.chilkat2.Ntlm

Generates the client-to-server Type 3 Authenticate message from the encoded Type 2 message in type2Msg.

getAbortCurrent() - Method in class com.chilkatsoft.chilkat2.Bz2

Set this property to true to request cancellation of the compression or decompression operation currently executing on this object.

getAbortCurrent() - Method in class com.chilkatsoft.chilkat2.Crypt2

Setting this property to true will abort the current method, but only for those methods having an Async alternative.

getAbortCurrent() - Method in class com.chilkatsoft.chilkat2.Dkim

Set to true to request cancellation of a currently running operation.

getAbortCurrent() - Method in class com.chilkatsoft.chilkat2.Ftp2

Set to true to request cancellation of the operation currently running on this object.

getAbortCurrent() - Method in class com.chilkatsoft.chilkat2.Gzip

Set this property to true to request that the currently running operation be aborted.

getAbortCurrent() - Method in class com.chilkatsoft.chilkat2.Http

When set to true, causes the currently running method to abort.

getAbortCurrent() - Method in class com.chilkatsoft.chilkat2.Imap

Controls cancellation of the method currently running on this Imap object.

getAbortCurrent() - Method in class com.chilkatsoft.chilkat2.MailMan

Set this property to true to request that the currently running operation be aborted.

getAbortCurrent() - Method in class com.chilkatsoft.chilkat2.Mht

Set to true to request cancellation of the operation currently running on this object.

getAbortCurrent() - Method in class com.chilkatsoft.chilkat2.Scp

Set to true to request cancellation of the method currently executing on this object.

getAbortCurrent() - Method in class com.chilkatsoft.chilkat2.SFtp

Set to true to request that the currently running Chilkat operation abort.

getAbortCurrent() - Method in class com.chilkatsoft.chilkat2.Socket

Set this property to true to request cancellation of the method currently executing on this object.

getAbortCurrent() - Method in class com.chilkatsoft.chilkat2.Spider

When set to true, causes the currently running method to abort.

getAbortCurrent() - Method in class com.chilkatsoft.chilkat2.Ssh

Set to true to request that the currently running Chilkat operation abort.

getAbortCurrent() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Set this property to true from another thread to request that the currently running foreground operation be aborted.

getAbortCurrent() - Method in class com.chilkatsoft.chilkat2.Stream

When set to true, causes the currently running method to abort.

getAbortCurrent() - Method in class com.chilkatsoft.chilkat2.UnixCompress

When set to true, causes the currently running method to abort.

getAbortCurrent() - Method in class com.chilkatsoft.chilkat2.Upload

When set to true, causes the currently running method to abort.

getAbortCurrent() - Method in class com.chilkatsoft.chilkat2.Zip

Stops the currently executing operation when set to true.

getAccept() - Method in class com.chilkatsoft.chilkat2.Http

This property sets the Accept header for all HTTP requests, except those sent by the Http.httpReq(String, HttpRequest, HttpResponse) and Http.httpSReq(String, int, boolean, HttpRequest, HttpResponse) methods that use headers from an HttpRequest object.

getAcceptFailReason() - Method in class com.chilkatsoft.chilkat2.Socket

Contains the numeric result for the most recent AcceptNext or deprecated AcceptNextConnection operation.

getAcceptLog() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Contains the in-memory activity log for the background listener thread started by SshTunnel.beginAccepting(int).

getAcceptLogPath() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the local file path where activity from the background listener thread is written.

getAccessKey() - Method in class com.chilkatsoft.chilkat2.AuthAws

The AWS access key.

getAccessKey() - Method in class com.chilkatsoft.chilkat2.AuthAzureSAS

This is the signing key (access key) that must be kept private.

getAccessKey() - Method in class com.chilkatsoft.chilkat2.AuthAzureStorage

A valid base64 access key for the Azure storage account.

getAccessToken() - Method in class com.chilkatsoft.chilkat2.AuthGoogle

The access token to be used in Google API requests.

getAccessToken() - Method in class com.chilkatsoft.chilkat2.OAuth2

Contains the access_token extracted from the most recent successful token response.

getAccessTokenResponse() - Method in class com.chilkatsoft.chilkat2.OAuth2

Contains the raw response body returned by the token endpoint after a successful authorization-code exchange or refresh-token request.

getAccessTokenResponseSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.OAuth2

Copies the raw token-endpoint response into sb and returns true on success.

getAccount() - Method in class com.chilkatsoft.chilkat2.AuthAzureStorage

The Azure storage account name.

getAccount() - Method in class com.chilkatsoft.chilkat2.Ftp2

Very rarely needed today: Almost all modern FTP servers rely exclusively on the USER and PASS commands for authentication and access control.

getActivePortRangeEnd() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the last local TCP port that may be used for active-mode data connections.

getActivePortRangeStart() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the first local TCP port that may be used for active-mode data connections.

getActiveProtocol() - Method in class com.chilkatsoft.chilkat2.SCard

The name of the active protocol if connected smart card reader, or an empty string if not connected.

getAdaptersAddresses(JsonObject) - Method in class com.chilkatsoft.chilkat2.Socket

Populates json with information about local network adapters, including IPv4 addresses, IPv6 addresses, and MAC addresses.

getAfterBetween(String, String, String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Begin searching after the 1st occurrence of searchAfter is found, and then return the substring found between the next occurrence of beginMark and the next occurrence of endMark.

getAfterFinal(String, boolean) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Returns the substring found after the final occurrence of marker.

getAlgorithm() - Method in class com.chilkatsoft.chilkat2.Compression

Specifies the compression algorithm to use.

getAlgorithm() - Method in class com.chilkatsoft.chilkat2.EdDSA

Selects the Ed25519 signature variant used by EdDSA.signBdENC(BinData, String, PrivateKey) and EdDSA.verifyBdENC(BinData, String, String, PublicKey).

getAlgorithmId() - Method in class com.chilkatsoft.chilkat2.Pfx

Gets or sets the password-based encryption scheme used for PKCS#8 shrouded private-key bags when writing a PFX.

getAllocateSize() - Method in class com.chilkatsoft.chilkat2.Ftp2

Rarely needed: The FTP ALLO command pre-allocates disk space on the server before an upload.

getAllOrNone() - Method in class com.chilkatsoft.chilkat2.MailMan

Determines whether an email should be sent when one or more recipients are rejected by the SMTP server.

getAllowGzip() - Method in class com.chilkatsoft.chilkat2.Http

If true then the Accept-Encoding: gzip is automatically added for all HTTP requests, except those made using the Http.httpReq(String, HttpRequest, HttpResponse) and Http.httpSReq(String, int, boolean, HttpRequest, HttpResponse) methods that use headers from an HttpRequest object.

getAllowHeaderFolding() - Method in class com.chilkatsoft.chilkat2.Http

When set to false, MIME header folding is not applied to request headers automatically.

getAllowHeaderFolding() - Method in class com.chilkatsoft.chilkat2.Rest

Controls whether long request-header fields may be folded onto continuation lines.

getAllowHeaderQB() - Method in class com.chilkatsoft.chilkat2.Rest

Controls whether non-ASCII request-header values may be converted to RFC 2047 encoded-word form using Q or Base64 encoding.

getAllowMlsd() - Method in class com.chilkatsoft.chilkat2.Ftp2

Controls whether machine-readable directory listings are requested with MLSD when the server advertises support.

getAllVars(JsonObject) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Returns all defined variables in json.

getAlpnProtocol() - Method in class com.chilkatsoft.chilkat2.Socket

A single application-layer protocol name for the TLS ALPN extension, such as h2 or http/1.1.

getAlpnProtocols() - Method in class com.chilkatsoft.chilkat2.Socket

The list of ALPN (Application-Layer Protocol Negotiation) protocols, in preference order, as JSON.

getAlternativeBody(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns the Nth alternative body.

getAlternativeBodyBd(int, BinData) - Method in class com.chilkatsoft.chilkat2.Email

Returns the contents of the Nth alternative body to binData.

getAlternativeBodyByContentType(String) - Method in class com.chilkatsoft.chilkat2.Email

Returns the alternative body by Content-Type, such as text/plain, text/html, text/xml, etc.

getAlternativeContentType(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns the content type of the Nth alternative body.

getAltHeaderField(int, String) - Method in class com.chilkatsoft.chilkat2.Email

Returns the value of a header field within the Nth alternative body's MIME sub-part.

getAltToCharset() - Method in class com.chilkatsoft.chilkat2.Charset

Specifies the alternate destination character encoding used only when Charset.getErrorAction() is 6.

getAndSaveEML(String, String) - Method in class com.chilkatsoft.chilkat2.Mht

Creates EML output from the HTTP/HTTPS page or local HTML file in url_or_htmlFilepath and saves it to the destination path in emlPath.

getAndSaveMHT(String, String) - Method in class com.chilkatsoft.chilkat2.Mht

Creates MHT output from the HTTP/HTTPS page or local HTML file in url_or_htmlFilepath and saves it to the destination path in mhtPath.

getAndZipEML(String, String, String) - Method in class com.chilkatsoft.chilkat2.Mht

Creates EML output from the HTTP/HTTPS page or local HTML file in url_or_htmlFilepath and stores it as the ZIP entry named by zipEntryFilename inside the archive file in zipFilename.

getAndZipMHT(String, String, String) - Method in class com.chilkatsoft.chilkat2.Mht

Creates MHT output from the HTTP/HTTPS page or local HTML file in url_or_htmlFilepath and stores it as the ZIP entry named by zipEntryFilename inside the archive file in zipFilename.

getAnsiCodePage() - Method in class com.chilkatsoft.chilkat2.Global

The default ANSI code page is determined at runtime based on the computer where the application happens to be running.

getApiKey() - Method in class com.chilkatsoft.chilkat2.Ai

This is the API key used for authentication.

getApiKeyHeader() - Method in class com.chilkatsoft.chilkat2.Ai

For custom Ai.getProvider()'s, use this field name for the API key in the HTTP header, but only if the API key is to be placed in a custom header field.

getApiSpec() - Method in class com.chilkatsoft.chilkat2.Ai

Specifies the API specification to be used.

getAppCallbackUrl() - Method in class com.chilkatsoft.chilkat2.OAuth2

Specifies a public HTTPS callback URL on an application-controlled web server when the provider will not redirect directly to localhost or a loopback IP address.

getAppendFromDir() - Method in class com.chilkatsoft.chilkat2.Zip

Specifies a base directory when adding files to the ZIP.

getAppendMode() - Method in class com.chilkatsoft.chilkat2.Pem

When set to true, each of the Load* methods appends to the current contents of this PEM object.

getAppendSeen() - Method in class com.chilkatsoft.chilkat2.Imap

Controls the initial \Seen flag for these methods: Imap.appendMail(String, Email) Imap.appendMime(String, String) Imap.appendMimeWithDateStr(String, String, String)

getAppendUid() - Method in class com.chilkatsoft.chilkat2.Imap

Contains the UID assigned by the server to the message most recently appended successfully.

getArray(Xml, String) - Method in class com.chilkatsoft.chilkat2.Xmp

Finds and returns an XMP array property.

getAsDateTimeTicks(boolean) - Method in class com.chilkatsoft.chilkat2.DateTime

Returns the date/time as a 64-bit integer .NET DateTime value.

getAsDosDate(boolean) - Method in class com.chilkatsoft.chilkat2.DateTime

Returns the date/time as a 32-bit DOS date/time bitmask.

getAsIso8601(String, boolean) - Method in class com.chilkatsoft.chilkat2.DateTime

Returns the date/time in a compatible ISO 8601 format according to the format specified in formatStr..

getAsnFormat() - Method in class com.chilkatsoft.chilkat2.Ecc

Controls the binary layout of ECDSA signatures created by this object.

getAsOleDate(boolean) - Method in class com.chilkatsoft.chilkat2.DateTime

Returns the date/time in a Windows OLE DATE format.

getAsRfc822(boolean) - Method in class com.chilkatsoft.chilkat2.DateTime

Returns the date/time as an RFC822 formatted string.

getAsString() - Method in class com.chilkatsoft.chilkat2.StringBuilder

Returns the contents as a string.

getAsTimestamp(boolean) - Method in class com.chilkatsoft.chilkat2.DateTime

Returns the date/time as an RFC 3339 formatted string, such as 1990-12-31T23:59:60Z.

getAsUnixTime(boolean) - Method in class com.chilkatsoft.chilkat2.DateTime

Returns the date/time as a Unix time value, which is the number of seconds elapsed since 00:00:00 UTC on January 1, 1970.

getAsUnixTime64(boolean) - Method in class com.chilkatsoft.chilkat2.DateTime

The same as GetUnixTime, except returns the date/time as a 64-bit integer.

getAsUnixTimeDbl(boolean) - Method in class com.chilkatsoft.chilkat2.DateTime

The same as GetUnixTime, except returns the date/time as a double.

getAsUnixTimeStr(boolean) - Method in class com.chilkatsoft.chilkat2.DateTime

Returns the time in Unix format (in seconds since the epoch: 00:00:00 UTC on 1 January 1970).

getAtr() - Method in class com.chilkatsoft.chilkat2.ScMinidriver

The ATR of the card in the reader.

getAttachedEmail(int, Email) - Method in class com.chilkatsoft.chilkat2.Email

Copies the Nth embedded message/rfc822 MIME part into email.

getAttachedMessageAttr(int, String, String) - Method in class com.chilkatsoft.chilkat2.Email

Returns a header field attribute value for the Nth attached (embedded) email.

getAttachedMessageFilename(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns the filename of the Nth attached (embedded) email.

getAttachmentAttr(int, String, String) - Method in class com.chilkatsoft.chilkat2.Email

Returns a header field attribute value from the header field of the Nth attachment.

getAttachmentBd(int, BinData) - Method in class com.chilkatsoft.chilkat2.Email

Copies an attachment's binary data into binData.

getAttachmentContentID(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns the ContentID header field for the Nth attachment.

getAttachmentContentType(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns the Content-Type header field for the Nth attachment.

getAttachmentFilename(int) - Method in class com.chilkatsoft.chilkat2.Email

Retrieves an attachment's filename.

getAttachmentHeader(int, String) - Method in class com.chilkatsoft.chilkat2.Email

Returns the value of a header field (by name) of an attachment.

getAttachmentSize(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns the size, in bytes, of the attachment at the zero-based index specified by index.

getAttachmentString(int, String) - Method in class com.chilkatsoft.chilkat2.Email

Returns the attachment at the zero-based index specified by index as text.

getAttachmentStringCrLf(int, String) - Method in class com.chilkatsoft.chilkat2.Email

Retrieves an attachment's data as a String.

getAttrib(String, BinData) - Method in class com.chilkatsoft.chilkat2.SCard

Get an attribute from the IFD Handler (reader driver).

getAttribStr(String) - Method in class com.chilkatsoft.chilkat2.SCard

Get a string typed attribute from the IFD Handler (reader driver).

getAttribUint(String) - Method in class com.chilkatsoft.chilkat2.SCard

Get an unsigned integer typed attribute from the IFD Handler (reader driver).

getAttributeName(int) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the name of the attribute at zero-based index.

getAttributeValue(int) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the value of the attribute at zero-based index.

getAttributeValueInt(int) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the value of the attribute at zero-based index, interpreted as a 32-bit integer.

getAttrValue(String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the value of the attribute named name on the calling element.

getAttrValueInt(String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the value of the attribute named name interpreted as a 32-bit integer.

getAuthFailReason() - Method in class com.chilkatsoft.chilkat2.SFtp

Contains the result code from the most recent call to SFtp.authenticatePw(String, String), SFtp.authenticatePk(String, SshKey), SFtp.authenticatePwPk(String, String, SshKey), or a corresponding secure-string authentication method.

getAuthFailReason() - Method in class com.chilkatsoft.chilkat2.Ssh

Contains the result code from the most recent call to an SSH authentication method, including Ssh.authenticatePw(String, String), Ssh.authenticatePk(String, SshKey), Ssh.authenticatePwPk(String, String, SshKey), and their SecureString variants.

getAuthFlowState() - Method in class com.chilkatsoft.chilkat2.OAuth2

Reports the current state of the background authorization flow.

getAuthMethod() - Method in class com.chilkatsoft.chilkat2.Imap

Selects the IMAP authentication mechanism.

getAuthMethods() - Method in class com.chilkatsoft.chilkat2.Ssh

Queries a connected, unauthenticated SSH server for its advertised user-authentication methods.

getAuthorityKeyId() - Method in class com.chilkatsoft.chilkat2.Cert

The authority key identifier of the certificate in base64 string format.

getAuthorization() - Method in class com.chilkatsoft.chilkat2.Rest

Gets or sets the value sent in the HTTP Authorization request header.

getAuthorizationEndpoint() - Method in class com.chilkatsoft.chilkat2.OAuth2

Specifies the authorization endpoint to which the user's browser is directed.

getAuthorizationHeader() - Method in class com.chilkatsoft.chilkat2.OAuth1

The authorization header.

getAuthSignature() - Method in class com.chilkatsoft.chilkat2.Http

This property can be set to a JSON string containing the required information to add an HTTP Signature in the following format:

getAuthSsl() - Method in class com.chilkatsoft.chilkat2.Ftp2

Legacy and very uncommon: AUTH SSL originated in early FTP security drafts from the era when SSL was the standard encryption protocol.

getAuthTls() - Method in class com.chilkatsoft.chilkat2.Ftp2

Set to true to use explicit FTP over TLS by sending AUTH TLS on the FTP control channel.

getAuthToken() - Method in class com.chilkatsoft.chilkat2.Http

Applications can set this property to the OAuth2 access_token value to be sent in the Authorization: Bearer {access_token} header for all requests.

getAuthToken() - Method in class com.chilkatsoft.chilkat2.Mcp

An optional bearer token for authenticating to the MCP server.

getAuthzId() - Method in class com.chilkatsoft.chilkat2.Imap

Specifies the optional authorization identity used with the PLAIN authentication mechanism.

getAutoAddHostHeader() - Method in class com.chilkatsoft.chilkat2.Http

When set to true (the default), the Host header is automatically added to all requests.

getAutoCompact() - Method in class com.chilkatsoft.chilkat2.Jwt

Controls whether Chilkat removes insignificant JSON whitespace from the header and payload passed to CreateJwt and CreateJwtPk before Base64URL encoding and signing.

getAutoDownloadAttachments() - Method in class com.chilkatsoft.chilkat2.Imap

Controls whether methods that download a complete email also download ordinary attachment bodies.

getAutoFeat() - Method in class com.chilkatsoft.chilkat2.Ftp2

Rarely changed: Leave this property at its default value of true for nearly all modern FTP servers.

getAutoFix() - Method in class com.chilkatsoft.chilkat2.Ftp2

Controls automatic adjustment of Ftp2.getSsl(), Ftp2.getAuthSsl(), and Ftp2.getAuthTls() based solely on Ftp2.getPort().

getAutoFix() - Method in class com.chilkatsoft.chilkat2.Imap

When true (the default), changes the public Imap.getSsl() and Imap.getStartTls() property values when Imap.connect(String) is called for a standard IMAP port: Port 993: sets Ssl to true and StartTls to false for implicit TLS.

getAutoFix() - Method in class com.chilkatsoft.chilkat2.MailMan

Controls whether Chilkat automatically selects the SMTP and POP3 TLS mode from a standard port number when a connection is prepared.

getAutoGenMessageId() - Method in class com.chilkatsoft.chilkat2.MailMan

Determines whether Chilkat automatically generates a unique Message-ID header when an email is sent.

getAutoGetSizeForProgress() - Method in class com.chilkatsoft.chilkat2.Ftp2

Controls whether Chilkat sends a SIZE command before a download so percentage-based progress can be calculated.

getAutoOptsUtf8() - Method in class com.chilkatsoft.chilkat2.Ftp2

Controls whether OPTS UTF8 ON is sent automatically when a processed FEAT response advertises UTF8.

getAutoQBDecode() - Method in class com.chilkatsoft.chilkat2.Global

If set to true, then Q or B encoded strings can be passed in any string argument to any Chilkat method, and Chilkat will automatically decode the string before using it.

getAutoRun() - Method in class com.chilkatsoft.chilkat2.Zip

(Windows only, for creating self-extracting EXE's)

getAutoRunParams() - Method in class com.chilkatsoft.chilkat2.Zip

(Windows only, for creating self-extracting EXE's)

getAutoSetUseEpsv() - Method in class com.chilkatsoft.chilkat2.Ftp2

Recommended setting: Applications should set this property to true.

getAutoSmtpRset() - Method in class com.chilkatsoft.chilkat2.MailMan

When true, Chilkat automatically sends the SMTP RSET command before sending a new email over an already-open SMTP connection.

getAutoSplit() - Method in class com.chilkatsoft.chilkat2.Secrets

The AutoSplit property is specific to local_manager secrets on Windows.

getAutoSyst() - Method in class com.chilkatsoft.chilkat2.Ftp2

Controls whether a SYST command is sent automatically after login.

getAutoTemp() - Method in class com.chilkatsoft.chilkat2.Zip

(Windows only, for creating self-extracting EXE's)

getAutoTrim() - Method in class com.chilkatsoft.chilkat2.Csv

Controls whether leading and trailing whitespace is removed from values returned by GetCell and GetCellByName.

getAutoUnwrapSecurity() - Method in class com.chilkatsoft.chilkat2.MailMan

Determines whether Chilkat automatically unwraps digitally signed or encrypted email when the message is downloaded or loaded from MIME.

getAutoXcrc() - Method in class com.chilkatsoft.chilkat2.Ftp2

Controls automatic post-upload verification with the server-specific XCRC command.

getAvoidHttps() - Method in class com.chilkatsoft.chilkat2.Spider

If set the 1 (true) the spider will avoid all HTTPS URLs.

getAvoidPattern(int) - Method in class com.chilkatsoft.chilkat2.Spider

Returns the Nth avoid pattern previously added by calling AddAvoidPattern.

getAvoidWindowsPkAccess() - Method in class com.chilkatsoft.chilkat2.Cert

Applies only when running on a Microsoft Windows operating system.

getAvoidWindowsPkAccess() - Method in class com.chilkatsoft.chilkat2.CertStore

Applies only when running on a Microsoft Windows operating system.

getAwsAccessKey() - Method in class com.chilkatsoft.chilkat2.Http

The AWS Access Key to be used with the Amazon S3 methods listed below.

getAwsEndpoint() - Method in class com.chilkatsoft.chilkat2.Http

Specify the regional endpoint (domain) for Amazon S3 method calls.

getAwsRegion() - Method in class com.chilkatsoft.chilkat2.Http

The AWS S3 region (e.g., us-east-1, us-west-2, eu-west-1, eu-central-1) defaults to us-east-1.

getAwsSecretKey() - Method in class com.chilkatsoft.chilkat2.Http

The AWS Secret Key to be used with the Amazon S3 methods listed below.

getAwsSessionToken() - Method in class com.chilkatsoft.chilkat2.Http

This is the AWS session token for temporary security credentials.

getAwsSubResources() - Method in class com.chilkatsoft.chilkat2.Http

This property can be used to specify sub-resources to be included in the Amazon S3 methods listed below.

getBandwidthThrottleDown() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the approximate maximum download rate in bytes per second.

getBandwidthThrottleDown() - Method in class com.chilkatsoft.chilkat2.Http

If set to a non-zero value, this limits the download bandwidth to the specified maximum number of bytes per second.

getBandwidthThrottleDown() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the approximate maximum download rate, in bytes per second.

getBandwidthThrottleDown() - Method in class com.chilkatsoft.chilkat2.Socket

Limits receive throughput to approximately the specified number of bytes per second.

getBandwidthThrottleUp() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the approximate maximum upload rate in bytes per second.

getBandwidthThrottleUp() - Method in class com.chilkatsoft.chilkat2.Http

If set to a non-zero value, this property limits the upload bandwidth to the specified maximum number of bytes per second.

getBandwidthThrottleUp() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the approximate maximum upload rate, in bytes per second.

getBandwidthThrottleUp() - Method in class com.chilkatsoft.chilkat2.Socket

Limits send throughput to approximately the specified number of bytes per second.

getBandwidthThrottleUp() - Method in class com.chilkatsoft.chilkat2.Upload

If non-zero, limits (throttles) the upload bandwidth to approximately this maximum number of bytes per second.

getBaseDir() - Method in class com.chilkatsoft.chilkat2.DirTree

Specifies the root directory whose contents are traversed.

getBaseDomain(String) - Method in class com.chilkatsoft.chilkat2.Spider

Returns the second-level + top-level domain of the domain.

getBaseString() - Method in class com.chilkatsoft.chilkat2.OAuth1

This is the exact string that was signed.

getBaseUrl() - Method in class com.chilkatsoft.chilkat2.Ai

Specifies the provider's base URL.

getBaseUrl() - Method in class com.chilkatsoft.chilkat2.Mht

Specifies a web base URL used when relative references in a local HTML file or in-memory HTML string must be resolved in an HTTP/HTTPS context.

getBasicAuth() - Method in class com.chilkatsoft.chilkat2.Http

To enable HTTP basic authentication, set this property to true.

getBcc(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns a blind carbon-copy recipient's full email address.

getBccAddr(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns the Nth BCC address (only the address part, not the friendly-name part).

getBccName(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns the Nth BCC name (only the friendly-name part, not the address part).

getBCryptWorkFactor() - Method in class com.chilkatsoft.chilkat2.Crypt2

The BCrypt work factor determines the computational cost of Crypt2.bCryptHash(String) and Crypt2.bCryptVerify(String, String) .

getBefore(String, boolean) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Returns the substring found before the 1st occurrence of marker.

getBehaviors() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

A comma-separated list of keywords to specify special behaviors to work around potential oddities or special requirements needed for providing signatures to particular systems.

getBetween(String, String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Returns the substring found between the 1st occurrence of beginMark and the next occurrence of endMark.

getBigEndian() - Method in class com.chilkatsoft.chilkat2.Socket

Controls the byte order used by SendCount and ReceiveCount.

getBitLength() - Method in class com.chilkatsoft.chilkat2.PrivateKey

Returns the nominal size of the loaded private key, in bits.

getBlockSize() - Method in class com.chilkatsoft.chilkat2.Crypt2

This property indicates the block size in bytes for the chosen encryption algorithm.

getBody() - Method in class com.chilkatsoft.chilkat2.Email

Gets or sets the primary body of the email.

getBodyBd(BinData) - Method in class com.chilkatsoft.chilkat2.HttpResponse

Copies the response body to a BinData object.

getBodyBd(BinData) - Method in class com.chilkatsoft.chilkat2.Mime

Replaces the contents of binDat with the decoded body bytes of the current part.

getBodyDecoded() - Method in class com.chilkatsoft.chilkat2.Mime

Returns the decoded body as text.

getBodyEncoded() - Method in class com.chilkatsoft.chilkat2.Mime

Returns the current part's transfer-encoded body text without decoding Base64 or quoted-printable.

getBodyJarr(JsonArray) - Method in class com.chilkatsoft.chilkat2.HttpResponse

Loads the JSON array response body into a JsonArray This method should only be called when it is known that the response body contains a JSON array (beginning with a square bracket '[' and ending with a square bracket ']')

getBodyJson(JsonObject) - Method in class com.chilkatsoft.chilkat2.HttpResponse

Loads the JSON response body into a JsonObject.

getBodyQP() - Method in class com.chilkatsoft.chilkat2.HttpResponse

The same as the Body property, but returned as a quoted-printable encoded string.

getBodySb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.HttpResponse

Copies the response body to a Chilkat StringBuilder object.

getBodyStr() - Method in class com.chilkatsoft.chilkat2.HttpResponse

The response body returned as a string.

getBodyXml(Xml) - Method in class com.chilkatsoft.chilkat2.HttpResponse

Loads the XML response body into an XML object.

getBoolValue() - Method in class com.chilkatsoft.chilkat2.Asn

The ASN.1 item's boolean value if it is a boolean item.

getBoundary() - Method in class com.chilkatsoft.chilkat2.HttpRequest

Sets an explicit boundary string to be used in multipart/form-data requests.

getBoundary() - Method in class com.chilkatsoft.chilkat2.Mime

Gets or sets the raw boundary token used by a multipart MIME entity.

getByte(int) - Method in class com.chilkatsoft.chilkat2.BinData

Returns the value of the byte at the given index.

getCacheDir() - Method in class com.chilkatsoft.chilkat2.Spider

Specifies a cache directory to use for spidering.

getCacheRoot(int) - Method in class com.chilkatsoft.chilkat2.Http

Returns the Nth cache root, with indexing starting at 0.

getCacheRoot(int) - Method in class com.chilkatsoft.chilkat2.Mht

Returns the cache-root directory at zero-based index index.

getCadesEnabled() - Method in class com.chilkatsoft.chilkat2.Crypt2

This property applies to all PKCS7 signature creation methods.

getCadesSigPolicyHash() - Method in class com.chilkatsoft.chilkat2.Crypt2

This property is for PKCS7 CMS signatures that wish to include CAdES signature policy attributes.

getCadesSigPolicyId() - Method in class com.chilkatsoft.chilkat2.Crypt2

This property is for PKCS7 CMS signatures that wish to include CAdES signature policy attributes.

getCadesSigPolicyUri() - Method in class com.chilkatsoft.chilkat2.Crypt2

This property is for PKCS7 CMS signatures that wish to include CAdES signature policy attributes.

getCanonicalizedResourceV2() - Method in class com.chilkatsoft.chilkat2.AuthAws

If AWS Signature Version V2 is used, then this property must be set.

getCanRead() - Method in class com.chilkatsoft.chilkat2.Stream

true if the stream supports reading.

getCanWrite() - Method in class com.chilkatsoft.chilkat2.Stream

true if the stream supports writing.

getCaptureXmlListing() - Method in class com.chilkatsoft.chilkat2.Tar

Controls whether extraction methods also capture an XML inventory of the archive.

getCardAtr() - Method in class com.chilkatsoft.chilkat2.SCard

This is the Current ATR of a card in the connected reader.

getCardName() - Method in class com.chilkatsoft.chilkat2.ScMinidriver

The name of the card in the reader.

getCardProperties(JsonObject) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Gets all card properties and returns them in json.

getCaretControl() - Method in class com.chilkatsoft.chilkat2.Ssh

Controls whether recognized caret notation is converted to ASCII control characters in strings passed to Ssh.sendReqExec(int, String) and Ssh.channelSendString(int, String, String).

getCaseSensitive() - Method in class com.chilkatsoft.chilkat2.Zip

Controls whether filename matching is case-sensitive.

getCC(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns a carbon-copy recipient's full email address.

getCcAddr(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns the Nth CC address (only the address part, not the friendly-name part).

getCcName(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns the Nth CC name (only the friendly-name part, not the address part).

getCdata() - Method in class com.chilkatsoft.chilkat2.Xml

Controls how this element's text content is emitted.

getCell(int, int) - Method in class com.chilkatsoft.chilkat2.Csv

Returns the contents of the cell at data row row and column col.

getCellByName(int, String) - Method in class com.chilkatsoft.chilkat2.Csv

Returns the contents of the cell at data row rowIndex in the column named by columnName.

getCert(int, Cert) - Method in class com.chilkatsoft.chilkat2.CertStore

Loads the Nth certificate into cert.

getCert(int, Cert) - Method in class com.chilkatsoft.chilkat2.Pkcs11

Loads cert with the Nth certificate indicated by index.

getCert(int, String, Cert) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Get the certificate at the specified containerIndex and keySpec.

getCerts(StringArray) - Method in class com.chilkatsoft.chilkat2.XmlDSig

Returns the certificates found in the signature indicated by the Selector property.

getCertVersion() - Method in class com.chilkatsoft.chilkat2.Cert

The version of the certificate (1, 2, or 3).

getChannelExitStatus(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Returns the remote process exit status received for channelNum.

getChannelNumber(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Returns the channel number at zero-based enumeration index in the active channel collection.

getChannelOpenFailCode() - Method in class com.chilkatsoft.chilkat2.Ssh

Contains the SSH channel-open failure code when the server rejects a request to open a channel.

getChannelOpenFailReason() - Method in class com.chilkatsoft.chilkat2.Ssh

Contains the descriptive text associated with Ssh.getChannelOpenFailCode() when the server rejects a channel-open request.

getChannelType(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Returns the type of the channel at zero-based enumeration index in the active channel collection.

getCharset() - Method in class com.chilkatsoft.chilkat2.Compression

Specifies the character encoding used when converting text to bytes before compression, and bytes back to text after decompression.

getCharset() - Method in class com.chilkatsoft.chilkat2.Crypt2

This property specifies the character encoding used to represent text as bytes for encryption and hashing.

getCharset() - Method in class com.chilkatsoft.chilkat2.Email

Represents the main charset of the email, such as utf-8, iso-8859-1, Shift_JIS, US-ASCII, etc.

getCharset() - Method in class com.chilkatsoft.chilkat2.HttpRequest

Controls the character encoding used in the URL encoding of query params.

getCharset() - Method in class com.chilkatsoft.chilkat2.HttpResponse

The response charset, such as iso-8859-1, if applicable.

getCharset() - Method in class com.chilkatsoft.chilkat2.Mime

Gets or sets the charset parameter of the Content-Type header field.

getCharset() - Method in class com.chilkatsoft.chilkat2.Rsa

This property specifies the character encoding used to represent text as bytes for encryption, decryption, signing, and signature validation.

getCharset() - Method in class com.chilkatsoft.chilkat2.Tar

Specifies the character encoding used to decode filenames stored in a TAR archive during extraction.

getChild(int) - Method in class com.chilkatsoft.chilkat2.Xml

Returns an Xml object referencing the direct child at zero-based index.

getChild2(int) - Method in class com.chilkatsoft.chilkat2.Xml

Moves the calling Xml object's internal reference to the direct child at zero-based index.

getChildAttrValue(String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the value of attribute attrName on the descendant element selected by tagPath.

getChildBoolValue(String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the integer content of the child selected by tagPath as a Boolean value: content equal to 0 yields false; a non-zero integer yields true.

getChildContent(String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the text content of the child selected by tagPath.

getChildContentByIndex(int) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the text content of the direct child at zero-based index.

getChildContentSb(String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Xml

Finds the element selected by tagPath and appends that element's text content to sb.

getChildExact(String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the first direct child whose tag equals tag and whose text content exactly equals content.

getChildIntValue(String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the content of the child selected by tagPath, interpreted as a 32-bit integer.

getChildTag(int) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the tag name of the direct child at zero-based index.

getChildTagByIndex(int) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the tag name of the direct child at zero-based index.

getChildWithAttr(String, String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the child selected by tagPath that also has an attribute named attrName whose value exactly equals attrValue.

getChildWithContent(String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the first direct child whose text content exactly equals content.

getChildWithTag(String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns an Xml object referencing the child selected by tagPath.

getChildWithTag2(String) - Method in class com.chilkatsoft.chilkat2.Xml

Moves the calling Xml object's internal reference to the child selected by tagPath.

getChopAtQuery() - Method in class com.chilkatsoft.chilkat2.Spider

If equal to 1 (true), then the query portion of all URLs are automatically removed when adding to the unspidered list.

getChunkSize() - Method in class com.chilkatsoft.chilkat2.Upload

The chunk size (in bytes) used by the underlying TCP/IP sockets for uploading files.

getCipherMode() - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the cipher mode for block encryption algorithms (AES, Blowfish,TwoFish, DES, 3DES, RC2).

getClassName() - Method in exception com.chilkatsoft.chilkat2.ChilkatException

The Chilkat class of the object whose method failed, such as Http.

getClearArchiveAttribute() - Method in class com.chilkatsoft.chilkat2.Zip

(Windows only)

getClearReadOnlyAttr() - Method in class com.chilkatsoft.chilkat2.Zip

If true, removes the read-only attribute from extracted files.

getClientChallenge() - Method in class com.chilkatsoft.chilkat2.Ntlm

Specifies the 8-byte client challenge used when generating the Type 3 authenticate message.

getClientId() - Method in class com.chilkatsoft.chilkat2.OAuth2

Specifies the client identifier assigned when the application is registered with the authorization server.

getClientIdentifier() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the SSH client-identification string sent when a connection is established.

getClientIdentifier() - Method in class com.chilkatsoft.chilkat2.Ssh

Specifies the SSH client-identification string sent when a connection is established.

getClientIdentifier() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the SSH client-identification string sent when connecting to the SSH server.

getClientIpAddress() - Method in class com.chilkatsoft.chilkat2.Ftp2

This property is normally left unset. Set it only on a multihomed computer when the application must bind the outgoing connection to a specific local network interface.

getClientIpAddress() - Method in class com.chilkatsoft.chilkat2.Http

A computer can have multiple network interfaces (e.g., Ethernet, Wi-Fi, VPN, virtual adapters).

getClientIpAddress() - Method in class com.chilkatsoft.chilkat2.Imap

Specifies the local IP address to bind when the computer has multiple network interfaces or addresses.

getClientIpAddress() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the local IP address to use when connecting from a computer that has multiple network interfaces or multiple IP addresses.

getClientIpAddress() - Method in class com.chilkatsoft.chilkat2.SFtp

This property is normally left unset. Set it only on a multihomed computer when the application must bind the outgoing connection to a specific local network interface.

getClientIpAddress() - Method in class com.chilkatsoft.chilkat2.Socket

Specifies a numeric local IP address to use when binding the socket to a local interface.

getClientIpAddress() - Method in class com.chilkatsoft.chilkat2.Ssh

This property is normally left unset. Set it only when the computer has multiple network interfaces or multiple local IP addresses and the application needs to use a specific one.

getClientIpAddress() - Method in class com.chilkatsoft.chilkat2.Upload

The IP address to use for computers with multiple network interfaces or IP addresses.

getClientLogDir() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the local directory where a separate log file is created for each tunnel client.

getClientPort() - Method in class com.chilkatsoft.chilkat2.Socket

Specifies the local TCP port to bind before initiating an outbound connection.

getClientPort() - Method in class com.chilkatsoft.chilkat2.Ssh

This property is normally left at its default value of 0. In this case, the operating system automatically chooses an unused local port from its ephemeral-port range.

getClientSecret() - Method in class com.chilkatsoft.chilkat2.OAuth2

Specifies the client secret assigned to a confidential client by the authorization server.

getCloseAutoRespond() - Method in class com.chilkatsoft.chilkat2.WebSocket

Controls whether Chilkat automatically answers an incoming Close control frame.

getCloseReason() - Method in class com.chilkatsoft.chilkat2.WebSocket

Returns the UTF-8 reason text contained in the received Close control frame.

getCloseReceived() - Method in class com.chilkatsoft.chilkat2.WebSocket

true after a Close control frame has been received on the current WebSocket connection.

getCloseStatusCode() - Method in class com.chilkatsoft.chilkat2.WebSocket

Returns the status code contained in the received Close control frame.

getCmsOptions() - Method in class com.chilkatsoft.chilkat2.Crypt2

A JSON string to manage additional CMS (PKCS7) signature and validation options.

getCmsOptions() - Method in class com.chilkatsoft.chilkat2.Mime

Gets or sets a JSON string containing advanced CMS/PKCS #7 signing and validation options.

getCodeChallenge() - Method in class com.chilkatsoft.chilkat2.OAuth2

Set to true to enable Proof Key for Code Exchange (PKCE) for the authorization-code flow.

getCodeChallengeMethod() - Method in class com.chilkatsoft.chilkat2.OAuth2

Selects the PKCE transformation used when OAuth2.getCodeChallenge() is true.

getColumnName(int) - Method in class com.chilkatsoft.chilkat2.Csv

Returns the original, untrimmed name of the column at zero-based index index.

getCommandCharset() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the character encoding used by high-level FTP operations for commands containing non-ASCII text, including remote paths and filenames.

getComment() - Method in class com.chilkatsoft.chilkat2.Gzip

An optional comment to embed in the Gzip file when a Compress* method is called.

getComment() - Method in class com.chilkatsoft.chilkat2.SshKey

Gets or sets the optional comment associated with the key.

getComment() - Method in class com.chilkatsoft.chilkat2.Zip

Sets or retrieves the global ZIP file comment.

getComment() - Method in class com.chilkatsoft.chilkat2.ZipEntry

Gets or sets the comment stored in the ZIP archive for this entry.

getCommonName() - Method in class com.chilkatsoft.chilkat2.Csr

Gets or sets the subject common name (CN), OID 2.5.4.3, for the CSR.

getCompany() - Method in class com.chilkatsoft.chilkat2.Csr

Gets or sets the subject organization name (O), OID 2.5.4.10.

getCompanyDivision() - Method in class com.chilkatsoft.chilkat2.Csr

Gets or sets the subject organizational unit name (OU), OID 2.5.4.11.

getCompressedLength() - Method in class com.chilkatsoft.chilkat2.ZipEntry

The compressed size of this entry, in bytes.

getCompressedLength64() - Method in class com.chilkatsoft.chilkat2.ZipEntry

The compressed size of this entry, in bytes, as a 64-bit integer.

getCompressedLengthStr() - Method in class com.chilkatsoft.chilkat2.ZipEntry

The compressed size of this entry as a decimal string.

getCompression() - Method in class com.chilkatsoft.chilkat2.Secrets

If set to true, then the contents of the secret will be stored compressed.

getCompressionLevel() - Method in class com.chilkatsoft.chilkat2.Gzip

Controls the compression level used when creating Gzip data.

getCompressionLevel() - Method in class com.chilkatsoft.chilkat2.ZipEntry

Gets or sets the compression level for this entry.

getCompressionMethod() - Method in class com.chilkatsoft.chilkat2.ZipEntry

Gets or sets the compression method used for this entry.

getConnected() - Method in class com.chilkatsoft.chilkat2.Mcp

Read-only.

getConnectedReader() - Method in class com.chilkatsoft.chilkat2.SCard

The name of the currently connected smart card reader, or an empty string if not connected.

getConnectedToHost() - Method in class com.chilkatsoft.chilkat2.Imap

Contains the hostname or IP address of the IMAP server to which the object is currently connected.

getConnectFailReason() - Method in class com.chilkatsoft.chilkat2.Ftp2

Contains a numeric reason code after Ftp2.connect() or Ftp2.connectOnly() fails.

getConnectFailReason() - Method in class com.chilkatsoft.chilkat2.Http

This property will be set to the status of the last HTTP connection made (or failed to be made) by any HTTP method.

getConnectFailReason() - Method in class com.chilkatsoft.chilkat2.MailMan

Contains a numeric code describing the result of the last connection attempt.

getConnectFailReason() - Method in class com.chilkatsoft.chilkat2.Rest

After Rest.connect(String, int, boolean, boolean) fails, returns a code identifying the connection stage or TLS handshake stage that failed.

getConnectFailReason() - Method in class com.chilkatsoft.chilkat2.Socket

Contains the numeric result for the most recent connect-family operation, including TCP connection and SSH connection/channel setup.

getConnectTimeout() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the maximum number of seconds to wait for a remote endpoint to accept a TCP connection.

getConnectTimeout() - Method in class com.chilkatsoft.chilkat2.Http

Determines the maximum time, in seconds, to wait for an HTTP server to accept a TCP connection before timing out.

getConnectTimeout() - Method in class com.chilkatsoft.chilkat2.Imap

The maximum number of seconds to wait while establishing the TCP connection to the IMAP server.

getConnectTimeout() - Method in class com.chilkatsoft.chilkat2.MailMan

The maximum number of seconds to wait while attempting to connect to an SMTP or POP3 server.

getConnectTimeout() - Method in class com.chilkatsoft.chilkat2.Mht

Specifies the maximum number of seconds allowed for establishing a connection to an HTTP server.

getConnectTimeout() - Method in class com.chilkatsoft.chilkat2.Spider

The maximum number of seconds to wait while connecting to an HTTP server.

getConnectTimeoutMs() - Method in class com.chilkatsoft.chilkat2.Mcp

The maximum amount of time, in milliseconds, to wait to establish the TCP/TLS connection to the MCP server.

getConnectTimeoutMs() - Method in class com.chilkatsoft.chilkat2.Rest

Gets or sets the maximum number of milliseconds to wait for the remote server to accept the TCP connection.

getConnectTimeoutMs() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the maximum number of milliseconds allowed for the remote endpoint to accept the TCP connection.

getConnectTimeoutMs() - Method in class com.chilkatsoft.chilkat2.Ssh

Specifies the maximum number of milliseconds allowed for the remote endpoint to accept the TCP connection.

getConnectTimeoutMs() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the maximum number of milliseconds allowed for establishing the SSH connection.

getConnectVerified() - Method in class com.chilkatsoft.chilkat2.Ftp2

Indicates whether the TCP connection to the FTP server was successfully established during the most recent connection attempt.

getConstructed() - Method in class com.chilkatsoft.chilkat2.Asn

true if this ASN.1 item is a constructed item.

getConsumerKey() - Method in class com.chilkatsoft.chilkat2.OAuth1

The consumer key.

getConsumerSecret() - Method in class com.chilkatsoft.chilkat2.OAuth1

The consumer secret.

getContainerKeys(int, PublicKey, PublicKey) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Queries a key container to get the keys that are present.

getContent() - Method in class com.chilkatsoft.chilkat2.Xml

Gets or sets the text content stored directly on this XML element.

getContentInt() - Method in class com.chilkatsoft.chilkat2.Xml

Gets or sets this element's content as a 32-bit integer.

getContentLength() - Method in class com.chilkatsoft.chilkat2.HttpResponse

The content length of the response, in bytes.

getContentLength64() - Method in class com.chilkatsoft.chilkat2.HttpResponse

The content length of the response, in number of bytes, returned as a 64-bit integer.

getContentStr() - Method in class com.chilkatsoft.chilkat2.Asn

The ASN.1 item's content if it is an ASN.1 string type (such as Utf8String, BmpString, PrintableString, VisibleString, T61String, IA5String, NumericString, or UniversalString).

getContentType() - Method in class com.chilkatsoft.chilkat2.HttpRequest

The ContentType property sets the Content-Type header field, and identifies the content-type of the HTTP request body.

getContentType() - Method in class com.chilkatsoft.chilkat2.Mime

Gets or sets the MIME media type of the current part, excluding all parameters.

getContext() - Method in class com.chilkatsoft.chilkat2.EdDSA

Gets or sets the context bytes used by the Ed25519ctx and Ed25519ph signature variants.

getContext() - Method in class com.chilkatsoft.chilkat2.SCard

Contains the string user or system if this object has established a context (by calling EstablishContext).

getCookieDir() - Method in class com.chilkatsoft.chilkat2.Http

Designates a directory path for automatic cookie storage (such as "c:/myCookieDir" or "/Users/example/myCookieDir") when the Http.getSaveCookies() property is set to true.

getCookieDomain(int) - Method in class com.chilkatsoft.chilkat2.HttpResponse

Returns the domain of the Nth cookie in the response.

getCookieExpiresStr(int) - Method in class com.chilkatsoft.chilkat2.HttpResponse

Returns the expiration date/time of the Nth cookie in the response.

getCookieName(int) - Method in class com.chilkatsoft.chilkat2.HttpResponse

Returns the name of the Nth cookie returned in the response.

getCookiePath(int) - Method in class com.chilkatsoft.chilkat2.HttpResponse

Returns the path of the Nth cookie returned in the response.

getCookieValue(int) - Method in class com.chilkatsoft.chilkat2.HttpResponse

Returns the value of the Nth cookie returned in the response.

getCookieXml(String) - Method in class com.chilkatsoft.chilkat2.Http

Returns cookies in XML format for a specified domain.

getCount() - Method in class com.chilkatsoft.chilkat2.Hashtable

The number of entries currently stored in the hashtable.

getCount() - Method in class com.chilkatsoft.chilkat2.Mailboxes

Returns the number of mailboxes in this collection.

getCount() - Method in class com.chilkatsoft.chilkat2.MessageSet

Returns the number of unique message identifiers currently stored in the set.

getCount() - Method in class com.chilkatsoft.chilkat2.StringArray

The number of strings contained within the object's internal array (i.e.

getCount() - Method in class com.chilkatsoft.chilkat2.StringTable

The number of strings in the table.

getCountry() - Method in class com.chilkatsoft.chilkat2.Csr

Gets or sets the subject country name (C), OID 2.5.4.6.

getCrc() - Method in class com.chilkatsoft.chilkat2.ZipEntry

The CRC value for this ZIP entry.

getCreateTimeByNameStr(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the creation time for the file or directory named by filename in the current remote directory as an RFC 822 date-time string, such as Fri, 21 Nov 1997 09:55:06 -0600.

getCreateTimeStr() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns the file creation date and time as an RFC 822-formatted string, such as Fri, 21 Nov 1997 09:55:06 -0600.

getCreateTimeStr(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the creation time for cached directory-listing entry index as an RFC 822 date-time string, such as Fri, 21 Nov 1997 09:55:06 -0600.

getCrlf() - Method in class com.chilkatsoft.chilkat2.Csv

Controls the line endings used by SaveFile, SaveFile2, SaveToString, and SaveToSb.

getCrlf() - Method in class com.chilkatsoft.chilkat2.StringArray

If true, strings are always automatically converted to use CRLF line endings.

getCrlfMode() - Method in class com.chilkatsoft.chilkat2.Ftp2

Controls line-ending conversion when downloading in ASCII transfer mode.

getCryptAlgorithm() - Method in class com.chilkatsoft.chilkat2.Crypt2

Selects the encryption algorithm for encrypting and decrypting.

getCspContainerMap(JsonObject) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Returns the contents of the CSP container map file (cmapfile).

getCurBytesReceived() - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the number of bytes received by the current or most recently completed FTP download as a 32-bit unsigned integer.

getCurBytesReceived64() - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the number of bytes received by the current or most recently completed FTP download as a 64-bit integer.

getCurBytesReceivedStr() - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the number of bytes received by the current or most recently completed FTP download as a decimal string.

getCurBytesSent() - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the number of bytes sent by the current or most recently completed FTP upload as a 32-bit unsigned integer.

getCurBytesSent64() - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the number of bytes sent by the current or most recently completed FTP upload as a 64-bit integer.

getCurBytesSentStr() - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the number of bytes sent by the current or most recently completed FTP upload as a decimal string.

getCurrentDateTime() - Method in class com.chilkatsoft.chilkat2.Mime

Returns the current local date and time formatted as an Internet message date, including the numeric UTC offset.

getCurrentDir() - Method in class com.chilkatsoft.chilkat2.FileAccess

Returns the current working directory of the calling process.

getCurrentFilename() - Method in class com.chilkatsoft.chilkat2.Upload

The current filename being uploaded while an asynchronous upload is in progress.

getCurrentRemoteDir() - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the current working directory reported by the FTP server, normally by using the PWD command.

getCurrentState() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Returns an XML snapshot describing the tunnel manager, SSH channels, and current tunnel clients.

getCustomKeyInfoXml() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Specifies custom XML to be inserted in the KeyInfo element of the Signature.

getData() - Method in class com.chilkatsoft.chilkat2.BinData

Retrieves the binary data contained within the object.

getData() - Method in class com.chilkatsoft.chilkat2.ServerSentEvent

The data for the server-side event.

getDataAvailable() - Method in class com.chilkatsoft.chilkat2.Stream

true if it is known for sure that data is ready and waiting to be read.

getDataChunk(int, int) - Method in class com.chilkatsoft.chilkat2.BinData

Retrieves a chunk of the binary data contained within the object.

getDataProtection() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the protection level for FTP data connections.

getDateStr() - Method in class com.chilkatsoft.chilkat2.HttpResponse

Returns the content of the Date response header field in RFC822 date/time string format.

getDay() - Method in class com.chilkatsoft.chilkat2.DtObj

The day of the month.

getDebugHtmlAfter() - Method in class com.chilkatsoft.chilkat2.Mht

Specifies a local file path where Chilkat saves the HTML after it has been processed for MHT or EML generation.

getDebugHtmlBefore() - Method in class com.chilkatsoft.chilkat2.Mht

Specifies a local file path where Chilkat saves the source HTML before it is transformed for MHT or EML generation.

getDebugLogFilePath() - Method in class com.chilkatsoft.chilkat2.ChilkatObject

The path of a file to which the library appends its log for every method of this object, or an empty string.

getDebugMode() - Method in class com.chilkatsoft.chilkat2.Rest

When true, calls to the Send* and FullRequest* methods compose the complete request but do not transmit it.

getDecodeHtmlEntities() - Method in class com.chilkatsoft.chilkat2.HtmlToText

Controls whether HTML character references are decoded when converting HTML to plain text.

getDecryptCertInfo(JsonObject) - Method in class com.chilkatsoft.chilkat2.Mime

Examines the current encrypted S/MIME entity and writes recipient-certificate identifiers to the JsonObject in certInfo.

getDecrypted() - Method in class com.chilkatsoft.chilkat2.Email

true if the email arrived encrypted and was successfully decrypted, otherwise false.

getDecryptPassword() - Method in class com.chilkatsoft.chilkat2.Zip

Password used to extract encrypted ZIP archives.

getDefaultChunkSize() - Method in class com.chilkatsoft.chilkat2.Stream

The default internal chunk size for reading or writing.

getDefaultFreshPeriod() - Method in class com.chilkatsoft.chilkat2.Http

Sets the default freshness period (in minutes) for cached documents when the Http.getFreshnessAlgorithm() property is set to 0.

getDefaultNtlmVersion() - Method in class com.chilkatsoft.chilkat2.Global

Selects the default NTLM protocol version to use for NTLM authentication for HTTP, POP3, IMAP, SMTP, and HTTP proxies.

getDefaultUtf8() - Method in class com.chilkatsoft.chilkat2.Global

Sets the default value of the Utf8 property for each Chilkat class.

getDeflateLevel() - Method in class com.chilkatsoft.chilkat2.Compression

Sets the compression level used by the deflate and zlib algorithms.

getDelimiter() - Method in class com.chilkatsoft.chilkat2.Csv

Specifies the single character used to separate fields within each CSV record.

getDelimiterChar() - Method in class com.chilkatsoft.chilkat2.JsonObject

Specifies the character used to separate object-member names in Chilkat JSON paths.

getDeliveryStatusInfo(String) - Method in class com.chilkatsoft.chilkat2.Email

Returns a field from the message/delivery-status part of a delivery-status notification.

getDerBd(boolean, BinData) - Method in class com.chilkatsoft.chilkat2.PublicKey

Writes the public key as binary DER to bd.

getDestHostname() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the destination hostname or IP address for fixed-destination port forwarding.

getDestPort() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the TCP port of the destination service used for fixed-destination forwarding, such as the port of a database server.

getDigestAuth() - Method in class com.chilkatsoft.chilkat2.Http

Setting this property to true causes the HTTP component to use digest authentication.

getDigestEmail(int, Email) - Method in class com.chilkatsoft.chilkat2.Email

Returns in email the Nth digest email contained within a multipart/digest.

getDirCount() - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the number of files and directories in the cached listing of the current remote directory after applying the case-insensitive Ftp2.getListPattern().

getDirectoryAsXML() - Method in class com.chilkatsoft.chilkat2.Zip

Returns the ZIP directory structure as an XML document.

getDirectoryName(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Returns the directory portion of path according to Chilkat path-parsing rules.

getDirListingCharset() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the character encoding used only to decode directory-listing and related server-response bytes.

getDirMode() - Method in class com.chilkatsoft.chilkat2.Tar

Specifies the UNIX permission bits written to the TAR header for directory entries created by the WriteTar* methods.

getDirPrefix() - Method in class com.chilkatsoft.chilkat2.Tar

Specifies a path prefix to prepend to entries when a TAR archive is created.

getDirRoot(int) - Method in class com.chilkatsoft.chilkat2.Tar

Returns a directory root previously added with Tar.addDirRoot(String) or Tar.addDirRoot2(String, String).

getDiscardPaths() - Method in class com.chilkatsoft.chilkat2.Zip

If true, removes all directory path information when adding files.

getDisconnectCode() - Method in class com.chilkatsoft.chilkat2.SFtp

Contains the RFC 4253 reason code from the most recent SSH DISCONNECT message received from the server.

getDisconnectCode() - Method in class com.chilkatsoft.chilkat2.Ssh

Contains the reason code from the most recent SSH DISCONNECT message received from the server.

getDisconnectReason() - Method in class com.chilkatsoft.chilkat2.SFtp

Contains the descriptive text sent with the most recent server SSH DISCONNECT message.

getDisconnectReason() - Method in class com.chilkatsoft.chilkat2.Ssh

Contains the descriptive text sent with the most recent server SSH DISCONNECT message.

getDisposition() - Method in class com.chilkatsoft.chilkat2.Mime

Gets or sets the disposition value from the Content-Disposition header field, excluding parameters such as filename.

getDkimAlg() - Method in class com.chilkatsoft.chilkat2.Dkim

Specifies the signing algorithm written to the a= tag of a newly created DKIM-Signature header.

getDkimBodyLengthCount() - Method in class com.chilkatsoft.chilkat2.Dkim

Controls the maximum number of bytes from the canonicalized message body used when computing the DKIM body hash.

getDkimCanon() - Method in class com.chilkatsoft.chilkat2.Dkim

Specifies one DKIM canonicalization algorithm to use for both the signed header fields and the message body.

getDkimDomain() - Method in class com.chilkatsoft.chilkat2.Dkim

Specifies the signing domain written verbatim to the d= tag of the generated DKIM-Signature header.

getDkimHeaders() - Method in class com.chilkatsoft.chilkat2.Dkim

A colon-separated list of header field names to include in the DKIM signature.

getDkimSelector() - Method in class com.chilkatsoft.chilkat2.Dkim

Specifies the selector written verbatim to the s= tag of a generated DKIM signature.

getDnsComputerName() - Method in class com.chilkatsoft.chilkat2.Ntlm

Specifies the server's DNS computer name for inclusion in the MsvAvDnsComputerName entry of the Type 2 message's TargetInfo block.

getDnsDomainName() - Method in class com.chilkatsoft.chilkat2.Ntlm

Specifies the server's DNS domain name for inclusion in the MsvAvDnsDomainName entry of the Type 2 message's TargetInfo block.

getDnsTimeToLive() - Method in class com.chilkatsoft.chilkat2.Global

If DNS caching is enabled, this is the time-to-live (in seconds) for a cached DNS lookup.

getDocRoot() - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns a JsonObject reference to the root object of the JSON document containing this object.

getDocRoot2(JsonObject) - Method in class com.chilkatsoft.chilkat2.JsonObject

Updates docRoot to reference the root object of the JSON document containing the caller and returns true on success.

getDocType() - Method in class com.chilkatsoft.chilkat2.Xml

Gets or sets the document type declaration associated with the XML document.

getDomain() - Method in class com.chilkatsoft.chilkat2.HttpResponse

The domain of the HTTP server that created this response.

getDomain() - Method in class com.chilkatsoft.chilkat2.Imap

Specifies the Windows domain used for NTLM authentication.

getDomain() - Method in class com.chilkatsoft.chilkat2.Ntlm

Specifies the client's domain or workgroup name.

getDomain() - Method in class com.chilkatsoft.chilkat2.Spider

The domain name that is being spidered.

getDomain(String) - Method in class com.chilkatsoft.chilkat2.Http

Utility method to extract the domain name from a URL.

getDoneIterating() - Method in class com.chilkatsoft.chilkat2.DirTree

Indicates whether the traversal has reached its normal end and no current item remains.

getDownloadTransferRate() - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the current average download rate in bytes per second.

getDropCustomTags() - Method in class com.chilkatsoft.chilkat2.HtmlToXml

Controls whether tags that Chilkat does not recognize as standard HTML elements are omitted from the generated XML.

getDsnEnvid() - Method in class com.chilkatsoft.chilkat2.MailMan

The DsnEnvid property specifies the SMTP DSN ENVID value, which is an arbitrary identifier attached to the SMTP envelope.

getDsnInfo(JsonObject) - Method in class com.chilkatsoft.chilkat2.Email

If the Email.isMultipartReport() method indicates that the email is multipart/report, use this method to obtain the delivery-status information, including the final recipients, as JSON that is easy to parse.

getDsnNotify() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SMTP DSN NOTIFY parameter used when sending email.

getDsnRet() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SMTP DSN RET parameter used when sending email.

getDss(JsonObject) - Method in class com.chilkatsoft.chilkat2.Pdf

Gets the contents of the PDF's Document Security Store (/DSS) if it exists.

getDynamicPortForwarding() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Controls whether the listener performs fixed-destination or dynamic port forwarding.

getElapsedSeconds() - Method in class com.chilkatsoft.chilkat2.Socket

Returns the whole number of seconds elapsed since the most recent call to StartTiming.

getEmailAddress() - Method in class com.chilkatsoft.chilkat2.AuthGoogle

The client email address of the service account.

getEmailAddress() - Method in class com.chilkatsoft.chilkat2.Csr

Gets or sets the legacy PKCS #9 emailAddress subject attribute, OID 1.2.840.113549.1.9.1.

getEmailDateStr() - Method in class com.chilkatsoft.chilkat2.Email

The date/time from the Date header in the UTC/GMT timezone in RFC822 string form.

getEmbedCertChain() - Method in class com.chilkatsoft.chilkat2.MailMan

When true, Chilkat embeds the signing certificate chain in signed email.

getEmbedded(int) - Method in class com.chilkatsoft.chilkat2.Xmp

Returns the Nth embedded XMP document as a Chilkat XML object.

getEmbeddedFileBd(int, BinData) - Method in class com.chilkatsoft.chilkat2.Pdf

Loads the bd with the contents of the Nth embedded file contained in the currently open PDF.

getEmbeddedFileInfo(int, JsonObject) - Method in class com.chilkatsoft.chilkat2.Pdf

Gets information about the Nth embedded file contained in the currently open PDF.

getEmbedImages() - Method in class com.chilkatsoft.chilkat2.Mht

Controls whether images referenced by the HTML are downloaded or read from disk and embedded as related MIME parts in both MHT and EML output.

getEmbedLocalOnly() - Method in class com.chilkatsoft.chilkat2.Mht

When true, only images whose references resolve to the local filesystem are embedded.

getEmitBom() - Method in class com.chilkatsoft.chilkat2.Xml

Controls whether a byte order mark (BOM, also called a preamble) is written when XML is saved to a file.

getEmitCompact() - Method in class com.chilkatsoft.chilkat2.JsonArray

Controls whether emitted JSON is compact or pretty-formatted.

getEmitCompact() - Method in class com.chilkatsoft.chilkat2.JsonObject

Controls whether emitted JSON is compact or pretty-printed.

getEmitCompact() - Method in class com.chilkatsoft.chilkat2.Xml

Controls whether XML emitted by GetXml and GetXmlSb is compact.

getEmitCrlf() - Method in class com.chilkatsoft.chilkat2.JsonArray

Controls line endings when pretty-formatted JSON is emitted.

getEmitCrLf() - Method in class com.chilkatsoft.chilkat2.JsonObject

Controls line endings when pretty-printed JSON is emitted (EmitCompact = false).

getEmitXmlDecl() - Method in class com.chilkatsoft.chilkat2.Xml

Controls whether the XML declaration is included when XML is emitted.

getEML(String) - Method in class com.chilkatsoft.chilkat2.Mht

Creates an EML MIME message from the HTTP/HTTPS page or local HTML file in url_or_htmlFilepath and returns the complete EML text in memory.

getEmpty() - Method in class com.chilkatsoft.chilkat2.PublicKey

Returns true if no public key is currently loaded, and false if this object contains a public key.

getEnableBodyVars() - Method in class com.chilkatsoft.chilkat2.HttpCurl

Enables variable substitution in the body of the request.

getEnableCache() - Method in class com.chilkatsoft.chilkat2.SFtp

Controls whether Chilkat caches remote file sizes and attributes requested by SFtp.getFileSize32(String, boolean, boolean), SFtp.getFileSize64(String, boolean, boolean), SFtp.getFileSizeStr(String, boolean, boolean), SFtp.getFileCreateTimeStr(String, boolean, boolean), SFtp.getFileLastAccessStr(String, boolean, boolean), SFtp.getFileLastModifiedStr(String, boolean, boolean), SFtp.getFileOwner(String, boolean, boolean), SFtp.getFileGroup(String, boolean, boolean), SFtp.getFilePermissions(String, boolean, boolean).

getEnableCompression() - Method in class com.chilkatsoft.chilkat2.SFtp

Controls whether SSH compression may be negotiated.

getEnableCompression() - Method in class com.chilkatsoft.chilkat2.Ssh

Controls whether SSH compression may be negotiated.

getEnableDnsCaching() - Method in class com.chilkatsoft.chilkat2.Global

Controls whether DNS domain lookups (to resolve to IP addresses) are cached in memory.

getEnableQuotes() - Method in class com.chilkatsoft.chilkat2.Csv

Controls whether double quotation marks have their standard CSV meaning when reading and writing data.

getEnableSecrets() - Method in class com.chilkatsoft.chilkat2.Ai

If true a secret specifier of the format "!!part1|part2|.." can be provided instead of the actual value for the ApiKey property.

getEnableSecrets() - Method in class com.chilkatsoft.chilkat2.AuthAws

If true a secret specifier of the format "!!part1|part2|.." can be provided instead of the actual value for the AccessKey and SecretKey properties.

getEnableSecrets() - Method in class com.chilkatsoft.chilkat2.Ftp2

Controls automatic resolution of credential values from secure operating-system storage.

getEnableSecrets() - Method in class com.chilkatsoft.chilkat2.Http

This property that automatic resolution of credentials from the operating system’s secure storage.

getEnableSecrets() - Method in class com.chilkatsoft.chilkat2.Imap

Enables automatic resolution of credential values from secure operating-system storage.

getEnableSecrets() - Method in class com.chilkatsoft.chilkat2.JsonObject

Enables automatic resolution of Chilkat secret specification strings for supported string-setting methods.

getEnableSecrets() - Method in class com.chilkatsoft.chilkat2.MailMan

Enables automatic resolution of passwords and credentials from secure local storage.

getEnableSecrets() - Method in class com.chilkatsoft.chilkat2.OAuth2

Controls automatic resolution of selected values from operating-system secure storage.

getEnableSecrets() - Method in class com.chilkatsoft.chilkat2.Rest

Controls automatic resolution of credentials from operating-system secure storage.

getEnableSecrets() - Method in class com.chilkatsoft.chilkat2.SFtp

Enables automatic resolution of secret specification strings from secure operating-system storage.

getEnableSecrets() - Method in class com.chilkatsoft.chilkat2.Ssh

Enables automatic resolution of secret specification strings from secure operating-system storage.

getEnableSecrets() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Enables automatic resolution of credentials from secure storage provided by the operating system.

getEncoded() - Method in class com.chilkatsoft.chilkat2.Cert

Returns a base64 encoded string representation of the certificate's binary DER format, which can be passed to SetFromEncoded to recreate the certificate object.

getEncoded(boolean, String) - Method in class com.chilkatsoft.chilkat2.PublicKey

Returns the DER representation selected by preferPkcs1, encoded as text using the binary encoding named by encoding.

getEncoded(String) - Method in class com.chilkatsoft.chilkat2.BinData

Retrieves the binary data as an encoded string.

getEncoded(String, String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Returns the string contents encoded in an encoding such as base64, hex, quoted-printable, or URL-encoding.

getEncodedAuthTag(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

When encrypting in GCM mode, Chilkat generates the GCM authentication tag.

getEncodedChunk(int, int, String) - Method in class com.chilkatsoft.chilkat2.BinData

Retrieves a chunk of the binary data and returns it in encoded form.

getEncodedContent(String) - Method in class com.chilkatsoft.chilkat2.Asn

Returns the content of the ASN.1 item in encoded string form.

getEncodedDer(String) - Method in class com.chilkatsoft.chilkat2.Asn

Returns the binary DER in encoded string form.

getEncodedHash(String) - Method in class com.chilkatsoft.chilkat2.Dsa

Returns the current Hash bytes encoded according to encoding.

getEncodedItem(String, String, String, int) - Method in class com.chilkatsoft.chilkat2.Pem

Returns the encoded contents of the Nth item of a particular type (0-based index).

getEncodedIV(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

This method retrieves the IV set by the application during the last call to Crypt2.setEncodedIV(String, String) or Crypt2.randomizeIV().

getEncodedSb(String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.BinData

Writes the encoded data to a StringBuilder.

getEncodedSignature() - Method in class com.chilkatsoft.chilkat2.OAuth1

The URL encoded representation of the Signature property

getEncodedSignature(String) - Method in class com.chilkatsoft.chilkat2.Dsa

Returns the current Signature bytes encoded according to encoding.

getEncoding() - Method in class com.chilkatsoft.chilkat2.Mime

Gets or sets the value of the Content-Transfer-Encoding header field for the current part.

getEncoding() - Method in class com.chilkatsoft.chilkat2.Xml

Gets or sets the encoding value used in the XML declaration.

getEncodingMode() - Method in class com.chilkatsoft.chilkat2.Compression

Specifies the text encoding used by methods whose names end in ENC, such as CompressBytesENC and DecompressStringENC.

getEncodingMode() - Method in class com.chilkatsoft.chilkat2.Crypt2

The EncodingMode property specifies the binary encoding format (e.g., base64, hex, base58, base64url) used by functions ending in "ENC", like Crypt2.encryptStringENC(String) and Crypt2.decryptStringENC(String).

getEncodingMode() - Method in class com.chilkatsoft.chilkat2.Ntlm

Controls the textual encoding used when Chilkat exposes binary NTLM values as strings or accepts them from strings.

getEncodingMode() - Method in class com.chilkatsoft.chilkat2.Rsa

This property defines the encoding for methods ending in ENC, such as EncryptStringENC.

getEncryptedBy() - Method in class com.chilkatsoft.chilkat2.Email

If the email was received encrypted, this contains the details of the certificate used for encryption.

getEncryption() - Method in class com.chilkatsoft.chilkat2.Zip

Specifies encryption mode: 0 → No encryption 4 → WinZip-compatible AES encryption

getEncryptionKeyLen() - Method in class com.chilkatsoft.chilkat2.ZipEntry

The AES encryption key length for this entry.

getEncryptKeyLength() - Method in class com.chilkatsoft.chilkat2.Zip

Specifies the AES encryption key length.

getEncryptPassword() - Method in class com.chilkatsoft.chilkat2.Zip

Password used when creating encrypted ZIP archives.

getEndOfFile() - Method in class com.chilkatsoft.chilkat2.FileAccess

Returns true when the currently open file is positioned at end-of-file; otherwise returns false.

getEndOfStream() - Method in class com.chilkatsoft.chilkat2.Stream

true if the end-of-stream has already been reached.

getEntireBody() - Method in class com.chilkatsoft.chilkat2.Mime

Returns the complete serialized body of the current MIME entity.

getEntireHead() - Method in class com.chilkatsoft.chilkat2.Mime

Returns the complete serialized header section of the current MIME entity.

getEntireHeader() - Method in class com.chilkatsoft.chilkat2.HttpRequest

Composes and returns the entire MIME header of the HTTP request.

getEntropy(int, String) - Method in class com.chilkatsoft.chilkat2.Prng

Requests numBytes bytes from the platform's cryptographic system entropy source and returns them using the text encoding named by encoding.

getEntryID() - Method in class com.chilkatsoft.chilkat2.ZipEntry

A unique identifier assigned to this entry while the ZIP object is instantiated in memory.

getEntryType() - Method in class com.chilkatsoft.chilkat2.ZipEntry

Indicates the origin and current state of this ZIP entry.

getErrorAction() - Method in class com.chilkatsoft.chilkat2.Charset

Controls what happens when an input character has been decoded successfully but cannot be represented in the destination charset.

getEscapeBackslash() - Method in class com.chilkatsoft.chilkat2.Csv

Controls whether a backslash causes the following character to be treated literally while parsing CSV data.

getEtag(String) - Method in class com.chilkatsoft.chilkat2.Cache

Returns the ETag metadata stored with the cache item identified by key.

getEventName() - Method in class com.chilkatsoft.chilkat2.ServerSentEvent

The name of the server-side event.

getExeConfigParam(String) - Method in class com.chilkatsoft.chilkat2.Zip

(Windows only, for creating self-extracting EXE's)

getExeDefaultDir() - Method in class com.chilkatsoft.chilkat2.Zip

(Windows only, for creating self-extracting EXE's)

getExeFinishNotifier() - Method in class com.chilkatsoft.chilkat2.Zip

(Windows only, for creating self-extracting EXE's)

getExeIconFile() - Method in class com.chilkatsoft.chilkat2.Zip

(Windows only, for creating self-extracting EXE's)

getExeNoInterface() - Method in class com.chilkatsoft.chilkat2.Zip

(Windows only, for creating self-extracting EXE's)

getExeSilentProgress() - Method in class com.chilkatsoft.chilkat2.Zip

(Windows only, for creating self-extracting EXE's)

getExeTitle() - Method in class com.chilkatsoft.chilkat2.Zip

(Windows only, for creating self-extracting EXE's)

getExeUnzipCaption() - Method in class com.chilkatsoft.chilkat2.Zip

(Windows only, for creating self-extracting EXE's)

getExeUnzipDir() - Method in class com.chilkatsoft.chilkat2.Zip

(Windows only, for creating self-extracting EXE's)

getExeWaitForSetup() - Method in class com.chilkatsoft.chilkat2.Zip

If true, waits for the AutoRun executable to finish before exiting.

getExeXmlConfig() - Method in class com.chilkatsoft.chilkat2.Zip

Allows for an XML config document to be used to specify all possible options for self-extracting EXEs.

getExpect100Continue() - Method in class com.chilkatsoft.chilkat2.Upload

When true, the request header will included an Expect: 100-continue header field.

getExpirationStr(String) - Method in class com.chilkatsoft.chilkat2.Cache

Returns the expiration date and time stored for the item identified by url, formatted as an RFC 822-style Internet date string.

getExpired() - Method in class com.chilkatsoft.chilkat2.Cert

Has a value of true if the certificate or any certificate in the chain of authority has expired.

getExpireNumSeconds() - Method in class com.chilkatsoft.chilkat2.AuthGoogle

The expiration time, in seconds, of the access token to be requested.

getExtendedKeyUsage() - Method in class com.chilkatsoft.chilkat2.Cert

Returns a string containing a comma separated list of keywords with the extended key usages of the certificate.

getExtension(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Returns the filename extension portion of path, including the leading period.

getExtensionAsText(String) - Method in class com.chilkatsoft.chilkat2.Cert

Returns the certificate extension data as a string.

getExtensionAsXml(String) - Method in class com.chilkatsoft.chilkat2.Cert

Returns the certificate extension data in XML format (converted from ASN.1).

getExtensionBd(String, BinData) - Method in class com.chilkatsoft.chilkat2.Cert

Returns the certificate extension data specified by oid in bd.

getExtensionRequest(Xml) - Method in class com.chilkatsoft.chilkat2.Csr

Retrieves the PKCS #9 extensionRequest attribute, OID 1.2.840.113549.1.9.14, from the currently loaded CSR.

getExternalRefDirs() - Method in class com.chilkatsoft.chilkat2.XmlDSig

May contain a set of directory paths specifying where referenced external files are located.

getFailedCurl() - Method in class com.chilkatsoft.chilkat2.HttpCurl

Set to the specific curl command in the execution plan that failed.

getFailedUrl(int) - Method in class com.chilkatsoft.chilkat2.Spider

Returns the Nth URL in the failed URL list.

getFailReason() - Method in class com.chilkatsoft.chilkat2.HttpCurl

Set to an integer value indicating the reason for failure for the methods HttpCurl.doYourThing(String) and HttpCurl.examinePlan(String, JsonObject)

getFailureInfo() - Method in class com.chilkatsoft.chilkat2.OAuth2

Contains diagnostic information when OAuth2.getAuthFlowState() is 5.

getFetchFromCache() - Method in class com.chilkatsoft.chilkat2.Http

Set to true to enable fetching pages from cache whenever possible.

getFetchFromCache() - Method in class com.chilkatsoft.chilkat2.Mht

When true, Chilkat attempts to satisfy page and resource requests from the configured disk cache before downloading them.

getFetchFromCache() - Method in class com.chilkatsoft.chilkat2.Spider

If equal to 1 (true) then pages are fetched from cache when possible.

getFile(String, String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Downloads the remote file at remoteFilePath to the local filesystem path at localFilePath.

getFileBd(String, BinData) - Method in class com.chilkatsoft.chilkat2.Ftp2

Downloads the remote file at remoteFilePath and appends its bytes to the existing contents of the BinData object in binData.

getFileCount() - Method in class com.chilkatsoft.chilkat2.Zip

Number of files in the ZIP, excluding directory entries.

getFileCreateTimeStr(String, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Returns the remote file's creation date and time.

getFileDateTimeStr() - Method in class com.chilkatsoft.chilkat2.ZipEntry

Gets or sets the local last-modified date/time for this ZIP entry in RFC 822 string format.

getFileDistList() - Method in class com.chilkatsoft.chilkat2.Email

Set this property to send an email to a list of recipients stored in a plain text file.

getFileGroup(String, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Returns the remote file's group ownership.

getFileLastAccessStr(String, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Returns the remote file's last-access date and time.

getFileLastModifiedStr(String, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Returns the remote file's last-modified date and time.

getFileMode() - Method in class com.chilkatsoft.chilkat2.Tar

Specifies the UNIX permission bits written to the TAR header for ordinary file entries created by the WriteTar* methods.

getFilename() - Method in class com.chilkatsoft.chilkat2.Gzip

The filename to embed in the Gzip file when a Compress* method is called.

getFilename() - Method in class com.chilkatsoft.chilkat2.Mime

Gets or sets the filename parameter of the Content-Disposition header field.

getFilename() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns the name of the directory entry.

getFilename(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the name of cached directory-listing entry index.

getFilename(int) - Method in class com.chilkatsoft.chilkat2.SFtpDir

Returns the filename of the directory entry at the zero-based index.

getFilename(String) - Method in class com.chilkatsoft.chilkat2.Cache

Returns the absolute filesystem path of the cache file associated with key.

getFileName() - Method in class com.chilkatsoft.chilkat2.Zip

Path of the ZIP file to be written or overwritten.

getFileName() - Method in class com.chilkatsoft.chilkat2.ZipEntry

Gets or sets the filename, including any relative path, stored for this entry inside the ZIP archive.

getFileName(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Returns the final filename component of path, including its extension.

getFilenameCharset() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the character encoding used for SFTP filenames.

getFileNameHex() - Method in class com.chilkatsoft.chilkat2.ZipEntry

Returns the raw filename bytes found in the ZIP entry, encoded as a hexadecimal string.

getFileNameWithoutExtension(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Returns the final filename component of path with its extension removed.

getFileOpenError() - Method in class com.chilkatsoft.chilkat2.FileAccess

Provides the detailed open-error code from the most recent call to FileOpen, OpenForRead, OpenForWrite, OpenForReadWrite, or OpenForAppend.

getFileOpenErrorMsg() - Method in class com.chilkatsoft.chilkat2.FileAccess

Returns the human-readable message corresponding to FileOpenError for the most recent file-open attempt.

getFileOwner(String, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Returns the remote file's owner.

getFilePermissions(String, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Returns the remote item's complete POSIX mode value.

getFileSb(String, String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Ftp2

Downloads the remote file at remoteFilePath, decodes its bytes using the charset named by charset, and appends the resulting text to the existing contents of the StringBuilder in sb.

getFileSize32() - Method in class com.chilkatsoft.chilkat2.DirTree

Returns the size of the current file in bytes as a 32-bit integer.

getFileSize32(String, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Returns the remote file's size in bytes as a 32-bit integer.

getFileSize64() - Method in class com.chilkatsoft.chilkat2.DirTree

Returns the size of the current file in bytes as a 64-bit integer.

getFileSize64(String, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Returns the remote file's size in bytes as a 64-bit integer.

getFileSizeStr() - Method in class com.chilkatsoft.chilkat2.DirTree

Returns the size of the current file in bytes as an unsigned decimal string.

getFileSizeStr(String, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Returns the remote file's size in bytes as a decimal string.

getFileTimeStr(String, int) - Method in class com.chilkatsoft.chilkat2.FileAccess

Returns one file timestamp as an ISO 8601 UTC string in the form YYYY-MM-DDTHH:MM:SSZ.

getFileToStream(String, Stream) - Method in class com.chilkatsoft.chilkat2.Ftp2

Downloads the remote file at remoteFilePath and writes its bytes to the Stream in toStream.

getFileType() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Identifies the type of directory entry.

getFilter() - Method in class com.chilkatsoft.chilkat2.MailMan

Specifies a filter expression applied by methods such as LoadXmlFile, LoadXmlString, LoadMbx, CopyMail, and TransferMail.

getFinalFrame() - Method in class com.chilkatsoft.chilkat2.WebSocket

true if the frame most recently delivered by ReadFrame had its WebSocket FIN bit set; otherwise false.

getFinalRedirectUrl() - Method in class com.chilkatsoft.chilkat2.Http

If the Http.getWasRedirected() property indicates an HTTP GET was redirected, and the Http.getFollowRedirects() property is set to true, this property will hold the final redirect URL.

getFinalRedirectUrl() - Method in class com.chilkatsoft.chilkat2.HttpResponse

Returns the redirect URL for 301/302 responses.

getFinalRedirectUrl() - Method in class com.chilkatsoft.chilkat2.Spider

If the last URL crawled was redirected (as indicated by the WasRedirected property), this property will contain the final redirect URL.

getFindStartIndex() - Method in class com.chilkatsoft.chilkat2.JsonArray

Specifies the zero-based array index at which FindString and FindObject begin searching.

getFirstChunk() - Method in class com.chilkatsoft.chilkat2.Compression

Indicates that the next chunk-aware compression or decompression call is the first chunk in a sequence.

getFirstChunk() - Method in class com.chilkatsoft.chilkat2.Crypt2

Using the FirstChunk and Crypt2.getLastChunk() properties is the way to do streaming encryption or decryption with Chilkat.

getFlags() - Method in class com.chilkatsoft.chilkat2.Ntlm

Specifies the NTLM negotiate flags as a compact string in which each letter represents one bit.

getFlags(int) - Method in class com.chilkatsoft.chilkat2.Mailboxes

Returns a comma-separated list of flags for the mailbox at the zero-based index specified by index.

getFollowRedirects() - Method in class com.chilkatsoft.chilkat2.Http

When set to true, 301, 302, 303, 307, and 308 redirects are automatically followed.

getForceCipher() - Method in class com.chilkatsoft.chilkat2.SFtp

Restricts SSH cipher negotiation to a single cipher.

getForceCipher() - Method in class com.chilkatsoft.chilkat2.Ssh

Restricts SSH cipher negotiation to one cipher or a comma-separated preference list.

getForcePortIpAddress() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the IPv4 address advertised to the server for active-mode data connections.

getForceV3() - Method in class com.chilkatsoft.chilkat2.SFtp

Controls SFTP protocol-version negotiation.

getForClientAuthentication() - Method in class com.chilkatsoft.chilkat2.Cert

true if this certificate can be used for client authentication, otherwise false.

getForCodeSigning() - Method in class com.chilkatsoft.chilkat2.Cert

true if this certificate can be used for code signing, otherwise false.

getForSecureEmail() - Method in class com.chilkatsoft.chilkat2.Cert

true if this certificate can be used for sending secure email, otherwise false.

getForServerAuthentication() - Method in class com.chilkatsoft.chilkat2.Cert

true if this certificate can be used for server authentication, otherwise false.

getForTimeStamping() - Method in class com.chilkatsoft.chilkat2.Cert

true if this certificate can be used for time stamping, otherwise false.

getFrag() - Method in class com.chilkatsoft.chilkat2.Url

Contains any text following a fragment marker (#) in the URL, excluding the fragment marker.

getFrameData() - Method in class com.chilkatsoft.chilkat2.WebSocket

Returns the bytes accumulated by successful calls to ReadFrame as a string, then clears the internal receive buffer.

getFrameDataBd(BinData) - Method in class com.chilkatsoft.chilkat2.WebSocket

Appends the bytes accumulated by successful calls to ReadFrame to binData, then clears the internal receive buffer.

getFrameDataLen() - Method in class com.chilkatsoft.chilkat2.WebSocket

Returns the number of payload bytes currently accumulated in the internal receive buffer.

getFrameDataSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.WebSocket

Appends the text represented by the bytes accumulated by successful calls to ReadFrame to sb, then clears the internal receive buffer.

getFrameOpcode() - Method in class com.chilkatsoft.chilkat2.WebSocket

Returns the symbolic opcode of the frame most recently delivered by ReadFrame.

getFrameOpcodeInt() - Method in class com.chilkatsoft.chilkat2.WebSocket

Returns the numeric opcode of the frame most recently delivered by ReadFrame.

getFreshnessAlgorithm() - Method in class com.chilkatsoft.chilkat2.Http

To determine the freshness of a cached HTTP GET response, the freshness algorithm is employed.

getFrom() - Method in class com.chilkatsoft.chilkat2.Email

Contains the sender name and email address as they appear in the From header, such as John Smith <john.smith@mail.com>.

getFromAddress() - Method in class com.chilkatsoft.chilkat2.Email

The email address of the sender.

getFromCharset() - Method in class com.chilkatsoft.chilkat2.Charset

Specifies the character encoding of the input bytes for conversion operations.

getFromName() - Method in class com.chilkatsoft.chilkat2.Email

The name of the sender.

getFullMime() - Method in class com.chilkatsoft.chilkat2.HttpResponse

Returns the full MIME (header + body) of the HTTP response.

getFullPath() - Method in class com.chilkatsoft.chilkat2.DirTree

Returns the absolute filesystem path of the current file or subdirectory, including the item's name.

getFullTranscript() - Method in class com.chilkatsoft.chilkat2.Ai

For multimodal inputs like image data, image URLs, file data, and file URLs, the full data or URL is sent initially.

getFullUncPath() - Method in class com.chilkatsoft.chilkat2.DirTree

Returns the current item's Windows extended-length absolute path.

getFunctionCalls(JsonObject) - Method in class com.chilkatsoft.chilkat2.Ai

This method returns the function calls in json if the output contains any.

getG() - Method in class com.chilkatsoft.chilkat2.Dh

Returns the current Diffie-Hellman generator, g.

getGeneratedUrl() - Method in class com.chilkatsoft.chilkat2.OAuth1

The URL that includes the OAuth1 query params.

getGid() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns the numeric group ID associated with the file.

getGreeting() - Method in class com.chilkatsoft.chilkat2.Ftp2

Contains the initial FTP server greeting received for the most recent connection immediately after the TCP or implicit-TLS connection was established.

getGroup() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns the textual group name associated with the file.

getGroup(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the group name or identifier for cached directory-listing entry index.

getGroupId() - Method in class com.chilkatsoft.chilkat2.Tar

Specifies the numeric group identifier (GID) written to TAR headers when an archive is created.

getGroupName() - Method in class com.chilkatsoft.chilkat2.Tar

Specifies the group name written to TAR headers when an archive is created.

getGroupSize() - Method in class com.chilkatsoft.chilkat2.Dsa

Specifies the size, in bits, of the DSA subgroup parameter Q used by the legacy GenKey method.

getGzipInfo(String, JsonObject) - Method in class com.chilkatsoft.chilkat2.Gzip

Retrieves metadata stored in a Gzip file and returns the information in a JsonObject.

getGzipInfoBd(BinData, JsonObject) - Method in class com.chilkatsoft.chilkat2.Gzip

Retrieves metadata stored in Gzip data contained within a BinData object and returns the information in a JsonObject.

getHasCertificationSig() - Method in class com.chilkatsoft.chilkat2.Pdf

Returns true if the currently open PDF has a certification signature.

getHasColumnNames() - Method in class com.chilkatsoft.chilkat2.Csv

Indicates whether the first record is a column-name row rather than a data row.

getHasEmojis() - Method in class com.chilkatsoft.chilkat2.StringBuilder

Returns true if the content contains one or more emoji characters.

getHasFunctionCalls() - Method in class com.chilkatsoft.chilkat2.Ai

true if the response output has function calls.

getHash(String, String) - Method in class com.chilkatsoft.chilkat2.BinData

Returns the hash of the contents of this object.

getHash(String, String, String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Returns the hash of the contents of this object.

getHashAlgorithm() - Method in class com.chilkatsoft.chilkat2.Crypt2

Selects the hash algorithm used by methods that create hashes.

getHashAlgorithm() - Method in class com.chilkatsoft.chilkat2.Csr

Gets or sets the message-digest algorithm used when signing a generated CSR.

getHasModeZ() - Method in class com.chilkatsoft.chilkat2.Ftp2

Indicates whether the FTP server advertised support for MODE Z, which compresses FTP data streams using the DEFLATE algorithm.

getHasUids() - Method in class com.chilkatsoft.chilkat2.MessageSet

Indicates how the numeric identifiers in this message set are interpreted: true — the values are IMAP UIDs.

getHasZipFormatErrors() - Method in class com.chilkatsoft.chilkat2.Zip

Indicates whether minor ZIP format problems were detected when opening the ZIP archive.

getHavalRounds() - Method in class com.chilkatsoft.chilkat2.Crypt2

Applies to the HAVAL hash algorithm only and must be set to the integer value 3, 4, or 5.

getHeader() - Method in class com.chilkatsoft.chilkat2.Email

The complete MIME header of the email.

getHeader() - Method in class com.chilkatsoft.chilkat2.HttpResponse

The full text of the response header.

getHeader(JsonObject) - Method in class com.chilkatsoft.chilkat2.Jwe

Copies the entire currently loaded JWE structure into json as a JSON object.

getHeader(String) - Method in class com.chilkatsoft.chilkat2.Jwt

Decodes and returns the JOSE header JSON from the first segment of the compact JWT.

getHeaderField(String) - Method in class com.chilkatsoft.chilkat2.Email

Returns the value of a header field.

getHeaderField(String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Returns the value of a request header field.

getHeaderField(String) - Method in class com.chilkatsoft.chilkat2.HttpResponse

Returns the value of a response header field accessed by field name.

getHeaderField(String) - Method in class com.chilkatsoft.chilkat2.Mime

Returns the value of the first header field whose name matches fieldName case-insensitively.

getHeaderFieldAttr(String, String) - Method in class com.chilkatsoft.chilkat2.HttpResponse

Returns a response header field attribute.

getHeaderFieldAttribute(String, String) - Method in class com.chilkatsoft.chilkat2.Mime

Returns an attribute value parsed from the first header field named by name.

getHeaderFieldName(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns the name of the Nth header field.

getHeaderFieldName(int) - Method in class com.chilkatsoft.chilkat2.Mime

Returns the name of the header-field occurrence at zero-based index.

getHeaderFieldValue(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns the value of the Nth header field.

getHeaderFieldValue(int) - Method in class com.chilkatsoft.chilkat2.Mime

Returns the unfolded value of the header-field occurrence at zero-based index.

getHeaderName(int) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Returns the Nth request header field name.

getHeaderName(int) - Method in class com.chilkatsoft.chilkat2.HttpResponse

Gets the name of the Nth response header field.

getHeaderValue(int) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Returns the Nth request header field value.

getHeaderValue(int) - Method in class com.chilkatsoft.chilkat2.HttpResponse

Gets the value of the Nth response header field.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Ai

The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Bz2

Specifies the interval, in milliseconds, between AbortCheck event callbacks during supported long-running compression and decompression operations.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.CodeSign

Specifies the approximate interval, in milliseconds, between AbortCheck event callbacks during supported operations.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Compression

Specifies the interval, in milliseconds, between AbortCheck event callbacks.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Crypt2

The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Dkim

Specifies the interval, in milliseconds, between AbortCheck callbacks during methods that support periodic cancellation checks.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Dns

The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the interval, in milliseconds, between AbortCheck callbacks during methods that support periodic cancellation checks.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Gzip

Specifies the interval, in milliseconds, between AbortCheck event callbacks.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Http

The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.HttpCurl

Specifies the interval, in milliseconds, between AbortCheck event callbacks.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Imap

Sets the interval, in milliseconds, between AbortCheck event callbacks during operations that support cancellation.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the interval, in milliseconds, between AbortCheck event callbacks.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Mcp

The interval in milliseconds between each AbortCheck event callback, which enables an application to abort a method before it completes.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Mht

Specifies the interval, in milliseconds, between AbortCheck event callbacks during supported long-running operations.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Pem

The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Rest

Controls the interval, in milliseconds, between AbortCheck event callbacks during supported long-running operations.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Scp

Specifies the interval, in milliseconds, between AbortCheck event callbacks during supported long-running operations.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the interval, in milliseconds, between AbortCheck event callbacks during operations that support progress events.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Socket

Specifies the interval, in milliseconds, between AbortCheck callbacks during supported long-running operations.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Spider

The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Ssh

Specifies the interval, in milliseconds, between AbortCheck event callbacks during operations that support progress events.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Stream

The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Tar

Specifies the approximate interval, in milliseconds, between AbortCheck event callbacks during supported long-running operations.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.UnixCompress

The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Upload

The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.WebSocket

Specifies the interval, in milliseconds, between AbortCheck event callbacks during supported blocking operations.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.Zip

Interval, in milliseconds, between abort-check callbacks.

getHeartbeatMs() - Method in class com.chilkatsoft.chilkat2.ZipEntry

The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete.

getHeloHostname() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the hostname sent in the SMTP EHLO or HELO command.

getHexG() - Method in class com.chilkatsoft.chilkat2.Dsa

Returns the DSA domain parameter G, the generator of the subgroup of order Q modulo P.

getHexP() - Method in class com.chilkatsoft.chilkat2.Dsa

Returns the DSA domain parameter P, the large prime modulus.

getHexQ() - Method in class com.chilkatsoft.chilkat2.Dsa

Returns the DSA domain parameter Q, a prime divisor of P - 1.

getHexX() - Method in class com.chilkatsoft.chilkat2.Dsa

Returns the DSA private value X.

getHexY() - Method in class com.chilkatsoft.chilkat2.Dsa

Returns the DSA public value Y, where Y = GX mod P.

getHighestModSeq() - Method in class com.chilkatsoft.chilkat2.Imap

Contains the HIGHESTMODSEQ value of the currently selected mailbox as a decimal string.

getHmacKey() - Method in class com.chilkatsoft.chilkat2.OAuth1

The exact HMAC key used to sign the BaseString.

getHost() - Method in class com.chilkatsoft.chilkat2.Rest

Gets or sets the value of the HTTP Host request header.

getHost() - Method in class com.chilkatsoft.chilkat2.Url

The DNS host name or IP address part of the URL.

getHostedConvo() - Method in class com.chilkatsoft.chilkat2.Ai

This applies to providers like OpenAI that can maintain conversation state on the server.

getHostKeyAlg() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the preferred host-key algorithm used during SSH connection establishment.

getHostKeyAlg() - Method in class com.chilkatsoft.chilkat2.Ssh

Specifies the preferred host-key algorithm used during SSH connection establishment.

getHostKeyFingerprint() - Method in class com.chilkatsoft.chilkat2.SFtp

Contains the connected server's host-key fingerprint in Chilkat's legacy MD5 format.

getHostKeyFingerprint() - Method in class com.chilkatsoft.chilkat2.Ssh

Contains the connected server’s host-key fingerprint in Chilkat’s legacy MD5 format:

getHostKeyFingerprint() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Contains the SSH server host-key fingerprint after SshTunnel.connect(String, int) or SshTunnel.connectThroughSsh(Ssh, String, int) establishes the SSH connection.

getHostKeyFP(String, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Returns the connected server's host-key fingerprint using hashAlg.

getHostKeyFP(String, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.Ssh

Returns the active connection’s server host-key fingerprint.

getHostname() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the FTP server hostname or numeric IPv4/IPv6 address.

getHostname() - Method in class com.chilkatsoft.chilkat2.Upload

The hostname of the HTTP server that is the target of the upload.

getHostType() - Method in class com.chilkatsoft.chilkat2.Url

The type of the host name specified in the URL.

getHour() - Method in class com.chilkatsoft.chilkat2.DtObj

The hour.

getHtml() - Method in class com.chilkatsoft.chilkat2.HtmlToXml

The HTML source to be converted.

getHtmlBody() - Method in class com.chilkatsoft.chilkat2.Email

Returns the body having the text/html content type.

getHtmlBodySb(boolean, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Email

Returns the body having the text/html content type.

getHtmlFileCharset(String) - Method in class com.chilkatsoft.chilkat2.Charset

Examines the HTML file at htmlFilePath and returns the charset name declared by an HTML <meta> element, when present.

getHttpProxyAuthMethod() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the authentication method used with an HTTP proxy.

getHttpProxyAuthMethod() - Method in class com.chilkatsoft.chilkat2.Imap

Specifies the authentication mechanism used by an HTTP proxy.

getHttpProxyAuthMethod() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the authentication method used when the configured HTTP proxy requires credentials.

getHttpProxyAuthMethod() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the authentication method used by an HTTP proxy.

getHttpProxyAuthMethod() - Method in class com.chilkatsoft.chilkat2.Socket

Specifies the authentication method used with an HTTP proxy.

getHttpProxyAuthMethod() - Method in class com.chilkatsoft.chilkat2.Ssh

Specifies the authentication method used by an HTTP proxy.

getHttpProxyAuthMethod() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the authentication method to use when the outbound connection to the SSH server passes through an HTTP proxy that requires authentication.

getHttpProxyDomain() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the Windows domain used for NTLM authentication to the HTTP proxy.

getHttpProxyDomain() - Method in class com.chilkatsoft.chilkat2.Imap

Specifies the optional Windows domain for HTTP-proxy NTLM authentication.

getHttpProxyDomain() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the optional Windows domain used for NTLM authentication with an HTTP proxy.

getHttpProxyDomain() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the optional Windows domain used for NTLM authentication with an HTTP proxy.

getHttpProxyDomain() - Method in class com.chilkatsoft.chilkat2.Socket

Specifies the optional Windows domain used for NTLM authentication to an HTTP proxy.

getHttpProxyDomain() - Method in class com.chilkatsoft.chilkat2.Ssh

Specifies the optional Windows domain used for NTLM authentication with an HTTP proxy.

getHttpProxyDomain() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the optional Windows domain used for NTLM authentication with the HTTP proxy.

getHttpProxyForHttp() - Method in class com.chilkatsoft.chilkat2.Socket

Set this property to true when the proxied connection will carry HTTP requests, such as when a Rest object uses this socket through UseConnection.

getHttpProxyHostname() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the hostname or numeric IP address of an HTTP proxy used to establish the FTP control connection.

getHttpProxyHostname() - Method in class com.chilkatsoft.chilkat2.Imap

Specifies the hostname or numeric IPv4 address of an HTTP proxy through which the IMAP connection is established.

getHttpProxyHostname() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the hostname or IP address of the HTTP proxy used for SMTP and POP3 connections.

getHttpProxyHostname() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the hostname or numeric IP address of an HTTP proxy used to establish the SSH connection.

getHttpProxyHostname() - Method in class com.chilkatsoft.chilkat2.Socket

Specifies the hostname or numeric IP address of the HTTP proxy.

getHttpProxyHostname() - Method in class com.chilkatsoft.chilkat2.Ssh

Specifies the hostname or numeric IP address of an HTTP proxy.

getHttpProxyHostname() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the hostname or IPv4 address of the HTTP proxy through which the outbound connection to the SSH server is made.

getHttpProxyPassword() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the password used to authenticate to the HTTP proxy.

getHttpProxyPassword() - Method in class com.chilkatsoft.chilkat2.Imap

Specifies the password used to authenticate with the configured HTTP proxy.

getHttpProxyPassword() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the password used to authenticate with the configured HTTP proxy.

getHttpProxyPassword() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the password used to authenticate with an HTTP proxy.

getHttpProxyPassword() - Method in class com.chilkatsoft.chilkat2.Socket

Specifies the password used to authenticate with the HTTP proxy.

getHttpProxyPassword() - Method in class com.chilkatsoft.chilkat2.Ssh

Specifies the password used to authenticate with an HTTP proxy.

getHttpProxyPassword() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the password used to authenticate with the HTTP proxy for the outbound connection to the SSH server.

getHttpProxyPort() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the TCP port of the HTTP proxy.

getHttpProxyPort() - Method in class com.chilkatsoft.chilkat2.Imap

Specifies the TCP port of the configured HTTP proxy.

getHttpProxyPort() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the TCP port of the HTTP proxy.

getHttpProxyPort() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the HTTP proxy port.

getHttpProxyPort() - Method in class com.chilkatsoft.chilkat2.Socket

Specifies the TCP port of the HTTP proxy.

getHttpProxyPort() - Method in class com.chilkatsoft.chilkat2.Ssh

Specifies the HTTP proxy port.

getHttpProxyPort() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the TCP port of the HTTP proxy used for the outbound connection to the SSH server.

getHttpProxyUsername() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the username used to authenticate to the HTTP proxy.

getHttpProxyUsername() - Method in class com.chilkatsoft.chilkat2.Imap

Specifies the username used to authenticate with the configured HTTP proxy.

getHttpProxyUsername() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the username used to authenticate with the configured HTTP proxy.

getHttpProxyUsername() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the username used to authenticate with an HTTP proxy.

getHttpProxyUsername() - Method in class com.chilkatsoft.chilkat2.Socket

Specifies the username used to authenticate with the HTTP proxy.

getHttpProxyUsername() - Method in class com.chilkatsoft.chilkat2.Ssh

Specifies the username used to authenticate with an HTTP proxy.

getHttpProxyUsername() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the username used to authenticate with the HTTP proxy for the outbound connection to the SSH server.

getHttpVerb() - Method in class com.chilkatsoft.chilkat2.HttpRequest

The HttpVerb property should be set to the name of the HTTP method that appears on the start line of an HTTP request, such as GET, POST, PUT, DELETE, etc.

getHttpVersion() - Method in class com.chilkatsoft.chilkat2.HttpRequest

The HTTP version in the request header.

getI() - Method in class com.chilkatsoft.chilkat2.JsonObject

Supplies the integer substituted for i when a JSON path contains an array index such as [i].

getI() - Method in class com.chilkatsoft.chilkat2.Xml

Provides a substitution value for [i] in Chilkat tag paths and ChilkatPath expressions.

getIat() - Method in class com.chilkatsoft.chilkat2.AuthGoogle

This property can be set to override the default current date/time value for the iat claim of the JWT.

getId(int) - Method in class com.chilkatsoft.chilkat2.MessageSet

Returns the message identifier at the zero-based index specified by index.

getIdleTimeoutMs() - Method in class com.chilkatsoft.chilkat2.Ai

The maximum amount of time to wait for additional incoming data when receiving a response.

getIdleTimeoutMs() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the maximum period, in milliseconds, during which no control-channel response or forward upload progress is observed.

getIdleTimeoutMs() - Method in class com.chilkatsoft.chilkat2.Mcp

The maximum amount of time, in milliseconds, to wait for additional incoming data when receiving a response has paused.

getIdleTimeoutMs() - Method in class com.chilkatsoft.chilkat2.Rest

Gets or sets the maximum number of milliseconds to wait when a send or receive operation has stopped making progress.

getIdleTimeoutMs() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the maximum period, in milliseconds, during which an SFTP operation may make no progress while sending or receiving data.

getIdleTimeoutMs() - Method in class com.chilkatsoft.chilkat2.Ssh

Specifies an inactivity interval, in milliseconds, for SSH receive waits that use this property.

getIdleTimeoutMs() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies a stall timeout, in milliseconds, for tunnel data-transfer operations.

getIdleTimeoutMs() - Method in class com.chilkatsoft.chilkat2.Upload

A timeout in milliseconds.

getIdleTimeoutMs() - Method in class com.chilkatsoft.chilkat2.WebSocket

Specifies the maximum number of milliseconds an active send or receive operation may remain stalled while waiting for additional network progress.

getIgnoreAccessDenied() - Method in class com.chilkatsoft.chilkat2.Zip

If true, files that cannot be read, written, or created due to filesystem permission errors are skipped.

getIgnoreExternalRefs() - Method in class com.chilkatsoft.chilkat2.XmlDSig

If true, then ignore failures caused by external references not being available.

getIgnoreMustRevalidate() - Method in class com.chilkatsoft.chilkat2.Http

If an HTTP response includes the Cache-Control: must-revalidate header, it indicates that the server requires the client to revalidate the page with the server rather than serving it directly from the cache.

getIgnoreMustRevalidate() - Method in class com.chilkatsoft.chilkat2.Mht

Controls how cached responses containing Cache-Control: must-revalidate are handled.

getIgnoreNoCache() - Method in class com.chilkatsoft.chilkat2.Http

Some HTTP responses include headers indicating the page should not be cached.

getIgnoreNoCache() - Method in class com.chilkatsoft.chilkat2.Mht

Controls whether HTTP response directives that prohibit or restrict caching are ignored.

getImapUid() - Method in class com.chilkatsoft.chilkat2.Email

When email headers are downloaded from an IMAP server (using Chilkat IMAP), a ckx-imap-uid header field is added.

getImmediateDelete() - Method in class com.chilkatsoft.chilkat2.MailMan

Determines whether pending POP3 deletion marks are committed automatically after a successful delete operation or full-message retrieval performed with keepOnServer = false.

getInboundSocksPassword() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the password required from inbound SOCKS5 clients when SshTunnel.getDynamicPortForwarding() is true.

getInboundSocksUsername() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the username required from inbound SOCKS clients when SshTunnel.getDynamicPortForwarding() is true.

getIncludeCertChain() - Method in class com.chilkatsoft.chilkat2.Crypt2

This applies only to creating digital signatures.

getIncludeDotDirs() - Method in class com.chilkatsoft.chilkat2.SFtp

Controls whether ReadDir and SFtp.readDirListing(String, SFtpDir) include the special . and .. directory entries.

getIncludeNonce() - Method in class com.chilkatsoft.chilkat2.OAuth2

Set to true to include an OpenID Connect nonce parameter in the authorization request.

getIncludeRootCert() - Method in class com.chilkatsoft.chilkat2.MailMan

Determines whether the root CA certificate is included in the S/MIME signature of a signed email.

getIncNamespacePrefix() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

The namespace prefix to use for InclusiveNamespaces elements.

getIncNamespaceUri() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

The namespace URI for any InclusiveNamespaces elements that are created.

getIndex(String) - Method in class com.chilkatsoft.chilkat2.Csv

Returns the zero-based index of the column named by columnName, or -1 if no matching column exists.

getInitialCount() - Method in class com.chilkatsoft.chilkat2.Crypt2

The initial counter for the ChaCha20 encryption algorithm, which has a default value of 0, is pre-agreed by both the encryptor and decryptor.

getInitializeFailCode() - Method in class com.chilkatsoft.chilkat2.SFtp

Contains the RFC 4254 channel-open failure code when SFtp.initializeSftp() cannot open the SFTP session channel.

getInitializeFailReason() - Method in class com.chilkatsoft.chilkat2.SFtp

Contains the descriptive text associated with SFtp.getInitializeFailCode() when SFtp.initializeSftp() cannot open the SFTP session channel.

getInt2(int, boolean) - Method in class com.chilkatsoft.chilkat2.BinData

Returns the value of the 16-bit signed integer stored in big-endian or little-endian byte ordering at the given index.

getInt4(int, boolean) - Method in class com.chilkatsoft.chilkat2.BinData

Returns the value of the 32-bit signed integer stored in big-endian or little-endian byte ordering at the given index.

getIntendedKeyUsage() - Method in class com.chilkatsoft.chilkat2.Cert

Bitflags indicating the intended usages of the certificate.

getIntValue() - Method in class com.chilkatsoft.chilkat2.Asn

The ASN.1 item's integer value if it is a small integer item.

getIntValue() - Method in class com.chilkatsoft.chilkat2.StringBuilder

Returns the content of the string converted to an integer.

getIsAccepting() - Method in class com.chilkatsoft.chilkat2.SshTunnel

true when the local listener thread is running and accepting inbound TCP connections; otherwise false.

getIsAesEncrypted() - Method in class com.chilkatsoft.chilkat2.ZipEntry

Indicates whether this ZIP entry is AES encrypted.

getIsAppendOnly() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns true if the server marks the file as append-only.

getIsArchive() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns true if the server marks the file for inclusion in backup or archive operations.

getIsBase64() - Method in class com.chilkatsoft.chilkat2.StringBuilder

Returns true if the content contains only those characters allowed in the base64 encoding.

getIsBase64() - Method in class com.chilkatsoft.chilkat2.Xml

Returns true if this element's content consists only of characters allowed in standard Base64 text, with whitespace ignored.

getIsCaseInsensitive() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Applies to directories.

getIsCompressed() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns true if the file is stored using transparent filesystem-level compression on the server.

getIsConnected() - Method in class com.chilkatsoft.chilkat2.Ftp2

Deprecated.

getIsConnected() - Method in class com.chilkatsoft.chilkat2.SFtp

Returns true when Chilkat's last known state indicates that the underlying SSH transport is connected.

getIsConnected() - Method in class com.chilkatsoft.chilkat2.Socket

Returns true when the socket is in its last known connected state; otherwise returns false.

getIsConnected() - Method in class com.chilkatsoft.chilkat2.Ssh

Returns true when Chilkat currently considers the SSH transport connected.

getIsConnected() - Method in class com.chilkatsoft.chilkat2.WebSocket

true when the underlying WebSocket network connection is currently open; otherwise false.

getIsDirectory() - Method in class com.chilkatsoft.chilkat2.DirTree

Returns true when the current item is a subdirectory and false when it is a file.

getIsDirectory() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns true if the directory entry is a directory.

getIsDirectory() - Method in class com.chilkatsoft.chilkat2.ZipEntry

Indicates whether this ZIP entry is a directory entry.

getIsDirectory(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns true when cached directory-listing entry index is identified as a directory.

getIsDsaKey() - Method in class com.chilkatsoft.chilkat2.SshKey

Indicates whether the object currently contains a DSA key.

getIsDst() - Method in class com.chilkatsoft.chilkat2.DateTime

This is the Daylight Saving Time flag.

getIsEncrypted() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns true if the file is stored using transparent filesystem-level encryption on the server.

getIsHidden() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns true if the server marks the entry as hidden.

getIsImmutable() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns true if the server marks the file as immutable.

getIsPop3Connected() - Method in class com.chilkatsoft.chilkat2.MailMan

Returns true if Chilkat believes the POP3 connection is still open.

getIsPrivateKey() - Method in class com.chilkatsoft.chilkat2.SshKey

Indicates whether the current key includes a private key.

getIsReadOnly() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns true if the server marks the file as read-only.

getIsRegular() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns true if the directory entry is a regular file rather than a directory, symbolic link, device, socket, FIFO, or other special type.

getIsRoot() - Method in class com.chilkatsoft.chilkat2.Cert

true if this is the root certificate, otherwise false.

getIsRsaKey() - Method in class com.chilkatsoft.chilkat2.SshKey

Indicates whether the object currently contains an RSA key.

getIsSmtpConnected() - Method in class com.chilkatsoft.chilkat2.MailMan

Returns true if Chilkat believes the SMTP connection is still open.

getIsSparse() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns true if the server identifies the file as sparse.

getIssuer(Cert) - Method in class com.chilkatsoft.chilkat2.Cert

Finds and returns the issuer certificate in issuer.

getIssuerC() - Method in class com.chilkatsoft.chilkat2.Cert

The certificate issuer's country.

getIssuerCN() - Method in class com.chilkatsoft.chilkat2.Cert

The certificate issuer's common name.

getIssuerDN() - Method in class com.chilkatsoft.chilkat2.Cert

The issuer's full distinguished name.

getIssuerE() - Method in class com.chilkatsoft.chilkat2.Cert

The certificate issuer's email address.

getIssuerL() - Method in class com.chilkatsoft.chilkat2.Cert

The certificate issuer's locality, which could be a city, count, township, or other geographic region.

getIssuerO() - Method in class com.chilkatsoft.chilkat2.Cert

The certificate issuer's organization, which is typically the company name.

getIssuerOU() - Method in class com.chilkatsoft.chilkat2.Cert

The certificate issuer's organizational unit, which is the unit within the organization.

getIssuerS() - Method in class com.chilkatsoft.chilkat2.Cert

The certificate issuer's state or province.

getIsSymbolicLink(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns true when cached directory-listing entry index is identified as a symbolic link.

getIsSymLink() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns true if the directory entry is a symbolic link.

getIsSync() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns true if modifications to the file are committed synchronously to server storage.

getIsSystem() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns true if the server marks the file as part of the operating system.

getIsWriteClosed() - Method in class com.chilkatsoft.chilkat2.Stream

true if the stream is closed for writing.

getIterationCount() - Method in class com.chilkatsoft.chilkat2.Crypt2

The iteration count in password-based encryption (PBE) establishes the computational difficulty for encryption and decryption, thereby enhancing resistance to exhaustive search attacks.

getJ() - Method in class com.chilkatsoft.chilkat2.JsonObject

Supplies the integer substituted for j when a JSON path contains [j].

getJ() - Method in class com.chilkatsoft.chilkat2.Xml

Provides a substitution value for [j] in Chilkat tag paths and ChilkatPath expressions.

getJsonKey() - Method in class com.chilkatsoft.chilkat2.AuthGoogle

The JSON key for obtaining an access token.

getJsToolTimeout() - Method in class com.chilkatsoft.chilkat2.Ai

The maximum time in seconds allowed for an automatic JavaScript tool function.

getJwk() - Method in class com.chilkatsoft.chilkat2.PrivateKey

Exports the key as a compact JWK (JSON Web Key).

getJwk() - Method in class com.chilkatsoft.chilkat2.PublicKey

Returns the public key as a compact JWK (JSON Web Key).

getJwkThumbprint(String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Computes the RFC 7638 thumbprint of the public portion of the loaded key using the hash algorithm named by hashAlg.

getJwkThumbprint(String) - Method in class com.chilkatsoft.chilkat2.PublicKey

Returns the RFC 7638 JWK thumbprint for this public key.

getK() - Method in class com.chilkatsoft.chilkat2.JsonObject

Supplies the integer substituted for k when a JSON path contains [k].

getK() - Method in class com.chilkatsoft.chilkat2.Xml

Provides a substitution value for [k] in Chilkat tag paths and ChilkatPath expressions.

getKeepAcceptLog() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Controls whether activity from the background listener thread is retained in memory.

getKeepAlive() - Method in class com.chilkatsoft.chilkat2.Socket

Controls the operating system SO_KEEPALIVE option for the underlying TCP socket.

getKeepResponseBody() - Method in class com.chilkatsoft.chilkat2.Http

If set to true, the response body, if it is text, is stored in the Http.getLastResponseBody() property for methods not returning an HttpResponse object.

getKeepSessionLog() - Method in class com.chilkatsoft.chilkat2.Ftp2

Controls collection of an in-memory FTP protocol log.

getKeepSessionLog() - Method in class com.chilkatsoft.chilkat2.Imap

Enables or disables the in-memory IMAP protocol log.

getKeepSessionLog() - Method in class com.chilkatsoft.chilkat2.SFtp

Controls whether SSH and SFTP protocol traffic is accumulated in SFtp.getSessionLog().

getKeepSessionLog() - Method in class com.chilkatsoft.chilkat2.Socket

Set this property to true to record bytes sent and received through this wrapper in SessionLog.

getKeepSessionLog() - Method in class com.chilkatsoft.chilkat2.Ssh

Controls whether SSH protocol traffic is accumulated in Ssh.getSessionLog().

getKeepTunnelLog() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Controls whether SSH tunnel-thread activity is retained in memory.

getKeyInfo() - Method in class com.chilkatsoft.chilkat2.XmlDSig

Returns the KeyInfo XML for the signature indicated by the Selector property.

getKeyInfoId() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

If set, causes the generated KeyInfo element to include an Id attribute with this value.

getKeyInfoKeyName() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Specifies the KeyName to be inserted in the KeyInfo element of the Signature if the KeyInfoType equals KeyName.

getKeyInfoType() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Specifies the type of information that will be included in the optional KeyInfo element of the Signature.

getKeyLength() - Method in class com.chilkatsoft.chilkat2.Crypt2

The key length in bits for symmetric encryption algorithms.

getKeys(StringTable) - Method in class com.chilkatsoft.chilkat2.Hashtable

Appends all hashtable key strings to the StringTable passed in strTable.

getKeySize() - Method in class com.chilkatsoft.chilkat2.PublicKey

Returns the key size in bits.

getKeyType() - Method in class com.chilkatsoft.chilkat2.PrivateKey

Identifies the algorithm of the currently loaded key.

getKeyType() - Method in class com.chilkatsoft.chilkat2.PublicKey

Returns the type of public key currently held by this object.

getKeyType() - Method in class com.chilkatsoft.chilkat2.SshKey

Returns the type of key currently held by this object.

getLanguage() - Method in class com.chilkatsoft.chilkat2.Email

Identifies the primary language group detected in the email subject and body text.

getLargeFileMeasures() - Method in class com.chilkatsoft.chilkat2.Ftp2

Controls an additional keepalive measure for very long uploads and downloads.

getLastAccessTimeStr() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns the file's last-access date and time as an RFC 822-formatted string, such as Fri, 21 Nov 1997 09:55:06 -0600.

getLastAppendedMime() - Method in class com.chilkatsoft.chilkat2.Imap

Contains the MIME source sent by the most recent successful call to one of the following methods: Imap.appendMail(String, Email) Imap.appendMime(String, String) Imap.appendMimeWithDateStr(String, String, String) Imap.appendMimeWithFlags(String, String, boolean, boolean, boolean, boolean) Imap.appendMimeWithFlagsSb(String, StringBuilder, boolean, boolean, boolean, boolean)

getLastChunk() - Method in class com.chilkatsoft.chilkat2.Compression

Indicates that the next chunk-aware compression or decompression call is the final chunk in a sequence.

getLastChunk() - Method in class com.chilkatsoft.chilkat2.Crypt2

See the documentation for the Crypt2.getFirstChunk() property.

getLastCommand() - Method in class com.chilkatsoft.chilkat2.Imap

Contains the most recent raw IMAP command sent to the server.

getLastContentType() - Method in class com.chilkatsoft.chilkat2.Http

The Content-Type header value from the most recent HTTP response received.

getLastDebugRequest(BinData) - Method in class com.chilkatsoft.chilkat2.Rest

Copies the fully composed HTTP request generated while Rest.getDebugMode() was true into the BinData in bd.

getLastErrorHtml() - Method in class com.chilkatsoft.chilkat2.ChilkatObject

The log of the most recent method call as HTML.

getLastErrorText() - Method in exception com.chilkatsoft.chilkat2.ChilkatException

The full LastErrorText of the failed call, captured when it failed: what the library did and why it stopped.

getLastErrorText() - Method in class com.chilkatsoft.chilkat2.ChilkatObject

The log of the most recent method call: what happened and, on failure, why.

getLastErrorXml() - Method in class com.chilkatsoft.chilkat2.ChilkatObject

The log of the most recent method call as XML.

getLastEtagFetched() - Method in class com.chilkatsoft.chilkat2.Cache

Returns the ETag metadata associated with the most recently fetched cache item.

getLastEventId() - Method in class com.chilkatsoft.chilkat2.ServerSentEvent

The content of the id field, if present.

getLastExpirationFetchedStr() - Method in class com.chilkatsoft.chilkat2.Cache

Returns the expiration date and time stored for the most recently fetched cache item, formatted as an RFC 822-style Internet date.

getLastFromCache() - Method in class com.chilkatsoft.chilkat2.Http

true if the last GET was fetched from cache.

getLastFromCache() - Method in class com.chilkatsoft.chilkat2.Spider

Equal to 1 if the last page spidered was fetched from the cache.

getLastHeader() - Method in class com.chilkatsoft.chilkat2.Http

Contains the text of the last HTTP header sent by any method.

getLastHitExpired() - Method in class com.chilkatsoft.chilkat2.Cache

Returns true when the expiration time of the most recently fetched item is earlier than the current system date and time; otherwise returns false.

getLastHtml() - Method in class com.chilkatsoft.chilkat2.Spider

The HTML text of the last paged fetched by the spider.

getLastHtmlDescription() - Method in class com.chilkatsoft.chilkat2.Spider

The HTML META description from the last page fetched by the spider.

getLastHtmlKeywords() - Method in class com.chilkatsoft.chilkat2.Spider

The HTML META keywords from the last page fetched by the spider.

getLastHtmlTitle() - Method in class com.chilkatsoft.chilkat2.Spider

The HTML title from the last page fetched by the spider.

getLastInputAsHex() - Method in class com.chilkatsoft.chilkat2.Charset

Returns the input bytes captured for the most recent conversion performed while Charset.getSaveLast() was enabled, represented as hexadecimal text.

getLastInputAsQP() - Method in class com.chilkatsoft.chilkat2.Charset

Returns the input bytes captured for the most recent conversion performed while Charset.getSaveLast() was enabled, represented as quoted-printable text.

getLastIntermediateResponse() - Method in class com.chilkatsoft.chilkat2.Imap

Contains the most recent intermediate response received from the IMAP server while a command was in progress.

getLastJsonData(JsonObject) - Method in class com.chilkatsoft.chilkat2.Ai

Provides details about the last method called on this object instance.

getLastJsonData(JsonObject) - Method in class com.chilkatsoft.chilkat2.Crypt2

Offers details on the last method executed.

getLastJsonData(JsonObject) - Method in class com.chilkatsoft.chilkat2.Ftp2

Copies structured supplemental JSON produced by the immediately preceding method into the JsonObject in json.

getLastJsonData(JsonObject) - Method in class com.chilkatsoft.chilkat2.Http

Offers details about the most recent method called on this object instance, although some methods may not supply any information.

getLastJsonData(JsonObject) - Method in class com.chilkatsoft.chilkat2.MailMan

Copies into json any structured JSON details produced by the immediately preceding method call.

getLastJsonData(JsonObject) - Method in class com.chilkatsoft.chilkat2.Mcp

Returns, in json, the complete JSON-RPC response envelope from the most recent request (the jsonrpc, id, and result or error members), for diagnostics and logging.

getLastJsonData(JsonObject) - Method in class com.chilkatsoft.chilkat2.Mime

Copies structured details from the most recent operation into json when such details are available.

getLastJsonData(JsonObject) - Method in class com.chilkatsoft.chilkat2.Pdf

Provides information about what transpired in the last method called.

getLastJsonData(JsonObject) - Method in class com.chilkatsoft.chilkat2.Pfx

Replaces the entire contents of json with structured JSON information from the most recent operation.

getLastJsonData(JsonObject) - Method in class com.chilkatsoft.chilkat2.Rest

Copies operation-specific diagnostic or result information from the most recently completed method into the JsonObject in json.

getLastJsonData(JsonObject) - Method in class com.chilkatsoft.chilkat2.SFtp

Populates json with supplemental details produced by the most recent method when such details are available.

getLastJsonData(JsonObject) - Method in class com.chilkatsoft.chilkat2.Socket

Copies additional JSON details from the most recently called method into json, when that method produced such information.

getLastJsonData(JsonObject) - Method in class com.chilkatsoft.chilkat2.Ssh

Copies structured diagnostic information from the most recently called method into the JsonObject in json.

getLastKeyFetched() - Method in class com.chilkatsoft.chilkat2.Cache

Returns the application-defined key associated with the most recently fetched cache item.

getLastMethodFailed() - Method in class com.chilkatsoft.chilkat2.Socket

Returns true if the most recent action method called through this wrapper failed; otherwise returns false.

getLastMethodSuccess() - Method in class com.chilkatsoft.chilkat2.ChilkatObject

Whether the most recent method call succeeded.

getLastModDate() - Method in class com.chilkatsoft.chilkat2.Http

The Last-Modified header value from the most recent HTTP response received.

getLastModDateStr() - Method in class com.chilkatsoft.chilkat2.Spider

The last modification date/time (RFC822 format) from the last page fetched by the spider.

getLastModifiedTimeByNameStr(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the last-modified time for the item named by filename in the current remote directory as an RFC 822 date-time string, such as Fri, 21 Nov 1997 09:55:06 -0600.

getLastModifiedTimeStr() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns the file's last-modified date and time as an RFC 822-formatted string, such as Fri, 21 Nov 1997 09:55:06 -0600.

getLastModifiedTimeStr(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the last-modified time for cached directory-listing entry index as an RFC 822 date-time string, such as Fri, 21 Nov 1997 09:55:06 -0600.

getLastModStr() - Method in class com.chilkatsoft.chilkat2.Gzip

Specifies the last-modified date/time to embed in the Gzip file when a Compress* method is called.

getLastOutputAsHex() - Method in class com.chilkatsoft.chilkat2.Charset

Returns the output bytes captured for the most recent conversion performed while Charset.getSaveLast() was enabled, represented as hexadecimal text.

getLastOutputAsQP() - Method in class com.chilkatsoft.chilkat2.Charset

Returns the output bytes captured for the most recent conversion performed while Charset.getSaveLast() was enabled, represented as quoted-printable text.

getLastRedirectUrl() - Method in class com.chilkatsoft.chilkat2.Rest

Returns the redirect target from the most recently received response.

getLastReply() - Method in class com.chilkatsoft.chilkat2.Ftp2

Contains the most recent FTP control-channel reply, including its three-digit status code and message.

getLastRequestHeader() - Method in class com.chilkatsoft.chilkat2.Rest

Returns the HTTP header fields from the most recently composed request, excluding the request line.

getLastRequestStartLine() - Method in class com.chilkatsoft.chilkat2.Rest

Returns the request line from the most recently composed request.

getLastResponse() - Method in class com.chilkatsoft.chilkat2.Imap

Contains the raw response most recently received from the IMAP server.

getLastResponseBody() - Method in class com.chilkatsoft.chilkat2.Http

The response body from the last HTTP request is saved in this property only if the Http.getKeepResponseBody() property is set to TRUE.

getLastResponseCode() - Method in class com.chilkatsoft.chilkat2.Imap

Contains the optional IMAP response code from the most recent server response, such as NONEXISTENT or AUTHENTICATIONFAILED.

getLastResponseHeader() - Method in class com.chilkatsoft.chilkat2.Http

Returns the most recent full response header for methods that do not use an HttpResponse object.

getLastResponseRefused() - Method in class com.chilkatsoft.chilkat2.Ai

Read-only.

getLastSmtpStatus() - Method in class com.chilkatsoft.chilkat2.MailMan

Contains the SMTP failure status code returned by the server for the most recent SMTP operation.

getLastSmtpStatusMsg() - Method in class com.chilkatsoft.chilkat2.MailMan

Provides the text associated with the most recent SMTP reply received from the server.

getLastStatus() - Method in class com.chilkatsoft.chilkat2.Http

Contains the most recent response status code for methods that don't utilize an HttpResponse object.

getLastStatusCode() - Method in class com.chilkatsoft.chilkat2.SFtp

Contains the numeric code from the most recently received SFTP SSH_FXP_STATUS response.

getLastStatusMessage() - Method in class com.chilkatsoft.chilkat2.SFtp

Contains the message text from the most recently received SFTP SSH_FXP_STATUS response.

getLastStatusText() - Method in class com.chilkatsoft.chilkat2.Http

Contains the latest response status text for methods that don't use an HttpResponse object.

getLastSubItem() - Method in class com.chilkatsoft.chilkat2.Asn

Returns the last ASN.1 sub-item.

getLastUrl() - Method in class com.chilkatsoft.chilkat2.Spider

The URL of the last page spidered.

getLength() - Method in class com.chilkatsoft.chilkat2.Stream

The length (in bytes) of the stream's source.

getLength() - Method in class com.chilkatsoft.chilkat2.StringArray

The number of strings contained within the internal collection.

getLength() - Method in class com.chilkatsoft.chilkat2.StringBuilder

The number of characters of the string contained within this instance.

getLength32() - Method in class com.chilkatsoft.chilkat2.Stream

The length (in bytes) of the stream's source.

getLevel() - Method in class com.chilkatsoft.chilkat2.Cache

Gets or sets the number of directory levels used beneath each cache root.

getListenBindIpAddress() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the local IPv4 address to which the tunnel's listening socket is bound.

getListenPort() - Method in class com.chilkatsoft.chilkat2.OAuth2

Specifies the local TCP port on which Chilkat listens for the browser's OAuth redirect.

getListenPort() - Method in class com.chilkatsoft.chilkat2.Socket

Returns the port on which the socket is listening.

getListenPort() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Contains the local TCP port used by the listener started by SshTunnel.beginAccepting(int).

getListenPortRangeEnd() - Method in class com.chilkatsoft.chilkat2.OAuth2

Defines the inclusive end of a local-listener port range that begins with OAuth2.getListenPort().

getListenPortSelected() - Method in class com.chilkatsoft.chilkat2.OAuth2

Returns the local port selected for the current or most recently completed authorization flow.

getListOption() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies an option string appended literally to the legacy LIST command, such as -a.

getListPattern() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the case-insensitive wildcard pattern applied to the cached listing of the current remote directory.

getLittleEndian() - Method in class com.chilkatsoft.chilkat2.Rsa

When creating RSA signatures, this property determines the endianness: set it to true for little-endian signatures and false for big-endian signatures.

getLMFactor() - Method in class com.chilkatsoft.chilkat2.Http

The LMFactor is an integer between 1 and 100 that specifies the percentage of time from an HTTP page's last-modified date to be used as the freshness period.

getLoadedFrom() - Static method in class com.chilkatsoft.chilkat2.Chilkat2Native

Where the native library was loaded from (null before Chilkat2Native.ensureLoaded()).

getLocalDateStr() - Method in class com.chilkatsoft.chilkat2.Email

The date/time found in the Date header field returned in the local timezone in RFC822 string form.

getLocalHost() - Method in class com.chilkatsoft.chilkat2.OAuth2

Selects the host name used in the loopback redirect URI:

getLocalIpAddress() - Method in class com.chilkatsoft.chilkat2.Socket

Returns the local numeric IP address for the socket connection currently held by this object.

getLocality() - Method in class com.chilkatsoft.chilkat2.Csr

Gets or sets the subject locality name (L), OID 2.5.4.7.

getLocalPort() - Method in class com.chilkatsoft.chilkat2.Socket

Returns the local TCP port for the socket connection or listener currently held by this object.

getLocation() - Method in class com.chilkatsoft.chilkat2.Secrets

The location of the secrets.

getLockFileOnOpen() - Method in class com.chilkatsoft.chilkat2.FileAccess

Windows only. If true, OpenForAppend, OpenForRead, OpenForReadWrite, and OpenForWrite request exclusive access to the file.

getLoggedInUser() - Method in class com.chilkatsoft.chilkat2.Imap

Contains the username of the authenticated IMAP session.

getLogin() - Method in class com.chilkatsoft.chilkat2.Http

This is the login string to be used with HTTP basic, digest, or NTLM authentication.

getLogin() - Method in class com.chilkatsoft.chilkat2.Upload

The HTTP login for sites requiring authentication.

getLogin() - Method in class com.chilkatsoft.chilkat2.Url

If the URL contains a login and password, this is the login part.

getLoginDomain() - Method in class com.chilkatsoft.chilkat2.Http

The optional domain name to be used with NTLM authentication.

getLoginVerified() - Method in class com.chilkatsoft.chilkat2.Ftp2

Indicates whether FTP authentication succeeded during the most recent login attempt.

getLogMailReceivedFilename() - Method in class com.chilkatsoft.chilkat2.MailMan

Specifies a local file path where Chilkat writes each message exactly as it was received from the POP3 server.

getLogMailSentFilename() - Method in class com.chilkatsoft.chilkat2.MailMan

Specifies a local file path where Chilkat writes the exact MIME message sent to the SMTP server.

getLowerCaseNames() - Method in class com.chilkatsoft.chilkat2.JsonObject

If true, member names are converted to lowercase while JSON is loaded by Load, LoadBd, LoadSb, or LoadFile.

getMacAlgorithm() - Method in class com.chilkatsoft.chilkat2.Crypt2

Selects the MAC algorithm to be used for any of the Mac methods, such as MacStringENC, MacBytes, etc.

getMailAttachFilename(Email, int) - Method in class com.chilkatsoft.chilkat2.Imap

Returns the filename for attachment attachIndex represented by email.

getMailAttachSize(Email, int) - Method in class com.chilkatsoft.chilkat2.Imap

Returns the size in bytes of attachment attachIndex represented by email.

getMailboxCount() - Method in class com.chilkatsoft.chilkat2.MailMan

Returns the number of emails currently available in the POP3 mailbox.

getMailboxIndex(String) - Method in class com.chilkatsoft.chilkat2.Mailboxes

Returns the zero-based index of the mailbox whose name matches mbxName.

getMailboxInfoXml() - Method in class com.chilkatsoft.chilkat2.MailMan

Returns an XML document containing information about the messages currently stored in the POP3 mailbox.

getMailboxSize() - Method in class com.chilkatsoft.chilkat2.MailMan

Returns the total combined size, in bytes, of all messages currently stored in the POP3 mailbox.

getMailboxStatus(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sends the IMAP STATUS command for the mailbox in mailbox and returns the reported values as XML attributes.

getMailer() - Method in class com.chilkatsoft.chilkat2.Email

Identifies the email software that sent the email.

getMailFlag(Email, String) - Method in class com.chilkatsoft.chilkat2.Imap

Returns the state of the flag named by flagName from the IMAP metadata stored in the Email in email.

getMailHost() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the POP3 server hostname or IP address.

getMailNumAttach(Email) - Method in class com.chilkatsoft.chilkat2.Imap

Returns the number of ordinary attachments represented by email.

getMailPort() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the POP3 server port number.

getMailSize(Email) - Method in class com.chilkatsoft.chilkat2.Imap

Returns the complete server-reported size of the Email in email, in bytes, including attachment data.

getMaintainHash() - Method in class com.chilkatsoft.chilkat2.SecureString

If set to the name of a hash algorithm, then a hash of the current string value is maintained.

getMasterPassword() - Method in class com.chilkatsoft.chilkat2.XmlCertVault

The master password for the vault.

getMatchCaseSensitive() - Method in class com.chilkatsoft.chilkat2.Tar

Controls whether the patterns in Tar.getMustMatch() and Tar.getMustNotMatch() are matched case-sensitively.

getMaxConnections() - Method in class com.chilkatsoft.chilkat2.Http

This class automatically manages simultaneous open HTTP connections.

getMaxContainers() - Method in class com.chilkatsoft.chilkat2.ScMinidriver

The maximum number of key containers available.

getMaxCount() - Method in class com.chilkatsoft.chilkat2.MailMan

Limits the number of messages retrieved from the POP3 server.

getMaxDate() - Method in class com.chilkatsoft.chilkat2.Zip

Maximum last-modified timestamp for files processed during add or extract operations.

getMaxFreshPeriod() - Method in class com.chilkatsoft.chilkat2.Http

Sets a time limit for how long a document can remain fresh in the cache, measured in minutes, with a default value of 525,600 minutes (equivalent to 1 year).

getMaxPacketSize() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the maximum packet length used by the underlying SSH transport.

getMaxPacketSize() - Method in class com.chilkatsoft.chilkat2.Ssh

Specifies the maximum SSH channel packet size advertised in the SSH_MSG_CHANNEL_OPEN message.

getMaxReadIdleMs() - Method in class com.chilkatsoft.chilkat2.Socket

Specifies the maximum number of milliseconds that a read-related operation may make no receive progress.

getMaxResponseSize() - Method in class com.chilkatsoft.chilkat2.Http

Specify the maximum HTTP response size the program will accept.

getMaxResponseSize() - Method in class com.chilkatsoft.chilkat2.Spider

The maximum HTTP response size allowed.

getMaxSendIdleMs() - Method in class com.chilkatsoft.chilkat2.Socket

Specifies the maximum number of milliseconds that a send-related operation may make no write progress.

getMaxThreads() - Method in class com.chilkatsoft.chilkat2.Global

The maximum number of thread pool threads.

getMaxUncompressedSize() - Method in class com.chilkatsoft.chilkat2.Zip

Returns the largest uncompressed file size contained within the ZIP archive.

getMaxUncompressSize() - Method in class com.chilkatsoft.chilkat2.Zip

Prevents extraction of files larger than the specified uncompressed size.

getMaxUrlLen() - Method in class com.chilkatsoft.chilkat2.Http

Limit the length of URLs (including URL parameters) in HTTP requests by setting this property.

getMaxUrlLen() - Method in class com.chilkatsoft.chilkat2.Spider

The maximum URL length allowed.

getMaxWaitMs() - Method in class com.chilkatsoft.chilkat2.Dns

The maxiumum number of milliseconds to wait for the answer to a DNS query.

getMessageCount() - Method in class com.chilkatsoft.chilkat2.EmailBundle

Returns the number of Email objects currently contained in the bundle.

getMetadata(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Pdf

If the PDF contains Metadata, then loads the Metadata XML into sb and returns true.

getMethodName() - Method in exception com.chilkatsoft.chilkat2.ChilkatException

The Java name of the method that failed, such as quickGetStr.

getMgfHashAlg() - Method in class com.chilkatsoft.chilkat2.Csr

Gets or sets the hash algorithm used by MGF1 in an RSASSA-PSS CSR signature.

getMHT(String) - Method in class com.chilkatsoft.chilkat2.Mht

Creates an MHT web archive from the HTTP/HTTPS page or local HTML file in url_or_htmlFilepath and returns the complete MHT MIME text in memory.

getMicalg() - Method in class com.chilkatsoft.chilkat2.Mime

Gets or sets the micalg parameter of a multipart/signed Content-Type header field.

getMime() - Method in class com.chilkatsoft.chilkat2.Email

Returns the email as RFC822/MIME text containing the headers, body representations, related items, and attachments.

getMime() - Method in class com.chilkatsoft.chilkat2.Mime

Serializes and returns the complete MIME entity, including headers, body, multipart boundaries, and all descendants.

getMimeBd(BinData) - Method in class com.chilkatsoft.chilkat2.Email

Serializes the complete RFC822/MIME message and appends the bytes to bindat.

getMimeBd(BinData) - Method in class com.chilkatsoft.chilkat2.Mime

Serializes the complete MIME entity and appends its bytes to bindat.

getMimeSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Email

Returns the email as MIME text containing the email header, body (or bodies), related items (if any), and all attachments.

getMimeSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Mime

Serializes the complete MIME entity and appends it to sb.

getMinDate() - Method in class com.chilkatsoft.chilkat2.Zip

Minimum last-modified timestamp for files processed during add or extract operations.

getMinFreshPeriod() - Method in class com.chilkatsoft.chilkat2.Http

Sets the minimum time a document stays fresh in the cache, with a default of 30 minutes.

getMinute() - Method in class com.chilkatsoft.chilkat2.DtObj

The minute.

getModel() - Method in class com.chilkatsoft.chilkat2.Ai

The model to be used for AI conversations.

getModels(StringTable) - Method in class com.chilkatsoft.chilkat2.Ai

Returns a list of models available to your account, such as GPT-4o and GPT-5.

getMonth() - Method in class com.chilkatsoft.chilkat2.DtObj

The month.

getMustMatch() - Method in class com.chilkatsoft.chilkat2.Tar

Specifies an inclusion pattern applied when creating or extracting TAR archives, including compressed TAR formats.

getMustNotMatch() - Method in class com.chilkatsoft.chilkat2.Tar

Specifies an exclusion pattern applied when creating or extracting TAR archives, including compressed TAR formats.

getMyIpAddress() - Method in class com.chilkatsoft.chilkat2.Socket

Returns a local IP address for the computer.

getMyServerCert(Cert) - Method in class com.chilkatsoft.chilkat2.Socket

Copies the TLS server certificate configured by InitSslServer into cert.

getName() - Method in class com.chilkatsoft.chilkat2.Mime

Gets or sets the name parameter of the Content-Type header field.

getName(int) - Method in class com.chilkatsoft.chilkat2.Mailboxes

Returns the name of the mailbox at the zero-based index specified by index.

getNameserver(int) - Method in class com.chilkatsoft.chilkat2.Dns

Returns the IP address of the Nth nameserver currently used by Chilkat for DNS queries and domain to IP address lookups.

getNbsp() - Method in class com.chilkatsoft.chilkat2.HtmlToXml

Controls how HTML non-breaking-space entities are handled during conversion.

getNeedSendPong() - Method in class com.chilkatsoft.chilkat2.WebSocket

true when a Ping frame has been received but no corresponding Pong has yet been sent.

getNegotiateAuth() - Method in class com.chilkatsoft.chilkat2.Http

Set this property equal to true for Negotiate authentication.

getNetBiosComputerName() - Method in class com.chilkatsoft.chilkat2.Ntlm

Specifies the server's NetBIOS computer name for inclusion in the MsvAvNbComputerName entry of the Type 2 message's TargetInfo block.

getNetBiosDomainName() - Method in class com.chilkatsoft.chilkat2.Ntlm

Specifies the server's NetBIOS domain name for inclusion in the MsvAvNbDomainName entry of the Type 2 message's TargetInfo block.

getNext() - Method in class com.chilkatsoft.chilkat2.ZipEntry

Updates this ZipEntry object so that it represents the next entry in the same ZIP archive.

getNextMatch(String) - Method in class com.chilkatsoft.chilkat2.ZipEntry

Updates this ZipEntry object so that it represents the next entry in the ZIP archive matching the specified wildcard pattern.

getNoAbsolutePaths() - Method in class com.chilkatsoft.chilkat2.Tar

Controls whether absolute archive paths are converted to relative paths during extraction.

getNonce() - Method in class com.chilkatsoft.chilkat2.OAuth1

The nonce.

getNonceLength() - Method in class com.chilkatsoft.chilkat2.OAuth2

Specifies the number of random bytes used to generate the hexadecimal OpenID Connect nonce when OAuth2.getIncludeNonce() is true.

getNoScripts() - Method in class com.chilkatsoft.chilkat2.Mht

Controls script removal when creating MHT output.

getNoUnpad() - Method in class com.chilkatsoft.chilkat2.Rsa

If true, skips unpadding when decrypting.

getNth(int, String, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Returns the Nth substring in string that is a list delimted by delimiterChar.

getNthBinaryPartOfTypeBd(int, String, boolean, boolean, BinData) - Method in class com.chilkatsoft.chilkat2.Email

Loads bd with the binary bytes of the Nth MIME sub-part matching contentType, which can be an exact Content-Type such as application/pdf, or a wildcarded Content-Type such as application/*, or */*.

getNthChildWithTag(String, int) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the zero-based nth direct child whose tag exactly equals tag.

getNthChildWithTag2(String, int) - Method in class com.chilkatsoft.chilkat2.Xml

Moves the calling Xml object's internal reference to the zero-based nth direct child whose tag equals tag.

getNthContentType(int, String, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.Email

Returns the Content-Type of the Nth non-multipart MIME part matching the pattern in contentType.

getNthFlag(int, int) - Method in class com.chilkatsoft.chilkat2.Mailboxes

Returns one flag from a mailbox in the collection.

getNthTextPartOfType(int, String, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.Email

Returns the text content of the Nth non-multipart MIME part matching the Content-Type pattern in contentType.

getNtlmAuth() - Method in class com.chilkatsoft.chilkat2.Http

Setting this property to true causes the HTTP component to use NTLM authentication (also known as IWA -- or Integrated Windows Authentication) when authentication with an HTTP server.

getNtlmAuth() - Method in class com.chilkatsoft.chilkat2.Mht

When true, Chilkat uses NTLM authentication when the origin HTTP server requests authentication.

getNtlmVersion() - Method in class com.chilkatsoft.chilkat2.Ntlm

Selects the challenge-response algorithm used to generate and verify the authentication response.

getNumAlternatives() - Method in class com.chilkatsoft.chilkat2.Email

The number of body representations present in the email.

getNumAttachedMessages() - Method in class com.chilkatsoft.chilkat2.Email

The number of embedded emails represented by message/rfc822 MIME parts.

getNumAttachments() - Method in class com.chilkatsoft.chilkat2.Email

The number of ordinary attachments contained in the email.

getNumAttributes() - Method in class com.chilkatsoft.chilkat2.Xml

Returns the number of attributes on this element.

getNumAvoidPatterns() - Method in class com.chilkatsoft.chilkat2.Spider

The number of avoid patterns previously set by calling AddAvoidPattern.

getNumBcc() - Method in class com.chilkatsoft.chilkat2.Email

The number of blind carbon-copy email recipients.

getNumBits() - Method in class com.chilkatsoft.chilkat2.Rsa

The bit length, such as 2048, of the imported or generated RSA key.

getNumBlocks(int) - Method in class com.chilkatsoft.chilkat2.FileAccess

Returns how many blockSize-byte blocks are required to cover the currently open file.

getNumBytes() - Method in class com.chilkatsoft.chilkat2.BinData

The number of bytes contained within the object.

getNumBytesAvailable() - Method in class com.chilkatsoft.chilkat2.Socket

Returns the number of bytes immediately available to the socket layer without waiting.

getNumBytesSent() - Method in class com.chilkatsoft.chilkat2.Upload

After an upload has completed, this property contains the number of bytes sent.

getNumCacheLevels() - Method in class com.chilkatsoft.chilkat2.Http

This setting determines the directory levels used under each cache root.

getNumCacheLevels() - Method in class com.chilkatsoft.chilkat2.Mht

Specifies the number of directory levels used beneath each disk-cache root.

getNumCacheRoots() - Method in class com.chilkatsoft.chilkat2.Http

Specifies the number of established cache roots used by the HTTP cache to distribute the disk cache across multiple directories.

getNumCacheRoots() - Method in class com.chilkatsoft.chilkat2.Mht

Returns the number of disk-cache root directories currently configured through Mht.addCacheRoot(String).

getNumCC() - Method in class com.chilkatsoft.chilkat2.Email

The number of carbon-copy email recipients.

getNumCertificates() - Method in class com.chilkatsoft.chilkat2.CertStore

The number of certificates held in the certificate store.

getNumCerts() - Method in class com.chilkatsoft.chilkat2.CertChain

The number of certificates currently contained in the chain.

getNumCerts() - Method in class com.chilkatsoft.chilkat2.Pem

The number of certificates in the loaded PEM.

getNumCerts() - Method in class com.chilkatsoft.chilkat2.Pfx

Returns the number of certificates currently contained in this PFX object.

getNumCerts() - Method in class com.chilkatsoft.chilkat2.Pkcs11

The number of certificates contained on the smart card or USB token.

getNumCerts() - Method in class com.chilkatsoft.chilkat2.TrustedRoots

The number of certificates explicitly contained in this object.

getNumChildren() - Method in class com.chilkatsoft.chilkat2.Xml

Returns the number of direct child elements of this element.

getNumCols(int) - Method in class com.chilkatsoft.chilkat2.Csv

Returns the number of fields in the data row at zero-based index row.

getNumColumns() - Method in class com.chilkatsoft.chilkat2.Csv

The number of columns in the first row of the CSV.

getNumCookies() - Method in class com.chilkatsoft.chilkat2.HttpResponse

The number of cookies included in the response.

getNumCrls() - Method in class com.chilkatsoft.chilkat2.Pem

The number of certificate revocation lists (CRLs) in the loaded PEM.

getNumCsrs() - Method in class com.chilkatsoft.chilkat2.Pem

The number of certificate signing requests (CSRs) in the loaded PEM.

getNumDaysOld() - Method in class com.chilkatsoft.chilkat2.Email

Returns the number of days old from the current system date/time.

getNumDecryptCerts() - Method in class com.chilkatsoft.chilkat2.Mime

Returns the number of recipient or decryption certificates currently recorded by the most recent S/MIME encryption, decryption, or security-unwrapping operation.

getNumDigests() - Method in class com.chilkatsoft.chilkat2.Email

Returns the number of message/rfc822 parts contained within the multipart/digest enclosure.

getNumDirRoots() - Method in class com.chilkatsoft.chilkat2.Tar

Returns the number of directory roots currently registered for archive creation by calls to Tar.addDirRoot(String) and Tar.addDirRoot2(String, String).

getNumEmbedded() - Method in class com.chilkatsoft.chilkat2.Xmp

The number of XMP metadata documents found within the JPG or TIFF file loaded by LoadAppFile.

getNumEmbeddedFiles() - Method in class com.chilkatsoft.chilkat2.Pdf

The number of embedded files present in the currently open PDF.

getNumEntries() - Method in class com.chilkatsoft.chilkat2.Zip

Total number of entries in the ZIP, including both files and directories.

getNumExpiredCerts() - Method in class com.chilkatsoft.chilkat2.CertChain

The number of certificates in the chain whose validity period has expired.

getNumFailed() - Method in class com.chilkatsoft.chilkat2.Spider

The number of URLs in the object's failed URL list.

getNumFilesAndDirs() - Method in class com.chilkatsoft.chilkat2.SFtpDir

Returns the number of entries in this directory listing.

getNumFlags(int) - Method in class com.chilkatsoft.chilkat2.Mailboxes

Returns the number of flags associated with the mailbox at the zero-based index specified by index.

getNumHeaderFields() - Method in class com.chilkatsoft.chilkat2.Email

The number of header fields.

getNumHeaderFields() - Method in class com.chilkatsoft.chilkat2.HttpRequest

Returns the number of request header fields.

getNumHeaderFields() - Method in class com.chilkatsoft.chilkat2.HttpResponse

The number of response header fields.

getNumHeaderFields() - Method in class com.chilkatsoft.chilkat2.Mime

Returns the number of header-field occurrences in the current part.

getNumMessages() - Method in class com.chilkatsoft.chilkat2.Imap

Contains the number of messages reported when the current mailbox was selected.

getNumNameservers() - Method in class com.chilkatsoft.chilkat2.Dns

The number of nameservers currently being used by Chilkat for DNS queries in all objects/classes, such as for HTTP, Email, FTP, SSH, etc.

getNumOpenChannels() - Method in class com.chilkatsoft.chilkat2.Ssh

Returns the number of channel records in the active SSH channel collection.

getNumOutboundLinks() - Method in class com.chilkatsoft.chilkat2.Spider

The number of URLs in the object's outbound links URL list.

getNumPages() - Method in class com.chilkatsoft.chilkat2.Pdf

The number of pages in the currently open PDF.

getNumParams() - Method in class com.chilkatsoft.chilkat2.HttpRequest

Returns the number of query parameters.

getNumParts() - Method in class com.chilkatsoft.chilkat2.Mime

Returns the number of direct child parts.

getNumPartsOfType(String, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.Email

Returns the number of non-multipart MIME parts matching the Content-Type pattern in contentType.

getNumPrivateKeys() - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Returns the number of private-key entries currently contained in the keystore.

getNumPrivateKeys() - Method in class com.chilkatsoft.chilkat2.Pem

The number of private keys in the loaded PEM.

getNumPrivateKeys() - Method in class com.chilkatsoft.chilkat2.Pfx

Returns the number of private keys currently contained in this PFX object.

getNumPublicKeys() - Method in class com.chilkatsoft.chilkat2.Pem

The number of public keys in the loaded PEM.

getNumReceived() - Method in class com.chilkatsoft.chilkat2.Stream

The number of bytes received by the stream.

getNumReceivedClientCerts() - Method in class com.chilkatsoft.chilkat2.Socket

Returns the number of client certificates associated with the connection currently held by this object.

getNumRecipients() - Method in class com.chilkatsoft.chilkat2.Jwe

Returns the number of recipients in the loaded JWE or in the JWE currently being configured.

getNumReferences() - Method in class com.chilkatsoft.chilkat2.XmlDSig

The number of data objects referenced in the XML digital signature.

getNumRelatedItems() - Method in class com.chilkatsoft.chilkat2.Email

The number of related MIME items present in the email.

getNumReplacePatterns() - Method in class com.chilkatsoft.chilkat2.Email

Returns the number of replacement patterns previously set by calling the Email.setReplacePattern(String, String) method 1 or more times.

getNumReports() - Method in class com.chilkatsoft.chilkat2.Email

Contains the number of report parts in a multipart/report email.

getNumResponseHeaders() - Method in class com.chilkatsoft.chilkat2.Rest

Returns the number of response header field occurrences.

getNumRoots() - Method in class com.chilkatsoft.chilkat2.Cache

Returns the number of cache-root directories that have been registered by calling Cache.addRoot(String).

getNumRows() - Method in class com.chilkatsoft.chilkat2.Csv

The number of data rows in the CSV.

getNumSecondsRemaining() - Method in class com.chilkatsoft.chilkat2.AuthGoogle

If the access token is valid, contains the number of seconds remaining until it expires.

getNumSecretKeys() - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Returns the number of symmetric secret-key entries currently contained in the keystore.

getNumSent() - Method in class com.chilkatsoft.chilkat2.Stream

The number of bytes sent by the stream.

getNumSignatures() - Method in class com.chilkatsoft.chilkat2.Jws

Returns the number of signature slots represented by this object.

getNumSignatures() - Method in class com.chilkatsoft.chilkat2.Pdf

The number of digital signatures present in the currently open PDF.

getNumSignatures() - Method in class com.chilkatsoft.chilkat2.XmlDSig

The number of digital signatures found within the loaded XML.

getNumSignerCerts() - Method in class com.chilkatsoft.chilkat2.Crypt2

This property is set upon verifying a digital signature and indicates the number of signer certificates.

getNumSignerCerts() - Method in class com.chilkatsoft.chilkat2.Mime

Returns the number of signer certificates currently recorded by the most recent S/MIME signing, signature-verification, or security-unwrapping operation.

getNumSocketsInSet() - Method in class com.chilkatsoft.chilkat2.Socket

Returns the number of sockets contained in this object's socket set.

getNumSpidered() - Method in class com.chilkatsoft.chilkat2.Spider

The number of URLs in the object's already-spidered URL list.

getNumSslAcceptableClientCAs() - Method in class com.chilkatsoft.chilkat2.Socket

Returns the number of acceptable certificate-authority distinguished names supplied by the TLS server for the connection currently held by this object.

getNumSubItems() - Method in class com.chilkatsoft.chilkat2.Asn

The number of sub-items contained within this ASN.1 item.

getNumTo() - Method in class com.chilkatsoft.chilkat2.Email

The number of direct email recipients.

getNumTrustedCerts() - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Returns the number of trusted-certificate entries currently contained in the keystore.

getNumUnspidered() - Method in class com.chilkatsoft.chilkat2.Spider

The number of URLs in the object's unspidered URL list.

getOaepHash() - Method in class com.chilkatsoft.chilkat2.Crypt2

Selects the hash algorithm for use within OAEP padding when encrypting using pki with RSAES-OAEP.

getOaepHash() - Method in class com.chilkatsoft.chilkat2.Email

Selects the hash algorithm used by OAEP padding when encrypting email with RSAES-OAEP.

getOaepHash() - Method in class com.chilkatsoft.chilkat2.Mime

Gets or sets the hash algorithm used by RSAES-OAEP when encrypting the CMS content-encryption key.

getOaepHash() - Method in class com.chilkatsoft.chilkat2.Rsa

Selects the hash algorithm for use within OAEP padding for encryption.

getOaepLabel() - Method in class com.chilkatsoft.chilkat2.Rsa

The optional RSA encryption OAEP label is a hex representation of the label bytes used for encrypting with OAEP padding.

getOaepMgfHash() - Method in class com.chilkatsoft.chilkat2.Crypt2

Selects the MGF hash algorithm for use within OAEP padding when encrypting using pki with RSAES-OAEP.

getOaepMgfHash() - Method in class com.chilkatsoft.chilkat2.Email

Selects the mask-generation function (MGF) hash algorithm used by OAEP padding when encrypting email with RSAES-OAEP.

getOaepMgfHash() - Method in class com.chilkatsoft.chilkat2.Mime

Gets or sets the hash algorithm used by the MGF1 mask generation function within RSAES-OAEP.

getOaepMgfHash() - Method in class com.chilkatsoft.chilkat2.Rsa

Selects the MGF (mask generation) hash algorithm for use within OAEP padding for encryption.

getOaepPadding() - Method in class com.chilkatsoft.chilkat2.Crypt2

Selects the RSA encryption scheme when encrypting using pki (with a certificate and private key).

getOaepPadding() - Method in class com.chilkatsoft.chilkat2.Email

Selects the RSA encryption scheme when encrypting email.

getOaepPadding() - Method in class com.chilkatsoft.chilkat2.Mime

Selects the RSA key-transport padding used when creating encrypted MIME.

getOAuth1() - Method in class com.chilkatsoft.chilkat2.Http

If true then causes an OAuth Authorization header to be added to any request sent by the HTTP object.

getOAuth2AccessToken() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the OAuth2 access token used for POP3 or SMTP XOAUTH2 authentication.

getOAuthBodyHash() - Method in class com.chilkatsoft.chilkat2.Http

When set to true, the oauth_body_hash, which contains the SHA-256 hash of the HTTP request body, is automatically included in the OAuth1.0a Authorization header.

getOAuthCallback() - Method in class com.chilkatsoft.chilkat2.Http

The OAuth 1.0a callback URL.

getOAuthConsumerKey() - Method in class com.chilkatsoft.chilkat2.Http

The OAuth1.0a consumer key to be used in the oauth_consumer_key parameter of the Authorization header.

getOAuthConsumerSecret() - Method in class com.chilkatsoft.chilkat2.Http

The consumer secret to be used in computing the contents of the OAuth1.0a Authorization header.

getOauthMethod() - Method in class com.chilkatsoft.chilkat2.OAuth1

The HTTP method, such as GET, POST, PUT, DELETE, or HEAD.

getOAuthRealm() - Method in class com.chilkatsoft.chilkat2.Http

The OAuth1.0a realm to be used in the Authorization header.

getOAuthSigMethod() - Method in class com.chilkatsoft.chilkat2.Http

Specify the oauth_signature_method parameter in the OAuth 1.0a Authorization header.

getOAuthToken() - Method in class com.chilkatsoft.chilkat2.Http

The value to be used for the oauth_token parameter in the OAuth1.0a Authorization header.

getOAuthTokenSecret() - Method in class com.chilkatsoft.chilkat2.Http

The OAuth1.0a token secret to be used in computing the Authorization header.

getOauthUrl() - Method in class com.chilkatsoft.chilkat2.OAuth1

The OAuth URL, such as http://echo.lab.madgex.com/echo.ashx.

getOAuthVerifier() - Method in class com.chilkatsoft.chilkat2.Http

The value to be used for the verifier to be used in the oauth_verifier parameter of the OAuth1.0a Authorization header.

getOauthVersion() - Method in class com.chilkatsoft.chilkat2.OAuth1

The oauth_version.

getObjectId() - Method in class com.chilkatsoft.chilkat2.Socket

Returns the unique identifier assigned to this socket object.

getOcspUrl() - Method in class com.chilkatsoft.chilkat2.Cert

If present in the certificate's extensions, returns the OCSP URL of the certificate.

getOemCodePage() - Method in class com.chilkatsoft.chilkat2.Ntlm

Specifies the OEM code page used to encode NTLM text fields when Unicode negotiation is disabled.

getOemCodePage() - Method in class com.chilkatsoft.chilkat2.Zip

Specifies the OEM code page used for ZIP filename encoding.

getOob() - Method in class com.chilkatsoft.chilkat2.OAuth2

Set to true to use the legacy out-of-band redirect URI urn:ietf:wg:oauth:2.0:oob.

getOpaqueSigning() - Method in class com.chilkatsoft.chilkat2.MailMan

Controls the MIME format used for digitally signed email.

getOriginalPath() - Method in class com.chilkatsoft.chilkat2.SFtpDir

Returns the original remote path used to create this directory listing.

getOutboundBindIpAddress() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the local IP address to which the outbound socket is bound before connecting to the SSH server.

getOutboundBindPort() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the local TCP port to bind before making the outbound connection to the SSH server.

getOutboundLink(int) - Method in class com.chilkatsoft.chilkat2.Spider

Returns the Nth URL in the outbound link URL list.

getOutputBd(BinData) - Method in class com.chilkatsoft.chilkat2.Ai

Returns in bd the binary output from the last call to Ai.ask(String), such as for an AI generated image.

getOutputJson(JsonObject) - Method in class com.chilkatsoft.chilkat2.Ai

Returns the model's structured JSON output from the most recent Ai.ask(String), parsed into json.

getOutputText() - Method in class com.chilkatsoft.chilkat2.Ai

Returns the text output from the last call to Ai.ask(String).

getOutputTextSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Ai

Returns the text output, appended to sb, from the last call to Ai.ask(String).

getOverwriteExisting() - Method in class com.chilkatsoft.chilkat2.Email

When true (the default) the methods to save email attachments and related items will overwrite files if they already exist.

getOverwriteExisting() - Method in class com.chilkatsoft.chilkat2.Zip

If true, existing files are overwritten during extraction.

getOwner() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns the textual owner name associated with the file.

getOwner(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the owner name or identifier for cached directory-listing entry index.

getOwnerPassword() - Method in class com.chilkatsoft.chilkat2.Pdf

The PDF owner password, if required.

getP() - Method in class com.chilkatsoft.chilkat2.Dh

Returns the current Diffie-Hellman prime modulus, p, as a hex-encoded SSH1-format bignum.

getP12() - Method in class com.chilkatsoft.chilkat2.AuthGoogle

Returns the private key in a PFX (P12) object.

getP7mEncryptAttachFilename() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the filename used in the Content-Disposition header when sending a PKCS#7 encrypted email.

getP7mSigAttachFilename() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the filename used in the Content-Disposition header when sending an opaque signed PKCS#7 email.

getP7sSigAttachFilename() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the filename used in the Content-Disposition header when sending a signed email with a detached PKCS#7 signature.

getPaddingScheme() - Method in class com.chilkatsoft.chilkat2.Crypt2

This property defines the padding scheme Chilkat uses for adding padding to input data during encryption and removing it during decryption.

getParam(String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Returns a request query parameter value by name.

getParamName(int) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Returns the Nth request query parameter field name.

getParamValue(int) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Returns the Nth request query parameter field value.

getParent() - Method in class com.chilkatsoft.chilkat2.Xml

Returns an Xml object referencing this element's parent.

getParent2() - Method in class com.chilkatsoft.chilkat2.Xml

Moves the calling Xml object's internal reference to its parent.

getPartialTransfer() - Method in class com.chilkatsoft.chilkat2.Ftp2

Indicates whether the most recent download method received some, but not all, of the remote file.

getPartSelector() - Method in class com.chilkatsoft.chilkat2.Rest

Selects the multipart entity or part targeted by multipart-building operations such as AddHeader, RemoveHeader, and the SetMultipartBody* methods.

getPassive() - Method in class com.chilkatsoft.chilkat2.Ftp2

Selects the FTP data-connection mode.

getPassiveUseHostAddr() - Method in class com.chilkatsoft.chilkat2.Ftp2

Controls how the address returned by PASV is handled.

getPassword() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the password used for FTP authentication.

getPassword() - Method in class com.chilkatsoft.chilkat2.Http

The HTTP password for pages requiring a login/password.

getPassword() - Method in class com.chilkatsoft.chilkat2.Ntlm

Specifies the password for UserName.

getPassword() - Method in class com.chilkatsoft.chilkat2.SshKey

Gets or sets the password used when importing or exporting an encrypted private key.

getPassword() - Method in class com.chilkatsoft.chilkat2.Upload

The HTTP password for sites requiring authentication.

getPassword() - Method in class com.chilkatsoft.chilkat2.Url

If the URL contains a login and password, this is the password part.

getPasswordChangeRequested() - Method in class com.chilkatsoft.chilkat2.SFtp

Indicates that the server rejected password authentication because the account password must be changed.

getPasswordChangeRequested() - Method in class com.chilkatsoft.chilkat2.Ssh

Indicates that the server rejected password authentication because it requires the user to change the password.

getPasswordProtect() - Method in class com.chilkatsoft.chilkat2.Zip

Indicates whether the ZIP uses legacy Zip 2.0 password protection.

getPath() - Method in class com.chilkatsoft.chilkat2.HttpRequest

The path of the resource requested.

getPath() - Method in class com.chilkatsoft.chilkat2.Upload

The path part of the upload URL.

getPath() - Method in class com.chilkatsoft.chilkat2.Url

The path (and params) part of the URL, excluding the query and fragment.

getPathPrefix() - Method in class com.chilkatsoft.chilkat2.JsonObject

Specifies a path prefix automatically prepended to JSON paths passed to path-based methods such as StringOf, ObjectOf, UpdateString, SetBoolOf, and SizeOfArray.

getPathPrefix() - Method in class com.chilkatsoft.chilkat2.Zip

Gets or sets a path prefix that is prepended to ZIP entry paths for files appended from the local filesystem.

getPathWithQueryParams() - Method in class com.chilkatsoft.chilkat2.Url

The path (and params) part of the URL, including the query params, but excluding the fragment.

getPayload(String) - Method in class com.chilkatsoft.chilkat2.Jws

Returns the loaded payload as text after decoding its bytes using charset charset.

getPayload(String) - Method in class com.chilkatsoft.chilkat2.Jwt

Decodes and returns the claims-set JSON from the second segment of the compact JWT.

getPayloadBd(BinData) - Method in class com.chilkatsoft.chilkat2.Jws

Writes the exact loaded JWS payload bytes to binData without charset conversion.

getPayloadSb(String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Jws

Decodes the loaded payload bytes using charset charset and writes the resulting text to sbPayload.

getPbes2CryptAlg() - Method in class com.chilkatsoft.chilkat2.Pfx

Gets or sets the content-encryption cipher used when Pfx.getAlgorithmId() is pbes2.

getPbes2HmacAlg() - Method in class com.chilkatsoft.chilkat2.Pfx

Gets or sets the HMAC algorithm used by PBKDF2 when Pfx.getAlgorithmId() is pbes2.

getPbesAlgorithm() - Method in class com.chilkatsoft.chilkat2.Crypt2

If the Crypt2.getCryptAlgorithm() property is set to pbes1 or pbes2, this property defines the symmetric encryption algorithm to be used for password-based encryption (PBE).

getPbesPassword() - Method in class com.chilkatsoft.chilkat2.Crypt2

The password to be used when the Crypt2.getCryptAlgorithm() is "pbes1" or "pbes2".

getPcscLibPath() - Method in class com.chilkatsoft.chilkat2.SCard

For Linux systems only.

getPeekMode() - Method in class com.chilkatsoft.chilkat2.Imap

Controls whether fetching full message content marks the message as seen.

getPem(boolean) - Method in class com.chilkatsoft.chilkat2.PublicKey

Returns the public key in PEM format.

getPercentDoneOnSend() - Method in class com.chilkatsoft.chilkat2.Rest

Applies to the full-request methods that both upload a request and download a response.

getPercentDoneScale() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the integer value that represents 100 percent in PercentDone callbacks.

getPercentDoneScale() - Method in class com.chilkatsoft.chilkat2.Http

This property is only valid in programming environment and languages that allow for event callbacks.

getPercentDoneScale() - Method in class com.chilkatsoft.chilkat2.Imap

Sets the scale used by PercentDone event callbacks.

getPercentDoneScale() - Method in class com.chilkatsoft.chilkat2.MailMan

This property is only valid in programming environments and languages that allow for event callbacks.

getPercentDoneScale() - Method in class com.chilkatsoft.chilkat2.Scp

Specifies the value that represents 100% completion in PercentDone event callbacks.

getPercentDoneScale() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the value representing 100% completion in PercentDone event callbacks.

getPercentDoneScale() - Method in class com.chilkatsoft.chilkat2.Socket

Defines the numeric value that represents 100 percent in PercentDone callbacks.

getPercentDoneScale() - Method in class com.chilkatsoft.chilkat2.Tar

Specifies the value reported by PercentDone when an eligible operation is 100% complete.

getPercentDoneScale() - Method in class com.chilkatsoft.chilkat2.Upload

This property is only valid in programming environment and languages that allow for event callbacks.

getPercentDoneScale() - Method in class com.chilkatsoft.chilkat2.Zip

Controls the granularity of PercentDone event callbacks.

getPercentUploaded() - Method in class com.chilkatsoft.chilkat2.Upload

Contains the current percentage completion (0 to 100) while an asynchronous upload is in progress.

getPermissions() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns the POSIX-style file-permission bit mask.

getPermissions(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the permissions or status string for cached directory-listing entry index.

getPermType(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the format identifier for the permissions string available for cached listing entry index.

getPingAutoRespond() - Method in class com.chilkatsoft.chilkat2.WebSocket

Controls automatic handling of incoming Ping control frames.

getPkcs1ENC(String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Exports the key as the traditional or preferred unencrypted DER representation and encodes the DER as text using the binary encoding named by encoding.

getPkcs1Pem() - Method in class com.chilkatsoft.chilkat2.PrivateKey

Exports the key as unencrypted PEM, preferring the traditional algorithm-specific representation when one exists.

getPkcs7CryptAlg() - Method in class com.chilkatsoft.chilkat2.Crypt2

This property determines the underlying symmetric encryption algorithm when the Crypt2.getCryptAlgorithm() property is set to pki for selecting PKCS7 public-key encryption.

getPkcs7CryptAlg() - Method in class com.chilkatsoft.chilkat2.Email

When an email is sent encrypted (using PKCS#7 public-key encryption), this selects the underlying symmetric encryption algorithm.

getPkcs7CryptAlg() - Method in class com.chilkatsoft.chilkat2.Mime

Gets or sets the symmetric content-encryption algorithm used when creating CMS/PKCS #7 encrypted MIME.

getPkcs7KeyLength() - Method in class com.chilkatsoft.chilkat2.Email

When the email is sent encrypted using PKCS#7 public-key encryption, this selects the key length of the underlying symmetric encryption algorithm.

getPkcs7KeyLength() - Method in class com.chilkatsoft.chilkat2.Mime

Gets or sets the content-encryption key length, in bits, used when creating CMS/PKCS #7 encrypted MIME.

getPkcs8ENC(String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Exports the key as unencrypted PKCS #8 DER and encodes the DER as text using the binary encoding named by encoding.

getPkcs8EncryptAlg() - Method in class com.chilkatsoft.chilkat2.PrivateKey

Controls the block cipher used by encrypted PKCS #8 export methods.

getPkcs8EncryptedENC(String, String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Exports the key as password-protected PKCS #8 DER, then encodes the encrypted DER as text.

getPkcs8EncryptedPem(String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Exports the key as password-protected PKCS #8 PEM using password as the password.

getPkcs8Pem() - Method in class com.chilkatsoft.chilkat2.PrivateKey

Exports the key as unencrypted PKCS #8 PEM.

getPkcsBd(boolean, String, BinData) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Exports the key as DER and replaces the contents of the BinData in bd.

getPkcsPadding() - Method in class com.chilkatsoft.chilkat2.Rsa

This property controls padding for both signing and encryption.

getPlainTextBody() - Method in class com.chilkatsoft.chilkat2.Email

Returns the email body having the text/plain content type.

getPongAutoConsume() - Method in class com.chilkatsoft.chilkat2.WebSocket

Controls whether incoming Pong control frames are hidden from the application.

getPongConsumed() - Method in class com.chilkatsoft.chilkat2.WebSocket

true if the most recent call to ReadFrame internally consumed a Pong frame while PongAutoConsume was true.

getPop3SessionId() - Method in class com.chilkatsoft.chilkat2.MailMan

Returns 0 when no POP3 session is active.

getPop3SessionLog() - Method in class com.chilkatsoft.chilkat2.MailMan

Provides the accumulated raw POP3 commands sent to the server and the raw responses received from the server.

getPop3SPA() - Method in class com.chilkatsoft.chilkat2.MailMan

Determines whether SPA, also known as NTLM authentication, is used for POP3.

getPop3SslServerCertVerified() - Method in class com.chilkatsoft.chilkat2.MailMan

Indicates whether the POP3 server certificate chain was successfully verified during the most recent SSL/TLS POP3 connection.

getPop3Stls() - Method in class com.chilkatsoft.chilkat2.MailMan

Determines whether Chilkat requires the POP3 connection to be upgraded to TLS using the STLS command.

getPop3StlsIfPossible() - Method in class com.chilkatsoft.chilkat2.MailMan

Determines whether Chilkat attempts POP3 STLS when the server advertises support for it.

getPopPassword() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the POP3 password.

getPopPasswordBase64() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the POP3 password as Base64-encoded data instead of plain text.

getPopSsl() - Method in class com.chilkatsoft.chilkat2.MailMan

Determines whether implicit SSL/TLS is used when connecting to the POP3 server.

getPopUsername() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the POP3 login name.

getPort() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the FTP server port.

getPort() - Method in class com.chilkatsoft.chilkat2.Imap

Specifies the IMAP server port.

getPort() - Method in class com.chilkatsoft.chilkat2.Upload

The port number of the upload target (i.e.

getPort() - Method in class com.chilkatsoft.chilkat2.Url

The port number of the URL.

getPrecomputedMd5() - Method in class com.chilkatsoft.chilkat2.AuthAws

This property can optionally be set for AWS requests that have a non-empty request body.

getPrecomputedSha256() - Method in class com.chilkatsoft.chilkat2.AuthAws

This property can optionally be set for AWS requests that have a non-empty request body.

getPreferCompact() - Method in class com.chilkatsoft.chilkat2.Jwe

Controls whether encryption prefers JWE Compact Serialization.

getPreferCompact() - Method in class com.chilkatsoft.chilkat2.Jws

Controls whether Chilkat uses JWS Compact Serialization for a single signature.

getPreferFlattened() - Method in class com.chilkatsoft.chilkat2.Jwe

Controls which JWE JSON Serialization is produced for a single recipient.

getPreferFlattened() - Method in class com.chilkatsoft.chilkat2.Jws

Controls which JSON form is used when creating a JWS with exactly one signature and Jws.getPreferCompact() is false.

getPreferIpv6() - Method in class com.chilkatsoft.chilkat2.Ftp2

Controls the preferred address family when DNS resolution returns both IPv4 and IPv6 addresses.

getPreferIpv6() - Method in class com.chilkatsoft.chilkat2.Global

If true, then use IPv6 over IPv4 when both are supported for a particular domain.

getPreferIpv6() - Method in class com.chilkatsoft.chilkat2.Http

If true, then use IPv6 over IPv4 when both are supported for a particular domain.

getPreferIpv6() - Method in class com.chilkatsoft.chilkat2.Imap

Controls address-family preference when a hostname resolves to both IPv4 and IPv6 addresses.

getPreferIpv6() - Method in class com.chilkatsoft.chilkat2.MailMan

Determines whether IPv6 is preferred over IPv4 when both are available for a hostname.

getPreferIpv6() - Method in class com.chilkatsoft.chilkat2.Mht

Controls address-family preference when a hostname resolves to both IPv4 and IPv6 addresses.

getPreferIpv6() - Method in class com.chilkatsoft.chilkat2.SFtp

Controls the preferred address family when DNS resolution returns both IPv4 and IPv6 addresses.

getPreferIpv6() - Method in class com.chilkatsoft.chilkat2.Socket

This property and ListenIpv6 are two names for the same underlying setting.

getPreferIpv6() - Method in class com.chilkatsoft.chilkat2.Spider

If true, then use IPv6 over IPv4 when both are supported for a particular domain.

getPreferIpv6() - Method in class com.chilkatsoft.chilkat2.Ssh

Controls which address family is selected when DNS resolution for a hostname returns both an IPv4 address and an IPv6 address.

getPreferIpv6() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Controls which IP version is preferred when a hostname resolves to both IPv4 and IPv6 addresses.

getPreferIpv6() - Method in class com.chilkatsoft.chilkat2.Upload

If true, then use IPv6 over IPv4 when both are supported for a particular domain.

getPreferMHTScripts() - Method in class com.chilkatsoft.chilkat2.Mht

Controls which content is retained when HTML contains a script together with a <noscript> alternative.

getPreferNlst() - Method in class com.chilkatsoft.chilkat2.Ftp2

Controls whether NLST is preferred over LIST when a legacy directory listing is required.

getPreferredCharset() - Method in class com.chilkatsoft.chilkat2.Email

Only applies when building an email with non-English characters where the charset is not explicitly set.

getPrependHeaders() - Method in class com.chilkatsoft.chilkat2.Email

When true, header fields added via the Email.addHeaderField(String, String) or Email.addHeaderField2(String, String) methods are prepended to the top of the header as opposed to appended to the bottom.

getPreserveDate() - Method in class com.chilkatsoft.chilkat2.SFtp

Controls whether path-based upload and download methods preserve source timestamps on the destination.

getPreserveSignatures() - Method in class com.chilkatsoft.chilkat2.Pdf

Controls what Chilkat may do to a PDF that contains digital signatures.

getPrivateKey(PrivateKey) - Method in class com.chilkatsoft.chilkat2.Cert

Loads the privKey with the certificate's private key, if it exists.

getPrivateKeyAlias(int) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Returns the alias of the private-key entry at index.

getPrivateKeyExportable() - Method in class com.chilkatsoft.chilkat2.Cert

(Relevant only when running on a Microsoft Windows operating system.) Indicates whether the private key was installed with security settings that allow it to be re-exported.

getPrivateKeyFormat() - Method in class com.chilkatsoft.chilkat2.Pem

Controls the format to be used for unencrypted private keys when writing a PEM.

getPrivateKeyPem() - Method in class com.chilkatsoft.chilkat2.Cert

Exports the certificate's private key to a PEM string (if the private key is available).

getPrngName() - Method in class com.chilkatsoft.chilkat2.Prng

Selects the pseudo-random number generator used by this object.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Ai

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.AuthGoogle

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Bz2

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Cert

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.CodeSign

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Compression

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Crypt2

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Dkim

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Dns

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Gzip

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Http

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.HttpCurl

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Imap

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Js

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.MailMan

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Mcp

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Mht

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.OAuth2

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Pdf

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.PrivateKey

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Rest

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.SCard

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Scp

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Secrets

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.SFtp

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Socket

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Spider

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Ssh

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Stream

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Tar

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.TrustedRoots

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.UnixCompress

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Upload

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.WebSocket

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.Zip

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.ZipCrc

Returns the installed listener, or null.

getProgressListener() - Method in class com.chilkatsoft.chilkat2.ZipEntry

Returns the installed listener, or null.

getProgressMonSize() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the expected size, in bytes, of the next file downloaded by Ftp2.getFile(String, String) when the size is not otherwise known.

getProgressMonSize64() - Method in class com.chilkatsoft.chilkat2.Ftp2

The 64-bit form of Ftp2.getProgressMonSize().

getPrompt(String, JsonObject, JsonObject) - Method in class com.chilkatsoft.chilkat2.Mcp

Calls the MCP prompts/get method for the prompt named name, passing the JSON arguments object in argsJson (pass an empty object for a prompt that takes no arguments).

getProperty(Xml, String) - Method in class com.chilkatsoft.chilkat2.Xmp

The GetProperty method.

getProtectedH(int, JsonObject) - Method in class com.chilkatsoft.chilkat2.Jws

Copies the decoded protected header of signature index into json.

getProtectedHeader(JsonObject) - Method in class com.chilkatsoft.chilkat2.Jwe

Copies the decoded shared JWE Protected Header into json.

getProtocol() - Method in class com.chilkatsoft.chilkat2.Mime

Gets or sets the protocol parameter of the Content-Type header field.

getProtocolVersion() - Method in class com.chilkatsoft.chilkat2.Mcp

The MCP protocol version.

getProtocolVersion() - Method in class com.chilkatsoft.chilkat2.SFtp

Contains the SFTP protocol version negotiated by SFtp.initializeSftp(), normally a value from 3 through 6.

getProvider() - Method in class com.chilkatsoft.chilkat2.Ai

This is the AI provider.

getProxy() - Method in class com.chilkatsoft.chilkat2.Mht

Specifies an HTTP proxy as hostname:port, for example proxy.example.com:8080.

getProxyAuthMethod() - Method in class com.chilkatsoft.chilkat2.Http

Set this to basic if you know in advance that Basic authentication is to be used for the HTTP proxy.

getProxyDirectTls() - Method in class com.chilkatsoft.chilkat2.Http

Set to true if the proxy server expects a direct TLS connection.

getProxyDomain() - Method in class com.chilkatsoft.chilkat2.Http

The domain name of a proxy host if an HTTP proxy is used.

getProxyDomain() - Method in class com.chilkatsoft.chilkat2.Spider

The domain name of a proxy host if an HTTP proxy is used.

getProxyDomain() - Method in class com.chilkatsoft.chilkat2.Upload

The domain name of a proxy host if an HTTP proxy is used.

getProxyHostname() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the hostname or IP address of a traditional FTP application proxy or firewall.

getProxyLogin() - Method in class com.chilkatsoft.chilkat2.Http

If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy login.

getProxyLogin() - Method in class com.chilkatsoft.chilkat2.Mht

Specifies the username used to authenticate with the HTTP proxy configured by Mht.getProxy().

getProxyLogin() - Method in class com.chilkatsoft.chilkat2.Spider

If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy login.

getProxyLogin() - Method in class com.chilkatsoft.chilkat2.Upload

If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy login.

getProxyLoginDomain() - Method in class com.chilkatsoft.chilkat2.Http

The NTLM authentication domain (optional) if NTLM authentication is used.

getProxyMethod() - Method in class com.chilkatsoft.chilkat2.Ftp2

Selects the login sequence required by a traditional FTP proxy or firewall.

getProxyPassword() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the password used to authenticate to a traditional FTP proxy or firewall.

getProxyPassword() - Method in class com.chilkatsoft.chilkat2.Http

If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy password.

getProxyPassword() - Method in class com.chilkatsoft.chilkat2.Mht

Specifies the password used to authenticate with the HTTP proxy configured by Mht.getProxy().

getProxyPassword() - Method in class com.chilkatsoft.chilkat2.Spider

If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy password.

getProxyPassword() - Method in class com.chilkatsoft.chilkat2.Upload

If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy password.

getProxyPort() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the TCP port on which the traditional FTP proxy or firewall accepts connections.

getProxyPort() - Method in class com.chilkatsoft.chilkat2.Http

The port number of a proxy server if an HTTP proxy is used.

getProxyPort() - Method in class com.chilkatsoft.chilkat2.Spider

The port number of a proxy server if an HTTP proxy is used.

getProxyPort() - Method in class com.chilkatsoft.chilkat2.Upload

The port number of a proxy server if an HTTP proxy is used.

getProxyUsername() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the username used to authenticate to a traditional FTP proxy or firewall.

getPssPadding() - Method in class com.chilkatsoft.chilkat2.Csr

Controls the RSA signature scheme used when generating a CSR with an RSA private key.

getPssSaltLen() - Method in class com.chilkatsoft.chilkat2.Rsa

When using RSASSA-PSS padding for signatures, you can choose the PSS salt length.

getPubKeyDer(boolean, BinData) - Method in class com.chilkatsoft.chilkat2.Cert

Loads the bd with the certificate's public key in ASN.1 DER format.

getPublicKey() - Method in class com.chilkatsoft.chilkat2.XmlDSig

Returns the public key from the KeyInfo XML for the signature indicated by the Selector property.

getPublicKey(PublicKey) - Method in class com.chilkatsoft.chilkat2.Cert

Loads the pubKey with the certificate's public key.

getPublicKey(PublicKey) - Method in class com.chilkatsoft.chilkat2.Csr

Copies the public key contained in the currently loaded CSR into pubkey.

getPublicKeyFormat() - Method in class com.chilkatsoft.chilkat2.Pem

Controls the format to be used for public keys when writing a PEM.

getPwdProtCharset() - Method in class com.chilkatsoft.chilkat2.Zip

Specifies the character encoding used to convert the decrypt password into its binary byte representation for legacy password-protected ZIP archives that use Zip 2.0 encryption.

getQuery() - Method in class com.chilkatsoft.chilkat2.Url

The query part of the URL, excluding the fragment.

getQueryString() - Method in class com.chilkatsoft.chilkat2.OAuth1

Contains the normalized set of request parameters that are signed.

getQuota(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sends the IMAP GETQUOTA command for the quota root in quotaRoot and returns the server response as JSON.

getQuotaRoot(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sends the IMAP GETQUOTAROOT command for the mailbox in mailboxName and returns the server response as JSON.

getRange(int, int, boolean) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Returns a string containing the specified range of characters from this instance.

getRangeSb(int, int, boolean, StringBuilder) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Appends to startIndex the specified range of characters from this instance.

getRawHex(StringBuilder) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Exports the raw private value as lowercase hexadecimal and replaces the contents of the StringBuilder in pubKey with the corresponding raw public key.

getRc2EffectiveKeyLength() - Method in class com.chilkatsoft.chilkat2.Crypt2

The effective key length (in bits) for the RC2 encryption algorithm.

getRcvBytesPerSec() - Method in class com.chilkatsoft.chilkat2.Socket

Returns the average raw receive rate, in bytes per second, since receive performance measurement began or was last reset.

getRcvdClientCert(int, Cert) - Method in class com.chilkatsoft.chilkat2.Socket

Copies the client certificate at zero-based index into cert from the TLS handshake of an accepted server-side connection.

getReachesRoot() - Method in class com.chilkatsoft.chilkat2.CertChain

true if the chain extends to a terminal root certificate rather than stopping at an intermediate certificate.

getReadDirMustMatch() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies a semicolon-separated list of filename patterns.

getReadDirMustNotMatch() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies a semicolon-separated list of filename patterns.

getReaderStatus() - Method in class com.chilkatsoft.chilkat2.SCard

The current status of the connected reader.

getReadFailReason() - Method in class com.chilkatsoft.chilkat2.Stream

This property is automatically set when a Read* method is called.

getReadFrameFailReason() - Method in class com.chilkatsoft.chilkat2.WebSocket

When ReadFrame returns false, this property categorizes the reason:

getReadOnly() - Method in class com.chilkatsoft.chilkat2.SecureString

Can be set to true to make this secure string read-only (cannot be modified).

getReadTimeout() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the maximum number of seconds that a data connection may remain without receiving another byte.

getReadTimeout() - Method in class com.chilkatsoft.chilkat2.Http

The amount of time in seconds to wait before timing out when reading from an HTTP server.

getReadTimeout() - Method in class com.chilkatsoft.chilkat2.Imap

The maximum number of seconds that an incoming IMAP response may stall with no additional bytes received.

getReadTimeout() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the maximum number of seconds to wait when the SMTP or POP3 server stops responding.

getReadTimeout() - Method in class com.chilkatsoft.chilkat2.Mht

Specifies the maximum number of seconds that an HTTP read may remain inactive while waiting for additional data.

getReadTimeout() - Method in class com.chilkatsoft.chilkat2.Spider

The maximum number of seconds to wait when reading from an HTTP server.

getReadTimeoutMs() - Method in class com.chilkatsoft.chilkat2.Ssh

Specifies a receive timeout, in milliseconds, for SSH methods that use this property.

getReadTimeoutMs() - Method in class com.chilkatsoft.chilkat2.Stream

The maximum number of seconds to wait while reading.

getRealm() - Method in class com.chilkatsoft.chilkat2.OAuth1

The realm (optional).

getReason() - Method in exception com.chilkatsoft.chilkat2.ChilkatException

The one-line reason used in Throwable.getMessage(): the last line of LastErrorText that is a sentence rather than a structural line (--X, ChilkatLog:, name: value).

getReceivedCertReq() - Method in class com.chilkatsoft.chilkat2.Http

Indicates whether the last HTTPS connection received a TLS CertificateRequest handshake message indicating that the server may require a client certificate.

getReceivedCount() - Method in class com.chilkatsoft.chilkat2.Socket

Tracks the cumulative number of application bytes actually received from the connection by receive operations.

getReceivedEncrypted() - Method in class com.chilkatsoft.chilkat2.Email

true if this email was originally received with encryption, otherwise false.

getReceivedInt() - Method in class com.chilkatsoft.chilkat2.Socket

Contains the value produced by the most recent successful call through this wrapper to ReceiveByte, ReceiveInt16, or ReceiveInt32.

getReceivedNumBytes(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Returns the number of bytes currently available in the normal receive buffer for channelNum.

getReceivedSb(int, String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Ssh

Decodes and appends to sb all text currently accumulated in the normal receive buffer for channelNum, using charset.

getReceivedSigned() - Method in class com.chilkatsoft.chilkat2.Email

true if this email was originally received with a digital signature, otherwise false.

getReceivedStderrText(int, String) - Method in class com.chilkatsoft.chilkat2.Ssh

Decodes and returns all text currently accumulated in the separate stderr buffer for channelNum, using charset.

getReceivedText(int, String) - Method in class com.chilkatsoft.chilkat2.Ssh

Decodes and returns all text currently accumulated in the normal receive buffer for channelNum, using charset.

getReceivedTextS(int, String, String) - Method in class com.chilkatsoft.chilkat2.Ssh

Decodes text in the normal receive buffer for channelNum and performs a literal, case-sensitive search for substr using charset.

getReceiveFailReason() - Method in class com.chilkatsoft.chilkat2.Socket

Contains the numeric result for the most recent receive-side operation.

getReceivePacketSize() - Method in class com.chilkatsoft.chilkat2.Socket

Controls the maximum number of bytes requested by availability-based receive methods when Chilkat must perform a direct read from a plain TCP connection.

getRecurse() - Method in class com.chilkatsoft.chilkat2.DirTree

Controls whether traversal descends into nested subdirectories.

getRedirectAllowHtml() - Method in class com.chilkatsoft.chilkat2.OAuth2

Gets or sets the HTML response sent by Chilkat's local listener to the browser after authorization is granted and the redirect is accepted.

getRedirectDenyHtml() - Method in class com.chilkatsoft.chilkat2.OAuth2

Gets or sets the HTML response sent by Chilkat's local listener to the browser when the authorization server reports that access was denied.

getRedirectReqReceived() - Method in class com.chilkatsoft.chilkat2.OAuth2

Contains the raw HTTP request received from the browser by Chilkat's local redirect listener.

getRedirectRequestParam(String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Returns the decoded value of paramName from the authorization redirect received by Chilkat's local listener.

getRedirectVerb() - Method in class com.chilkatsoft.chilkat2.Http

Indicates the HTTP verb, such as GET, POST, PUT, etc.

getRefFailReason() - Method in class com.chilkatsoft.chilkat2.XmlDSig

Indicates the failure reason for the last call to VerifyReferenceDigest.

getRefreshToken() - Method in class com.chilkatsoft.chilkat2.OAuth2

Gets or sets the refresh token used to obtain new access tokens.

getRefusalText() - Method in class com.chilkatsoft.chilkat2.Ai

Read-only.

getRegion() - Method in class com.chilkatsoft.chilkat2.AuthAws

The AWS region, such as us-east-1, us-west-2, eu-west-1, eu-central-1, etc.

getRejectSelfSignedCerts() - Method in class com.chilkatsoft.chilkat2.TrustedRoots

Controls the special case in which an SSL/TLS server presents a certificate chain containing exactly one certificate and that certificate is self-signed.

getRelatedAttr(int, String, String) - Method in class com.chilkatsoft.chilkat2.Email

Returns a header field attribute value from the header field of the Nth related item.

getRelatedContentID(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns the content ID of a related item contained with the email.

getRelatedContentLocation(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns the Content-Location of a related item contained with the email.

getRelatedContentType(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns the Content-Type of the Nth related content item in an email message.

getRelatedFilename(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns the filename of a related item contained with the email.

getRelatedHeader(int, String) - Method in class com.chilkatsoft.chilkat2.Email

Returns the value of a header field (by name) of a related item.

getRelatedString(int, String) - Method in class com.chilkatsoft.chilkat2.Email

Returns the text with CR line-endings of a related item contained with the email.

getRelatedStringCrLf(int, String) - Method in class com.chilkatsoft.chilkat2.Email

Returns the text with CRLF line-endings of a related item contained with the email.

getRelativePath() - Method in class com.chilkatsoft.chilkat2.DirTree

Returns the path of the current file or subdirectory relative to BaseDir, including the item's name.

getRemoteFileTextC(String, String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Downloads the remote file at remoteFilename, decodes the bytes using the character encoding named by charset, and returns the text.

getRemoteFileTextData(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Downloads the remote file at remoteFilename and returns its contents decoded using the ANSI character encoding.

getRemoteIpAddress() - Method in class com.chilkatsoft.chilkat2.Socket

Returns the numeric IP address of the peer for the connection currently held by this object.

getRemotePort() - Method in class com.chilkatsoft.chilkat2.Socket

Returns the TCP port of the peer for the connection currently held by this object.

getReplacePattern(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns a replacement pattern previously defined for mail-merge operations.

getReplaceString(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns a replacement string for a previously defined pattern/replacement string pair.

getReplaceString2(String) - Method in class com.chilkatsoft.chilkat2.Email

Returns a replacement string for a previously defined pattern/replacement string pair.

getReplyTo() - Method in class com.chilkatsoft.chilkat2.Email

Sets the Reply-To header field to the specified email address such as john@example.com.

getReport(int) - Method in class com.chilkatsoft.chilkat2.Email

(See the Email.getNumReports() property.) Returns the body content of the Nth report within a multipart/report email.

getReqExecCharset() - Method in class com.chilkatsoft.chilkat2.Ssh

Specifies the character encoding used for command text sent by Ssh.sendReqExec(int, String), Ssh.quickCommand(String, String), and Ssh.quickCmdSend(String).

getRequestHeader(String) - Method in class com.chilkatsoft.chilkat2.Http

Returns the value of a header field previously set by calling Http.setRequestHeader(String, String).

getRequireCompleteChain() - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Controls whether a complete certificate chain is required when a private-key entry is added.

getRequiredContentType() - Method in class com.chilkatsoft.chilkat2.Http

If set, then any HTTP response to any POST or GET, including downloads, will be rejected if the content-type in the response header does not match this setting.

getRequireHostnameMatch() - Method in class com.chilkatsoft.chilkat2.Http

If true, then the hostname/domain in the URL must match at least one of the entries in the server certificate's SAN.

getRequireHostnameMatch() - Method in class com.chilkatsoft.chilkat2.MailMan

Determines whether the hostname used for the TLS connection must match a name in the server certificate's Subject Alternative Name (SAN) extension.

getRequireSniMatch() - Method in class com.chilkatsoft.chilkat2.Socket

Controls what a TLS server does when the client's SNI (Server Name Indication) hostname matches no certificate added by AddSslServerCert.

getRequireSslCertVerify() - Method in class com.chilkatsoft.chilkat2.Ftp2

Controls verification of the FTP server's TLS certificate chain.

getRequireSslCertVerify() - Method in class com.chilkatsoft.chilkat2.Http

If true, then the HTTP client will verify the server's SSL certificate.

getRequireSslCertVerify() - Method in class com.chilkatsoft.chilkat2.Imap

Controls verification of the IMAP server's TLS certificate chain.

getRequireSslCertVerify() - Method in class com.chilkatsoft.chilkat2.MailMan

Determines whether Chilkat requires the SMTP or POP3 server certificate chain to be successfully verified for an SSL/TLS connection.

getRequireSslCertVerify() - Method in class com.chilkatsoft.chilkat2.Mht

Controls verification of the TLS server certificate for HTTPS connections.

getRequireSslCertVerify() - Method in class com.chilkatsoft.chilkat2.Socket

Controls verification of a server certificate when this object acts as a TLS client.

getResetDateOnLoad() - Method in class com.chilkatsoft.chilkat2.MailMan

Determines whether the email's Date header is reset to the current date and time when an email is loaded.

getResource() - Method in class com.chilkatsoft.chilkat2.OAuth2

Specifies an optional provider-defined resource parameter identifying the API or audience for which a token is requested.

getResponseBd(BinData) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Appends to bd the HTTP response body from the last call to HttpCurl.doYourThing(String).

getResponseBodyStr() - Method in class com.chilkatsoft.chilkat2.HttpCurl

Returns the HTTP response body from the last call to HttpCurl.doYourThing(String) .

getResponseBodyStr() - Method in class com.chilkatsoft.chilkat2.Upload

Returns the response body as a string.

getResponseFilePath() - Method in class com.chilkatsoft.chilkat2.HttpCurl

Set this property to the path of a file to stream the response body to a file.

getResponseHeader() - Method in class com.chilkatsoft.chilkat2.HttpCurl

Returns the HTTP response header from the last call to HttpCurl.doYourThing(String): the status line (such as HTTP/1.1 200 OK) followed by the header fields, with CRLF line endings.

getResponseHeader() - Method in class com.chilkatsoft.chilkat2.Rest

Returns the HTTP response header fields from the most recently received response, excluding the status line.

getResponseHeader() - Method in class com.chilkatsoft.chilkat2.Upload

An HTTP upload is nothing more than an HTTP POST that contains the content of the files being uploaded.

getResponseHeaderField(String) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Returns the value of the response header field named name (case-insensitive) from the last call to HttpCurl.doYourThing(String), such as "Content-Type" or "ETag".

getResponseJarr(JsonArray) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Writes to jarr the HTTP response body from the last call to HttpCurl.doYourThing(String).

getResponseJson(JsonObject) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Writes to json the HTTP response body from the last call to HttpCurl.doYourThing(String).

getResponseMode() - Method in class com.chilkatsoft.chilkat2.OAuth2

Specifies the response mode requested from an OpenID Connect or provider-specific authorization endpoint.

getResponseSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Appends to sb the HTTP response body from the last call to HttpCurl.doYourThing(String).

getResponseStatus() - Method in class com.chilkatsoft.chilkat2.Upload

The HTTP response status code of the HTTP response.

getResponseStatusCode() - Method in class com.chilkatsoft.chilkat2.Ai

The HTTP response status code for the last Ai.ask(String) is as follows: 0 indicates an error occurred before receiving an HTTP response.

getResponseStatusCode() - Method in class com.chilkatsoft.chilkat2.Rest

Returns the numeric HTTP status code from the most recently received response, such as 200, 404, or 503.

getResponseStatusText() - Method in class com.chilkatsoft.chilkat2.Rest

Returns the reason phrase associated with the most recently received HTTP status code, such as OK or Not Found.

getResponseType() - Method in class com.chilkatsoft.chilkat2.OAuth2

Specifies the authorization response type.

getResponseXml(Xml) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Writes to xml the HTTP response body from the last call to HttpCurl.doYourThing(String).

getRestartNext() - Method in class com.chilkatsoft.chilkat2.Ftp2

Set to true to request that the next applicable upload or download resume from existing content instead of starting over.

getRetry() - Method in class com.chilkatsoft.chilkat2.ServerSentEvent

The integer value of the retry field, if it exists; otherwise, 0.

getReturnReceipt() - Method in class com.chilkatsoft.chilkat2.Email

Set to true if you want the email to request a return-receipt when received by the recipient.

getRevoked() - Method in class com.chilkatsoft.chilkat2.Cert

Deprecated: This property does not check the revocation status of the certificate, and always returns false.

getRfc822Name() - Method in class com.chilkatsoft.chilkat2.Cert

The RFC822 name of the certificate.

getRightMargin() - Method in class com.chilkatsoft.chilkat2.HtmlToText

Controls line wrapping in the generated plain text.

getRoot() - Method in class com.chilkatsoft.chilkat2.Xml

Returns an Xml object referencing the root element of the XML tree that contains the current element.

getRoot(int) - Method in class com.chilkatsoft.chilkat2.Cache

Returns the directory path of the cache root at zero-based index.

getRoot2() - Method in class com.chilkatsoft.chilkat2.Xml

Moves the calling Xml object's internal reference to the root element of its XML tree.

getRsaPaddingHash() - Method in class com.chilkatsoft.chilkat2.ScMinidriver

If an RSA key is used for signing, this is the hash algorithm to used in conjunction with the padding scheme.

getRsaPaddingScheme() - Method in class com.chilkatsoft.chilkat2.ScMinidriver

If an RSA key is used for signing, this is the padding scheme to use.

getSafeBagAttr(boolean, int, String) - Method in class com.chilkatsoft.chilkat2.Pfx

Reads a recognized safe-bag attribute from a private key or certificate contained in this PFX.

getSans(StringTable) - Method in class com.chilkatsoft.chilkat2.Csr

Retrieves the Subject Alternative Names requested by the currently loaded CSR and writes them to the supplied StringTable.

getSaveCookies() - Method in class com.chilkatsoft.chilkat2.Http

If this property is true, cookies are automatically persisted to XML files in the directory specified by the CookiesDir property (or in memory if CookieDir = memory).

getSaveLast() - Method in class com.chilkatsoft.chilkat2.Charset

When true, retains the input and output byte sequences from each conversion so they can be inspected through Charset.getLastInputAsHex(), Charset.getLastInputAsQP(), Charset.getLastOutputAsHex(), and Charset.getLastOutputAsQP().

getScardError() - Method in class com.chilkatsoft.chilkat2.SCard

The last error returned by an underlying PC/SC function.

getScheme() - Method in class com.chilkatsoft.chilkat2.AuthAzureStorage

Can be SharedKey or SharedKeyLite.

getScheme() - Method in class com.chilkatsoft.chilkat2.Url

The scheme part of the URL.

getScope() - Method in class com.chilkatsoft.chilkat2.AuthGoogle

A space-delimited list of the permissions that the application requests.

getScope() - Method in class com.chilkatsoft.chilkat2.OAuth2

Specifies the access scopes requested from the authorization server.

getScriptFileMode() - Method in class com.chilkatsoft.chilkat2.Tar

Specifies the UNIX permission bits written to TAR headers for shell-script files recognized by extensions such as .sh, .csh, .bash, and .bsh.

getSearchCharset() - Method in class com.chilkatsoft.chilkat2.Imap

Specifies the IMAP CHARSET used by Search, Imap.queryMbx(String, boolean, MessageSet), and Imap.queryThread(String, String, boolean, JsonObject) when search criteria contain non-ASCII characters.

getSearchResults(JsonObject) - Method in class com.chilkatsoft.chilkat2.Ai

Returns the web search sources the model used in the most recent Ai.ask(String), if web search was enabled via the web_search param of Ai.setAskParams(JsonObject) .

getSecond() - Method in class com.chilkatsoft.chilkat2.DtObj

The second.

getSecretBd(JsonObject, BinData) - Method in class com.chilkatsoft.chilkat2.Secrets

Fetches a binary secret and returns the content in bd.

getSecretJson(JsonObject, JsonObject) - Method in class com.chilkatsoft.chilkat2.Secrets

Fetches a JSON secret and returns the content in jsonOut.

getSecretKey() - Method in class com.chilkatsoft.chilkat2.AuthAws

The AWS secret key.

getSecretKey(String, int, String) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Recovers the secret-key entry at index and returns its raw key bytes encoded using encoding.

getSecretKeyAlias(int) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Returns the alias of the secret-key entry at index.

getSecretSb(JsonObject, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Secrets

Fetches a string secret and returns the content in sb.

getSecretStr(JsonObject) - Method in class com.chilkatsoft.chilkat2.Secrets

Fetches a string secret and returns the content of the secret.

getSelectedConvo() - Method in class com.chilkatsoft.chilkat2.Ai

The currently selected conversation can be set to your desired conversation name.

getSelectedMailbox() - Method in class com.chilkatsoft.chilkat2.Imap

Contains the name of the currently selected or examined mailbox.

getSelector() - Method in class com.chilkatsoft.chilkat2.XmlDSig

If the loaded XML contains multiple signatures, this property can be set to specify which signature is in effect when calling other methods or properties.

getSelectorIndex() - Method in class com.chilkatsoft.chilkat2.Socket

Selects a socket by its direct zero-based position in this object's socket set.

getSelectorReadIndex() - Method in class com.chilkatsoft.chilkat2.Socket

Selects a zero-based position in the read-ready result produced by the most recent call to SelectForReading.

getSelectorWriteIndex() - Method in class com.chilkatsoft.chilkat2.Socket

Selects a zero-based position in the write-ready result produced by the most recent call to SelectForWriting.

getSelf() - Method in class com.chilkatsoft.chilkat2.Xml

Returns a new Xml object that references the same underlying XML element as the calling object.

getSelfSigned() - Method in class com.chilkatsoft.chilkat2.Cert

true if this is a self-signed certificate, otherwise false.

getSendBufferSize() - Method in class com.chilkatsoft.chilkat2.Http

The buffer size to be used with the underlying TCP/IP socket for sending.

getSendBufferSize() - Method in class com.chilkatsoft.chilkat2.Imap

Specifies the application-level buffer size used when sending data through the underlying TCP connection.

getSendBufferSize() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the buffer size used by the underlying TCP/IP socket when sending data.

getSendBytesPerSec() - Method in class com.chilkatsoft.chilkat2.Socket

Returns the average raw send rate, in bytes per second, since send performance measurement began or was last reset.

getSendCharset() - Method in class com.chilkatsoft.chilkat2.HttpRequest

Controls whether the charset is explicitly included in the content-type header field of the HTTP POST request.

getSendCookies() - Method in class com.chilkatsoft.chilkat2.Http

If true, then cookies previously persisted to the CookiesDir are automatically added to all HTTP requests.

getSendEncrypted() - Method in class com.chilkatsoft.chilkat2.Email

Set to true if this email should be sent encrypted.

getSendEnv() - Method in class com.chilkatsoft.chilkat2.Scp

Specifies environment variables to send for each SCP upload or download.

getSendFailReason() - Method in class com.chilkatsoft.chilkat2.Socket

Contains the numeric result for the most recent send-side operation.

getSendPacketSize() - Method in class com.chilkatsoft.chilkat2.Socket

Specifies the internal chunk size used when sending a large amount of data over a plain TCP connection.

getSendSigned() - Method in class com.chilkatsoft.chilkat2.Email

Set to true if this email should be sent with a digital signature.

getSeparatorChar() - Method in class com.chilkatsoft.chilkat2.Imap

Contains the mailbox-hierarchy delimiter reported by the IMAP server, typically / or ..

getSerialDecimal() - Method in class com.chilkatsoft.chilkat2.Cert

The certificate's serial number as a decimal string.

getSerialNumber() - Method in class com.chilkatsoft.chilkat2.Cert

The certificate's serial number as a hexidecimal string.

getServerCert(boolean, Cert) - Method in class com.chilkatsoft.chilkat2.MailMan

Gets the digital certificate presented by the SMTP or POP3 server for the current SSL/TLS connection and stores it in cert.

getServerCert(Cert) - Method in class com.chilkatsoft.chilkat2.Ftp2

Loads into the Cert object in cert the leaf certificate presented on the currently connected FTPS control channel.

getServerCert(Cert) - Method in class com.chilkatsoft.chilkat2.Imap

Stores the certificate presented by the IMAP server for the current or most recent TLS connection in the Cert object supplied as cert.

getServerCert(Cert) - Method in class com.chilkatsoft.chilkat2.Socket

Copies the certificate presented by the remote TLS server into cert for the current client-side TLS connection.

getServerCert(String, int, Cert) - Method in class com.chilkatsoft.chilkat2.Http

Establishes an SSL/TLS connection with a web server to acquire its SSL certificate without retrieving any data, then disconnects.

getServerChallenge() - Method in class com.chilkatsoft.chilkat2.Ntlm

Specifies the 8-byte server challenge carried in the Type 2 challenge message.

getServerIdentifier() - Method in class com.chilkatsoft.chilkat2.SFtp

Contains the SSH server-identification string received during connection establishment.

getServerIdentifier() - Method in class com.chilkatsoft.chilkat2.Ssh

Contains the SSH server-identification string received during connection establishment.

getServerInstructions() - Method in class com.chilkatsoft.chilkat2.Mcp

Read-only.

getServerName() - Method in class com.chilkatsoft.chilkat2.Mcp

Read-only.

getServerVersion() - Method in class com.chilkatsoft.chilkat2.Mcp

Read-only.

getService() - Method in class com.chilkatsoft.chilkat2.AuthAzureStorage

Can be Blob, Queue, File, or Table.

getServiceName() - Method in class com.chilkatsoft.chilkat2.AuthAws

The AWS service namespace, such as s3, ses, etc.

getSessionId() - Method in class com.chilkatsoft.chilkat2.Mcp

Read-only.

getSessionLog() - Method in class com.chilkatsoft.chilkat2.Ftp2

Contains the in-memory FTP session log collected while Ftp2.getKeepSessionLog() is true.

getSessionLog() - Method in class com.chilkatsoft.chilkat2.Imap

Contains the in-memory log of raw IMAP commands and server responses.

getSessionLog() - Method in class com.chilkatsoft.chilkat2.SFtp

Contains the in-memory SSH/SFTP protocol log.

getSessionLog() - Method in class com.chilkatsoft.chilkat2.Socket

Returns the accumulated send/receive session log for this wrapper when KeepSessionLog is true.

getSessionLog() - Method in class com.chilkatsoft.chilkat2.Ssh

Contains the in-memory SSH protocol log for the current or most recently completed successful session.

getSessionLogEncoding() - Method in class com.chilkatsoft.chilkat2.Socket

Controls how bytes are rendered in SessionLog.

getSessionLogFilename() - Method in class com.chilkatsoft.chilkat2.Http

Enables file-based session logging.

getSha1Thumbprint() - Method in class com.chilkatsoft.chilkat2.Cert

Hexidecimal string of the SHA-1 thumbprint for the certificate.

getSharedLibPath() - Method in class com.chilkatsoft.chilkat2.Pkcs11

On Windows systems, then should be set to the name of the DLL file (if the DLL is located in C:\Windows\System32), or it can be the full path to the DLL.

getSigAllocateSize() - Method in class com.chilkatsoft.chilkat2.Pdf

Defaults to 15000.

getSigContextPin() - Method in class com.chilkatsoft.chilkat2.Pkcs11

If the smart card or token requires a signature context login within the signing operation, then set this property to the context-specific signature PIN.

getSigId() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

An option Id attribute value for the Signature element.

getSigLocation() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Indicates where the Signature is to be located within the XML that is signed.

getSigLocationIdx() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Insert the signature at the Nth occurrence of the XmlDSigGen.getSigLocation().

getSigLocationMod() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Modifies the placement of the signature at the location specified by SigLocation.

getSigNamespacePrefix() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

The namespace prefix of the Signature that is to be created.

getSigNamespaceUri() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

The namespace URI of the Signature that is to be created.

getSignature() - Method in class com.chilkatsoft.chilkat2.OAuth1

The generated base64 signature.

getSignature(BinData) - Method in class com.chilkatsoft.chilkat2.Cert

Loads the bd with the certificate's signature.

getSignatureContent(int, BinData) - Method in class com.chilkatsoft.chilkat2.Pdf

Returns the CMS signature for the Nth signature contained in the PDF.

getSignatureMethod() - Method in class com.chilkatsoft.chilkat2.OAuth1

The signature method.

getSignatureSigningTimeStr(int) - Method in class com.chilkatsoft.chilkat2.Crypt2

This method retrieves the signing time of the Nth certificate in a digital signature after verification.

getSignatureSigningTimeStr(int) - Method in class com.chilkatsoft.chilkat2.Mime

Returns the CMS signingTime signed attribute for the signer at zero-based index, formatted as an RFC 822-style date string in GMT.

getSignaturesValid() - Method in class com.chilkatsoft.chilkat2.Email

true if the email was received with one or more digital signatures, and if all the signatures were validated indicating that the email was not altered.

getSignatureVerified() - Method in class com.chilkatsoft.chilkat2.Cert

Returns true if the certificate and all certificates in the chain of authority have valid signatures, otherwise returns false.

getSignatureVersion() - Method in class com.chilkatsoft.chilkat2.AuthAws

The AWS Signature Version to be used in authentication.

getSignedAttributes(int, BinData, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Crypt2

Extracts the signed (authenticated) attributes for the Nth signer, where signerIndex is typically 0, as most signatures have only one signer.

getSignedBy() - Method in class com.chilkatsoft.chilkat2.Email

If the email was received digitally signed, this property contains the fields of the certificate's SubjectDN.

getSignedInfoCanonAlg() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

The canonicalization method to be used for the SignedInfo when creating the XML signature.

getSignedInfoDigestMethod() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

The digest method to be used for signing the SignedInfo part of the Signature.

getSignedInfoId() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Optional Id attribute to be added to the SignedInfo element.

getSignedInfoPrefixList() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

The inclusive namespace prefix list to be added, if any, when the SignedInfoCanonAlg is equal to EXCL_C14N.

getSignerCert(int, Cert) - Method in class com.chilkatsoft.chilkat2.Pdf

This method retrieves the signer certificate after calling VerifySignature.

getSignerCert(Cert) - Method in class com.chilkatsoft.chilkat2.CodeSign

Retrieves the X.509 signer certificate discovered by the most recent call to CodeSign.verifySignature(String, JsonObject) on this CodeSign object.

getSigningAlg() - Method in class com.chilkatsoft.chilkat2.Crypt2

This property applies when creating RSA signatures.

getSigningAlg() - Method in class com.chilkatsoft.chilkat2.Email

Selects the signature algorithm to be used when sending signed (PKCS#7) email.

getSigningAlg() - Method in class com.chilkatsoft.chilkat2.Mime

Gets or sets the RSA signature scheme used when creating CMS/PKCS #7 signed MIME.

getSigningAlg() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Selects the signature algorithm to be used when using an RSA key to sign.

getSigningAttributes() - Method in class com.chilkatsoft.chilkat2.Crypt2

Contains JSON to specify the authenticated (signed) attributes or unauthenticated (unsigned) attributes that are to be included in CMS signatures.

getSigningHashAlg() - Method in class com.chilkatsoft.chilkat2.Email

Selects the underlying hash algorithm used when sending signed (PKCS#7) email.

getSigningHashAlg() - Method in class com.chilkatsoft.chilkat2.Mime

Gets or sets the message-digest algorithm used when creating CMS/PKCS #7 signatures.

getSigValueId() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

An option Id attribute value for the SignatureValue element.

getSimpleInt(Xml, String) - Method in class com.chilkatsoft.chilkat2.Xmp

Finds and returns an XMP integer property.

getSimpleStr(Xml, String) - Method in class com.chilkatsoft.chilkat2.Xmp

Finds and returns an XMP simple string property.

getSinkFile() - Method in class com.chilkatsoft.chilkat2.Stream

Sets the sink to the path of a file.

getSinkFileAppend() - Method in class com.chilkatsoft.chilkat2.Stream

If true, the stream appends to the SinkFile rather than truncating and re-writing the sink file.

getSize() - Method in class com.chilkatsoft.chilkat2.Email

The size in bytes of the email, including all parts and attachments.

getSize() - Method in class com.chilkatsoft.chilkat2.JsonArray

Returns the number of values currently contained in the JSON array.

getSize() - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns the number of direct name/value members in this JSON object.

getSize(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the size in bytes of cached directory-listing entry index as a 32-bit integer.

getSize32() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns the file size in bytes as a 32-bit integer.

getSize64() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns the file size in bytes as a 64-bit integer.

getSize64(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the size in bytes of cached directory-listing entry index as a 64-bit integer.

getSizeByName(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the size in bytes of the file named by filename in the current remote directory as a 32-bit integer.

getSizeByName64(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sends a SIZE command for filename and returns the remote size in bytes as a 64-bit integer.

getSizeByUidl(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Returns the size, in bytes, of the email on the POP3 server identified by uidl.

getSizeLimit() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the maximum message size, in bytes, for POP3 operations that can download one or more complete emails.

getSizeStr() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns the file size in bytes as a base-10 string.

getSizeStr(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the size in bytes of cached directory-listing entry index as a decimal string.

getSizeStrByName(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the size in bytes of the file named by filename in the current remote directory as a decimal string.

getSmartCardFailReason() - Method in class com.chilkatsoft.chilkat2.Cert

Set after calling LoadFromSmartcard.

getSmartCardNoDialog() - Method in class com.chilkatsoft.chilkat2.Cert

If set to true, then no dialog will automatically popup if the SmartCardPin is incorrect.

getSmartCardPin() - Method in class com.chilkatsoft.chilkat2.Cert

Can be set to the PIN value for a certificate / private key stored on a smart card.

getSmartCardPin() - Method in class com.chilkatsoft.chilkat2.CertStore

Can be set to the PIN value for a certificate / private key stored on a smart card.

getSmtpAuthMethod() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SMTP authentication method to use.

getSmtpFailReason() - Method in class com.chilkatsoft.chilkat2.MailMan

Contains a keyword describing the result or failure reason for the last SMTP operation.

getSmtpHost() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SMTP server hostname or IP address.

getSmtpLoginDomain() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the Windows domain to use when logging in to an SMTP server with NTLM authentication.

getSmtpMailFrom() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SMTP envelope sender address used in the MAIL FROM command.

getSmtpPassword() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the password used for SMTP authentication.

getSmtpPipelining() - Method in class com.chilkatsoft.chilkat2.MailMan

Determines whether SMTP pipelining is used when the server advertises support for it.

getSmtpPort() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SMTP server port.

getSmtpSessionLog() - Method in class com.chilkatsoft.chilkat2.MailMan

Provides the accumulated raw SMTP commands sent to the server and raw responses received from the server.

getSmtpSsl() - Method in class com.chilkatsoft.chilkat2.MailMan

Determines whether Chilkat uses implicit SSL/TLS when connecting to the SMTP server.

getSmtpSslServerCertVerified() - Method in class com.chilkatsoft.chilkat2.MailMan

Indicates whether the SMTP server certificate chain was successfully verified during the most recent SSL/TLS SMTP connection.

getSmtpUsername() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the username used for SMTP authentication.

getSniHostname() - Method in class com.chilkatsoft.chilkat2.Http

Sets the SNI hostname for the TLS ClientHello.

getSniHostname() - Method in class com.chilkatsoft.chilkat2.MailMan

Specifies the DNS hostname sent in the Server Name Indication (SNI) extension of the TLS handshake for SMTP and POP3 connections.

getSniHostname() - Method in class com.chilkatsoft.chilkat2.Socket

Sets the Server Name Indication (SNI) hostname sent in the TLS ClientHello.

getSocksHostname() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the hostname or IP address of the SOCKS proxy.

getSocksHostname() - Method in class com.chilkatsoft.chilkat2.Http

The SOCKS4/SOCKS5 hostname or IPv4 address (in dotted decimal notation).

getSocksHostname() - Method in class com.chilkatsoft.chilkat2.Imap

Specifies the hostname or numeric IP address of the SOCKS proxy.

getSocksHostname() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SOCKS4 or SOCKS5 proxy hostname or IPv4 address.

getSocksHostname() - Method in class com.chilkatsoft.chilkat2.Mht

Specifies the hostname or dotted-decimal IPv4 address of the SOCKS proxy.

getSocksHostname() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the SOCKS proxy hostname or IPv4 address.

getSocksHostname() - Method in class com.chilkatsoft.chilkat2.Socket

Specifies the hostname or numeric IP address of the SOCKS proxy.

getSocksHostname() - Method in class com.chilkatsoft.chilkat2.Ssh

Specifies the SOCKS proxy hostname or IPv4 address.

getSocksHostname() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the hostname or IPv4 address of the outbound SOCKS4 or SOCKS5 proxy used to reach the SSH server.

getSocksPassword() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the password for SOCKS5 username/password authentication.

getSocksPassword() - Method in class com.chilkatsoft.chilkat2.Http

The SOCKS5 password (if required).

getSocksPassword() - Method in class com.chilkatsoft.chilkat2.Imap

Specifies the SOCKS5 proxy password.

getSocksPassword() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SOCKS5 proxy password, if authentication is required.

getSocksPassword() - Method in class com.chilkatsoft.chilkat2.Mht

Specifies the password for SOCKS5 proxy authentication.

getSocksPassword() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the SOCKS5 password when username/password authentication is required.

getSocksPassword() - Method in class com.chilkatsoft.chilkat2.Socket

Specifies the password for SOCKS5 username/password authentication.

getSocksPassword() - Method in class com.chilkatsoft.chilkat2.Ssh

Specifies the SOCKS5 password when username/password authentication is required.

getSocksPassword() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the password for authenticating with an outbound SOCKS5 proxy used to reach the SSH server.

getSocksPort() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the SOCKS proxy port.

getSocksPort() - Method in class com.chilkatsoft.chilkat2.Http

The SOCKS4/SOCKS5 proxy port.

getSocksPort() - Method in class com.chilkatsoft.chilkat2.Imap

Specifies the SOCKS proxy port.

getSocksPort() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SOCKS proxy port.

getSocksPort() - Method in class com.chilkatsoft.chilkat2.Mht

Specifies the TCP port of the SOCKS4 or SOCKS5 proxy.

getSocksPort() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the SOCKS proxy port.

getSocksPort() - Method in class com.chilkatsoft.chilkat2.Socket

Specifies the TCP port of the SOCKS proxy.

getSocksPort() - Method in class com.chilkatsoft.chilkat2.Ssh

Specifies the SOCKS proxy port.

getSocksPort() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the TCP port of the outbound SOCKS4 or SOCKS5 proxy used to reach the SSH server.

getSocksUsername() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the SOCKS user identifier.

getSocksUsername() - Method in class com.chilkatsoft.chilkat2.Http

The SOCKS4/SOCKS5 proxy username.

getSocksUsername() - Method in class com.chilkatsoft.chilkat2.Imap

Specifies the username sent to a SOCKS4 or SOCKS5 proxy.

getSocksUsername() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SOCKS4 or SOCKS5 proxy username.

getSocksUsername() - Method in class com.chilkatsoft.chilkat2.Mht

Specifies the username sent to the SOCKS4 or SOCKS5 proxy.

getSocksUsername() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the SOCKS proxy username.

getSocksUsername() - Method in class com.chilkatsoft.chilkat2.Socket

Specifies the SOCKS proxy username.

getSocksUsername() - Method in class com.chilkatsoft.chilkat2.Ssh

Specifies the SOCKS username.

getSocksUsername() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the username for the outbound SOCKS4 or SOCKS5 proxy used to reach the SSH server.

getSocksVersion() - Method in class com.chilkatsoft.chilkat2.Ftp2

Selects SOCKS proxy usage.

getSocksVersion() - Method in class com.chilkatsoft.chilkat2.Http

SocksVersion May be set to one of the following integer values:

getSocksVersion() - Method in class com.chilkatsoft.chilkat2.Imap

Selects whether the IMAP connection uses a SOCKS proxy.

getSocksVersion() - Method in class com.chilkatsoft.chilkat2.MailMan

Specifies whether a SOCKS proxy is used.

getSocksVersion() - Method in class com.chilkatsoft.chilkat2.Mht

Selects whether requests are routed through a SOCKS proxy.

getSocksVersion() - Method in class com.chilkatsoft.chilkat2.SFtp

Selects whether and how a SOCKS proxy is used.

getSocksVersion() - Method in class com.chilkatsoft.chilkat2.Socket

Selects whether connections are routed through a SOCKS proxy.

getSocksVersion() - Method in class com.chilkatsoft.chilkat2.Ssh

Selects whether and how a SOCKS proxy is used.

getSocksVersion() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Selects whether the outbound connection to the SSH server is made through a SOCKS proxy.

getSoRcvBuf() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the socket receive-buffer size.

getSoRcvBuf() - Method in class com.chilkatsoft.chilkat2.Http

Sets the receive buffer size socket option.

getSoRcvBuf() - Method in class com.chilkatsoft.chilkat2.Imap

Sets the operating system's TCP receive-buffer size.

getSoRcvBuf() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the socket receive buffer size.

getSoRcvBuf() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the socket receive-buffer size.

getSoRcvBuf() - Method in class com.chilkatsoft.chilkat2.Socket

Requests the operating-system receive-buffer size for the TCP socket.

getSoRcvBuf() - Method in class com.chilkatsoft.chilkat2.Ssh

Specifies the socket receive-buffer size.

getSoRcvBuf() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the receive-buffer size for the underlying TCP socket.

getSoReuseAddr() - Method in class com.chilkatsoft.chilkat2.Socket

Controls the SO_REUSEADDR option for a socket that will bind and listen.

getSortCaseInsensitive() - Method in class com.chilkatsoft.chilkat2.Xml

Controls case sensitivity for the XML sorting methods.

getSortCriteria() - Method in class com.chilkatsoft.chilkat2.Imap

Specifies the sort order used by Imap.queryMbx(String, boolean, MessageSet).

getSoSndBuf() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the socket send-buffer size.

getSoSndBuf() - Method in class com.chilkatsoft.chilkat2.Http

Sets the send buffer size socket option.

getSoSndBuf() - Method in class com.chilkatsoft.chilkat2.Imap

Sets the operating system's TCP send-buffer size.

getSoSndBuf() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the socket send buffer size.

getSoSndBuf() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the socket send-buffer size.

getSoSndBuf() - Method in class com.chilkatsoft.chilkat2.Socket

Requests the operating-system send-buffer size for the TCP socket.

getSoSndBuf() - Method in class com.chilkatsoft.chilkat2.Ssh

Specifies the socket send-buffer size.

getSoSndBuf() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the send-buffer size for the underlying TCP socket.

getSourceFile() - Method in class com.chilkatsoft.chilkat2.Stream

Sets the source to the path of a file.

getSourceFilePart() - Method in class com.chilkatsoft.chilkat2.Stream

If the source is a file, then this property can be used to stream one part of the file.

getSourceFilePartSize() - Method in class com.chilkatsoft.chilkat2.Stream

If the source is a file, then this property, in conjunction with the SourceFilePart property, can be used to stream a single part of the file.

getSpideredUrl(int) - Method in class com.chilkatsoft.chilkat2.Spider

Returns the Nth URL in the already-spidered URL list.

getSpkiFingerprint(String, String) - Method in class com.chilkatsoft.chilkat2.Cert

Returns the SPKI Fingerprint suitable for use in pinning.

getSsl() - Method in class com.chilkatsoft.chilkat2.Ftp2

Set to true to use implicit FTP over TLS.

getSsl() - Method in class com.chilkatsoft.chilkat2.Imap

Controls implicit TLS for the IMAP connection.

getSsl() - Method in class com.chilkatsoft.chilkat2.Socket

Controls whether incoming connections accepted by this listener must complete a TLS handshake.

getSsl() - Method in class com.chilkatsoft.chilkat2.Upload

Set this to true if the upload is to HTTPS.

getSsl() - Method in class com.chilkatsoft.chilkat2.Url

true if the URL indicates SSL/TLS, otherwise false.

getSslAcceptableClientCaDn(int) - Method in class com.chilkatsoft.chilkat2.Socket

Returns the certificate-authority distinguished name at zero-based index from the list sent by a TLS server when it requests a client certificate.

getSslAllowedCiphers() - Method in class com.chilkatsoft.chilkat2.Ftp2

Restricts the cipher suites and selected TLS security requirements offered for FTP TLS connections.

getSslAllowedCiphers() - Method in class com.chilkatsoft.chilkat2.Http

Provides a means for setting a list of ciphers that are allowed for SSL/TLS connections.

getSslAllowedCiphers() - Method in class com.chilkatsoft.chilkat2.Imap

Restricts the cipher suites and selected TLS security requirements offered for an IMAP TLS connection.

getSslAllowedCiphers() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the TLS cipher suites Chilkat is allowed to offer when establishing SSL/TLS connections.

getSslAllowedCiphers() - Method in class com.chilkatsoft.chilkat2.Socket

Restricts the cipher suites permitted for TLS connections.

getSslAllowedCiphers() - Method in class com.chilkatsoft.chilkat2.Upload

Provides a means for setting a list of ciphers that are allowed for SSL/TLS connections.

getSslProtocol() - Method in class com.chilkatsoft.chilkat2.Ftp2

Selects the TLS protocol version or minimum version allowed for secure FTP connections.

getSslProtocol() - Method in class com.chilkatsoft.chilkat2.Http

Selects the SSL/TLS protocol version to be used for connections.

getSslProtocol() - Method in class com.chilkatsoft.chilkat2.Imap

Selects the TLS protocol version or minimum version allowed for secure IMAP connections.

getSslProtocol() - Method in class com.chilkatsoft.chilkat2.MailMan

Selects the SSL/TLS protocol version used for secure SMTP and POP3 connections.

getSslProtocol() - Method in class com.chilkatsoft.chilkat2.Socket

Selects the SSL/TLS protocol version allowed for secure connections.

getSslProtocol() - Method in class com.chilkatsoft.chilkat2.Upload

Selects the secure protocol to be used for secure (SSL/TLS) connections.

getSslServerCertVerified() - Method in class com.chilkatsoft.chilkat2.Ftp2

Indicates whether the FTP server certificate chain was successfully verified for the current or most recent TLS connection.

getSslServerCertVerified() - Method in class com.chilkatsoft.chilkat2.Imap

Indicates whether the IMAP server certificate chain was successfully verified for the current or most recent TLS connection.

getStandalone() - Method in class com.chilkatsoft.chilkat2.Xml

Controls the standalone pseudo-attribute in the XML declaration.

getStartTls() - Method in class com.chilkatsoft.chilkat2.Imap

Controls explicit TLS using the IMAP STARTTLS command.

getStartTLS() - Method in class com.chilkatsoft.chilkat2.MailMan

Determines whether Chilkat requires SMTP STARTTLS.

getStartTLSifPossible() - Method in class com.chilkatsoft.chilkat2.MailMan

Determines whether Chilkat attempts SMTP STARTTLS when the server advertises support for it.

getState() - Method in class com.chilkatsoft.chilkat2.Csr

Gets or sets the subject state or province name (ST, sometimes displayed as S), OID 2.5.4.8.

getStateParam() - Method in class com.chilkatsoft.chilkat2.OAuth2

Allows the application to supply an explicit OAuth state value.

getStatusChange(int, StringTable, JsonObject) - Method in class com.chilkatsoft.chilkat2.SCard

Blocks execution until the current availability of the cards in a specific set of readers changes.

getStatusChangeCancel() - Method in class com.chilkatsoft.chilkat2.SCard

Cancels an ongoing GetStatusChange method call.

getStatusCode() - Method in class com.chilkatsoft.chilkat2.HttpCurl

Returns the HTTP status code from the last call to HttpCurl.doYourThing(String).

getStatusCode() - Method in class com.chilkatsoft.chilkat2.HttpResponse

The status code (as an integer) from the first line of an HTTP response.

getStatusLine() - Method in class com.chilkatsoft.chilkat2.HttpResponse

The first line of an HTTP response, such as HTTP/1.0 200 OK.

getStatusText() - Method in class com.chilkatsoft.chilkat2.HttpResponse

The text that follows the status code in the 1st line of the HTTP response.

getStderrToStdout() - Method in class com.chilkatsoft.chilkat2.Ssh

Controls whether SSH extended-data received as stderr is merged into the normal channel receive buffer.

getStreaming() - Method in class com.chilkatsoft.chilkat2.Ai

When set to true, the Ai.ask(String) method operates in streaming mode, returning immediately after the request is sent.

getStreamNonChunked() - Method in class com.chilkatsoft.chilkat2.Rest

Controls whether streaming uploads use a Content-Length header instead of HTTP/1.1 chunked transfer encoding when the total body size is known.

getStreamResponseBodyPath() - Method in class com.chilkatsoft.chilkat2.Http

Allows for the HTTP response body to be streamed directly into a file.

getStrict() - Method in class com.chilkatsoft.chilkat2.JsonObject

When Strict is true, the Load methods first check that the data is well-formed JSON.

getStrict() - Method in class com.chilkatsoft.chilkat2.Xml

When Strict is true, the XML loading methods first check that the input is well-formed XML.

getString(int) - Method in class com.chilkatsoft.chilkat2.StringArray

Returns the string at an indexed location within the internal collection.

getString(String) - Method in class com.chilkatsoft.chilkat2.BinData

Interprets the bytes according to charset and returns the string.

getStringBom() - Method in class com.chilkatsoft.chilkat2.Stream

If true, then include the BOM when creating a string source via SetSourceString where the charset is utf-8, utf-16, etc.

getStringCharset() - Method in class com.chilkatsoft.chilkat2.Socket

Specifies the character encoding used by text-oriented socket methods.

getStringCharset() - Method in class com.chilkatsoft.chilkat2.Stream

Indicates the expected character encoding, such as utf-8, windows-1256, utf-16, etc.

getStringLen(int) - Method in class com.chilkatsoft.chilkat2.StringArray

Returns Nth string's length, in characters.

getStrings(int, int, boolean) - Method in class com.chilkatsoft.chilkat2.StringTable

Return the number of strings specified by count, one per line, starting at startIdx.

getStringToSign() - Method in class com.chilkatsoft.chilkat2.AuthAzureSAS

Defines the format of the string to sign.

getStripColorCodes() - Method in class com.chilkatsoft.chilkat2.Ssh

Controls whether terminal control sequences are removed from received text, so that the text returned is plain text.

getStructInnerDescrip() - Method in class com.chilkatsoft.chilkat2.Xmp

Determines whether structures are stored with rdf:parseType=Resource, or within an rdf:Description sub-node.

getStructPropNames(Xml, String) - Method in class com.chilkatsoft.chilkat2.Xmp

Returns the property names used by an exsting structure within an XMP document.

getStructTmMonth() - Method in class com.chilkatsoft.chilkat2.DtObj

The month.

getStructTmYear() - Method in class com.chilkatsoft.chilkat2.DtObj

The year represented as the number of years since 1900.

getStructure(String) - Method in class com.chilkatsoft.chilkat2.Mime

Returns a concise MIME-tree summary.

getStructValue(Xml, String, String) - Method in class com.chilkatsoft.chilkat2.Xmp

Returns the value of a single item within an XMP structure property.

getSubEmailAddress() - Method in class com.chilkatsoft.chilkat2.AuthGoogle

The email address of the user for which the application is requesting delegated access.

getSubItem(int) - Method in class com.chilkatsoft.chilkat2.Asn

Returns the Nth ASN.1 sub-item.

getSubject() - Method in class com.chilkatsoft.chilkat2.Email

The email subject.

getSubjectAlternativeName() - Method in class com.chilkatsoft.chilkat2.Cert

The subject alternative name (SAN) name of the certificate returned as XML.

getSubjectC() - Method in class com.chilkatsoft.chilkat2.Cert

The certificate subject's country.

getSubjectCN() - Method in class com.chilkatsoft.chilkat2.Cert

The certificate subject's common name.

getSubjectDN() - Method in class com.chilkatsoft.chilkat2.Cert

The certificate subject's full distinguished name.

getSubjectE() - Method in class com.chilkatsoft.chilkat2.Cert

The certificate subject's email address.

getSubjectField(String) - Method in class com.chilkatsoft.chilkat2.Csr

Returns the value of a subject distinguished-name attribute from the currently loaded or configured CSR, identified by its object identifier.

getSubjectKeyId() - Method in class com.chilkatsoft.chilkat2.Cert

The subject key identifier of the certificate in base64 string format.

getSubjectL() - Method in class com.chilkatsoft.chilkat2.Cert

The certificate subject's locality, which could be a city, count, township, or other geographic region.

getSubjectO() - Method in class com.chilkatsoft.chilkat2.Cert

The certificate subject's organization, which is typically the company name.

getSubjectOU() - Method in class com.chilkatsoft.chilkat2.Cert

The certificate subject's organizational unit, which is the unit within the organization.

getSubjectPart(String) - Method in class com.chilkatsoft.chilkat2.Cert

Returns a part of the certificate's subject by name or OID.

getSubjectS() - Method in class com.chilkatsoft.chilkat2.Cert

The certificate subject's state or province.

getSuppressLinks() - Method in class com.chilkatsoft.chilkat2.HtmlToText

Controls whether hyperlink destination URLs are included in the generated plain text.

getSuppressOutput() - Method in class com.chilkatsoft.chilkat2.Tar

Controls whether untar operations write extracted files and directories to the filesystem.

getSyncCreateAllLocalDirs() - Method in class com.chilkatsoft.chilkat2.Ftp2

Controls whether download synchronization creates empty remote directories on the local filesystem.

getSyncCreateAllLocalDirs() - Method in class com.chilkatsoft.chilkat2.SFtp

Controls whether SFtp.syncTreeDownload(String, String, int, boolean) creates empty remote directories locally.

getSyncDirectives() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies comma-separated directives that modify SFtp.syncTreeUpload(String, String, int, boolean) or SFtp.syncTreeDownload(String, String, int, boolean).

getSyncedFiles() - Method in class com.chilkatsoft.chilkat2.Scp

Contains the local paths of the files transferred by the most recent call to Scp.syncTreeUpload(String, String, int, boolean) or Scp.syncTreeDownload(String, String, int, boolean).

getSyncedFiles(StringTable) - Method in class com.chilkatsoft.chilkat2.Ftp2

Appends to the StringTable in strTable the relative paths affected by the most recent synchronization operation.

getSyncedFiles(StringTable) - Method in class com.chilkatsoft.chilkat2.SFtp

Appends to strTab the relative paths processed by the most recent SFtp.syncTreeUpload(String, String, int, boolean) or SFtp.syncTreeDownload(String, String, int, boolean) operation.

getSyncMustMatch() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies a semicolon-separated list of case-insensitive wildcard patterns for files that are eligible for synchronization and tree operations.

getSyncMustMatch() - Method in class com.chilkatsoft.chilkat2.Scp

Specifies a semicolon-separated list of wildcard patterns for filenames that are eligible for transfer by Scp.syncTreeUpload(String, String, int, boolean) and Scp.syncTreeDownload(String, String, int, boolean).

getSyncMustMatch() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies a semicolon-separated list of wildcard filename patterns.

getSyncMustMatchDir() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies a semicolon-separated list of case-insensitive wildcard patterns for directories that synchronization methods are allowed to enter.

getSyncMustMatchDir() - Method in class com.chilkatsoft.chilkat2.Scp

Specifies a semicolon-separated list of wildcard patterns for directory names that may be traversed by Scp.syncTreeUpload(String, String, int, boolean) and Scp.syncTreeDownload(String, String, int, boolean).

getSyncMustMatchDir() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies a semicolon-separated list of wildcard directory-name patterns.

getSyncMustNotMatch() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies a semicolon-separated list of case-insensitive wildcard patterns for files that must be excluded from synchronization and tree operations.

getSyncMustNotMatch() - Method in class com.chilkatsoft.chilkat2.Scp

Specifies a semicolon-separated list of wildcard patterns for filenames that must be skipped by Scp.syncTreeUpload(String, String, int, boolean) and Scp.syncTreeDownload(String, String, int, boolean).

getSyncMustNotMatch() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies a semicolon-separated list of wildcard filename patterns.

getSyncMustNotMatchDir() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies a semicolon-separated list of case-insensitive wildcard patterns for directories that synchronization methods must not enter.

getSyncMustNotMatchDir() - Method in class com.chilkatsoft.chilkat2.Scp

Specifies a semicolon-separated list of wildcard patterns for directory names that must not be traversed by Scp.syncTreeUpload(String, String, int, boolean) and Scp.syncTreeDownload(String, String, int, boolean).

getSyncMustNotMatchDir() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies a semicolon-separated list of wildcard directory-name patterns.

getSyncPreview() - Method in class com.chilkatsoft.chilkat2.Ftp2

Contains the preview produced by Ftp2.syncRemoteTree2(String, int, boolean, boolean) when ARG4 is true.

getTag() - Method in class com.chilkatsoft.chilkat2.Asn

The ASN.1 item's tag as a descriptive string.

getTag() - Method in class com.chilkatsoft.chilkat2.Xml

Gets or sets the element name for this element, including any namespace prefix.

getTagNsPrefix() - Method in class com.chilkatsoft.chilkat2.Xml

Gets or sets the namespace prefix portion of this element's tag.

getTagPath() - Method in class com.chilkatsoft.chilkat2.Xml

Returns the Chilkat tag path needed to reach this element from the document root.

getTagUnprefixed() - Method in class com.chilkatsoft.chilkat2.Xml

Gets or sets the unprefixed portion of this element's tag.

getTagValue() - Method in class com.chilkatsoft.chilkat2.Asn

The ASN.1 item's tag as a integer value.

getTargetName() - Method in class com.chilkatsoft.chilkat2.Ntlm

Specifies the server-provided authentication target placed in the Type 2 challenge message.

getTcpNoDelay() - Method in class com.chilkatsoft.chilkat2.SFtp

Controls the TCP_NODELAY socket option.

getTcpNoDelay() - Method in class com.chilkatsoft.chilkat2.Socket

Controls the TCP_NODELAY option.

getTcpNoDelay() - Method in class com.chilkatsoft.chilkat2.Ssh

Controls the TCP_NODELAY setting for the underlying TCP connection.

getTcpNoDelay() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Controls the TCP_NODELAY socket option for the underlying TCP connection.

getTempDir() - Method in class com.chilkatsoft.chilkat2.Zip

Directory used for temporary files during ZIP operations.

getTempFilename(String, String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Generates a temporary pathname in dirPath using prefix and a random alphanumeric suffix, in the general form prefix_xxxx.TMP.

getTextChunk(int, int, String) - Method in class com.chilkatsoft.chilkat2.BinData

Returns numBytes bytes starting at startIdx.

getTextDirListing(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sends a legacy LIST request and returns the server's raw textual listing.

getTextFlag() - Method in class com.chilkatsoft.chilkat2.ZipEntry

Gets or sets the text flag in the internal file attributes for this ZIP entry.

getThreadPoolLogPath() - Method in class com.chilkatsoft.chilkat2.Global

If set, indicates the path of a log file to be used by the thread pool thread and each of the pool worker threads for logging async activity.

getTimeoutSeconds() - Method in class com.chilkatsoft.chilkat2.Js

Specify a timeout in seconds to prevent JavaScript from running indefinitely, such as in an infinite loop.

getTimestamp() - Method in class com.chilkatsoft.chilkat2.OAuth1

The timestamp, such as 1441632569.

getTlsCipherSuite() - Method in class com.chilkatsoft.chilkat2.Ftp2

Contains the cipher suite negotiated for the current or most recent successful TLS connection, such as TLS_AES_256_GCM_SHA384.

getTlsCipherSuite() - Method in class com.chilkatsoft.chilkat2.Http

Contains the current or last negotiated TLS cipher suite.

getTlsCipherSuite() - Method in class com.chilkatsoft.chilkat2.Imap

Contains the cipher suite negotiated for the current or most recent TLS connection, for example TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384.

getTlsCipherSuite() - Method in class com.chilkatsoft.chilkat2.MailMan

Contains the current or most recently negotiated TLS cipher suite.

getTlsCipherSuite() - Method in class com.chilkatsoft.chilkat2.Socket

Returns the cipher suite from the most recent successful TLS handshake performed by this Socket object, for example TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384.

getTlsPinSet() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies one or more expected Subject Public Key Info (SPKI) fingerprints for TLS public-key pinning.

getTlsPinSet() - Method in class com.chilkatsoft.chilkat2.Http

Specifies a set of pins for Public Key Pinning for TLS connections.

getTlsPinSet() - Method in class com.chilkatsoft.chilkat2.Imap

Specifies one or more expected SPKI fingerprints for TLS public-key pinning.

getTlsPinSet() - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the expected Subject Public Key Info (SPKI) fingerprints for TLS public key pinning.

getTlsPinSet() - Method in class com.chilkatsoft.chilkat2.Socket

Specifies one or more expected SubjectPublicKeyInfo (SPKI) fingerprints for TLS public-key pinning.

getTlsPinSet() - Method in class com.chilkatsoft.chilkat2.Upload

Specifies a set of pins for Public Key Pinning for TLS connections.

getTlsPref() - Method in class com.chilkatsoft.chilkat2.Dns

Specifies the TLS preference.

getTlsSessionResumed() - Method in class com.chilkatsoft.chilkat2.Socket

Returns true when this connection was resumed from a session ticket instead of being fully handshaked; otherwise returns false.

getTlsTicketLifetimeSeconds() - Method in class com.chilkatsoft.chilkat2.Socket

The number of seconds a session ticket issued by this TLS server remains valid.

getTlsVersion() - Method in class com.chilkatsoft.chilkat2.Ftp2

Contains the protocol version negotiated for the current or most recent successful TLS connection, such as TLS 1.2 or TLS 1.3.

getTlsVersion() - Method in class com.chilkatsoft.chilkat2.Http

Contains the current or last negotiated TLS protocol version.

getTlsVersion() - Method in class com.chilkatsoft.chilkat2.Imap

Contains the protocol version negotiated for the current or most recent TLS connection, such as TLS 1.2 or TLS 1.3.

getTlsVersion() - Method in class com.chilkatsoft.chilkat2.MailMan

Contains the current or most recently negotiated TLS protocol version.

getTlsVersion() - Method in class com.chilkatsoft.chilkat2.Socket

Returns the protocol version from the most recent successful TLS handshake performed by this Socket object, such as TLS 1.2 or TLS 1.3.

getTo(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns a to recipient's full email address.

getToAddr(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns the Nth To address (only the address part, not the friendly-name part).

getToCharset() - Method in class com.chilkatsoft.chilkat2.Charset

Specifies the destination character encoding for conversion operations.

getToken() - Method in class com.chilkatsoft.chilkat2.OAuth1

The token.

getTokenEndpoint() - Method in class com.chilkatsoft.chilkat2.OAuth2

Specifies the provider's token endpoint.

getTokenSecret() - Method in class com.chilkatsoft.chilkat2.OAuth1

The token secret

getTokenType() - Method in class com.chilkatsoft.chilkat2.OAuth2

Contains the token_type value from the most recent successful token response.

getToName(int) - Method in class com.chilkatsoft.chilkat2.Email

Returns the Nth To name (only the friendly-name part, not the address part).

getTotalUploadSize() - Method in class com.chilkatsoft.chilkat2.Upload

The total size of the upload (in bytes).

getTreeId() - Method in class com.chilkatsoft.chilkat2.Xml

Returns the identifier of the XML tree to which this element belongs.

getTrim() - Method in class com.chilkatsoft.chilkat2.StringArray

If true, whitespace, including carriage-returns and linefeeds, are automatically removed from the beginning and end of a string when added to the collection.

getTrustedCertAlias(int) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Returns the alias of the trusted-certificate entry at index.

getTrustedRoot() - Method in class com.chilkatsoft.chilkat2.Cert

Returns true if the certificate has a trusted root authority, otherwise returns false.

getTrustSystemCaRoots() - Method in class com.chilkatsoft.chilkat2.TrustedRoots

Controls whether operating-system CA roots are included when this object's trust configuration is activated.

getTunnelLog() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Contains the in-memory activity log for the SSH tunnel and client-manager threads.

getTunnelLogPath() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Specifies the local file path where SSH tunnel-thread activity is written.

getUid() - Method in class com.chilkatsoft.chilkat2.SFtpFile

Returns the numeric user ID associated with the file.

getUidl() - Method in class com.chilkatsoft.chilkat2.Email

Contains the unique message identifier assigned by a POP3 server.

getUidNext() - Method in class com.chilkatsoft.chilkat2.Imap

Contains the mailbox's reported UIDNEXT value—the UID expected to be assigned to the next appended message.

getUidValidity() - Method in class com.chilkatsoft.chilkat2.Imap

Contains the UIDVALIDITY value of the currently selected mailbox, or 0 when no mailbox is selected.

getUInt2(int, boolean) - Method in class com.chilkatsoft.chilkat2.BinData

Returns the value of the 16-bit unsigned integer stored in big-endian or little-endian byte ordering at the given index.

getUInt4(int, boolean) - Method in class com.chilkatsoft.chilkat2.BinData

Returns the value of the 32-bit unsigned integer stored in big-endian or little-endian byte ordering at the given index.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Ai

This is a catch-all property to be used for uncommon needs.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Cert

This is a catch-all property to be used for uncommon needs.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.CertChain

Specifies uncommon behavior as a comma-separated list of keywords.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.CertStore

This is a catch-all property to be used for uncommon needs.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.CodeSign

Provides a comma-separated list of specialized compatibility or validation options.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Compression

Provides a way to enable specialized or uncommon behavior.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Crypt2

This is a catch-all property to be used for uncommon needs.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Csv

Provides optional keywords for uncommon CSV-processing requirements.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.DirTree

Provides a comma-separated list of specialized compatibility options.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Dns

This is a catch-all property to be used for uncommon needs.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Dsa

Reserved for uncommon or compatibility-specific options.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Email

This is a catch-all property to be used for uncommon needs.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Ftp2

Provides a comma-separated list of compatibility options for uncommon platform or server requirements.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Global

This is a catch-all property to be used for uncommon needs.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.HtmlToText

Specifies uncommon HTML-to-text conversion options as a comma-separated list of keywords.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Http

This is a catch-all property to be used for uncommon needs.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.HttpCurl

Provides a comma-separated list of uncommon option keywords.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.HttpResponse

This is a catch-all property to be used for uncommon needs.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Imap

Provides comma-separated compatibility or platform-specific options for uncommon cases.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.JsonObject

Provides a catch-all string for uncommon, implementation-specific options.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Jwe

Provides a comma-separated list of specialized compatibility options that are not exposed as ordinary properties.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Jws

Provides a catch-all string for specialized compatibility options.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Jwt

Provides a catch-all string for specialized compatibility options that are not exposed as ordinary properties.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.MailMan

Provides a comma-separated list of uncommon option keywords.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Mime

Gets or sets a semicolon-delimited or implementation-specific option string used for uncommon compatibility requirements.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.OAuth1

This is a catch-all property to be used for uncommon needs.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.OAuth2

Provides a comma-separated list of specialized compatibility options.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Pdf

This is a catch-all property to be used for uncommon needs.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Pfx

Provides specialized compatibility options for unusual PFX interoperability requirements.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Pkcs11

This is a catch-all property to be used for uncommon needs.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.PrivateKey

Provides a catch-all string for specialized compatibility options that are not exposed as ordinary properties.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Rest

Provides opt-in compatibility settings for uncommon requirements.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Rsa

This is a catch-all property to be used for uncommon needs.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.ScMinidriver

This is a catch-all property to be used for uncommon needs.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Scp

Provides a comma-separated list of specialized compatibility options.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Secrets

This is a catch-all property to be used for uncommon needs.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.SFtp

Provides comma-separated compatibility, security, and synchronization options for uncommon scenarios.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Socket

Provides comma-separated compatibility or platform-specific options.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Ssh

Provides comma-separated compatibility and security options for uncommon SSH scenarios.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.SshKey

Provides optional settings for uncommon compatibility requirements.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Provides optional behavior for uncommon requirements.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.WebSocket

Contains a comma-separated list of rarely needed compatibility or platform options.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Xml

Provides a catch-all string for uncommon XML behaviors.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.XmlDSig

This is a catch-all property to be used for uncommon needs.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

This is a catch-all property to be used for uncommon needs.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Xmp

A property to be used for future uncommon needs.

getUncommonOptions() - Method in class com.chilkatsoft.chilkat2.Zip

Advanced options for uncommon scenarios.

getUncompressedLength() - Method in class com.chilkatsoft.chilkat2.ZipEntry

The uncompressed size of this entry, in bytes.

getUncompressedLength64() - Method in class com.chilkatsoft.chilkat2.ZipEntry

The uncompressed size of this entry, in bytes, as a 64-bit integer.

getUncompressedLengthStr() - Method in class com.chilkatsoft.chilkat2.ZipEntry

The uncompressed size of this ZIP entry as a decimal string.

getUnique() - Method in class com.chilkatsoft.chilkat2.StringArray

If true, then duplicates are not allowed.

getUnixPermOverride() - Method in class com.chilkatsoft.chilkat2.Scp

Specifies an octal UNIX permission mode to apply to files uploaded by SCP, overriding the permissions derived from the local source file.

getUnlockStatus() - Method in class com.chilkatsoft.chilkat2.Global

Indicates the unlocked status for the last call to UnlockBundle.

getUnpackDirect() - Method in class com.chilkatsoft.chilkat2.Mht

Controls whether MHT parts are extracted directly according to their relative Content-Location values.

getUnpackUseRelPaths() - Method in class com.chilkatsoft.chilkat2.Email

Applies to the Email.unpackHtml(String, String, String) method.

getUnpackUseRelPaths() - Method in class com.chilkatsoft.chilkat2.Mht

Controls how extracted resources are referenced from the rewritten HTML produced by the normal unpacking mode.

getUnprotectedH(int, JsonObject) - Method in class com.chilkatsoft.chilkat2.Jws

Copies the optional unprotected header of signature index into json.

getUnsignedSigFields(JsonObject) - Method in class com.chilkatsoft.chilkat2.Pdf

Returns JSON containing the name of each unsigned signature field found in the PDF.

getUnspideredUrl(int) - Method in class com.chilkatsoft.chilkat2.Spider

Returns the Nth URL in the unspidered URL list.

getUntarCaseSensitive() - Method in class com.chilkatsoft.chilkat2.Tar

Deprecated. Use Tar.getMatchCaseSensitive() instead.

getUntarDebugLog() - Method in class com.chilkatsoft.chilkat2.Tar

Controls whether untar methods add per-entry extraction details to LastErrorText, LastErrorXml, and LastErrorHtml.

getUntarDiscardPaths() - Method in class com.chilkatsoft.chilkat2.Tar

Controls whether directory components from archive entry names are discarded during extraction.

getUntarFromDir() - Method in class com.chilkatsoft.chilkat2.Tar

Specifies the destination directory for extraction.

getUntarMaxCount() - Method in class com.chilkatsoft.chilkat2.Tar

Limits the number of matching entries extracted by an untar operation.

getUnwrapExtras() - Method in class com.chilkatsoft.chilkat2.Mime

Controls whether Mime.unwrapSecurity() adds informative header fields describing the security layers removed.

getUpdateCache() - Method in class com.chilkatsoft.chilkat2.Http

Set this property to true to automatically updated with HTTP GET request responses.

getUpdateCache() - Method in class com.chilkatsoft.chilkat2.Mht

Controls whether successful HTTP GET responses are written to the configured disk cache.

getUpdateCache() - Method in class com.chilkatsoft.chilkat2.Spider

If equal to 1 (true) then pages saved to the cache.

getUploadChunkSize() - Method in class com.chilkatsoft.chilkat2.SFtp

Specifies the chunk size, in bytes, used by SFtp.uploadFile(String, String) and SFtp.uploadFileByName(String, String).

getUploadInProgress() - Method in class com.chilkatsoft.chilkat2.Upload

Set to true when an asynchronous upload is started.

getUploadSuccess() - Method in class com.chilkatsoft.chilkat2.Upload

Set to true (success) or false (failed) after an asynchronous upload completes or aborts due to failure.

getUploadTransferRate() - Method in class com.chilkatsoft.chilkat2.Ftp2

Returns the current average upload rate in bytes per second.

getUrlDomain(String) - Method in class com.chilkatsoft.chilkat2.Spider

Returns the domain name part of a URL.

getUrlEncodedParams() - Method in class com.chilkatsoft.chilkat2.HttpRequest

Returns the request parameters in URL encoded form (i.e.

getUrlPath(String) - Method in class com.chilkatsoft.chilkat2.Http

Returns the path part of a URL.

getUseApop() - Method in class com.chilkatsoft.chilkat2.MailMan

Determines whether Chilkat automatically uses APOP authentication when the POP3 server supports it.

getUseBasicAuth() - Method in class com.chilkatsoft.chilkat2.OAuth2

Controls how ClientId and ClientSecret are supplied during the authorization-code token exchange.

getUseCids() - Method in class com.chilkatsoft.chilkat2.Mht

Controls how embedded resources are identified and referenced in generated MHT and EML MIME documents.

getUseCurrentDate() - Method in class com.chilkatsoft.chilkat2.Gzip

Controls the last-modified date/time assigned to files created by Uncompress* methods.

getUseEpsv() - Method in class com.chilkatsoft.chilkat2.Ftp2

Controls whether passive data connections first use EPSV instead of PASV.

getUseFilename() - Method in class com.chilkatsoft.chilkat2.Mht

Controls whether the generated Content-Disposition for an embedded resource includes a filename parameter.

getUseIEProxy() - Method in class com.chilkatsoft.chilkat2.Http

If true, the proxy address/port used by Internet Explorer will also be used by Chilkat HTTP.

getUseIEProxy() - Method in class com.chilkatsoft.chilkat2.Mht

When true, Chilkat uses the proxy configuration associated with Windows Internet Options / Internet Explorer.

getUseInline() - Method in class com.chilkatsoft.chilkat2.Mht

Controls whether embedded resource parts receive an inline Content-Disposition when Mht.getUseFilename() does not independently require the header.

getUseMmDescription() - Method in class com.chilkatsoft.chilkat2.Mime

Controls whether Chilkat uses the conventional multipart preamble text This is a multi-part message in MIME format. when serializing a multipart entity.

getUsePkcsConstructedEncoding() - Method in class com.chilkatsoft.chilkat2.Global

This property should typically be left at the default value of false.

getUserAgent() - Method in class com.chilkatsoft.chilkat2.Http

This property sets the User-Agent header for all HTTP requests, except those sent by the Http.httpReq(String, HttpRequest, HttpResponse) and Http.httpSReq(String, int, boolean, HttpRequest, HttpResponse) methods that use headers from an HttpRequest object.

getUserAgent() - Method in class com.chilkatsoft.chilkat2.Spider

The value of the HTTP user-agent header field to be sent with HTTP requests.

getUserAuthBanner() - Method in class com.chilkatsoft.chilkat2.SFtp

Contains a user-authentication banner received from the server.

getUserAuthBanner() - Method in class com.chilkatsoft.chilkat2.Ssh

Contains a user-authentication banner received from the server during authentication.

getUserData() - Method in class com.chilkatsoft.chilkat2.Socket

Stores arbitrary application text with the socket object.

getUserId() - Method in class com.chilkatsoft.chilkat2.Tar

Specifies the numeric user identifier (UID) written to TAR headers when an archive is created.

getUsername() - Method in class com.chilkatsoft.chilkat2.Ftp2

Specifies the FTP login name.

getUserName() - Method in class com.chilkatsoft.chilkat2.Ntlm

Specifies the account name to authenticate.

getUserName() - Method in class com.chilkatsoft.chilkat2.Tar

Specifies the user name written to TAR headers when an archive is created.

getUserPassword() - Method in class com.chilkatsoft.chilkat2.Pdf

The PDF user password, if required.

getUseXPkcs7() - Method in class com.chilkatsoft.chilkat2.Mime

Controls whether newly created S/MIME media types use the historical x-pkcs7 names.

getUtc() - Method in class com.chilkatsoft.chilkat2.DtObj

true if this is a UTC time, otherwise false if this is a local time.

getUtcMode() - Method in class com.chilkatsoft.chilkat2.SFtp

Controls the time zone used by date/time getters.

getUtcOffset() - Method in class com.chilkatsoft.chilkat2.DateTime

For the current system's timezone, returns the number of seconds offset from UTC for this date/time.

getUuFilename() - Method in class com.chilkatsoft.chilkat2.Crypt2

When UU encoding, this is the filename to be embedded in UU encoded output.

getUuMode() - Method in class com.chilkatsoft.chilkat2.Crypt2

When UU encoding, this is the file permissions mode to be embedded in UU encoded output.

getValid() - Method in class com.chilkatsoft.chilkat2.AuthGoogle

true if the AccessToken property contains a valid non-expired access token obtained via the call to ObtainAccessToken.

getValidFromStr() - Method in class com.chilkatsoft.chilkat2.Cert

The date (in RFC822 string format) that this certificate becomes (or became) valid.

getValidToStr() - Method in class com.chilkatsoft.chilkat2.Cert

The date (in RFC822 string format) that this certificate expires.

getVar(String) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Retrieves the current value of the variable specified by varName.

getVerboseLogging() - Method in class com.chilkatsoft.chilkat2.ChilkatObject

Whether LastErrorText is verbose.

getVerboseTls() - Method in class com.chilkatsoft.chilkat2.Global

If set to true, then causes extremely verbose logging (in LastErrorText) all TLS connections in any Chilkat class.

getVerifyInfo() - Method in class com.chilkatsoft.chilkat2.Dkim

Contains JSON describing the most recent call to Dkim.dkimVerify(int, BinData).

getVerifyKeyedDigest() - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Controls validation of the keystore-level integrity digest when a JKS or JCEKS store is loaded.

getVersion() - Method in class com.chilkatsoft.chilkat2.ChilkatObject

The version of the Chilkat library.

getWasRedirected() - Method in class com.chilkatsoft.chilkat2.Http

This shows whether the last HTTP request automatically followed a redirect.

getWasRedirected() - Method in class com.chilkatsoft.chilkat2.Spider

Indicates whether the last URL crawled was redirected.

getWebSiteLogin() - Method in class com.chilkatsoft.chilkat2.Mht

Specifies the username used when the origin website requires HTTP authentication.

getWebSiteLoginDomain() - Method in class com.chilkatsoft.chilkat2.Mht

Specifies the optional Windows domain used with NTLM website authentication.

getWebSitePassword() - Method in class com.chilkatsoft.chilkat2.Mht

Specifies the password used with Mht.getWebSiteLogin() when the origin website requires HTTP authentication.

getWindDownCount() - Method in class com.chilkatsoft.chilkat2.Spider

The wind-down phase begins when this number of URLs has been spidered.

getWorkstation() - Method in class com.chilkatsoft.chilkat2.Ntlm

Specifies the optional client workstation name.

getWriteFailReason() - Method in class com.chilkatsoft.chilkat2.Stream

This property is automatically set when a Write* method is called.

getWriteFormat() - Method in class com.chilkatsoft.chilkat2.Tar

Specifies the TAR header format used by the WriteTar* methods.

getWriteTimeoutMs() - Method in class com.chilkatsoft.chilkat2.Stream

The maximum number of seconds to wait while writing.

getX509Type() - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Specifies the kind of X.509 certificate information is provided in the KeyInfo element when the KeyInfoType equals X509Data.

getXferByteCount() - Method in class com.chilkatsoft.chilkat2.SFtp

Contains the current transfer byte count for an upload or download in progress.

getXferByteCount64() - Method in class com.chilkatsoft.chilkat2.SFtp

Contains the current 64-bit transfer byte count for an upload or download in progress.

getXlsxDateFormat() - Method in class com.chilkatsoft.chilkat2.Csv

Specifies the date format used when converting Excel date cells from an .xlsx worksheet to CSV text.

getXml() - Method in class com.chilkatsoft.chilkat2.Email

Convert the email object to an XML document in memory

getXml() - Method in class com.chilkatsoft.chilkat2.EmailBundle

Serializes the entire email bundle to Chilkat XML and returns the XML document as a string.

getXml() - Method in class com.chilkatsoft.chilkat2.Mime

Converts the MIME tree to Chilkat's XML representation and returns it as a string.

getXml() - Method in class com.chilkatsoft.chilkat2.PrivateKey

Exports the key in Chilkat-compatible XML.

getXml() - Method in class com.chilkatsoft.chilkat2.PublicKey

Returns the public key in Chilkat XML format.

getXml() - Method in class com.chilkatsoft.chilkat2.Xml

Serializes the XML tree or subtree rooted at the current element and returns the XML text.

getXml() - Method in class com.chilkatsoft.chilkat2.XmlCertVault

Returns the contents of the cert vault as an XML string.

getXmlBd(BinData) - Method in class com.chilkatsoft.chilkat2.Xml

Serializes the XML tree or subtree rooted at the current element and appends the encoded XML bytes to bd.

getXmlCharset() - Method in class com.chilkatsoft.chilkat2.HtmlToXml

Specifies the character encoding to identify for the generated XML, such as utf-8 or iso-8859-1.

getXmlDirListing(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Retrieves a directory listing for pattern and returns parsed entries as an XML document rooted at <remoteDir>.

getXmlListing() - Method in class com.chilkatsoft.chilkat2.Tar

Contains the XML listing captured by the most recent untar operation for which Tar.getCaptureXmlListing() was true.

getXmlSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Xml

Serializes the XML tree or subtree rooted at the current element and appends the resulting XML text to sb.

getXMsVersion() - Method in class com.chilkatsoft.chilkat2.AuthAzureStorage

If set, automatically adds the x-ms-version HTTP request header to Azure Storage requests.

getYear() - Method in class com.chilkatsoft.chilkat2.DtObj

The year, such as 2012.

getZipx() - Method in class com.chilkatsoft.chilkat2.Zip

If true, creates ZIPX archives using the most appropriate compression method for each file.

getZipxDefaultAlg() - Method in class com.chilkatsoft.chilkat2.Zip

Default compression algorithm used when creating ZIPX archives.

Global - Class in com.chilkatsoft.chilkat2

<section class="global-summary">

Global() - Constructor for class com.chilkatsoft.chilkat2.Global

Creates a new Global object.

gSvcOauthAccessToken(String, String, String, int, Cert) - Method in class com.chilkatsoft.chilkat2.Http

Obtains a Google API OAuth2 access token for a service account.

gSvcOauthAccessToken2(Hashtable, int, Cert) - Method in class com.chilkatsoft.chilkat2.Http

This method is similar to G_SvcOauthAccessToken, but offers greater customization.

Gzip - Class in com.chilkatsoft.chilkat2

<section class="gzip-summary">

Gzip() - Constructor for class com.chilkatsoft.chilkat2.Gzip

Creates a new Gzip object.

H

hardLink(String, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Creates a hard link from newPath to the existing remote file at oldPath.

hasAttribute(String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns true if the calling element has an attribute named name; otherwise returns false.

hasAttrWithValue(String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns true if the calling element has an attribute named name whose value exactly equals value; otherwise returns false.

hasCapability(String, String) - Method in class com.chilkatsoft.chilkat2.Imap

Tests whether the capability named by name appears in the raw capability response in capabilityResponse.

hasChildWithContent(String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns true if any direct child has text content exactly equal to content; otherwise returns false.

hasChildWithTag(String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns true if the child selected by tagPath exists; otherwise returns false.

hasChildWithTagAndContent(String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns true if the child selected by tagPath exists and its text content exactly equals content; otherwise returns false.

hasEncapsulatedTimeStamp() - Method in class com.chilkatsoft.chilkat2.XmlDSig

Returns true if the signature indicated by the Selector property contains an EncapsulatedTimeStamp.

hasFlag(int, String) - Method in class com.chilkatsoft.chilkat2.Mailboxes

Returns true if the mailbox at the zero-based index specified by index contains the flag named by flagName.

hashBdENC(BinData) - Method in class com.chilkatsoft.chilkat2.Crypt2

Hashes the bytes in bd and returns the hash as a binary-encoded string.

hashBeginString(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

To hash a large amount of text, start by processing the first chunk using this method.

hashChunkBd(boolean, BinData) - Method in class com.chilkatsoft.chilkat2.Crypt2

Start or continue hashing data in chunks.

hasHeaderMatching(String, String, boolean) - Method in class com.chilkatsoft.chilkat2.Email

Returns true when the email contains a header field named fieldName whose value matches the wildcard pattern in valuePattern.

hashFileENC(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Hashes a file and returns the hash as an encoded string.

hashFinalENC() - Method in class com.chilkatsoft.chilkat2.Crypt2

Finalizes a multi-step hash computation and returns the hash bytes encoded according to the Crypt2.getEncodingMode() property setting.

hashMoreString(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Adds more text to the hash currently under computation.

hashOf(String, String, String) - Method in class com.chilkatsoft.chilkat2.Cert

Returns an encoded hash of a particular part of the certificate.

hashStringENC(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Hashes the str and returns the hash as a binary encoded string.

Hashtable - Class in com.chilkatsoft.chilkat2

<section class="hashtable-summary">

Hashtable() - Constructor for class com.chilkatsoft.chilkat2.Hashtable

Creates a new Hashtable object.

hasHtmlBody() - Method in class com.chilkatsoft.chilkat2.Email

Returns true if the email has an HTML body.

hashVal(String) - Method in class com.chilkatsoft.chilkat2.SecureString

Returns the hash value for the current value of this secure string.

hasInferiors(int) - Method in class com.chilkatsoft.chilkat2.Mailboxes

Returns true if the mailbox at the zero-based index specified by index either has child mailboxes or permits child mailboxes to be created beneath it.

hasMember(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns true if a value exists at jsonPath; otherwise returns false.

hasPlainTextBody() - Method in class com.chilkatsoft.chilkat2.Email

Returns true if the email has a plain-text body.

hasPrivateKey() - Method in class com.chilkatsoft.chilkat2.Cert

Returns true if a private key associated with the certificate is available.

hasRequestHeader(String) - Method in class com.chilkatsoft.chilkat2.Http

Returns true if the header field specified by name is included in all HTTP requests, except those sent by the Http.httpReq(String, HttpRequest, HttpResponse) or Http.httpSReq(String, int, boolean, HttpRequest, HttpResponse) methods.

hasSignatureSigningTime(int) - Method in class com.chilkatsoft.chilkat2.Crypt2

After verifying a digital signature with a signature verification method, you can call this method.

hasSignatureSigningTime(int) - Method in class com.chilkatsoft.chilkat2.Mime

Returns true if the signer at zero-based index has a CMS signingTime signed attribute.

hotp(String, String, String, int, int, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Implements RFC 4226: HOTP: An HMAC-Based One-Time Password Algorithm.

htmlDecodeToStr(String) - Method in class com.chilkatsoft.chilkat2.Charset

Decodes HTML named entities and numeric character references in inStr and returns the resulting Unicode string.

htmlEntityDecodeFile(String, String) - Method in class com.chilkatsoft.chilkat2.Charset

Reads the file at inPath, decodes HTML named entities and numeric character references, and writes the transformed content to destPath.

htmlToEML(String) - Method in class com.chilkatsoft.chilkat2.Mht

Creates an EML MIME message from the in-memory HTML string in htmlText and returns the complete EML text.

htmlToEMLFile(String, String) - Method in class com.chilkatsoft.chilkat2.Mht

Creates EML output from the in-memory HTML string in html and saves it to the file path in emlFilename.

htmlToMarkdown() - Method in class com.chilkatsoft.chilkat2.StringBuilder

Converts the HTML contained in this object to Markdown, replacing the contents with the Markdown.

htmlToMHT(String) - Method in class com.chilkatsoft.chilkat2.Mht

Creates an MHT web archive from the in-memory HTML string in htmlText and returns the complete MHT MIME text.

htmlToMHTFile(String, String) - Method in class com.chilkatsoft.chilkat2.Mht

Creates MHT output from the in-memory HTML string in html and saves it to the file path in mhtFilename.

HtmlToText - Class in com.chilkatsoft.chilkat2

<section class="htmltotext-summary">

HtmlToText() - Constructor for class com.chilkatsoft.chilkat2.HtmlToText

Creates a new HtmlToText object.

HtmlToXml - Class in com.chilkatsoft.chilkat2

<section class="htmltoxml-summary">

HtmlToXml() - Constructor for class com.chilkatsoft.chilkat2.HtmlToXml

Creates a new HtmlToXml object.

Http - Class in com.chilkatsoft.chilkat2

<section class="http-summary">

Http() - Constructor for class com.chilkatsoft.chilkat2.Http

Creates a new Http object.

httpBd(String, String, BinData, String, HttpResponse) - Method in class com.chilkatsoft.chilkat2.Http

Sends an HTTP request to url using the specified HTTP verb (e.g., POST, PUT, PATCH).

HttpCurl - Class in com.chilkatsoft.chilkat2

curl-style HTTP requests with dependency resolution

HttpCurl() - Constructor for class com.chilkatsoft.chilkat2.HttpCurl

Creates a new HttpCurl object.

httpFile(String, String, String, String, HttpResponse) - Method in class com.chilkatsoft.chilkat2.Http

Sends an HTTP request to url using the specified HTTP verb (e.g., POST, PUT, PATCH).

httpJson(String, String, JsonObject, String, HttpResponse) - Method in class com.chilkatsoft.chilkat2.Http

Sends an HTTP request to url using the specified method in verb (e.g., POST, PUT, PATCH).

httpNoBody(String, String, HttpResponse) - Method in class com.chilkatsoft.chilkat2.Http

Sends an HTTP request to url using the specified HTTP verb.

httpParams(String, String, JsonObject, HttpResponse) - Method in class com.chilkatsoft.chilkat2.Http

Sends an HTTP verb request to url with query parameters from json.

httpReq(String, HttpRequest, HttpResponse) - Method in class com.chilkatsoft.chilkat2.Http

Sends an HTTP request to url where the content of the request is defined by request.

HttpRequest - Class in com.chilkatsoft.chilkat2

<section class="httprequest-summary">

HttpRequest() - Constructor for class com.chilkatsoft.chilkat2.HttpRequest

Creates a new HttpRequest object.

HttpResponse - Class in com.chilkatsoft.chilkat2

<section class="httpresponse-summary">

HttpResponse() - Constructor for class com.chilkatsoft.chilkat2.HttpResponse

Creates a new HttpResponse object.

httpSb(String, String, StringBuilder, String, String, HttpResponse) - Method in class com.chilkatsoft.chilkat2.Http

Sends an HTTP request to url using the specified verb (e.g., POST, PUT, PATCH).

httpSReq(String, int, boolean, HttpRequest, HttpResponse) - Method in class com.chilkatsoft.chilkat2.Http

Sends an HTTP request to web server at domain:port using TLS if ssl equals true.

httpStr(String, String, String, String, String, HttpResponse) - Method in class com.chilkatsoft.chilkat2.Http

Sends an HTTP request to url using the specified verb (e.g., POST, PUT, PATCH).

I

idleCheck(int) - Method in class com.chilkatsoft.chilkat2.Imap

Waits up to timeoutMs milliseconds for unsolicited mailbox updates after Imap.idleStart() has entered IMAP IDLE mode.

idleDone() - Method in class com.chilkatsoft.chilkat2.Imap

Ends IMAP IDLE mode by sending the protocol's DONE continuation.

idleStart() - Method in class com.chilkatsoft.chilkat2.Imap

Sends the IMAP IDLE command and begins listening for unsolicited mailbox updates.

Imap - Class in com.chilkatsoft.chilkat2

<section class="imap-summary">

Imap() - Constructor for class com.chilkatsoft.chilkat2.Imap

Creates a new Imap object.

importCert(Cert, int, String, String) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Imports a certificate with its private key onto the smart card.

importConvo(String, JsonObject) - Method in class com.chilkatsoft.chilkat2.Ai

Imports the conversation from json and assigns it the name in name.

importEntropy(String) - Method in class com.chilkatsoft.chilkat2.Prng

Imports the Base64-encoded entropy value previously returned by ExportEntropy.

importKey(int, String, PrivateKey, String) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Imports a key to be stored in either the signature or key exchange location within a key container.

importPrivateKey(PrivateKey, JsonObject) - Method in class com.chilkatsoft.chilkat2.Pkcs11

Imports a private key onto the HSM.

importSshKey(SshKey, JsonObject) - Method in class com.chilkatsoft.chilkat2.Pkcs11

Imports an SSH private key onto the HSM.

importToKeychain(JsonObject) - Method in class com.chilkatsoft.chilkat2.Pfx

Imports all certificates and private keys currently held by this Pfx object into the application's default keychain.

importToWindows(boolean, boolean, boolean, boolean, boolean, String, String, String, String) - Method in class com.chilkatsoft.chilkat2.Pfx

Imports the certificates and private keys in this PFX into Windows certificate stores and Windows key storage.

indexOf(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns the zero-based position of the direct member named name, or -1 if that member name is not found.

initialize() - Method in class com.chilkatsoft.chilkat2.Pkcs11

Initializes the PKCS#11 library.

initialize(String) - Method in class com.chilkatsoft.chilkat2.Spider

Initializes the object to begin spidering a domain.

initializeSftp() - Method in class com.chilkatsoft.chilkat2.SFtp

Opens the SFTP subsystem and negotiates the SFTP protocol version.

initPin(String) - Method in class com.chilkatsoft.chilkat2.Pkcs11

Initializes the normal user's PIN.

initSslServer(Cert) - Method in class com.chilkatsoft.chilkat2.Socket

Configures this object for server-side TLS using cert as the server certificate.

initToken(int, String, String) - Method in class com.chilkatsoft.chilkat2.Pkcs11

Initializes a token.

inputAddFileData(String, BinData, String) - Method in class com.chilkatsoft.chilkat2.Ai

Adds file data, such as a PDF, to the potentially multimodal input that will be sent in the next call to Ai.ask(String).

inputAddFileId(String, String) - Method in class com.chilkatsoft.chilkat2.Ai

Adds a reference to a previously uploaded file.

inputAddFileUrl(String, String) - Method in class com.chilkatsoft.chilkat2.Ai

Adds a file located at a url to the potentially multimodal input that will be sent in the next call to Ai.ask(String).

inputAddFnResult(String, String) - Method in class com.chilkatsoft.chilkat2.Ai

Provide a function call result to the model.

inputAddImageData(BinData, String) - Method in class com.chilkatsoft.chilkat2.Ai

Adds an image to the potentially multimodal input that will be sent in the next call to Ai.ask(String).

inputAddImageFileId(String, String) - Method in class com.chilkatsoft.chilkat2.Ai

Adds a reference to a previously uploaded image file.

inputAddImageUrl(String, String) - Method in class com.chilkatsoft.chilkat2.Ai

Adds an image located at a url to the potentially multimodal input that will be sent in the next call to Ai.ask(String).

inputAddText(String) - Method in class com.chilkatsoft.chilkat2.Ai

Adds text to the potentially multimodal input that will be sent in the next call to Ai.ask(String).

inputAddTextSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Ai

Adds text to the potentially multimodal input that will be sent in the next call to Ai.ask(String).

inputClear() - Method in class com.chilkatsoft.chilkat2.Ai

Clears the inputs to be sent in the next call to Ai.ask(String).

insertAt(int, String) - Method in class com.chilkatsoft.chilkat2.StringArray

Inserts a string into the internal collection at a specified index.

insertChildTreeAfter(int, Xml) - Method in class com.chilkatsoft.chilkat2.Xml

Inserts the entire subtree referenced by tree as a direct child immediately after the existing child at zero-based index.

insertChildTreeBefore(int, Xml) - Method in class com.chilkatsoft.chilkat2.Xml

Inserts the entire subtree referenced by tree as a direct child immediately before the existing child at zero-based index.

insertColumn(int) - Method in class com.chilkatsoft.chilkat2.Csv

Inserts one empty field into each existing row and, when present, into the column-name row.

insertId(long) - Method in class com.chilkatsoft.chilkat2.MessageSet

Adds id to the message set and maintains the identifiers in ascending numeric order.

intAt(int) - Method in class com.chilkatsoft.chilkat2.JsonArray

Returns the integer value stored at zero-based position index.

intAt(int) - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns the integer value of the member at zero-based position index.

intAt(int) - Method in class com.chilkatsoft.chilkat2.StringTable

Returns the Nth string in the table, converted to an integer value.

intOf(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns the integer value at jsonPath.

isApplicationData() - Method in class com.chilkatsoft.chilkat2.Mime

Returns true when Mime.getContentType() begins with application/.

isAttachment() - Method in class com.chilkatsoft.chilkat2.Mime

Returns true when the current part's disposition value is attachment, matched case-insensitively.

isAudio() - Method in class com.chilkatsoft.chilkat2.Mime

Returns true when Mime.getContentType() begins with audio/.

isCached(String) - Method in class com.chilkatsoft.chilkat2.Cache

Returns true if an item exists for key, or false if the key is not present.

isClosed() - Method in class com.chilkatsoft.chilkat2.ChilkatObject

Returns whether ChilkatObject.close() has been called.

isConnected() - Method in class com.chilkatsoft.chilkat2.Imap

Returns the last known connection state without sending data to the IMAP server.

isEcdsa() - Method in class com.chilkatsoft.chilkat2.Cert

Returns true if certificate is ECDSA-based (i.e.

isEncrypted() - Method in class com.chilkatsoft.chilkat2.Mime

Returns true when the current MIME entity is a CMS/PKCS #7 encrypted S/MIME wrapper.

isGzip(BinData) - Method in class com.chilkatsoft.chilkat2.Gzip

Checks whether the data contained in a BinData object is in Gzip format.

isHtml() - Method in class com.chilkatsoft.chilkat2.Mime

Returns true when Mime.getContentType() is text/html.

isImage() - Method in class com.chilkatsoft.chilkat2.Mime

Returns true when Mime.getContentType() begins with image/, including values such as image/svg+xml.

isLoggedIn() - Method in class com.chilkatsoft.chilkat2.Imap

Indicates whether this object is in an authenticated IMAP session.

isMarked(int) - Method in class com.chilkatsoft.chilkat2.Mailboxes

Returns true if the mailbox at the zero-based index specified by index has the IMAP \Marked attribute.

isMultipart() - Method in class com.chilkatsoft.chilkat2.Mime

Returns true when Mime.getContentType() begins with multipart/.

isMultipartAlternative() - Method in class com.chilkatsoft.chilkat2.Mime

Returns true when Mime.getContentType() is multipart/alternative.

isMultipartMixed() - Method in class com.chilkatsoft.chilkat2.Mime

Returns true when Mime.getContentType() is multipart/mixed.

isMultipartRelated() - Method in class com.chilkatsoft.chilkat2.Mime

Returns true when Mime.getContentType() is multipart/related.

isMultipartReport() - Method in class com.chilkatsoft.chilkat2.Email

Returns true if the email is a multipart/report email.

isNoCompressExtension(String) - Method in class com.chilkatsoft.chilkat2.Zip

Checks whether a file extension is contained in the internal "no-compression" extension list.

isNullAt(int) - Method in class com.chilkatsoft.chilkat2.JsonArray

Returns true if the value at zero-based position index is the JSON value null; otherwise returns false.

isNullAt(int) - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns true if the member at zero-based position index has the JSON value null; otherwise returns false.

isNullOf(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns true if the value at jsonPath is the JSON literal null; otherwise returns false.

isPasswordProtected(String) - Method in class com.chilkatsoft.chilkat2.Zip

Checks whether a ZIP archive uses legacy Zip 2.0 password protection.

isPlainText() - Method in class com.chilkatsoft.chilkat2.Mime

Returns true when Mime.getContentType() is text/plain.

isReferenceExternal(int) - Method in class com.chilkatsoft.chilkat2.XmlDSig

Returns true if the reference at index is external.

isRootTrusted(TrustedRoots) - Method in class com.chilkatsoft.chilkat2.CertChain

Tests whether the certificate at the root end of this chain is present in the TrustedRoots collection passed in trustedRoots.

isRsa() - Method in class com.chilkatsoft.chilkat2.Cert

Returns true if certificate is RSA-based (i.e.

isSelectable(int) - Method in class com.chilkatsoft.chilkat2.Mailboxes

Returns true if the mailbox at the zero-based index specified by index can be selected or examined for message access.

isSigned() - Method in class com.chilkatsoft.chilkat2.Mime

Returns true when the current MIME entity is a complete CMS/PKCS #7 signed S/MIME wrapper, including detached multipart/signed and opaque signed-data forms.

isSmtpDsnCapable() - Method in class com.chilkatsoft.chilkat2.MailMan

Contacts the SMTP server and determines whether it supports the DSN, or Delivery Status Notification, extension defined by RFC 3461.

isSshConnected() - Method in class com.chilkatsoft.chilkat2.SshTunnel

Returns true when the SSH transport used by this tunnel is connected; otherwise returns false.

isText() - Method in class com.chilkatsoft.chilkat2.Mime

Returns true when Mime.getContentType() begins with text/.

isTimeValid(String, int) - Method in class com.chilkatsoft.chilkat2.Jwt

Checks the JWT exp (expiration time) and nbf (not before) claims against the current system time.

isValidUtf8() - Method in class com.chilkatsoft.chilkat2.BinData

Returns true if this object contains valid utf-8 byte sequences.

isVideo() - Method in class com.chilkatsoft.chilkat2.Mime

Returns true when Mime.getContentType() begins with video/.

isWellFormed(String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Returns true if the contents of this object are well-formed JSON or XML.

isWindows() - Static method in class com.chilkatsoft.chilkat2.Chilkat2Native

Whether the running JVM is on Windows (the Windows-only classes check this).

isXml() - Method in class com.chilkatsoft.chilkat2.Mime

Returns true only for text/xml or application/xml.

J

JavaKeyStore - Class in com.chilkatsoft.chilkat2

<section class="javakeystore-summary">

JavaKeyStore() - Constructor for class com.chilkatsoft.chilkat2.JavaKeyStore

Creates a new JavaKeyStore object.

Js - Class in com.chilkatsoft.chilkat2

<section class="js-summary">

Js() - Constructor for class com.chilkatsoft.chilkat2.Js

Creates a new Js object.

JsonArray - Class in com.chilkatsoft.chilkat2

<section class="jsonarray-summary">

JsonArray() - Constructor for class com.chilkatsoft.chilkat2.JsonArray

Creates a new JsonArray object.

JsonObject - Class in com.chilkatsoft.chilkat2

<section class="jsonobject-summary">

JsonObject() - Constructor for class com.chilkatsoft.chilkat2.JsonObject

Creates a new JsonObject object.

jsonTypeOf(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns an integer identifying the JSON type of the value at jsonPath.

Jwe - Class in com.chilkatsoft.chilkat2

<section class="jwe-summary">

Jwe() - Constructor for class com.chilkatsoft.chilkat2.Jwe

Creates a new Jwe object.

Jws - Class in com.chilkatsoft.chilkat2

<section class="jws-summary">

Jws() - Constructor for class com.chilkatsoft.chilkat2.Jws

Creates a new Jws object.

Jwt - Class in com.chilkatsoft.chilkat2

<section class="jwt-summary">

Jwt() - Constructor for class com.chilkatsoft.chilkat2.Jwt

Creates a new Jwt object.

L

largeFileUpload(String, String, int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Uploads the local file at localPath to the remote path at remotePath as a sequence of data transfers, each containing up to chunkSize bytes.

lastChild() - Method in class com.chilkatsoft.chilkat2.Xml

Returns an Xml object referencing the last direct child of the calling element.

lastChild2() - Method in class com.chilkatsoft.chilkat2.Xml

Moves the calling Xml object's internal reference to its last direct child.

lastDecryptCert(int, Cert) - Method in class com.chilkatsoft.chilkat2.Mime

Loads into cert the decryption certificate at zero-based index from the most recent successful decryption or security-unwrapping operation.

lastDecryptCert(Cert) - Method in class com.chilkatsoft.chilkat2.Crypt2

Returns in cert the last certificate used for public-key decryption.

lastDecryptCert(Cert) - Method in class com.chilkatsoft.chilkat2.Email

Returns in cert the certificate used to decrypt this email.

lastNLines(int, boolean) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Returns the last N lines of the text.

lastReadFailed(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Returns true if the most recent read associated with handle failed; otherwise returns false.

lastReadNumBytes(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Returns the number of bytes received by the most recent read associated with handle.

lastSignerCert(int, Cert) - Method in class com.chilkatsoft.chilkat2.Crypt2

Retrieves the Nth certificate used for signing in cert, where the first certificate is at index 0.

lastSignerCert(int, Cert) - Method in class com.chilkatsoft.chilkat2.Email

Copies the certificate for the signer at the zero-based index specified by index into cert.

lastSignerCert(int, Cert) - Method in class com.chilkatsoft.chilkat2.Mime

Loads into cert the signer certificate at zero-based index from the most recent successful signature-verification or security-unwrapping operation.

lastString() - Method in class com.chilkatsoft.chilkat2.StringArray

Returns the last string in the internal collection.

launchBrowser(String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Asks the operating system to open url in the user's default web browser.

leaveContext() - Method in class com.chilkatsoft.chilkat2.Log

Ends the current nested logging context and returns logging to its parent context.

linkedDomains(StringTable) - Method in class com.chilkatsoft.chilkat2.Email

Extracts domain names from hyperlinks in an HTML email.

linkPkcs11(Pkcs11) - Method in class com.chilkatsoft.chilkat2.Cert

Links to the certificate's private key located on an HSM (smart card, token, or cloud HSM).

listCerts(String, StringTable) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Lists the certs found on the smart card.

listConvos(StringTable) - Method in class com.chilkatsoft.chilkat2.Ai

Returns the full list of conversation names in st.

listPrompts(JsonObject) - Method in class com.chilkatsoft.chilkat2.Mcp

Calls the MCP prompts/list method.

listReaderGroups(StringTable) - Method in class com.chilkatsoft.chilkat2.SCard

Returns a list of currently available reader groups on the system.

listReaders(StringTable) - Method in class com.chilkatsoft.chilkat2.SCard

Returns a list of currently available readers on the system.

listResources(JsonObject) - Method in class com.chilkatsoft.chilkat2.Mcp

Calls the MCP resources/list method.

listSecrets(JsonObject, JsonObject) - Method in class com.chilkatsoft.chilkat2.Secrets

Lists secrets matching the wildcarded or exact values passed in json.

listTools(JsonObject) - Method in class com.chilkatsoft.chilkat2.Mcp

Calls the MCP tools/list method.

listXml(String) - Method in class com.chilkatsoft.chilkat2.Tar

Scans the uncompressed TAR archive at tarPath and returns an XML description of its files, directories, and archive metadata.

load(String) - Method in class com.chilkatsoft.chilkat2.JsonArray

Parses the JSON array text in jsonArray and loads it into this object.

load(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Parses the JSON text in json and loads the parsed data into this object for DOM-style access and modification.

loadAnyFormat(BinData, String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Loads a private key from the data in privKeyData by inspecting its contents.

loadAnyFormatFile(String, String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Loads a private key from the file at path by inspecting its contents.

loadAppFile(String) - Method in class com.chilkatsoft.chilkat2.Xmp

Loads a TIFF or JPG file into the XMP object.

loadAsnXml(String) - Method in class com.chilkatsoft.chilkat2.Asn

Loads ASN.1 from the XML representation (such as that created by the AsnToXml method).

loadBase64(String) - Method in class com.chilkatsoft.chilkat2.PublicKey

Loads a public key from standard Base64-encoded DER in keyStr.

loadBd(BinData) - Method in class com.chilkatsoft.chilkat2.Asn

Loads ASN.1 from the binary DER contained in bd.

loadBd(BinData) - Method in class com.chilkatsoft.chilkat2.JsonObject

Parses JSON from the bytes contained in bd and loads it into this object.

loadBd(BinData) - Method in class com.chilkatsoft.chilkat2.Pdf

Loads the PDF file contained in pdfData.

loadBd(BinData) - Method in class com.chilkatsoft.chilkat2.PublicKey

Loads a public key from the data in bd.

loadBd(BinData, boolean) - Method in class com.chilkatsoft.chilkat2.Xml

Parses XML from the bytes contained in bd and replaces the calling object's current XML tree with the loaded document.

loadBd(String, BinData) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Loads a JKS or JCEKS keystore from the bytes currently contained in bd.

loadBinaryFile(String) - Method in class com.chilkatsoft.chilkat2.Asn

Loads ASN.1 from a binary DER file.

loadBodyFromBd(BinData) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Uses the contents of the requestBody as the HTTP request body.

loadBodyFromFile(String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

The HTTP protocol is such that all HTTP requests are MIME.

loadBodyFromSb(StringBuilder, String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Uses the contents of the requestBody as the HTTP request body.

loadBodyFromString(String, String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

The HTTP protocol is such that all HTTP requests are MIME.

loadByCommonName(String) - Method in class com.chilkatsoft.chilkat2.Cert

This method searches for a certificate with the specified common name (CN) on different operating systems.

loadByEmailAddress(String) - Method in class com.chilkatsoft.chilkat2.Cert

This method searches for a certificate with the specified email address on different operating systems.

loadByIssuerAndSerialNumber(String, String) - Method in class com.chilkatsoft.chilkat2.Cert

This method searches for a certificate with the specified issuer common name (issuerCN) and serial number (serialNumber) on different operating systems.

loadBySubjectOid(String, String) - Method in class com.chilkatsoft.chilkat2.Cert

This method searches for a certificate containing a subject part matching the oid and value.

loadByThumbprint(String, String) - Method in class com.chilkatsoft.chilkat2.Cert

This method searches for a certificate with the specified thumbprint.

loadCaCertsPem(String) - Method in class com.chilkatsoft.chilkat2.TrustedRoots

Loads one or more PEM-encoded certificates from the file at path and adds them to this object's explicit trusted-certificate collection.

loadCsrPem(String) - Method in class com.chilkatsoft.chilkat2.Csr

Loads a PEM-encoded PKCS #10 Certificate Signing Request.

loadEcdsa(String, String, String) - Method in class com.chilkatsoft.chilkat2.PublicKey

Loads an elliptic-curve public key directly from its affine point coordinates.

loadEd25519(String) - Method in class com.chilkatsoft.chilkat2.PublicKey

Loads a raw Ed25519 public key from the hexadecimal string in pubKey.

loadEd25519(String, String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Loads an Ed25519 key pair from raw hexadecimal values.

loadEml(String) - Method in class com.chilkatsoft.chilkat2.Email

Loads a complete email from an .eml file.

loadEncoded(String, String) - Method in class com.chilkatsoft.chilkat2.Asn

Loads ASN.1 from an encoded string.

loadEncoded(String, String) - Method in class com.chilkatsoft.chilkat2.BinData

Loads binary data from an encoded string, replacing the current contents, if any.

loadEncoded(String, String, String) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Decodes the serialized keystore text in jksEncData using the binary encoding named by encoding, then loads the resulting JKS or JCEKS bytes.

loadEncryptedPem(String, String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Loads a private key from the PEM text in pemStr.

loadEncryptedPemFile(String, String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Loads a private key from the file at path, using password when the detected key is encrypted.

loadEvent(String) - Method in class com.chilkatsoft.chilkat2.ServerSentEvent

Loads the multi-line event text into this object.

loadFile(String) - Method in class com.chilkatsoft.chilkat2.BinData

Loads data from a file.

loadFile(String) - Method in class com.chilkatsoft.chilkat2.Csv

Clears the current contents and loads CSV data from the file specified by path.

loadFile(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Reads JSON text from the file at path, parses it, and loads the result into this object.

loadFile(String) - Method in class com.chilkatsoft.chilkat2.Pdf

Load a PDF file into this object in memory.

loadFile(String, String) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Loads a JKS or JCEKS keystore from the file at path.

loadFile(String, String) - Method in class com.chilkatsoft.chilkat2.SecureString

Loads the contents of a file into this secure string.

loadFile(String, String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Loads the contents of a file.

loadFile2(String, String) - Method in class com.chilkatsoft.chilkat2.Csv

Clears the current contents and loads CSV data from the file specified by filename.

loadFromBase64(String) - Method in class com.chilkatsoft.chilkat2.Cert

Loads an ASN.1 or DER encoded certificate represented in a Base64 string.

loadFromBd(BinData) - Method in class com.chilkatsoft.chilkat2.Cert

Loads an X.509 certificate from data contained in certBytes.

loadFromFile(String) - Method in class com.chilkatsoft.chilkat2.Cert

Loads a certificate from a .cer, .crt, .p7b, or .pem file.

loadFromFile(String) - Method in class com.chilkatsoft.chilkat2.PublicKey

Loads a public key from the local filesystem path specified by path.

loadFromFile(String) - Method in class com.chilkatsoft.chilkat2.StringArray

Loads strings from a file (one per line) into the internal collection.

loadFromFile2(String, String) - Method in class com.chilkatsoft.chilkat2.StringArray

Loads strings from a file (one per line) into the internal collection.

loadFromSmartcard(String) - Method in class com.chilkatsoft.chilkat2.Cert

Important: It's important to set the SmartCardPin property before calling this method.

loadFromString(String) - Method in class com.chilkatsoft.chilkat2.Csv

Clears the current contents and loads the CSV text contained in csvData.

loadFromString(String) - Method in class com.chilkatsoft.chilkat2.PublicKey

Loads a public key from the string in keyString.

loadFromText(String) - Method in class com.chilkatsoft.chilkat2.StringArray

Loads strings from an in-memory string (one per line) into the internal collection.

loadJwe(String) - Method in class com.chilkatsoft.chilkat2.Jwe

Loads jwe as JWE Compact Serialization, Flattened JWE JSON Serialization, or General JWE JSON Serialization.

loadJweSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Jwe

Loads the complete JWE text in sb.

loadJwk(String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Loads a private key from the JWK JSON in jsonStr.

loadJwkSet(String, JsonObject) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Loads supported keys from the JWK Set in jwkSet into this Java keystore object.

loadJws(String) - Method in class com.chilkatsoft.chilkat2.Jws

Loads a JWS from jwsStr.

loadJwsSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Jws

Loads a JWS from the current contents of sbJws.

loadMbxFile(String, EmailBundle) - Method in class com.chilkatsoft.chilkat2.MailMan

Loads emails from a .mbx mailbox file and stores them in bundle.

loadMime(String) - Method in class com.chilkatsoft.chilkat2.Mime

Parses the complete MIME text in mimeMsg and replaces the current object's headers, body, and multipart tree.

loadMimeBd(BinData) - Method in class com.chilkatsoft.chilkat2.Mime

Parses complete MIME bytes from bindat and replaces the current MIME on success.

loadMimeFile(String) - Method in class com.chilkatsoft.chilkat2.Mime

Reads and parses the complete MIME entity from the local file at fileName.

loadMimeSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Mime

Parses complete MIME text from sb and replaces the current MIME on success.

loadP7bFile(String) - Method in class com.chilkatsoft.chilkat2.Pem

Loads the contents of a PKCS7 container (.p7b file).

loadPem(String) - Method in class com.chilkatsoft.chilkat2.Cert

Loads the certificate from a PEM string.

loadPem(String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Loads a private key from the PEM text in str.

loadPem(String, String) - Method in class com.chilkatsoft.chilkat2.Pem

Loads the PEM from a PEM string.

loadPem(String, String) - Method in class com.chilkatsoft.chilkat2.Pfx

Loads one or more certificate/private-key identities from the PEM-formatted text in pemStr and builds the contents of this Pfx object.

loadPemFile(String) - Method in class com.chilkatsoft.chilkat2.CertStore

Loads the certificates contained within a PEM formatted file.

loadPemFile(String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Loads a private key from the file at path.

loadPemFile(String, String) - Method in class com.chilkatsoft.chilkat2.Pem

Loads the PEM from a PEM file.

loadPemStr(String) - Method in class com.chilkatsoft.chilkat2.CertStore

Loads the certificates contained within an in-memory PEM formatted string.

loadPfxBd(BinData, String) - Method in class com.chilkatsoft.chilkat2.Cert

Loads the certificate from the PFX contained in pfxData.

loadPfxBd(BinData, String) - Method in class com.chilkatsoft.chilkat2.CertStore

Loads the PFX/P12 bytes contained in bd.

loadPfxBd(BinData, String) - Method in class com.chilkatsoft.chilkat2.Pfx

Loads a PFX / PKCS#12 container from the bytes currently held in bd.

loadPfxEncoded(String, String, String) - Method in class com.chilkatsoft.chilkat2.Pfx

Decodes the text in encodedData using the binary encoding named by encoding, then loads the resulting bytes as a PFX / PKCS#12 container.

loadPfxFile(String, String) - Method in class com.chilkatsoft.chilkat2.Cert

Loads a PFX file.

loadPfxFile(String, String) - Method in class com.chilkatsoft.chilkat2.CertStore

Loads a PFX file.

loadPfxFile(String, String) - Method in class com.chilkatsoft.chilkat2.Pfx

Loads a PFX / PKCS#12 container from the file path in path.

loadPkcs1File(String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Loads a private key from the file at path.

loadPkcs8EncryptedFile(String, String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Loads a private key from the file at path, using password when the detected key is encrypted.

loadPkcs8File(String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Loads a private key from the file at path.

loadPredefined(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Loads this object from the predefined JSON document identified by name.

loadPublicKey(String, String, String) - Method in class com.chilkatsoft.chilkat2.Dkim

Loads and caches an RSA public key in this Dkim object for the exact selector and domain strings.

loadPublicKeyFile(String, String, String) - Method in class com.chilkatsoft.chilkat2.Dkim

Loads an RSA public key from the local file at publicKeyFilepath and caches it in this Dkim object for the exact selector and domain strings.

loadPvkFile(String, String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Loads a private key from the file at path, using password if the detected representation is encrypted.

loadSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.JsonArray

Parses the JSON array contained in sb and loads it into this object.

loadSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.JsonObject

Parses JSON from the current contents of sb and loads it into this object.

loadSb(StringBuilder, boolean) - Method in class com.chilkatsoft.chilkat2.Xml

Parses XML from the current contents of sb and replaces the calling object's current XML tree with the loaded document.

loadSignature(String) - Method in class com.chilkatsoft.chilkat2.XmlDSig

Loads an XML document containing 1 or more XML digital signatures.

loadSignatureBd(BinData) - Method in class com.chilkatsoft.chilkat2.XmlDSig

Loads an XML document containing one or more XML digital signatures from the contents of a BinData object.

loadSignatureSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.XmlDSig

Loads an XML document containing one or more XML digital signatures from the contents of a StringBuilder object.

loadText(String) - Method in class com.chilkatsoft.chilkat2.Dsa

Loads the entire file specified by path and returns its contents as text using the legacy ANSI character encoding.

loadText(String) - Method in class com.chilkatsoft.chilkat2.SshKey

Reads an entire text file and returns its contents as a string.

loadType3(String) - Method in class com.chilkatsoft.chilkat2.Ntlm

Parses an encoded Type 3 authenticate message received by server-side code and loads its client-supplied fields into this object.

loadX5C(JsonObject) - Method in class com.chilkatsoft.chilkat2.CertChain

Loads the certificate chain from the x5c member of the JWK contained in jwk.

loadXml(String) - Method in class com.chilkatsoft.chilkat2.Email

Loads an email from a Chilkat XML email file.

loadXml(String) - Method in class com.chilkatsoft.chilkat2.EmailBundle

Loads an email bundle from the local filesystem path specified by path.

loadXml(String) - Method in class com.chilkatsoft.chilkat2.Mime

Reconstructs a MIME tree from Chilkat's MIME XML in xml.

loadXml(String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Loads a private key from the XML text in xml.

loadXml(String) - Method in class com.chilkatsoft.chilkat2.Xml

Parses the XML text in xmlData and replaces the calling object's current XML tree content with the loaded document root.

loadXml(String) - Method in class com.chilkatsoft.chilkat2.XmlCertVault

Loads from an XML string.

loadXml2(String, boolean) - Method in class com.chilkatsoft.chilkat2.Xml

Parses the XML text in xmlData and replaces the current XML tree, like LoadXml.

loadXmlFile(String) - Method in class com.chilkatsoft.chilkat2.Mime

Reads Chilkat MIME XML from the local file at fileName and reconstructs the MIME tree.

loadXmlFile(String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Loads a private key from the file at path.

loadXmlFile(String) - Method in class com.chilkatsoft.chilkat2.Xml

Reads and parses an XML document from fileName, replacing the calling object's current XML tree with the loaded document root.

loadXmlFile(String) - Method in class com.chilkatsoft.chilkat2.XmlCertVault

Loads from an XML file.

loadXmlFile2(String, boolean) - Method in class com.chilkatsoft.chilkat2.Xml

Reads and parses an XML document from fileName, replacing the current XML tree.

loadXmlString(String) - Method in class com.chilkatsoft.chilkat2.Email

Loads an email from the Chilkat XML representation in xmlStr, typically obtained from Email.getXml().

loadXmlString(String) - Method in class com.chilkatsoft.chilkat2.EmailBundle

Loads an email bundle from the Chilkat XML string in xmlStr.

Log - Class in com.chilkatsoft.chilkat2

<section class="log-summary">

Log() - Constructor for class com.chilkatsoft.chilkat2.Log

Creates a new Log object.

logData(String, String) - Method in class com.chilkatsoft.chilkat2.Log

Adds a tagged text value to the current context.

logDataMax(String, String, int) - Method in class com.chilkatsoft.chilkat2.Log

Adds a tagged text value to the current context, but limits the logged value to at most the first maxNumChars characters of message.

logDateTime(String, boolean) - Method in class com.chilkatsoft.chilkat2.Log

Logs the current date and time under tag using an RFC 822-style date/time representation.

logError(String) - Method in class com.chilkatsoft.chilkat2.Log

Adds message as an error entry in the current logging context.

login(int, String) - Method in class com.chilkatsoft.chilkat2.Pkcs11

Authenticates a session with a PIN.

login(String, String) - Method in class com.chilkatsoft.chilkat2.Imap

Authenticates the connected IMAP session using the login name in loginName and the credential in password.

loginAfterConnectOnly() - Method in class com.chilkatsoft.chilkat2.Ftp2

Authenticates an FTP control connection previously established by Ftp2.connectOnly().

logInfo(String) - Method in class com.chilkatsoft.chilkat2.Log

Adds message as an informational entry in the current logging context.

loginSecure(SecureString, SecureString) - Method in class com.chilkatsoft.chilkat2.Imap

Authenticates the connected IMAP session using the SecureString login name in loginName and credential in password.

logInt(String, int) - Method in class com.chilkatsoft.chilkat2.Log

Adds the integer value to the current log under tag.

logInt64(String, long) - Method in class com.chilkatsoft.chilkat2.Log

Adds the signed 64-bit integer value to the current log under tag.

logout() - Method in class com.chilkatsoft.chilkat2.Imap

Sends the IMAP LOGOUT command and ends the authenticated session.

logout() - Method in class com.chilkatsoft.chilkat2.Pkcs11

Logs out from a token (smart card).

logTimestamp(String) - Method in class com.chilkatsoft.chilkat2.Log

Logs the current time-of-day under tag in HH:MM:SS:mmm form, where mmm represents milliseconds.

lookupInt(String) - Method in class com.chilkatsoft.chilkat2.Hashtable

Returns the integer value associated with the string key key.

lookupStr(String) - Method in class com.chilkatsoft.chilkat2.Hashtable

Returns the string value associated with the string key key.

lowerCase(String) - Method in class com.chilkatsoft.chilkat2.Charset

Returns the lowercase form of inStr using Chilkat’s Unicode case conversion.

M

macBdENC(BinData) - Method in class com.chilkatsoft.chilkat2.Crypt2

Generates a Message Authentication Code (MAC) for the bytes in bd using the algorithm defined by the Crypt2.getMacAlgorithm() property.

macStringENC(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Computes a Message Authentication Code (MAC) and returns it as a binary encoded string.

Mailboxes - Class in com.chilkatsoft.chilkat2

<section class="mailboxes-summary">

Mailboxes() - Constructor for class com.chilkatsoft.chilkat2.Mailboxes

Creates a new Mailboxes object.

MailMan - Class in com.chilkatsoft.chilkat2

<section class="mailman-summary">

MailMan() - Constructor for class com.chilkatsoft.chilkat2.MailMan

Creates a new MailMan object.

makeCopy(Email) - Method in class com.chilkatsoft.chilkat2.Email

Copies the entire state of this email into destEmail, including all message content, recipients, headers, body representations, attachments, related items, embedded messages, replacement patterns, certificates, certificate sources, and configuration properties.

makeCopy(JsonObject) - Method in class com.chilkatsoft.chilkat2.JsonObject

Copies this JSON object into json.

markdownToHtml(JsonObject, StringBuilder) - Method in class com.chilkatsoft.chilkat2.StringBuilder

This method converts the Markdown content of this object to HTML, storing the result in sbHtml.

maskQuotedStrings(String, int, StringTable) - Method in class com.chilkatsoft.chilkat2.StringBuilder

This function masks the content inside single and/or double-quoted strings by replacing it with a specified mask character (maskChar).

mbxList(boolean, String, String, Mailboxes) - Method in class com.chilkatsoft.chilkat2.Imap

Lists matching mailboxes and appends them to the Mailboxes object in mboxes.

Mcp - Class in com.chilkatsoft.chilkat2

<section class="mcp-summary">

Mcp() - Constructor for class com.chilkatsoft.chilkat2.Mcp

Creates a new Mcp object.

MessageSet - Class in com.chilkatsoft.chilkat2

<section class="messageset-summary">

MessageSet() - Constructor for class com.chilkatsoft.chilkat2.MessageSet

Creates a new MessageSet object.

mGetFiles(String, String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Downloads files in the current remote directory that match remotePattern into the existing local directory at localDir.

Mht - Class in com.chilkatsoft.chilkat2

<section class="mht-summary">

Mht() - Constructor for class com.chilkatsoft.chilkat2.Mht

Creates a new Mht object.

Mime - Class in com.chilkatsoft.chilkat2

<section class="mime-summary">

Mime() - Constructor for class com.chilkatsoft.chilkat2.Mime

Creates a new Mime object.

moveMember(int, int) - Method in class com.chilkatsoft.chilkat2.JsonObject

Moves the direct member at zero-based position fromIndex to toIndex.

moveMessages(MessageSet, String) - Method in class com.chilkatsoft.chilkat2.Imap

Moves the messages identified by the MessageSet in messageSet from the selected mailbox to destination mailbox destFolder using one IMAP MOVE command.

mPutFiles(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Uploads each local file matching pattern to the current remote directory.

mySqlAesDecrypt(String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Matches MySQL's AES_DECRYPT function.

mySqlAesEncrypt(String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

This function replicates MySQL's AES_ENCRYPT, returning the encrypted data as a hex-encoded string.

N

nameAt(int) - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns the name of the member at zero-based position index.

newArrayOf(String, String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Creates a JSON array at path and loads that array from the JSON text in jArr.

newChild(String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Creates and returns a new child at tagPath with the specified text content.

newChild2(String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Creates a new child at tagPath with the specified text content, but does not return a separate Xml object for the new element.

newChildAfter(int, String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Creates a new direct child with the specified tag and content, inserts it immediately after the child at zero-based index, and returns the new child element.

newChildBefore(int, String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Creates a new direct child with the specified tag and content, inserts it immediately before the child at zero-based index, and returns the new child element.

newChildInt2(String, int) - Method in class com.chilkatsoft.chilkat2.Xml

Creates a new child at tagPath whose content is the decimal representation of value.

newConvo(String, String, String) - Method in class com.chilkatsoft.chilkat2.Ai

Creates and initializes a transcript for a new conversation.

newMessageRfc822(Mime) - Method in class com.chilkatsoft.chilkat2.Mime

Clears the current object and initializes it as message/rfc822.

newMultipartAlternative() - Method in class com.chilkatsoft.chilkat2.Mime

Initializes an empty multipart/alternative entity.

newMultipartMixed() - Method in class com.chilkatsoft.chilkat2.Mime

Initializes an empty multipart/mixed entity.

newMultipartRelated() - Method in class com.chilkatsoft.chilkat2.Mime

Initializes an empty multipart/related entity.

newObjectOf(String, String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Creates a JSON object at path and loads that object from the JSON text in jObj.

newXmp() - Method in class com.chilkatsoft.chilkat2.Xmp

Creates and returns a new/empty XMP metadata document as a Chilkat XML object.

newZip(String) - Method in class com.chilkatsoft.chilkat2.Zip

Initializes a new empty ZIP archive.

nextAiEvent(int, StringBuilder, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Ai

Retrieves the next available AI streaming mode response update.

nextInTraversal2(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Xml

Moves the calling Xml object to the next element in a depth-first traversal of the tree and updates sbState with the traversal state.

nextSibling() - Method in class com.chilkatsoft.chilkat2.Xml

Returns an Xml object referencing the current element's next sibling, or no object when there is no next sibling.

nextSibling2() - Method in class com.chilkatsoft.chilkat2.Xml

Moves the calling Xml object's internal reference to its next sibling.

nlstXml(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sends NLST with remoteDirPattern appended literally and returns the names in XML form.

noop() - Method in class com.chilkatsoft.chilkat2.Ftp2

Sends the FTP NOOP command.

noop() - Method in class com.chilkatsoft.chilkat2.Imap

Sends the IMAP NOOP command and waits for the server response.

Ntlm - Class in com.chilkatsoft.chilkat2

<section class="ntlm-summary">

Ntlm() - Constructor for class com.chilkatsoft.chilkat2.Ntlm

Creates a new Ntlm object.

numChildrenAt(String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the number of direct children of the element selected by tagPath.

numChildrenHavingTag(String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the number of direct children whose tag exactly equals tag.

numDkimSigs(BinData) - Method in class com.chilkatsoft.chilkat2.Dkim

Returns the number of header fields named DKIM-Signature in mimeData.

O

OAuth1 - Class in com.chilkatsoft.chilkat2

<section class="oauth1-summary">

OAuth1() - Constructor for class com.chilkatsoft.chilkat2.OAuth1

Creates a new OAuth1 object.

OAuth2 - Class in com.chilkatsoft.chilkat2

OAuth2 Authorization Code Flow

OAuth2() - Constructor for class com.chilkatsoft.chilkat2.OAuth2

Creates a new OAuth2 object.

obfuscate() - Method in class com.chilkatsoft.chilkat2.StringBuilder

Obfuscates the string.

objectAt(int) - Method in class com.chilkatsoft.chilkat2.JsonArray

Returns the JSON object stored at zero-based position index.

objectAt(int) - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns the JSON object stored in the member at zero-based position index.

objectAt2(int, JsonObject) - Method in class com.chilkatsoft.chilkat2.JsonArray

Updates jsonObj so that it references the JSON object stored at zero-based position index.

objectAt2(int, JsonObject) - Method in class com.chilkatsoft.chilkat2.JsonObject

Updates jsonObj to reference the JSON object stored at zero-based member position index and returns true on success.

objectOf(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns the JSON object at jsonPath.

objectOf2(String, JsonObject) - Method in class com.chilkatsoft.chilkat2.JsonObject

Updates jsonObj to reference the JSON object at jsonPath and returns true on success.

obtainAccessToken(Socket) - Method in class com.chilkatsoft.chilkat2.AuthGoogle

Sends the HTTP request to fetch the access token.

ocspCheck(String, int) - Method in class com.chilkatsoft.chilkat2.Http

Gets the server certificate at a domain:port and then sends an OCSP request to the certificate's OCSP URL to determine if the certificate has been revoked.

olderThan(int, String) - Method in class com.chilkatsoft.chilkat2.DateTime

Returns true if the date/time is older than the current system date/time by n seconds/minutes/hours/days.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Ai

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.AuthGoogle

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Bz2

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Cert

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.CodeSign

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Compression

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Crypt2

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Dkim

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Dns

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Ftp2

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Gzip

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Http

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Imap

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Js

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.MailMan

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Mcp

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Mht

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.OAuth2

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Pdf

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Rest

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.SCard

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Scp

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Secrets

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.SFtp

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Socket

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Spider

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Ssh

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Stream

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Tar

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.TrustedRoots

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.UnixCompress

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Upload

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.WebSocket

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.Zip

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.ZipCrc

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onAbortCheck(BooleanSupplier) - Method in class com.chilkatsoft.chilkat2.ZipEntry

Installs a listener whose only callback is abortCheck: called every HeartbeatMs milliseconds during a long-running method; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Ai

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.AuthGoogle

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Bz2

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Cert

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.CodeSign

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Compression

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Crypt2

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Dkim

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Dns

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Ftp2

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Gzip

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Http

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Imap

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Js

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.MailMan

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Mcp

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Mht

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.OAuth2

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Pdf

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Rest

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.SCard

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Scp

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Secrets

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.SFtp

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Socket

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Spider

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Ssh

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Stream

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Tar

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.TrustedRoots

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.UnixCompress

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Upload

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.WebSocket

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.Zip

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.ZipCrc

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onPercentDone(IntPredicate) - Method in class com.chilkatsoft.chilkat2.ZipEntry

Installs a listener whose only callback is percentDone: called with the completion percentage (0..100) as a long-running method progresses; return true to abort it.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Ai

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.AuthGoogle

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Bz2

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Cert

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.CodeSign

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Compression

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Crypt2

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Dkim

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Dns

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Ftp2

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Gzip

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Http

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Imap

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Js

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.MailMan

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Mcp

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Mht

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.OAuth2

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Pdf

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Rest

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.SCard

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Scp

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Secrets

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.SFtp

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Socket

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Spider

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Ssh

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Stream

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Tar

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.TrustedRoots

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.UnixCompress

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Upload

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.WebSocket

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.Zip

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.ZipCrc

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

onProgressInfo(BiConsumer<String, String>) - Method in class com.chilkatsoft.chilkat2.ZipEntry

Installs a listener whose only callback is progressInfo: called with a name/value pair of progress information as a long-running method proceeds.

opaqueSignBd(BinData) - Method in class com.chilkatsoft.chilkat2.Crypt2

Digitally signs the contents of bd.

opaqueSignStringENC(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Digitally signs a string and returns PKCS#7 signed-data as a binary encoded string.

opaqueVerifyBd(BinData) - Method in class com.chilkatsoft.chilkat2.Crypt2

The method performs in-place verification of the PKCS#7 signed-data content of bd.

opaqueVerifyStringENC(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

This function verifies a PKCS#7 signed-data binary-encoded signature and returns the original text data.

openBd(BinData) - Method in class com.chilkatsoft.chilkat2.Zip

Opens a ZIP archive contained entirely within a BinData object.

openCurrentUserStore(boolean) - Method in class com.chilkatsoft.chilkat2.CertStore

On Windows, this method opens the Current-User\Personal certificate store in the registry.

openCustomChannel(String) - Method in class com.chilkatsoft.chilkat2.Ssh

Requests a custom SSH channel whose application-defined channel type is supplied in channelType.

openDir(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Opens the remote directory specified by path and returns a handle for reading its entries.

openDirectTcpIpChannel(String, int) - Method in class com.chilkatsoft.chilkat2.Ssh

Opens a direct-tcpip channel through the SSH server to targetHostname and targetPort.

openEmbedded(String, String) - Method in class com.chilkatsoft.chilkat2.Zip

(Windows only)

openFile(String, String, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Opens or creates the remote file at remotePath and returns a handle for subsequent read or write operations.

openFileStore(String, boolean) - Method in class com.chilkatsoft.chilkat2.CertStore

(This method only available on Microsoft Windows operating systems.)
Opens a file-based certificate store.

openForAppend(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Opens filePath for writing at end-of-file.

openForRead(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Opens an existing filePath for reading.

openForReadWrite(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Opens filePath for both reading and writing.

openForWrite(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Opens filePath for writing.

openLocalSystemStore(boolean) - Method in class com.chilkatsoft.chilkat2.CertStore

(This method is only available on Microsoft Windows operating systems.)
Opens the registry-based Local-Computer\Personal certificate store.

openRegistryStore(String, String, boolean) - Method in class com.chilkatsoft.chilkat2.CertStore

(This method only available on Microsoft Windows operating systems.)
Opens an arbitrary registry-based certificate store.

openSession(int, boolean) - Method in class com.chilkatsoft.chilkat2.Pkcs11

Opens a session on the token (i.e.

openSessionChannel() - Method in class com.chilkatsoft.chilkat2.Ssh

Opens a new SSH session channel.

openSmartcard(String) - Method in class com.chilkatsoft.chilkat2.CertStore

This function identifies connected HSM devices such as smart cards and USB tokens, and loads the certificates from each device.

openSmtpConnection() - Method in class com.chilkatsoft.chilkat2.MailMan

Explicitly opens a connection to the SMTP server and authenticates if a username and password, OAuth2 token, or other applicable authentication settings have been provided.

openWindowsStore(String, String, boolean) - Method in class com.chilkatsoft.chilkat2.CertStore

(This method only available on Microsoft Windows operating systems.)
Opens a Microsoft Windows certificate store.

openZip(String) - Method in class com.chilkatsoft.chilkat2.Zip

Opens a ZIP archive from the local filesystem.

optimize(String, JsonObject, JsonObject) - Method in class com.chilkatsoft.chilkat2.Pdf

Measures and shrinks the loaded PDF without changing how any page looks.

P

parseOcspReply(BinData, JsonObject) - Method in class com.chilkatsoft.chilkat2.Http

Parses an OCSP reply.

parseType1(String) - Method in class com.chilkatsoft.chilkat2.Ntlm

Parses an encoded Type 1 negotiate message and returns human-readable XML describing its fields, including negotiation flags and any supplied domain or workstation information.

parseType2(String) - Method in class com.chilkatsoft.chilkat2.Ntlm

Parses an encoded Type 2 challenge message and returns human-readable XML describing its fields, including flags, target name, server challenge, and target-information AV pairs when present.

parseType3(String) - Method in class com.chilkatsoft.chilkat2.Ntlm

Parses an encoded Type 3 authenticate message and returns human-readable XML describing its fields, including the reported username, domain, workstation, and challenge-response data.

parseUrl(String) - Method in class com.chilkatsoft.chilkat2.Url

Parses a full URL.

partAt(int, Mime) - Method in class com.chilkatsoft.chilkat2.Mime

Provides live access to the direct child at zero-based index through subPart.

partsToFiles(String, StringTable) - Method in class com.chilkatsoft.chilkat2.Mime

Recursively traverses the MIME tree and saves each part having a nonempty filename parameter to the existing directory in path.

pbkdf1(String, String, String, String, int, int, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

This function implements the PBKDF1 (Password-Based Key Derivation Function #1) algorithm.

pbkdf2(String, String, String, String, int, int, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Implements the PBKDF2 algorithm as follows: Convert password to the character encoding specified by charset before using it in the key derivation function.

Pdf - Class in com.chilkatsoft.chilkat2

PDF Signing, Metadata, and Attachments

Pdf() - Constructor for class com.chilkatsoft.chilkat2.Pdf

Creates a new Pdf object.

peekReceivedText(int, String) - Method in class com.chilkatsoft.chilkat2.Ssh

Returns the text currently buffered in the normal receive buffer for channelNum, decoded using charset, without removing any bytes.

Pem - Class in com.chilkatsoft.chilkat2

<section class="pem-summary">

Pem() - Constructor for class com.chilkatsoft.chilkat2.Pem

Creates a new Pem object.

pemFileToDerFile(String, String) - Method in class com.chilkatsoft.chilkat2.Cert

Converts a PEM file to a DER file.

percentDone(int) - Method in interface com.chilkatsoft.chilkat2.ProgressListener

Called as a long-running method progresses, where the library can measure progress.

Pfx - Class in com.chilkatsoft.chilkat2

<section class="pfx-summary">

Pfx() - Constructor for class com.chilkatsoft.chilkat2.Pfx

Creates a new Pfx object.

pinAuthenticate(String, String) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Performs regular PIN authentication.

pinAuthenticateHex(String, String) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

The same as PinAutheneticate, but the PIN is passed as a hex string.

pinChange(String, String, String) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Changes a PIN.

pinDeauthenticate(String) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Reverses a previous PIN authentication without resetting the card.

Pkcs11 - Class in com.chilkatsoft.chilkat2

<section class="pkcs11-summary">

Pkcs11() - Constructor for class com.chilkatsoft.chilkat2.Pkcs11

Creates a new Pkcs11 object.

platform() - Static method in class com.chilkatsoft.chilkat2.Chilkat2Native

The platform string of the running JVM: the directory name of a bundled library (/com/chilkatsoft/chilkat2/native/<platform>/) and of the extraction directory.

pollAi(boolean) - Method in class com.chilkatsoft.chilkat2.Ai

Returns immediately with one of the following values:

pollDataAvailable() - Method in class com.chilkatsoft.chilkat2.Socket

Performs a nonblocking check for readable activity on the socket.

pollDataAvailable() - Method in class com.chilkatsoft.chilkat2.WebSocket

Checks whether bytes are currently waiting to be read from the underlying WebSocket connection.

pop() - Method in class com.chilkatsoft.chilkat2.StringArray

Returns the last string and removes it from the internal collection.

pop3Authenticate() - Method in class com.chilkatsoft.chilkat2.MailMan

Authenticates with the POP3 server using the current POP3 property settings, such as MailMan.getPopUsername(), MailMan.getPopPassword(), and any authentication-related options.

pop3BeginSession() - Method in class com.chilkatsoft.chilkat2.MailMan

Explicitly begins a POP3 session by connecting to the POP3 server and authenticating using the current POP3 property settings.

pop3Connect() - Method in class com.chilkatsoft.chilkat2.MailMan

Explicitly connects to the POP3 server.

pop3EndSession() - Method in class com.chilkatsoft.chilkat2.MailMan

Sends the POP3 QUIT command and closes the current POP3 connection.

pop3EndSessionNoQuit() - Method in class com.chilkatsoft.chilkat2.MailMan

Closes the POP3 connection without sending the QUIT command.

pop3Noop() - Method in class com.chilkatsoft.chilkat2.MailMan

Sends a POP3 NOOP command to the server.

pop3Reset() - Method in class com.chilkatsoft.chilkat2.MailMan

Sends the POP3 RSET command to the server.

pop3SendRawCommand(String, String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sends a raw command to the POP3 server and returns the server's response.

predefine(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Stores this JSON document in Chilkat's internal global collection of predefined JSON documents under name.

prefetchPublicKey(String, String) - Method in class com.chilkatsoft.chilkat2.Dkim

Retrieves the DKIM public key from DNS and caches it in this Dkim object for the exact selector and domain strings.

preLoadCheck(String, JsonObject) - Method in class com.chilkatsoft.chilkat2.Pdf

Reports what can be known about a PDF file's encryption before it is loaded, so that an application can decide which password or certificate it needs: whether the file is encrypted, by which method and algorithm, whether a password is needed to open it, what a user may do with it, or which certificates can open it.

preLoadCheckBd(BinData, JsonObject) - Method in class com.chilkatsoft.chilkat2.Pdf

The same as Pdf.preLoadCheck(String, JsonObject), but examines the PDF contained in bd instead of a file.

prepend(String) - Method in class com.chilkatsoft.chilkat2.StringArray

Adds a string to the beginning of the internal collection.

prepend(String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Prepends a copy of the specified string to this instance.

previousSibling() - Method in class com.chilkatsoft.chilkat2.Xml

Returns an Xml object referencing the current element's previous sibling, or no object when there is no previous sibling.

previousSibling2() - Method in class com.chilkatsoft.chilkat2.Xml

Moves the calling Xml object's internal reference to its previous sibling.

PrivateKey - Class in com.chilkatsoft.chilkat2

<section class="privatekey-summary">

PrivateKey() - Constructor for class com.chilkatsoft.chilkat2.PrivateKey

Creates a new PrivateKey object.

privateKeyAt(int, PrivateKey) - Method in class com.chilkatsoft.chilkat2.Pem

Returns in privKey the Nth private key from the PEM.

privateKeyAt(int, PrivateKey) - Method in class com.chilkatsoft.chilkat2.Pfx

Copies the private key at the zero-based index index into privKey.

privateKeyAt(String, int, PrivateKey) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Loads privKey with the private key at zero-based index index.

privateKeyOf(String, String, boolean, PrivateKey) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Searches the private-key entries for an alias equal to aliasName and loads the matching private key into privKey.

Prng - Class in com.chilkatsoft.chilkat2

<section class="prng-summary">

Prng() - Constructor for class com.chilkatsoft.chilkat2.Prng

Creates a new Prng object.

progressInfo(String, String) - Method in interface com.chilkatsoft.chilkat2.ProgressListener

Called with a name/value pair of progress information as a long-running method proceeds.

ProgressListener - Interface in com.chilkatsoft.chilkat2

Receives the progress events of an event-capable Chilkat object during its long-running methods.

protection(String, JsonObject, JsonObject) - Method in class com.chilkatsoft.chilkat2.Pdf

Encrypts the loaded PDF, removes or changes its encryption, passwords and permissions, or reports its security settings.

pruneAttribute(String) - Method in class com.chilkatsoft.chilkat2.Xml

Recursively traverses the subtree rooted at the calling element and removes every occurrence of the attribute named attrName.

pruneTag(String) - Method in class com.chilkatsoft.chilkat2.Xml

Recursively traverses the subtree rooted at the calling element and removes every element whose tag equals tag.

PublicKey - Class in com.chilkatsoft.chilkat2

<section class="publickey-summary">

PublicKey() - Constructor for class com.chilkatsoft.chilkat2.PublicKey

Creates a new PublicKey object.

publicKeyAt(int, PublicKey) - Method in class com.chilkatsoft.chilkat2.Pem

Returns in pubKey the Nth public key from the PEM.

punyDecode() - Method in class com.chilkatsoft.chilkat2.StringBuilder

In-place decodes the string from punycode.

punyEncode() - Method in class com.chilkatsoft.chilkat2.StringBuilder

In-place encodes the string to punycode.

putFile(String, String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Uploads the local filesystem file at localFilePath to the remote path at remoteFilePath.

putFileBd(BinData, String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Uploads the bytes contained in the BinData object in binData to the remote path at remoteFilePath.

putFileFromTextData(String, String, String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Encodes the text in textData using the character encoding named by charset and uploads the resulting bytes to the remote file at remoteFilename.

putFileSb(StringBuilder, String, boolean, String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Encodes the text in the StringBuilder sb using the charset named by charset and uploads it to the remote path at remoteFilePath.

putPlan(String, String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Executes the upload plan in plan.

putTree(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Uploads the local directory tree rooted at localDir into the current remote directory, creating remote subdirectories as needed.

Q

qEncodeString(String, String) - Method in class com.chilkatsoft.chilkat2.Email

Converts the Unicode string in str to the charset specified by charset, Q-encodes the resulting multibyte data, and returns the encoded string.

qrCode(String, JsonObject, JsonObject) - Method in class com.chilkatsoft.chilkat2.Formats

The same as Barcode with the symbology defaulting to "qr", so the smallest request is { "payload": { "text": "..." } }.

query(String, String, JsonObject) - Method in class com.chilkatsoft.chilkat2.Dns

Performs an DNS query for domain and returns the answer in answer.

queryMbx(String, boolean, MessageSet) - Method in class com.chilkatsoft.chilkat2.Imap

Searches the selected mailbox using the IMAP criteria in criteria and stores matching identifiers in the MessageSet in msgSet.

queryThread(String, String, boolean, JsonObject) - Method in class com.chilkatsoft.chilkat2.Imap

Sends the IMAP THREAD command for the selected mailbox.

quickAppend(String) - Method in class com.chilkatsoft.chilkat2.Zip

Efficiently appends additional entries to an existing ZIP archive.

quickCmdCheck(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Waits up to pollTimeoutMs milliseconds for any command previously started by Ssh.quickCmdSend(String) to complete.

quickCmdSend(String) - Method in class com.chilkatsoft.chilkat2.Ssh

Starts a remote command and immediately returns its channel number, allowing multiple commands to run concurrently on the same authenticated SSH connection.

quickCommand(String, String) - Method in class com.chilkatsoft.chilkat2.Ssh

Executes one noninteractive remote command and returns the stdout collected as text.

quickDeleteStr(String) - Method in class com.chilkatsoft.chilkat2.Http

This function sends an HTTP DELETE request to a specified URL and returns the response body as a string.

quickGetBd(String, BinData) - Method in class com.chilkatsoft.chilkat2.Http

This function sends an HTTP GET request to a specified URL, which can include query parameters, and returns the binary response body in binData.

quickGetSb(String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Http

This function sends an HTTP GET request to a specified URL, which can include query parameters, and returns the text response body in sbContent.

quickGetStr(String) - Method in class com.chilkatsoft.chilkat2.Http

This function sends an HTTP GET request to a specified URL, which can include query parameters, and returns the text response body.

quickSend(String, String, String, String, String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sends a simple email to a single recipient without requiring the application to explicitly create an Email object.

quickSession(int, String) - Method in class com.chilkatsoft.chilkat2.Pkcs11

Quickly establishes a session on the 1st unempty slot, with or without login.

quickShell() - Method in class com.chilkatsoft.chilkat2.Ssh

Starts a remote shell using the simplified sequence OpenSessionChannel → SendReqPty → SendReqShell.

quote(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sends the raw FTP command text in cmd to the server.

R

randomInt(int, int) - Method in class com.chilkatsoft.chilkat2.Prng

Returns a pseudorandom integer in the inclusive range from low through high.

randomizeIV() - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the initialization vector (IV) to a random value.

randomPassword(int, boolean, boolean, String, String) - Method in class com.chilkatsoft.chilkat2.Prng

Generates a password of exactly length characters while applying the requested composition rules:

randomString(int, boolean, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.Prng

Generates a string of exactly length characters.

rawCommandBd(BinData, BinData) - Method in class com.chilkatsoft.chilkat2.Imap

Sends the raw IMAP command bytes in the BinData in bdCmd and stores the raw response bytes in bdResp.

readBd(BinData) - Method in class com.chilkatsoft.chilkat2.Stream

Read as much data as is immediately available on the stream.

readBinaryToEncoded(String, String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Reads the entire file at filePath as binary data and returns an encoded textual representation.

readBlockBd(int, int, BinData) - Method in class com.chilkatsoft.chilkat2.FileAccess

Reads the zero-based block blockIndex from the currently open file, using blockSize bytes per block, and appends the bytes to bd.

readBytesENC(String) - Method in class com.chilkatsoft.chilkat2.Stream

The same as ReadBytes, except returns the received bytes in encoded string form.

readDirListing(String, SFtpDir) - Method in class com.chilkatsoft.chilkat2.SFtp

Reads all remaining directory entries from handle, which must have been returned by SFtp.openDir(String), and stores them in dirObj.

readEntireTextFile(String, String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Reads the entire file at filePath, decodes its bytes using charset, and returns the resulting text.

readFile(String, String, BinData) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Reads the entire file specified by dirName and fileName into bd.

readFileBd(String, int, BinData) - Method in class com.chilkatsoft.chilkat2.SFtp

Reads up to numBytes bytes from the current position of the remote file identified by handle and appends them to bd.

readFileText(String, int, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Reads up to numBytes bytes from the current position of handle, decodes the bytes using charset, and returns the resulting text.

readFileText32(String, int, int, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Reads up to numBytes bytes from handle at the 32-bit byte offset, decodes the bytes using charset, and returns the resulting text.

readFileText64(String, long, int, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Reads up to numBytes bytes from handle at the 64-bit byte offset, decodes the bytes using charset, and returns the resulting text.

readFileText64s(String, String, int, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Reads up to numBytes bytes from handle at the byte offset supplied as decimal string offset, decodes the bytes using charset, and returns the resulting text.

readFileToString(String, String) - Method in class com.chilkatsoft.chilkat2.Charset

Reads the text file at path, decodes its bytes using the charset named by charset, and returns the resulting Unicode string.

readFrame() - Method in class com.chilkatsoft.chilkat2.WebSocket

Reads the next WebSocket frame from the connected server.

readLink(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Returns the target path stored in the symbolic link at remote path.

readNBytesENC(int, String) - Method in class com.chilkatsoft.chilkat2.Stream

The same as ReadNBytes, except returns the received bytes in encoded string form.

readNextFragment(boolean, String, String, String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.FileAccess

Scans the currently open file for the next text fragment beginning with beginMarker and ending with endMarker.

readResource(String, JsonObject) - Method in class com.chilkatsoft.chilkat2.Mcp

Calls the MCP resources/read method for the resource identified by the URI in uri.

readRespBd(BinData) - Method in class com.chilkatsoft.chilkat2.Rest

Reads the response body as raw bytes into the BinData in responseBody, replacing its previous contents.

readRespBodyStream(Stream, boolean) - Method in class com.chilkatsoft.chilkat2.Rest

Reads the response body into the Stream supplied in stream.

readRespBodyString() - Method in class com.chilkatsoft.chilkat2.Rest

Reads the response body as text and returns it.

readRespChunkBd(int, BinData) - Method in class com.chilkatsoft.chilkat2.Rest

After Rest.readResponseHeader() has been called, reads the next chunk of the response body and appends the received bytes to the BinData in bd.

readResponseHeader() - Method in class com.chilkatsoft.chilkat2.Rest

Reads the HTTP response status line and header fields.

readRespSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Rest

Reads the response body as text into the StringBuilder in responseBody, replacing its previous contents.

readSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Stream

Read as much data as is immediately available on the stream.

readString() - Method in class com.chilkatsoft.chilkat2.Stream

Read as much data as is immediately available on the stream.

readToCRLF() - Method in class com.chilkatsoft.chilkat2.Stream

Reads the stream until a CRLF is received.

readUntilMatch(String) - Method in class com.chilkatsoft.chilkat2.Stream

Reads the stream until the string indicated by matchStr is received.

realPath(String, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Asks the server to canonicalize originalPath and returns the resulting absolute remote path.

reassembleFile(String, String, String, String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Reassembles a file previously divided by SplitFile.

receiveBd(BinData) - Method in class com.chilkatsoft.chilkat2.Socket

Receives one delivery of binary data and appends it to binData.

receiveBdN(long, BinData) - Method in class com.chilkatsoft.chilkat2.Socket

Receives exactly numBytes bytes and appends them to binData.

receiveByte(boolean) - Method in class com.chilkatsoft.chilkat2.Socket

Reads exactly one byte from the connection and stores its numeric value in ReceivedInt.

receiveBytesENC(String) - Method in class com.chilkatsoft.chilkat2.Socket

Receives binary data and returns one delivery encoded as text using encodingAlg.

receiveBytesToFile(String) - Method in class com.chilkatsoft.chilkat2.Socket

Receives one available block of bytes and appends it to the file named by appendFilename.

receiveCount() - Method in class com.chilkatsoft.chilkat2.Socket

Reads exactly four bytes and interprets them as a signed 32-bit two's-complement integer.

receiveInt16(boolean, boolean) - Method in class com.chilkatsoft.chilkat2.Socket

Reads exactly two bytes, interprets them as a two's-complement integer, and stores the result in ReceivedInt.

receiveInt32(boolean) - Method in class com.chilkatsoft.chilkat2.Socket

Reads exactly four bytes, interprets them as a signed two's-complement integer, and stores the result in ReceivedInt.

receiveNBytesENC(long, String) - Method in class com.chilkatsoft.chilkat2.Socket

Receives exactly numBytes bytes and returns them encoded using encodingAlg.

receiveSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Socket

Receives text, decodes it using StringCharset, and appends it to sb.

receiveString() - Method in class com.chilkatsoft.chilkat2.Socket

Receives text and decodes it using StringCharset.

receiveStringMaxN(int) - Method in class com.chilkatsoft.chilkat2.Socket

Receives and decodes text like ReceiveString, but returns at most maxByteCount input bytes.

receiveStringUntilByte(int) - Method in class com.chilkatsoft.chilkat2.Socket

Receives bytes until the raw byte value lookForByte is found.

receiveToCRLF() - Method in class com.chilkatsoft.chilkat2.Socket

Receives text through a CRLF line terminator and returns the text including the terminator.

receiveUntilByteBd(int, BinData) - Method in class com.chilkatsoft.chilkat2.Socket

Reads bytes until lookForByte is encountered and appends all bytes up to and including the matching byte to bd.

receiveUntilMatch(String) - Method in class com.chilkatsoft.chilkat2.Socket

Receives bytes until the exact byte sequence represented by matchStr is found.

receiveUntilMatchSb(String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Socket

Receives bytes until the exact byte sequence represented by matchStr is found.

reconnect(String, String, String) - Method in class com.chilkatsoft.chilkat2.SCard

Reestablishes a connection to a reader that was previously connected to using Connect().

recrawlLast() - Method in class com.chilkatsoft.chilkat2.Spider

Re-crawls the last URL spidered.

reEncode(String, String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

This method converts between different encodings, such as from base64 to hex.

referenceUri(int) - Method in class com.chilkatsoft.chilkat2.XmlDSig

Returns the URI of the Nth reference specified by index.

refetchMailFlags(Email) - Method in class com.chilkatsoft.chilkat2.Imap

Fetches the current IMAP flags for the server message represented by email and updates its ckx-imap-* metadata headers.

refreshAccessToken() - Method in class com.chilkatsoft.chilkat2.OAuth2

Sends a refresh-token grant request to OAuth2.getTokenEndpoint() to obtain a new access token without repeating interactive browser authorization.

regexMatch(String, JsonObject, int) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Searches the content of this object for substrings that match a regular expression pattern and returns the matches in json.

regexReplace(JsonObject) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Replaces the substrings of capture groups found in a previous call to RegexMatch.

registerJsTools(StringBuilder, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.Ai

Adds JavaScript tool functions to the AI.

registerManualTools(JsonObject) - Method in class com.chilkatsoft.chilkat2.Ai

Sets the tools JSON for AI requests.

reKey() - Method in class com.chilkatsoft.chilkat2.Ssh

Initiates SSH key re-exchange and waits for it to complete.

releaseContext() - Method in class com.chilkatsoft.chilkat2.SCard

Destroys a communication context to the PC/SC Resource Manager.

remove(String) - Method in class com.chilkatsoft.chilkat2.Hashtable

Removes the entry whose string key is key.

remove(String) - Method in class com.chilkatsoft.chilkat2.StringArray

Removes all strings equal to the string argument from the internal collection.

removeAccents() - Method in class com.chilkatsoft.chilkat2.StringBuilder

Removes the accents (diacritics) from European accented characters.

removeAfterFinal(String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Removes the substring found after the final occurrence of the marker.

removeAllAttributes() - Method in class com.chilkatsoft.chilkat2.Xml

Removes every attribute from the calling element.

removeAllChildren() - Method in class com.chilkatsoft.chilkat2.Xml

Removes all direct child elements and their subtrees from the calling element.

removeAllEmbedded() - Method in class com.chilkatsoft.chilkat2.Xmp

Removes all XMP metadata documents from an XMP object.

removeAllNameservers() - Method in class com.chilkatsoft.chilkat2.Dns

Removes all nameservers from the collection of nameservers used by Chilkat.

removeAllParams() - Method in class com.chilkatsoft.chilkat2.HttpRequest

Removes all request parameters.

removeArray(Xml, String) - Method in class com.chilkatsoft.chilkat2.Xmp

Removes an XMP array property from the XMP document.

removeAt(int) - Method in class com.chilkatsoft.chilkat2.StringArray

Removes the string at a particular index.

removeAttachedMessage(int) - Method in class com.chilkatsoft.chilkat2.Email

Removes the Nth message/rfc822 sub-part of the email.

removeAttachedMessages() - Method in class com.chilkatsoft.chilkat2.Email

Removes all message/rfc822 sub-parts of the email object.

removeAttachmentPaths() - Method in class com.chilkatsoft.chilkat2.Email

Removes relative or absolute path information from attachment filenames stored in the MIME, leaving only each final filename component.

removeAttribute(String) - Method in class com.chilkatsoft.chilkat2.Xml

Removes the attribute named name from the calling element.

removeBefore(String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Removes the substring found before the 1st occurrence of the marker.

removeByteVal(int) - Method in class com.chilkatsoft.chilkat2.BinData

Removes bytes having a specified value (0-255).

removeCert(int) - Method in class com.chilkatsoft.chilkat2.Pem

Removes the Nth certificate from the PEM.

removeCertificate(Cert) - Method in class com.chilkatsoft.chilkat2.CertStore

(This method only available on Microsoft Windows operating systems.)
Removes the passed certificate from the store.

removeCharsAt(int, int) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Removes the specified range of characters from this instance.

removeChild(String) - Method in class com.chilkatsoft.chilkat2.Xml

Removes all child elements selected by tagPath beneath the calling element.

removeChildByIndex(int) - Method in class com.chilkatsoft.chilkat2.Xml

Removes the direct child at zero-based index, including that child's entire subtree.

removeChildWithContent(String) - Method in class com.chilkatsoft.chilkat2.Xml

Removes all direct children whose text content exactly equals content, including each removed child's subtree.

removeChunk(int, int) - Method in class com.chilkatsoft.chilkat2.BinData

Removes a chunk of bytes from the binary data.

removeCustomHeader(String) - Method in class com.chilkatsoft.chilkat2.Mht

Removes custom HTTP request headers having the field name in name.

removeDir(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Deletes the remote directory specified by path.

removeEmail(Email) - Method in class com.chilkatsoft.chilkat2.EmailBundle

Removes the first email in this in-memory bundle that matches email.

removeEmailByIndex(int) - Method in class com.chilkatsoft.chilkat2.EmailBundle

Removes the email at the zero-based index in index.

removeEmbedded(int) - Method in class com.chilkatsoft.chilkat2.Xmp

Removes a single XMP metadata document from the JPG or TIFF file.

removeEmojis() - Method in class com.chilkatsoft.chilkat2.StringBuilder

Removes all emoji characters from the string.

removeEntry(int, int) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Removes an entry selected by type and zero-based index.

removeFile(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Deletes the remote file specified by filename.

removeFromTree() - Method in class com.chilkatsoft.chilkat2.Xml

Detaches the calling element and its entire subtree from its parent.

removeHeader(String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Removes all occurrences of a HTTP request header field.

removeHeader(String) - Method in class com.chilkatsoft.chilkat2.Rest

Removes all request headers named by name from the request level selected by Rest.getPartSelector().

removeHeaderField(String) - Method in class com.chilkatsoft.chilkat2.Email

Removes by name all occurrences of a header field.

removeHeaderField(String, boolean) - Method in class com.chilkatsoft.chilkat2.Mime

Removes fields whose name matches fieldName case-insensitively.

removeHtmlAlternative() - Method in class com.chilkatsoft.chilkat2.Email

Removes the HTML body from the email (if an HTML body exists).

removeId(long) - Method in class com.chilkatsoft.chilkat2.MessageSet

Removes the identifier whose raw numeric value equals id.

removeNameserver(String) - Method in class com.chilkatsoft.chilkat2.Dns

Removes a nameserver from the collection of nameservers used by Chilkat.

removeNoCompressExtension(String) - Method in class com.chilkatsoft.chilkat2.Zip

Removes a file extension from the internal "no-compression" extension list.

removeNsMapping(String) - Method in class com.chilkatsoft.chilkat2.Xmp

Removes a namespace-to-URI mapping.

removeParam(String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Removes a single HTTP request parameter by name.

removeParam(String) - Method in class com.chilkatsoft.chilkat2.OAuth1

Removes a name/value parameter from the OAuth1 signature.

removePart(int) - Method in class com.chilkatsoft.chilkat2.Mime

Removes the direct child at zero-based index.

removePlainTextAlternative() - Method in class com.chilkatsoft.chilkat2.Email

Removes the plain-text body from the email (if a plain-text body exists).

removePrivateKey(int) - Method in class com.chilkatsoft.chilkat2.Pem

Removes the Nth private key from the PEM.

removeQueryParam(String) - Method in class com.chilkatsoft.chilkat2.Rest

Removes all query parameters whose name matches name.

removeRemoteDir(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Removes the remote directory at remoteDirPath.

removeRequestHeader(String) - Method in class com.chilkatsoft.chilkat2.Http

Eliminates a header field from being included in all HTTP requests, except for those sent by the Http.httpReq(String, HttpRequest, HttpResponse) and Http.httpSReq(String, int, boolean, HttpRequest, HttpResponse) methods, which rely on header fields provided in an HttpRequest object via method arguments.

removeSignature(String) - Method in class com.chilkatsoft.chilkat2.CodeSign

Removes the embedded Authenticode signature from the file specified by path: a Windows executable or DLL, or, starting in v11.7.0, a Windows Installer package (.msi), PowerShell file (.ps1, .psm1, .psd1), or VBScript file (.vbs).

removeSimple(Xml, String) - Method in class com.chilkatsoft.chilkat2.Xmp

Removes a simple XMP property from the XMP document.

removeStruct(Xml, String) - Method in class com.chilkatsoft.chilkat2.Xmp

Removes an XMP structure property from the XMP document.

removeStructProp(Xml, String, String) - Method in class com.chilkatsoft.chilkat2.Xmp

Removes a single member from an XMP structured property.

removeStyleSheet(String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Removes XML stylesheet processing instructions whose attribute named attrName has the value attrValue.

rename(String, String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Renames the direct member oldName to newName.

renameAt(int, String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Renames the member at zero-based position index to name.

renameFileOrDir(String, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Renames or moves a remote file or directory from oldPath to newPath.

renameMailbox(String, String) - Method in class com.chilkatsoft.chilkat2.Imap

Renames the mailbox in fromMailbox to the name in toMailbox.

renameRemoteFile(String, String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Renames or moves a remote file or directory from existingRemoteFilePath to newRemoteFilePath using the FTP RNFR/RNTO sequence.

renderGet(String) - Method in class com.chilkatsoft.chilkat2.Http

Builds the GET request that would be sent if a method such as Http.quickGetStr(String) was called.

renderToMime(Email) - Method in class com.chilkatsoft.chilkat2.MailMan

Renders the Email in email as the MIME text that would be sent to the SMTP server, without actually sending the email.

renderToMimeBd(Email, BinData) - Method in class com.chilkatsoft.chilkat2.MailMan

Renders the Email in email as MIME bytes and appends the result to renderedMime.

renderToMimeSb(Email, StringBuilder) - Method in class com.chilkatsoft.chilkat2.MailMan

Renders the Email in email as MIME text and appends the result to renderedMime.

replace(String, String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Replaces all occurrences of a specified string in this instance with another specified string.

replaceAfterFinal(String, String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Replaces the content found after the final occurrence of marker with replacement.

replaceAllBetween(String, String, String, boolean) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Replaces the first occurrence of ALL the content found between beginMark and endMark with replacement.

replaceAt(int, String) - Method in class com.chilkatsoft.chilkat2.StringArray

Replaces the string at a specified index.

replaceBetween(String, String, String, String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Replaces all occurrences of value with replacement, but only where value is found between beginMark and endMark.

replaceFirst(String, String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Replaces the first occurrence of a specified string in this instance with another string.

replaceI(String, int) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Replaces all occurrences of value with the decimal integer replacement.

replaceNoCase(String, String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Replaces all occurrences of value with replacement (case insensitive).

replaceString(String, String) - Method in class com.chilkatsoft.chilkat2.ZipEntry

Replaces this ZIP entry's existing contents with new text data.

replaceStrings(String, String, String, String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Reads the file at filePath as text using charset, replaces occurrences of existingString with replacementString, writes the updated text back to the file, and returns the number of replacements made.

replaceWord(String, String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Replaces all word occurrences of a specified string in this instance with another specified string.

reset() - Method in class com.chilkatsoft.chilkat2.Stream

Resets the stream.

resetPerf(boolean) - Method in class com.chilkatsoft.chilkat2.Socket

Restarts one direction of connection-level transfer-rate measurement.

responseHdrByName(String) - Method in class com.chilkatsoft.chilkat2.Rest

Returns the value of the response header field named by name.

responseHdrName(int) - Method in class com.chilkatsoft.chilkat2.Rest

Returns the field name of the response header at zero-based index index.

responseHdrValue(int) - Method in class com.chilkatsoft.chilkat2.Rest

Returns the field value of the response header at zero-based index index.

Rest - Class in com.chilkatsoft.chilkat2

<section class="rest-summary">

Rest() - Constructor for class com.chilkatsoft.chilkat2.Rest

Creates a new Rest object.

restoreDefaults() - Method in class com.chilkatsoft.chilkat2.Mht

Restores a limited set of MHT/EML conversion settings to their defaults and clears two method-added collections.

restoreMaskedStrings(int, StringTable) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Restores single and/or double-quoted strings previously masked by MaskQuotedStrings.

resumeDownload(String, String) - Method in class com.chilkatsoft.chilkat2.Http

Resumes downloading content from url and saves it to a partially completed local file at targetFilename.

resumeDownloadBd(String, BinData) - Method in class com.chilkatsoft.chilkat2.Http

Resumes a download from where it left off, determined by the number of bytes in binData.

resumeDownloadFileByName(String, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Resumes downloading remoteFilePath to the local filesystem path localFilePath.

resumeUploadFileByName(String, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Resumes uploading the local file at localFilePath to remoteFilePath.

rowMatches(int, String, boolean) - Method in class com.chilkatsoft.chilkat2.Csv

Compares the complete data row at zero-based index rowIndex with the wildcard pattern in matchPattern.

Rsa - Class in com.chilkatsoft.chilkat2

<section class="rsa-summary">

Rsa() - Constructor for class com.chilkatsoft.chilkat2.Rsa

Creates a new Rsa object.

S

s3CreateBucket(String) - Method in class com.chilkatsoft.chilkat2.Http

Creates a new Amazon S3 bucket.

s3DeleteBucket(String) - Method in class com.chilkatsoft.chilkat2.Http

Deletes an Amazon S3 bucket.

s3DeleteObject(String, String) - Method in class com.chilkatsoft.chilkat2.Http

Deletes a remote file (object) on the Amazon S3 service.

s3DeleteObjects(String, StringTable, JsonObject) - Method in class com.chilkatsoft.chilkat2.Http

Deletes several objects from a bucket with a single request.

s3DownloadBd(String, String, BinData) - Method in class com.chilkatsoft.chilkat2.Http

Downloads a file from the Amazon S3 service into bd.

s3DownloadFile(String, String, String) - Method in class com.chilkatsoft.chilkat2.Http

Downloads a file from the Amazon S3 service.

s3DownloadString(String, String, String) - Method in class com.chilkatsoft.chilkat2.Http

Downloads a text file (object) from the Amazon S3 service and returns the content as a string.

s3FileExists(String, String) - Method in class com.chilkatsoft.chilkat2.Http

Checks the existence of a remote file, returning: 1 if the file exists 0 if the file does not exist -1 if the check failed 2 if in asynchronous mode, indicating the background task started successfully

s3GenPresignedUrl(String, boolean, String, String, int, String) - Method in class com.chilkatsoft.chilkat2.Http

This method generates a temporary pre-signed URL for Amazon S3.

s3ListBucketObjects(String) - Method in class com.chilkatsoft.chilkat2.Http

Retrieve an XML-formatted list of objects in an Amazon S3 bucket, similar to a directory listing.

s3ListBuckets() - Method in class com.chilkatsoft.chilkat2.Http

Retrieves the XML listing of the buckets for an Amazon S3 account.

s3UploadBd(BinData, String, String, String) - Method in class com.chilkatsoft.chilkat2.Http

Uploads the contents of bd as a file to the Amazon S3 service.

s3UploadFile(String, String, String, String) - Method in class com.chilkatsoft.chilkat2.Http

Uploads a file to the Amazon S3 service.

s3UploadString(String, String, String, String, String) - Method in class com.chilkatsoft.chilkat2.Http

Uploads the content of objectContent as a file to Amazon S3.

saveAllAttachments(String) - Method in class com.chilkatsoft.chilkat2.Email

Saves all attachments to the directory specified by dirPath.

saveAppFile(String) - Method in class com.chilkatsoft.chilkat2.Xmp

Persists all changes made to the XMP document(s) by saving the XMP object to a file.

saveAttachedFile(int, String) - Method in class com.chilkatsoft.chilkat2.Email

Saves the attachment at the zero-based index specified by index to the directory specified by dirPath.

saveBd(String, String, String, BinData) - Method in class com.chilkatsoft.chilkat2.Cache

Stores the contents of bd as binary cache data under key.

saveBinaryContent(String, boolean, boolean, String) - Method in class com.chilkatsoft.chilkat2.Xml

Decodes the binary content stored in this element and writes the resulting bytes to filename.

saveBody(String) - Method in class com.chilkatsoft.chilkat2.Mime

Writes the decoded body bytes of the current part to the local path in filename.

saveBodyBinary(String) - Method in class com.chilkatsoft.chilkat2.HttpResponse

Saves the body of the HTTP response to a file.

saveBodyText(boolean, String) - Method in class com.chilkatsoft.chilkat2.HttpResponse

Saves the HTTP response body to a file.

saveDerFile(boolean, String) - Method in class com.chilkatsoft.chilkat2.PublicKey

Saves the public key to path as binary DER.

saveEml(String) - Method in class com.chilkatsoft.chilkat2.Email

Convert this email object to EML and save it to a file.

saveFile(String) - Method in class com.chilkatsoft.chilkat2.Csv

Writes the entire CSV to the file specified by path.

saveFile2(String, String) - Method in class com.chilkatsoft.chilkat2.Csv

Writes the entire CSV to the file specified by filename.

saveMime(String) - Method in class com.chilkatsoft.chilkat2.Mime

Serializes the complete MIME entity and writes it to the local path in filename, including headers, body, multipart boundaries, and all descendants.

saveNthToFile(int, String) - Method in class com.chilkatsoft.chilkat2.StringArray

Saves the Nth string in the collection to a file.

savePemFile(boolean, String) - Method in class com.chilkatsoft.chilkat2.PublicKey

Saves the public key to path in PEM format.

savePemFile(String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Saves the key at path as unencrypted PEM, preferring a traditional algorithm-specific representation when one exists.

savePkcs1File(String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Saves the key at path using the traditional or preferred unencrypted DER representation.Historical method name: RSA is saved as PKCS #1, EC as RFC 5915, DSA in its traditional structure, and Ed25519 as PKCS #8 because no traditional PKCS #1 form exists.File behavior: An existing destination file is replaced.

savePkcs8EncryptedFile(String, String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Saves the key as password-protected PKCS #8 DER.

savePkcs8EncryptedPemFile(String, String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Saves the key as password-protected PKCS #8 PEM.

savePkcs8File(String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Saves the key as unencrypted PKCS #8 DER at path.

savePkcs8PemFile(String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Saves the key as unencrypted PKCS #8 PEM at path.

saveRelatedItem(int, String) - Method in class com.chilkatsoft.chilkat2.Email

Saves the related item at the zero-based index specified by index to the directory specified by dirPath.

saveText(String, String) - Method in class com.chilkatsoft.chilkat2.Dsa

Writes strToSave to the file specified by path using the legacy ANSI character encoding.

saveText(String, String) - Method in class com.chilkatsoft.chilkat2.SshKey

Writes a string to a text file.

saveTextDt(String, DateTime, String, String) - Method in class com.chilkatsoft.chilkat2.Cache

Stores itemTextData as a text cache item under key, with the expiration date and time supplied in expireDateTime.

saveTextNoExpire(String, String, String) - Method in class com.chilkatsoft.chilkat2.Cache

Stores itemTextData as a non-expiring text cache item under key.

saveTextStr(String, String, String, String) - Method in class com.chilkatsoft.chilkat2.Cache

Stores itemTextData as a text cache item under key, with expireDateTime providing the expiration time as an RFC 822-style Internet date string.

saveToFile(String) - Method in class com.chilkatsoft.chilkat2.Cert

Saves a certificate object to a .cer file.

saveToFile(String) - Method in class com.chilkatsoft.chilkat2.StringArray

Saves the collection of strings to a file, one string per line.

saveToFile(String, boolean, String) - Method in class com.chilkatsoft.chilkat2.StringTable

Saves the string table to a file.

saveToFile2(String, String) - Method in class com.chilkatsoft.chilkat2.StringArray

Saves the collection of strings to a file, one string per line.

saveToSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Csv

Clears sb and writes the entire CSV document into it.

saveToString() - Method in class com.chilkatsoft.chilkat2.Csv

Returns the entire CSV document as a string.

saveToText() - Method in class com.chilkatsoft.chilkat2.StringArray

Writes the collection of strings to a single string, one per line (separated by CRLF line endings).

saveXml(String) - Method in class com.chilkatsoft.chilkat2.Email

Convert this email object to XML and save it to a file.

saveXml(String) - Method in class com.chilkatsoft.chilkat2.EmailBundle

Serializes the bundle and each contained Email to Chilkat XML, then writes the XML document to the local filesystem path specified by path.

saveXml(String) - Method in class com.chilkatsoft.chilkat2.Mime

Writes Chilkat's MIME XML representation to the local path in filename.

saveXml(String) - Method in class com.chilkatsoft.chilkat2.Xml

Serializes the XML tree or subtree rooted at the current element and writes it to fileName.

saveXml(String) - Method in class com.chilkatsoft.chilkat2.XmlCertVault

Saves the contents to an XML file.

saveXmlFile(String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Saves the key as unencrypted Chilkat-compatible XML at path.

saveXmlFile(String) - Method in class com.chilkatsoft.chilkat2.PublicKey

Saves the public key to the local filesystem path specified by path using exactly the same key-type-specific XML text returned by PublicKey.getXml().

SCard - Class in com.chilkatsoft.chilkat2

<section class="scard-summary">

SCard() - Constructor for class com.chilkatsoft.chilkat2.SCard

Creates a new SCard object.

ScMinidriver - Class in com.chilkatsoft.chilkat2

<section class="scminidriver-summary">

ScMinidriver() - Constructor for class com.chilkatsoft.chilkat2.ScMinidriver

Creates a new ScMinidriver object.

Scp - Class in com.chilkatsoft.chilkat2

<section class="scp-summary">

Scp() - Constructor for class com.chilkatsoft.chilkat2.Scp

Creates a new Scp object.

scrub(String) - Method in class com.chilkatsoft.chilkat2.Xml

Recursively normalizes the XML subtree rooted at the calling element according to the comma-separated keywords in directives.

searchAllForContent(Xml, String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the first element whose text content matches contentPattern, regardless of tag name.

searchAllForContent2(Xml, String) - Method in class com.chilkatsoft.chilkat2.Xml

Performs the same breadth-first content search as SearchAllForContent, but moves the calling Xml object's internal reference to the matching element instead of returning a separate element object.

searchForAttribute(Xml, String, String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the first element whose tag equals tag, that has an attribute named attr, and whose attribute value matches valuePattern.

searchForAttribute2(Xml, String, String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Performs the same breadth-first tag/attribute search as SearchForAttribute, but moves the calling Xml object's internal reference to the matching element instead of returning a separate object.

searchForContent(Xml, String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the first element whose tag equals tag and whose text content matches contentPattern.

searchForContent2(Xml, String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Performs the same breadth-first tag/content search as SearchForContent, but moves the calling Xml object's internal reference to the matching element.

searchForTag(Xml, String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the first element whose tag exactly equals tag.

searchForTag2(Xml, String) - Method in class com.chilkatsoft.chilkat2.Xml

Performs the same breadth-first tag search as SearchForTag, but moves the calling Xml object's internal reference to the matching element instead of returning a separate object.

Secrets - Class in com.chilkatsoft.chilkat2

<section class="secrets-summary">

Secrets() - Constructor for class com.chilkatsoft.chilkat2.Secrets

Creates a new Secrets object.

secretSpecToJson(String, JsonObject) - Method in class com.chilkatsoft.chilkat2.Secrets

Converts a secret specification string (secretSpec) to JSON.

secStrEquals(SecureString) - Method in class com.chilkatsoft.chilkat2.SecureString

Returns true if the secStr equals the contents of this secure string.

secureClear() - Method in class com.chilkatsoft.chilkat2.BinData

Securely clears the contents by writing 0 bytes to the memory prior to deallocating the internal memory.

secureClear() - Method in class com.chilkatsoft.chilkat2.StringBuilder

Removes all characters from the current StringBuilder instance, and write zero bytes to the allocated memory before deallocating.

SecureString - Class in com.chilkatsoft.chilkat2

<section class="securestring-summary">

SecureString() - Constructor for class com.chilkatsoft.chilkat2.SecureString

Creates a new SecureString object.

selectForReading(int) - Method in class com.chilkatsoft.chilkat2.Socket

Waits for read-ready activity on this socket or, when this object is a socket set, on any contained socket.

selectForWriting(int) - Method in class com.chilkatsoft.chilkat2.Socket

Waits for this socket, or sockets in a socket set, to become writable without blocking.

selectMailbox(String) - Method in class com.chilkatsoft.chilkat2.Imap

Opens the mailbox in mailbox for read-write access.

sendBd(BinData, long, long) - Method in class com.chilkatsoft.chilkat2.Socket

Sends bytes from binData, beginning at offset.

sendBundle(EmailBundle) - Method in class com.chilkatsoft.chilkat2.MailMan

Sends each email in bundle.

sendByte(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sends one byte whose value is specified by value.

sendBytesENC(String, String) - Method in class com.chilkatsoft.chilkat2.Socket

Decodes encodedBytes using encodingAlg, then sends the resulting binary bytes.

sendClose(boolean, int, String) - Method in class com.chilkatsoft.chilkat2.WebSocket

Sends a WebSocket Close control frame and begins or completes the closing handshake.

sendCommand(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sends the raw FTP command in cmd and returns the complete server reply.

sendControl(long, BinData, BinData) - Method in class com.chilkatsoft.chilkat2.SCard

Sends a command directly to the IFD Handler (reader driver) to be processed by the reader.

sendControlHex(long, String, BinData) - Method in class com.chilkatsoft.chilkat2.SCard

Sends a command directly to the IFD Handler (reader driver) to be processed by the reader.

sendCount(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sends byteCount as its four-byte signed two's-complement bit pattern.

sendEmail(Email) - Method in class com.chilkatsoft.chilkat2.MailMan

Sends a single email through the configured SMTP server.

sendFrame(String, boolean) - Method in class com.chilkatsoft.chilkat2.WebSocket

Sends one WebSocket text data frame containing stringToSend.

sendFrameBd(BinData, boolean) - Method in class com.chilkatsoft.chilkat2.WebSocket

Sends one WebSocket binary data frame containing the current bytes in bdToSend.

sendFrameSb(StringBuilder, boolean) - Method in class com.chilkatsoft.chilkat2.WebSocket

Sends one WebSocket text data frame containing the current contents of sbToSend.

sendIgnore() - Method in class com.chilkatsoft.chilkat2.SFtp

Sends an SSH IGNORE message.

sendIgnore() - Method in class com.chilkatsoft.chilkat2.Ssh

Sends an SSH IGNORE message.

sendInt16(int, boolean) - Method in class com.chilkatsoft.chilkat2.Socket

Sends the low 16 bits of value as a two-byte two's-complement bit pattern.

sendInt32(int, boolean) - Method in class com.chilkatsoft.chilkat2.Socket

Sends value as its complete four-byte signed two's-complement bit pattern.

sendMime(String, String, String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sends an email from caller-supplied MIME text.

sendMimeBd(String, String, BinData) - Method in class com.chilkatsoft.chilkat2.MailMan

Sends an email from caller-supplied MIME bytes contained in mimeData.

sendPing(String) - Method in class com.chilkatsoft.chilkat2.WebSocket

Sends a WebSocket Ping control frame.

sendPong() - Method in class com.chilkatsoft.chilkat2.WebSocket

Sends a WebSocket Pong control frame.

sendRawCommand(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sends the raw IMAP command text in cmd and returns the raw server response.

sendReqBd(String, String, BinData) - Method in class com.chilkatsoft.chilkat2.Rest

Sends a request whose binary body is read from the BinData in body.

sendReqExec(int, String) - Method in class com.chilkatsoft.chilkat2.Ssh

Requests execution of commandLine on the session channel identified by channelNum.

sendReqFormUrlEncoded(String, String) - Method in class com.chilkatsoft.chilkat2.Rest

Sends an application/x-www-form-urlencoded request.

sendReqMultipart(String, String) - Method in class com.chilkatsoft.chilkat2.Rest

Sends a multipart request using the parts configured with Rest.getPartSelector(), Rest.addHeader(String, String), and the multipart-body methods.

sendReqNoBody(String, String) - Method in class com.chilkatsoft.chilkat2.Rest

Sends a request without a request body.

sendReqPty(int, String, int, int, int, int) - Method in class com.chilkatsoft.chilkat2.Ssh

Recommendation for automation: Do not request a pseudo-terminal unless the remote command or application specifically requires terminal behavior.

sendReqSb(String, String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Rest

Sends a request whose text body is read from the StringBuilder in bodySb.

sendReqSetEnv(int, String, String) - Method in class com.chilkatsoft.chilkat2.Ssh

Requests that the server set environment variable name to value for the session channel identified by channelNum.

sendReqShell(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Starts a remote shell on the open session channel identified by channelNum.

sendReqSignal(int, String) - Method in class com.chilkatsoft.chilkat2.Ssh

Requests delivery of signalName to the remote process running on channelNum.

sendReqStreamBody(String, String, Stream) - Method in class com.chilkatsoft.chilkat2.Rest

Sends a request whose body is read from the Stream in stream.

sendReqStringBody(String, String, String) - Method in class com.chilkatsoft.chilkat2.Rest

Sends a request whose text body is supplied in bodyText, such as JSON, XML, form-independent text, or another textual representation.

sendReqSubsystem(int, String) - Method in class com.chilkatsoft.chilkat2.Ssh

Requests the predefined subsystem named by subsystemName on session channel channelNum.

sendReqWindowChange(int, int, int, int, int) - Method in class com.chilkatsoft.chilkat2.Ssh

Notifies the server that the terminal dimensions changed for the PTY associated with channelNum.

sendReqX11Forwarding(int, boolean, String, String, int) - Method in class com.chilkatsoft.chilkat2.Ssh

Sends an SSH X11-forwarding request on the session channel in channelNum.

sendReqXonXoff(int, boolean) - Method in class com.chilkatsoft.chilkat2.Ssh

Deprecated for practical use.

sendSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Socket

Encodes the contents of sb using StringCharset and sends the resulting bytes.

sendString(String) - Method in class com.chilkatsoft.chilkat2.Socket

Encodes stringToSend using StringCharset and sends the resulting bytes over the connected TCP or TLS socket.

sendWakeOnLan(String, int, String) - Method in class com.chilkatsoft.chilkat2.Socket

Sends a Wake-on-LAN magic packet for macAddress to the UDP broadcast address ipBroadcastAddr and port.

sendWakeOnLan2(String, int, String, String) - Method in class com.chilkatsoft.chilkat2.Socket

Sends the same Wake-on-LAN magic packet as SendWakeOnLan and appends a SecureOn password.

serialize() - Method in class com.chilkatsoft.chilkat2.DateTime

Serializes the date/time to a us-ascii string that can be imported at a later time via the DeSerialize method.

serialize() - Method in class com.chilkatsoft.chilkat2.DtObj

Serializes the date/time to a us-ascii string that can be imported at a later time via the DeSerialize method.

serialize() - Method in class com.chilkatsoft.chilkat2.StringArray

Returns an string which is an encoded representation of all the strings in the collection.

ServerSentEvent - Class in com.chilkatsoft.chilkat2

<section class="serversentevent-summary">

ServerSentEvent() - Constructor for class com.chilkatsoft.chilkat2.ServerSentEvent

Creates a new ServerSentEvent object.

setAad(String, String) - Method in class com.chilkatsoft.chilkat2.Jwe

Sets external Additional Authenticated Data (AAD) for a JWE being encrypted.

setAadBd(BinData) - Method in class com.chilkatsoft.chilkat2.Jwe

Sets external Additional Authenticated Data (AAD) to the exact bytes in aad.

setAbortCurrent(boolean) - Method in class com.chilkatsoft.chilkat2.Bz2

Sets the AbortCurrent property; see Bz2.getAbortCurrent().

setAbortCurrent(boolean) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the AbortCurrent property; see Crypt2.getAbortCurrent().

setAbortCurrent(boolean) - Method in class com.chilkatsoft.chilkat2.Dkim

Sets the AbortCurrent property; see Dkim.getAbortCurrent().

setAbortCurrent(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the AbortCurrent property; see Ftp2.getAbortCurrent().

setAbortCurrent(boolean) - Method in class com.chilkatsoft.chilkat2.Gzip

Sets the AbortCurrent property; see Gzip.getAbortCurrent().

setAbortCurrent(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the AbortCurrent property; see Http.getAbortCurrent().

setAbortCurrent(boolean) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the AbortCurrent property; see Imap.getAbortCurrent().

setAbortCurrent(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the AbortCurrent property; see MailMan.getAbortCurrent().

setAbortCurrent(boolean) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the AbortCurrent property; see Mht.getAbortCurrent().

setAbortCurrent(boolean) - Method in class com.chilkatsoft.chilkat2.Scp

Sets the AbortCurrent property; see Scp.getAbortCurrent().

setAbortCurrent(boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the AbortCurrent property; see SFtp.getAbortCurrent().

setAbortCurrent(boolean) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the AbortCurrent property; see Socket.getAbortCurrent().

setAbortCurrent(boolean) - Method in class com.chilkatsoft.chilkat2.Spider

Sets the AbortCurrent property; see Spider.getAbortCurrent().

setAbortCurrent(boolean) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the AbortCurrent property; see Ssh.getAbortCurrent().

setAbortCurrent(boolean) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the AbortCurrent property; see SshTunnel.getAbortCurrent().

setAbortCurrent(boolean) - Method in class com.chilkatsoft.chilkat2.Stream

Sets the AbortCurrent property; see Stream.getAbortCurrent().

setAbortCurrent(boolean) - Method in class com.chilkatsoft.chilkat2.UnixCompress

Sets the AbortCurrent property; see UnixCompress.getAbortCurrent().

setAbortCurrent(boolean) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the AbortCurrent property; see Upload.getAbortCurrent().

setAbortCurrent(boolean) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the AbortCurrent property; see Zip.getAbortCurrent().

setAccept(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the Accept property; see Http.getAccept().

setAcceptLog(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the AcceptLog property; see SshTunnel.getAcceptLog().

setAcceptLogPath(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the AcceptLogPath property; see SshTunnel.getAcceptLogPath().

setAccessKey(String) - Method in class com.chilkatsoft.chilkat2.AuthAws

Sets the AccessKey property; see AuthAws.getAccessKey().

setAccessKey(String) - Method in class com.chilkatsoft.chilkat2.AuthAzureSAS

Sets the AccessKey property; see AuthAzureSAS.getAccessKey().

setAccessKey(String) - Method in class com.chilkatsoft.chilkat2.AuthAzureStorage

Sets the AccessKey property; see AuthAzureStorage.getAccessKey().

setAccessToken(String) - Method in class com.chilkatsoft.chilkat2.AuthGoogle

Sets the AccessToken property; see AuthGoogle.getAccessToken().

setAccessToken(String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the AccessToken property; see OAuth2.getAccessToken().

setAccount(String) - Method in class com.chilkatsoft.chilkat2.AuthAzureStorage

Sets the Account property; see AuthAzureStorage.getAccount().

setAccount(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the Account property; see Ftp2.getAccount().

setActivePortRangeEnd(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the ActivePortRangeEnd property; see Ftp2.getActivePortRangeEnd().

setActivePortRangeStart(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the ActivePortRangeStart property; see Ftp2.getActivePortRangeStart().

setAlgorithm(String) - Method in class com.chilkatsoft.chilkat2.Compression

Sets the Algorithm property; see Compression.getAlgorithm().

setAlgorithm(String) - Method in class com.chilkatsoft.chilkat2.EdDSA

Sets the Algorithm property; see EdDSA.getAlgorithm().

setAlgorithmId(String) - Method in class com.chilkatsoft.chilkat2.Pfx

Sets the AlgorithmId property; see Pfx.getAlgorithmId().

setAlias(int, int, String) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Changes the alias of an entry selected by type and zero-based index.

setAllocateSize(long) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the AllocateSize property; see Ftp2.getAllocateSize().

setAllOrNone(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the AllOrNone property; see MailMan.getAllOrNone().

setAllowedAlgorithms(JsonObject) - Method in class com.chilkatsoft.chilkat2.SFtp

Configures the exact set of SSH algorithms permitted for subsequent connections using the settings in json.

setAllowedAlgorithms(JsonObject) - Method in class com.chilkatsoft.chilkat2.Ssh

Applies an explicit allow-list of SSH negotiation algorithms supplied in json.

setAllowedAlgorithms(JsonObject) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Restricts the SSH connection to the algorithms specified in json.

setAllowGzip(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the AllowGzip property; see Http.getAllowGzip().

setAllowHeaderFolding(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the AllowHeaderFolding property; see Http.getAllowHeaderFolding().

setAllowHeaderFolding(boolean) - Method in class com.chilkatsoft.chilkat2.Rest

Sets the AllowHeaderFolding property; see Rest.getAllowHeaderFolding().

setAllowHeaderQB(boolean) - Method in class com.chilkatsoft.chilkat2.Rest

Sets the AllowHeaderQB property; see Rest.getAllowHeaderQB().

setAllowMlsd(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the AllowMlsd property; see Ftp2.getAllowMlsd().

setAlpnProtocol(String) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the AlpnProtocol property; see Socket.getAlpnProtocol().

setAlpnProtocols(String) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the AlpnProtocols property; see Socket.getAlpnProtocols().

setAltToCharset(String) - Method in class com.chilkatsoft.chilkat2.Charset

Sets the AltToCharset property; see Charset.getAltToCharset().

setAnsiCodePage(int) - Method in class com.chilkatsoft.chilkat2.Global

Sets the AnsiCodePage property; see Global.getAnsiCodePage().

setApiKey(String) - Method in class com.chilkatsoft.chilkat2.Ai

Sets the ApiKey property; see Ai.getApiKey().

setApiKeyHeader(String) - Method in class com.chilkatsoft.chilkat2.Ai

Sets the ApiKeyHeader property; see Ai.getApiKeyHeader().

setApiSpec(String) - Method in class com.chilkatsoft.chilkat2.Ai

Sets the ApiSpec property; see Ai.getApiSpec().

setAppCallbackUrl(String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the AppCallbackUrl property; see OAuth2.getAppCallbackUrl().

setAppendFromDir(String) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the AppendFromDir property; see Zip.getAppendFromDir().

setAppendMode(boolean) - Method in class com.chilkatsoft.chilkat2.Pem

Sets the AppendMode property; see Pem.getAppendMode().

setAppendSeen(boolean) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the AppendSeen property; see Imap.getAppendSeen().

setAskParams(JsonObject) - Method in class com.chilkatsoft.chilkat2.Ai

Sets additional Ai.ask(String) params such as: effort (see below) max_output_tokens (see below) max_tool_iterations - v11.4.0 Applies only to automatic JavaScript tool function calls.

setAsnFormat(boolean) - Method in class com.chilkatsoft.chilkat2.Ecc

Sets the AsnFormat property; see Ecc.getAsnFormat().

setAttachmentCharset(int, String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the charset parameter of the Content-Type header field for the attachment at the zero-based index specified by index.

setAttachmentDisposition(int, String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the Content-Disposition value for the attachment at the zero-based index specified by index.

setAttachmentFilename(int, String) - Method in class com.chilkatsoft.chilkat2.Email

Changes the filename of the attachment at the zero-based index specified by index.

setAuth(JsonObject) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Sets authorization information that is applied to all calls to HttpCurl.doYourThing(String) .

setAuthAws(AuthAws) - Method in class com.chilkatsoft.chilkat2.Rest

Associates the AuthAws provider in authProvider with this REST object.

setAuthAzureSas(AuthAzureSAS) - Method in class com.chilkatsoft.chilkat2.Rest

Associates the AuthAzureSAS provider in authProvider with this REST object.

setAuthAzureStorage(AuthAzureStorage) - Method in class com.chilkatsoft.chilkat2.Rest

Associates the AuthAzureStorage provider in authProvider with this REST object.

setAuthBasic(String, String) - Method in class com.chilkatsoft.chilkat2.Rest

Configures HTTP Basic authentication using username as the username and password as the password.

setAuthBasicSecure(SecureString, SecureString) - Method in class com.chilkatsoft.chilkat2.Rest

Configures HTTP Basic authentication using the SecureString objects in username and password for the username and password.

setAuthGoogle(AuthGoogle) - Method in class com.chilkatsoft.chilkat2.Rest

Associates the AuthGoogle provider in authProvider with this REST object.

setAuthMethod(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the AuthMethod property; see Imap.getAuthMethod().

setAuthOAuth1(OAuth1, boolean) - Method in class com.chilkatsoft.chilkat2.Rest

Associates the OAuth1 provider in authProvider with this REST object for OAuth 1.0 or OAuth 1.0a request signing.

setAuthOAuth2(OAuth2) - Method in class com.chilkatsoft.chilkat2.Rest

Associates the OAuth2 provider in authProvider with this REST object.

setAuthorization(String) - Method in class com.chilkatsoft.chilkat2.Rest

Sets the Authorization property; see Rest.getAuthorization().

setAuthorizationEndpoint(String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the AuthorizationEndpoint property; see OAuth2.getAuthorizationEndpoint().

setAuthPrivateKey(String, PrivateKey) - Method in class com.chilkatsoft.chilkat2.Http

Sets the private key to be used with some forms of authentication.

setAuthSignature(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the AuthSignature property; see Http.getAuthSignature().

setAuthSsl(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the AuthSsl property; see Ftp2.getAuthSsl().

setAuthTls(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the AuthTls property; see Ftp2.getAuthTls().

setAuthToken(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the AuthToken property; see Http.getAuthToken().

setAuthToken(String) - Method in class com.chilkatsoft.chilkat2.Mcp

Sets the AuthToken property; see Mcp.getAuthToken().

setAuthTokenSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Http

Sets the Http.getAuthToken() property.

setAuthzId(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the AuthzId property; see Imap.getAuthzId().

setAutoAddHostHeader(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the AutoAddHostHeader property; see Http.getAutoAddHostHeader().

setAutoCompact(boolean) - Method in class com.chilkatsoft.chilkat2.Jwt

Sets the AutoCompact property; see Jwt.getAutoCompact().

setAutoDownloadAttachments(boolean) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the AutoDownloadAttachments property; see Imap.getAutoDownloadAttachments().

setAutoFeat(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the AutoFeat property; see Ftp2.getAutoFeat().

setAutoFix(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the AutoFix property; see Ftp2.getAutoFix().

setAutoFix(boolean) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the AutoFix property; see Imap.getAutoFix().

setAutoFix(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the AutoFix property; see MailMan.getAutoFix().

setAutoGenMessageId(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the AutoGenMessageId property; see MailMan.getAutoGenMessageId().

setAutoGetSizeForProgress(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the AutoGetSizeForProgress property; see Ftp2.getAutoGetSizeForProgress().

setAutoOptsUtf8(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the AutoOptsUtf8 property; see Ftp2.getAutoOptsUtf8().

setAutoQBDecode(boolean) - Method in class com.chilkatsoft.chilkat2.Global

Sets the AutoQBDecode property; see Global.getAutoQBDecode().

setAutoRun(String) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the AutoRun property; see Zip.getAutoRun().

setAutoRunParams(String) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the AutoRunParams property; see Zip.getAutoRunParams().

setAutoSetUseEpsv(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the AutoSetUseEpsv property; see Ftp2.getAutoSetUseEpsv().

setAutoSmtpRset(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the AutoSmtpRset property; see MailMan.getAutoSmtpRset().

setAutoSplit(boolean) - Method in class com.chilkatsoft.chilkat2.Secrets

Sets the AutoSplit property; see Secrets.getAutoSplit().

setAutoSyst(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the AutoSyst property; see Ftp2.getAutoSyst().

setAutoTemp(boolean) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the AutoTemp property; see Zip.getAutoTemp().

setAutoTrim(boolean) - Method in class com.chilkatsoft.chilkat2.Csv

Sets the AutoTrim property; see Csv.getAutoTrim().

setAutoUnwrapSecurity(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the AutoUnwrapSecurity property; see MailMan.getAutoUnwrapSecurity().

setAutoXcrc(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the AutoXcrc property; see Ftp2.getAutoXcrc().

setAvoidHttps(boolean) - Method in class com.chilkatsoft.chilkat2.Spider

Sets the AvoidHttps property; see Spider.getAvoidHttps().

setAvoidWindowsPkAccess(boolean) - Method in class com.chilkatsoft.chilkat2.Cert

Sets the AvoidWindowsPkAccess property; see Cert.getAvoidWindowsPkAccess().

setAvoidWindowsPkAccess(boolean) - Method in class com.chilkatsoft.chilkat2.CertStore

Sets the AvoidWindowsPkAccess property; see CertStore.getAvoidWindowsPkAccess().

setAwsAccessKey(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the AwsAccessKey property; see Http.getAwsAccessKey().

setAwsEndpoint(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the AwsEndpoint property; see Http.getAwsEndpoint().

setAwsRegion(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the AwsRegion property; see Http.getAwsRegion().

setAwsSecretKey(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the AwsSecretKey property; see Http.getAwsSecretKey().

setAwsSessionToken(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the AwsSessionToken property; see Http.getAwsSessionToken().

setAwsSubResources(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the AwsSubResources property; see Http.getAwsSubResources().

setBandwidthThrottleDown(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the BandwidthThrottleDown property; see Ftp2.getBandwidthThrottleDown().

setBandwidthThrottleDown(int) - Method in class com.chilkatsoft.chilkat2.Http

Sets the BandwidthThrottleDown property; see Http.getBandwidthThrottleDown().

setBandwidthThrottleDown(int) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the BandwidthThrottleDown property; see SFtp.getBandwidthThrottleDown().

setBandwidthThrottleDown(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the BandwidthThrottleDown property; see Socket.getBandwidthThrottleDown().

setBandwidthThrottleUp(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the BandwidthThrottleUp property; see Ftp2.getBandwidthThrottleUp().

setBandwidthThrottleUp(int) - Method in class com.chilkatsoft.chilkat2.Http

Sets the BandwidthThrottleUp property; see Http.getBandwidthThrottleUp().

setBandwidthThrottleUp(int) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the BandwidthThrottleUp property; see SFtp.getBandwidthThrottleUp().

setBandwidthThrottleUp(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the BandwidthThrottleUp property; see Socket.getBandwidthThrottleUp().

setBandwidthThrottleUp(int) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the BandwidthThrottleUp property; see Upload.getBandwidthThrottleUp().

setBaseDir(String) - Method in class com.chilkatsoft.chilkat2.DirTree

Sets the BaseDir property; see DirTree.getBaseDir().

setBaseUrl(String) - Method in class com.chilkatsoft.chilkat2.Ai

Sets the BaseUrl property; see Ai.getBaseUrl().

setBaseUrl(String) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the BaseUrl property; see Mht.getBaseUrl().

setBasicAuth(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the BasicAuth property; see Http.getBasicAuth().

setBCryptWorkFactor(int) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the BCryptWorkFactor property; see Crypt2.getBCryptWorkFactor().

setBehaviors(String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the Behaviors property; see XmlDSigGen.getBehaviors().

setBigEndian(boolean) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the BigEndian property; see Socket.getBigEndian().

setBinaryContentBd(BinData, boolean, boolean, String) - Method in class com.chilkatsoft.chilkat2.Xml

Stores the bytes in data as binary content on this element, with optional ZIP compression and optional password-based AES encryption.

setBinaryContentFromFile(String, boolean, boolean, String) - Method in class com.chilkatsoft.chilkat2.Xml

Reads the bytes from filename and stores them as this element's binary content, with optional ZIP compression and optional password-based encryption.

setBody(String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the Body property; see Email.getBody().

setBody(String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the current part's body from str while preserving existing content headers such as Content-Type, charset, and Content-Transfer-Encoding.

setBodyBd(BinData) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the decoded body bytes from bd, changes Content-Transfer-Encoding to base64, and preserves the bytes exactly.

setBodyBd(BinData, String, String, String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the main email body from the binary data in bd.

setBodyFromEncoded(String, String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the body from transfer-encoded text.

setBodyFromFile(String) - Method in class com.chilkatsoft.chilkat2.Mime

Reads the local file at fileName and replaces the current part's body and content headers according to the filename extension.

setBodyFromHtml(String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets str as HTML and changes the media type to text/html.

setBodyFromPlainText(String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets str as plain text.

setBodyFromXml(String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets str as XML, changes the media type to text/xml, and selects a transfer encoding appropriate for the text.

setBoolAt(int, boolean) - Method in class com.chilkatsoft.chilkat2.JsonArray

Replaces the value at zero-based position index with the specified JSON boolean value.

setBoolAt(int, boolean) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sets the member at zero-based position index to a JSON boolean value.

setBoolOf(String, boolean) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sets the value at jsonPath to a JSON boolean value.

setBoolValue(boolean) - Method in class com.chilkatsoft.chilkat2.Asn

Sets the BoolValue property; see Asn.getBoolValue().

setBootstrapSecret(JsonObject, Secrets) - Method in class com.chilkatsoft.chilkat2.Secrets

Accessing a cloud-based secrets manager requires authentication credentials, which cannot be stored in the manager itself.

setBoundary(String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Sets the Boundary property; see HttpRequest.getBoundary().

setBoundary(String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the Boundary property; see Mime.getBoundary().

setCacheDir(String) - Method in class com.chilkatsoft.chilkat2.Spider

Sets the CacheDir property; see Spider.getCacheDir().

setCadesEnabled(boolean) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the CadesEnabled property; see Crypt2.getCadesEnabled().

setCadesSigPolicyHash(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the CadesSigPolicyHash property; see Crypt2.getCadesSigPolicyHash().

setCadesSigPolicyId(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the CadesSigPolicyId property; see Crypt2.getCadesSigPolicyId().

setCadesSigPolicyUri(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the CadesSigPolicyUri property; see Crypt2.getCadesSigPolicyUri().

setCanonicalizedResourceV2(String) - Method in class com.chilkatsoft.chilkat2.AuthAws

Sets the CanonicalizedResourceV2 property; see AuthAws.getCanonicalizedResourceV2().

setCaptureXmlListing(boolean) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the CaptureXmlListing property; see Tar.getCaptureXmlListing().

setCaretControl(boolean) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the CaretControl property; see Ssh.getCaretControl().

setCaseSensitive(boolean) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the CaseSensitive property; see Zip.getCaseSensitive().

setCdata(boolean) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the Cdata property; see Xml.getCdata().

setCell(int, int, String) - Method in class com.chilkatsoft.chilkat2.Csv

Sets the cell at zero-based data row row and column col to content.

setCellByName(int, String, String) - Method in class com.chilkatsoft.chilkat2.Csv

Sets the cell at zero-based data row rowIndex in the column named by columnName to contentStr.

setCharset(String) - Method in class com.chilkatsoft.chilkat2.Compression

Sets the Charset property; see Compression.getCharset().

setCharset(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the Charset property; see Crypt2.getCharset().

setCharset(String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the Charset property; see Email.getCharset().

setCharset(String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Sets the Charset property; see HttpRequest.getCharset().

setCharset(String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the Charset property; see Mime.getCharset().

setCharset(String) - Method in class com.chilkatsoft.chilkat2.Rsa

Sets the Charset property; see Rsa.getCharset().

setCharset(String) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the Charset property; see Tar.getCharset().

setChopAtQuery(boolean) - Method in class com.chilkatsoft.chilkat2.Spider

Sets the ChopAtQuery property; see Spider.getChopAtQuery().

setChunkSize(int) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the ChunkSize property; see Upload.getChunkSize().

setCipherMode(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the CipherMode property; see Crypt2.getCipherMode().

setCkPermission(String, String) - Method in class com.chilkatsoft.chilkat2.Js

Sets sandbox related permissions for Chilkat objects.

setClearArchiveAttribute(boolean) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the ClearArchiveAttribute property; see Zip.getClearArchiveAttribute().

setClearReadOnlyAttr(boolean) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the ClearReadOnlyAttr property; see Zip.getClearReadOnlyAttr().

setClientAssertionKey(PrivateKey, String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the private key for private_key_jwt client authentication (RFC 7523) in the OAuth2 client credentials flow of the Http.getAuthToken() property.

setClientChallenge(String) - Method in class com.chilkatsoft.chilkat2.Ntlm

Sets the ClientChallenge property; see Ntlm.getClientChallenge().

setClientId(String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the ClientId property; see OAuth2.getClientId().

setClientIdentifier(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the ClientIdentifier property; see SFtp.getClientIdentifier().

setClientIdentifier(String) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the ClientIdentifier property; see Ssh.getClientIdentifier().

setClientIdentifier(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the ClientIdentifier property; see SshTunnel.getClientIdentifier().

setClientIpAddress(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the ClientIpAddress property; see Ftp2.getClientIpAddress().

setClientIpAddress(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the ClientIpAddress property; see Http.getClientIpAddress().

setClientIpAddress(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the ClientIpAddress property; see Imap.getClientIpAddress().

setClientIpAddress(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the ClientIpAddress property; see MailMan.getClientIpAddress().

setClientIpAddress(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the ClientIpAddress property; see SFtp.getClientIpAddress().

setClientIpAddress(String) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the ClientIpAddress property; see Socket.getClientIpAddress().

setClientIpAddress(String) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the ClientIpAddress property; see Ssh.getClientIpAddress().

setClientIpAddress(String) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the ClientIpAddress property; see Upload.getClientIpAddress().

setClientLogDir(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the ClientLogDir property; see SshTunnel.getClientLogDir().

setClientPort(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the ClientPort property; see Socket.getClientPort().

setClientPort(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the ClientPort property; see Ssh.getClientPort().

setClientSecret(String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the ClientSecret property; see OAuth2.getClientSecret().

setCloseAutoRespond(boolean) - Method in class com.chilkatsoft.chilkat2.WebSocket

Sets the CloseAutoRespond property; see WebSocket.getCloseAutoRespond().

setCloudSigner(JsonObject) - Method in class com.chilkatsoft.chilkat2.Cert

Provides information for a cloud signing service to do the signing via a remote signing server.

setCmsOptions(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the CmsOptions property; see Crypt2.getCmsOptions().

setCmsOptions(String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the CmsOptions property; see Mime.getCmsOptions().

setCodeChallenge(boolean) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the CodeChallenge property; see OAuth2.getCodeChallenge().

setCodeChallengeMethod(String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the CodeChallengeMethod property; see OAuth2.getCodeChallengeMethod().

setColumnName(int, String) - Method in class com.chilkatsoft.chilkat2.Csv

Sets the name of the column at zero-based index index to columnName.

setCommandCharset(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the CommandCharset property; see Ftp2.getCommandCharset().

setComment(String) - Method in class com.chilkatsoft.chilkat2.Gzip

Sets the Comment property; see Gzip.getComment().

setComment(String) - Method in class com.chilkatsoft.chilkat2.SshKey

Sets the Comment property; see SshKey.getComment().

setComment(String) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the Comment property; see Zip.getComment().

setComment(String) - Method in class com.chilkatsoft.chilkat2.ZipEntry

Sets the Comment property; see getComment().

setCommonName(String) - Method in class com.chilkatsoft.chilkat2.Csr

Sets the CommonName property; see Csr.getCommonName().

setCompany(String) - Method in class com.chilkatsoft.chilkat2.Csr

Sets the Company property; see Csr.getCompany().

setCompanyDivision(String) - Method in class com.chilkatsoft.chilkat2.Csr

Sets the CompanyDivision property; see Csr.getCompanyDivision().

setCompression(boolean) - Method in class com.chilkatsoft.chilkat2.Secrets

Sets the Compression property; see Secrets.getCompression().

setCompressionLevel(int) - Method in class com.chilkatsoft.chilkat2.Gzip

Sets the CompressionLevel property; see Gzip.getCompressionLevel().

setCompressionLevel(int) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the compression level for all file and data entries currently contained within the ZIP object.

setCompressionLevel(int) - Method in class com.chilkatsoft.chilkat2.ZipEntry

Sets the CompressionLevel property; see getCompressionLevel().

setCompressionMethod(int) - Method in class com.chilkatsoft.chilkat2.ZipEntry

Sets the CompressionMethod property; see getCompressionMethod().

setConnectionSettings(Socket) - Method in class com.chilkatsoft.chilkat2.Ai

This method copies connection settings, including HTTP proxy, SOCKS proxy, network interface IP address, and other related settings from sock.

setConnectionSettings(Socket) - Method in class com.chilkatsoft.chilkat2.Mcp

Copies connection settings, including HTTP proxy, SOCKS proxy, bind (network interface) IP address, and TLS options, from sock.

setConnectTimeout(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the ConnectTimeout property; see Ftp2.getConnectTimeout().

setConnectTimeout(int) - Method in class com.chilkatsoft.chilkat2.Http

Sets the ConnectTimeout property; see Http.getConnectTimeout().

setConnectTimeout(int) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the ConnectTimeout property; see Imap.getConnectTimeout().

setConnectTimeout(int) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the ConnectTimeout property; see MailMan.getConnectTimeout().

setConnectTimeout(int) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the ConnectTimeout property; see Mht.getConnectTimeout().

setConnectTimeout(int) - Method in class com.chilkatsoft.chilkat2.Spider

Sets the ConnectTimeout property; see Spider.getConnectTimeout().

setConnectTimeoutMs(int) - Method in class com.chilkatsoft.chilkat2.Mcp

Sets the ConnectTimeoutMs property; see Mcp.getConnectTimeoutMs().

setConnectTimeoutMs(int) - Method in class com.chilkatsoft.chilkat2.Rest

Sets the ConnectTimeoutMs property; see Rest.getConnectTimeoutMs().

setConnectTimeoutMs(int) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the ConnectTimeoutMs property; see SFtp.getConnectTimeoutMs().

setConnectTimeoutMs(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the ConnectTimeoutMs property; see Ssh.getConnectTimeoutMs().

setConnectTimeoutMs(int) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the ConnectTimeoutMs property; see SshTunnel.getConnectTimeoutMs().

setConsumerKey(String) - Method in class com.chilkatsoft.chilkat2.OAuth1

Sets the ConsumerKey property; see OAuth1.getConsumerKey().

setConsumerSecret(String) - Method in class com.chilkatsoft.chilkat2.OAuth1

Sets the ConsumerSecret property; see OAuth1.getConsumerSecret().

setContent(String) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the Content property; see Xml.getContent().

setContentInt(int) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the ContentInt property; see Xml.getContentInt().

setContentStr(String) - Method in class com.chilkatsoft.chilkat2.Asn

Sets the ContentStr property; see Asn.getContentStr().

setContentType(String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Sets the ContentType property; see HttpRequest.getContentType().

setContentType(String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the ContentType property; see Mime.getContentType().

setContext(String) - Method in class com.chilkatsoft.chilkat2.EdDSA

Sets the Context property; see EdDSA.getContext().

setCookieDir(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the CookieDir property; see Http.getCookieDir().

setCookieXml(String, String) - Method in class com.chilkatsoft.chilkat2.Http

This method restores cookies for a specified domain.

setCountry(String) - Method in class com.chilkatsoft.chilkat2.Csr

Sets the Country property; see Csr.getCountry().

setCreateDt(String, boolean, DateTime) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the remote file's creation date and time.

setCreateTimeStr(String, boolean, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the remote file's creation date and time.

setCrlf(boolean) - Method in class com.chilkatsoft.chilkat2.Csv

Sets the Crlf property; see Csv.getCrlf().

setCrlf(boolean) - Method in class com.chilkatsoft.chilkat2.StringArray

Sets the Crlf property; see StringArray.getCrlf().

setCrlfMode(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the CrlfMode property; see Ftp2.getCrlfMode().

setCryptAlgorithm(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the CryptAlgorithm property; see Crypt2.getCryptAlgorithm().

setCurrentDir(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Changes the current working directory of the calling process to dirPath.

setCustomKeyInfoXml(String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the CustomKeyInfoXml property; see XmlDSigGen.getCustomKeyInfoXml().

setDataProtection(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the DataProtection property; see Ftp2.getDataProtection().

setDay(int) - Method in class com.chilkatsoft.chilkat2.DtObj

Sets the Day property; see DtObj.getDay().

setDebugHtmlAfter(String) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the DebugHtmlAfter property; see Mht.getDebugHtmlAfter().

setDebugHtmlBefore(String) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the DebugHtmlBefore property; see Mht.getDebugHtmlBefore().

setDebugLogFilePath(String) - Method in class com.chilkatsoft.chilkat2.ChilkatObject

Sets the path of a file to which the library appends its log (empty to turn it off).

setDebugMode(boolean) - Method in class com.chilkatsoft.chilkat2.Rest

Sets the DebugMode property; see Rest.getDebugMode().

setDecodeHtmlEntities(boolean) - Method in class com.chilkatsoft.chilkat2.HtmlToText

Sets the DecodeHtmlEntities property; see HtmlToText.getDecodeHtmlEntities().

setDecryptCert(Cert) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the digital certificate for decryption when the Crypt2.getCryptAlgorithm() property is set to "pki".

setDecryptCert(Cert) - Method in class com.chilkatsoft.chilkat2.Email

Allows for a certificate to be explicitly provided for decryption.

setDecryptCert(Cert) - Method in class com.chilkatsoft.chilkat2.Imap

Specifies the Cert in cert for decrypting S/MIME messages downloaded by this Imap object.

setDecryptCert(Cert) - Method in class com.chilkatsoft.chilkat2.MailMan

Explicitly specifies the certificate to use when decrypting encrypted email.

setDecryptCert(Cert) - Method in class com.chilkatsoft.chilkat2.Pdf

Sets the certificate (with its private key) used to open a certificate-encrypted PDF.

setDecryptCert2(Cert, PrivateKey) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the digital certificate and associated private key for decryption when the Crypt2.getCryptAlgorithm() property is set to "pki".

setDecryptCert2(Cert, PrivateKey) - Method in class com.chilkatsoft.chilkat2.Email

Explicitly provides the certificate in cert and the corresponding private key in key for decryption.

setDecryptCert2(Cert, PrivateKey) - Method in class com.chilkatsoft.chilkat2.Imap

Specifies the certificate in cert and its separately supplied PrivateKey in key for decrypting S/MIME messages.

setDecryptCert2(Cert, PrivateKey) - Method in class com.chilkatsoft.chilkat2.MailMan

Explicitly specifies both the certificate and its associated private key to use when decrypting S/MIME encrypted email.

setDecryptPassword(String) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the DecryptPassword property; see Zip.getDecryptPassword().

setDefaultChunkSize(int) - Method in class com.chilkatsoft.chilkat2.Stream

Sets the DefaultChunkSize property; see Stream.getDefaultChunkSize().

setDefaultFreshPeriod(int) - Method in class com.chilkatsoft.chilkat2.Http

Sets the DefaultFreshPeriod property; see Http.getDefaultFreshPeriod().

setDefaultNtlmVersion(int) - Method in class com.chilkatsoft.chilkat2.Global

Sets the DefaultNtlmVersion property; see Global.getDefaultNtlmVersion().

setDefaultUtf8(boolean) - Method in class com.chilkatsoft.chilkat2.Global

Sets the DefaultUtf8 property; see Global.getDefaultUtf8().

setDeflateLevel(int) - Method in class com.chilkatsoft.chilkat2.Compression

Sets the DeflateLevel property; see Compression.getDeflateLevel().

setDelimiter(String) - Method in class com.chilkatsoft.chilkat2.Csv

Sets the Delimiter property; see Csv.getDelimiter().

setDelimiterChar(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sets the DelimiterChar property; see JsonObject.getDelimiterChar().

setDestHostname(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the DestHostname property; see SshTunnel.getDestHostname().

setDestPort(int) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the DestPort property; see SshTunnel.getDestPort().

setDigestAuth(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the DigestAuth property; see Http.getDigestAuth().

setDirListingCharset(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the DirListingCharset property; see Ftp2.getDirListingCharset().

setDirMode(int) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the DirMode property; see Tar.getDirMode().

setDirPrefix(String) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the DirPrefix property; see Tar.getDirPrefix().

setDiscardPaths(boolean) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the DiscardPaths property; see Zip.getDiscardPaths().

setDisposition(String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the Disposition property; see Mime.getDisposition().

setDkimAlg(String) - Method in class com.chilkatsoft.chilkat2.Dkim

Sets the DkimAlg property; see Dkim.getDkimAlg().

setDkimBodyLengthCount(int) - Method in class com.chilkatsoft.chilkat2.Dkim

Sets the DkimBodyLengthCount property; see Dkim.getDkimBodyLengthCount().

setDkimCanon(String) - Method in class com.chilkatsoft.chilkat2.Dkim

Sets the DkimCanon property; see Dkim.getDkimCanon().

setDkimDomain(String) - Method in class com.chilkatsoft.chilkat2.Dkim

Sets the DkimDomain property; see Dkim.getDkimDomain().

setDkimHeaders(String) - Method in class com.chilkatsoft.chilkat2.Dkim

Sets the DkimHeaders property; see Dkim.getDkimHeaders().

setDkimPrivateKey(PrivateKey) - Method in class com.chilkatsoft.chilkat2.Dkim

Copies the RSA key from privateKey into this object for subsequent calls to Dkim.dkimSign(BinData).

setDkimSelector(String) - Method in class com.chilkatsoft.chilkat2.Dkim

Sets the DkimSelector property; see Dkim.getDkimSelector().

setDnsComputerName(String) - Method in class com.chilkatsoft.chilkat2.Ntlm

Sets the DnsComputerName property; see Ntlm.getDnsComputerName().

setDnsDomainName(String) - Method in class com.chilkatsoft.chilkat2.Ntlm

Sets the DnsDomainName property; see Ntlm.getDnsDomainName().

setDnsTimeToLive(int) - Method in class com.chilkatsoft.chilkat2.Global

Sets the DnsTimeToLive property; see Global.getDnsTimeToLive().

setDocType(String) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the DocType property; see Xml.getDocType().

setDomain(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the Domain property; see Imap.getDomain().

setDomain(String) - Method in class com.chilkatsoft.chilkat2.Ntlm

Sets the Domain property; see Ntlm.getDomain().

setDPoPKey(PrivateKey) - Method in class com.chilkatsoft.chilkat2.Http

Sets the private key for automatically adding the DPoP header to HTTP requests.

setDropCustomTags(boolean) - Method in class com.chilkatsoft.chilkat2.HtmlToXml

Sets the DropCustomTags property; see HtmlToXml.getDropCustomTags().

setDsnEnvid(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the DsnEnvid property; see MailMan.getDsnEnvid().

setDsnNotify(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the DsnNotify property; see MailMan.getDsnNotify().

setDsnRet(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the DsnRet property; see MailMan.getDsnRet().

setDt(DateTime) - Method in class com.chilkatsoft.chilkat2.Email

Sets the Date header field of the email to have the value of the date/time object provided.

setDt(DateTime) - Method in class com.chilkatsoft.chilkat2.Gzip

Sets the last-modified date/time to embed in the Gzip file when a Compress* method is called.

setDt(DateTime) - Method in class com.chilkatsoft.chilkat2.ZipEntry

Sets the last-modified date/time for this ZIP entry.

setDynamicPortForwarding(boolean) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the DynamicPortForwarding property; see SshTunnel.getDynamicPortForwarding().

setEdifactBody(String, String, String, String) - Method in class com.chilkatsoft.chilkat2.Email

Creates a typical email used to send EDIFACT messages.

setEmailAddress(String) - Method in class com.chilkatsoft.chilkat2.AuthGoogle

Sets the EmailAddress property; see AuthGoogle.getEmailAddress().

setEmailAddress(String) - Method in class com.chilkatsoft.chilkat2.Csr

Sets the EmailAddress property; see Csr.getEmailAddress().

setEmailDateStr(String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the EmailDateStr property; see Email.getEmailDateStr().

setEmbedCertChain(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the EmbedCertChain property; see MailMan.getEmbedCertChain().

setEmbedImages(boolean) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the EmbedImages property; see Mht.getEmbedImages().

setEmbedLocalOnly(boolean) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the EmbedLocalOnly property; see Mht.getEmbedLocalOnly().

setEmitBom(boolean) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the EmitBom property; see Xml.getEmitBom().

setEmitCompact(boolean) - Method in class com.chilkatsoft.chilkat2.JsonArray

Sets the EmitCompact property; see JsonArray.getEmitCompact().

setEmitCompact(boolean) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sets the EmitCompact property; see JsonObject.getEmitCompact().

setEmitCompact(boolean) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the EmitCompact property; see Xml.getEmitCompact().

setEmitCrlf(boolean) - Method in class com.chilkatsoft.chilkat2.JsonArray

Sets the EmitCrlf property; see JsonArray.getEmitCrlf().

setEmitCrLf(boolean) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sets the EmitCrLf property; see JsonObject.getEmitCrLf().

setEmitXmlDecl(boolean) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the EmitXmlDecl property; see Xml.getEmitXmlDecl().

setEnableBodyVars(boolean) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Sets the EnableBodyVars property; see HttpCurl.getEnableBodyVars().

setEnableCache(boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the EnableCache property; see SFtp.getEnableCache().

setEnableCompression(boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the EnableCompression property; see SFtp.getEnableCompression().

setEnableCompression(boolean) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the EnableCompression property; see Ssh.getEnableCompression().

setEnableDnsCaching(boolean) - Method in class com.chilkatsoft.chilkat2.Global

Sets the EnableDnsCaching property; see Global.getEnableDnsCaching().

setEnableQuotes(boolean) - Method in class com.chilkatsoft.chilkat2.Csv

Sets the EnableQuotes property; see Csv.getEnableQuotes().

setEnableSecrets(boolean) - Method in class com.chilkatsoft.chilkat2.Ai

Sets the EnableSecrets property; see Ai.getEnableSecrets().

setEnableSecrets(boolean) - Method in class com.chilkatsoft.chilkat2.AuthAws

Sets the EnableSecrets property; see AuthAws.getEnableSecrets().

setEnableSecrets(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the EnableSecrets property; see Ftp2.getEnableSecrets().

setEnableSecrets(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the EnableSecrets property; see Http.getEnableSecrets().

setEnableSecrets(boolean) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the EnableSecrets property; see Imap.getEnableSecrets().

setEnableSecrets(boolean) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sets the EnableSecrets property; see JsonObject.getEnableSecrets().

setEnableSecrets(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the EnableSecrets property; see MailMan.getEnableSecrets().

setEnableSecrets(boolean) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the EnableSecrets property; see OAuth2.getEnableSecrets().

setEnableSecrets(boolean) - Method in class com.chilkatsoft.chilkat2.Rest

Sets the EnableSecrets property; see Rest.getEnableSecrets().

setEnableSecrets(boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the EnableSecrets property; see SFtp.getEnableSecrets().

setEnableSecrets(boolean) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the EnableSecrets property; see Ssh.getEnableSecrets().

setEnableSecrets(boolean) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the EnableSecrets property; see SshTunnel.getEnableSecrets().

setEncodedAad(String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the optional authenticated additional data (AAD) for AES encryption in GCM mode.

setEncodedAuthTag(String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

In GCM mode, the authentication tag is a short value (e.g.

setEncodedContent(String, String) - Method in class com.chilkatsoft.chilkat2.Asn

Sets the content of this primitive ASN.1 item.

setEncodedHash(String, String) - Method in class com.chilkatsoft.chilkat2.Dsa

Decodes encodedHash using the encoding named by encoding and stores the resulting bytes in the Hash property.

setEncodedIV(String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the initialization vector used in symmetric encrpytion (AES, Blowfish, etc.) from a binary-encoded string using any Chilkat-supported encoding method (e.g., base64, hex).

setEncodedKey(String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the encryption key used in symmetric encryption (AES, Blowfish, etc.) from a binary-encoded string using any Chilkat-supported encoding method (e.g., base64, hex).

setEncodedSalt(String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the pbes2 or pbes1 salt bytes from a binary-encoded string using any Chilkat-supported encoding method (e.g., base64, hex).

setEncodedSignature(String, String) - Method in class com.chilkatsoft.chilkat2.Dsa

Decodes the signature text in encodedSig using the encoding named by encoding and stores the resulting bytes in the Signature property.

setEncodedSignatureRS(String, String, String) - Method in class com.chilkatsoft.chilkat2.Dsa

Builds the DSA signature from separately encoded r and s integer values.

setEncoding(String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the Encoding property; see Mime.getEncoding().

setEncoding(String) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the Encoding property; see Xml.getEncoding().

setEncodingMode(String) - Method in class com.chilkatsoft.chilkat2.Compression

Sets the EncodingMode property; see Compression.getEncodingMode().

setEncodingMode(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the EncodingMode property; see Crypt2.getEncodingMode().

setEncodingMode(String) - Method in class com.chilkatsoft.chilkat2.Ntlm

Sets the EncodingMode property; see Ntlm.getEncodingMode().

setEncodingMode(String) - Method in class com.chilkatsoft.chilkat2.Rsa

Sets the EncodingMode property; see Rsa.getEncodingMode().

setEncryptCert(Cert) - Method in class com.chilkatsoft.chilkat2.Crypt2

Instructs the encryption library to use a specified digital certificate for public-key encryption.

setEncryptCert(Cert) - Method in class com.chilkatsoft.chilkat2.Email

Sets the certificate in cert as the explicit recipient encryption certificate.

setEncryption(int) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the Encryption property; see Zip.getEncryption().

setEncryptKeyLength(int) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the EncryptKeyLength property; see Zip.getEncryptKeyLength().

setEncryptPassword(String) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the EncryptPassword property; see Zip.getEncryptPassword().

setEntireHeader(String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Sets the EntireHeader property; see HttpRequest.getEntireHeader().

setErrorAction(int) - Method in class com.chilkatsoft.chilkat2.Charset

Sets the ErrorAction property; see Charset.getErrorAction().

setErrorString(String, String) - Method in class com.chilkatsoft.chilkat2.Charset

Configures the replacement used when Charset.getErrorAction() is 1.

setEscapeBackslash(boolean) - Method in class com.chilkatsoft.chilkat2.Csv

Sets the EscapeBackslash property; see Csv.getEscapeBackslash().

setExclusions(StringArray) - Method in class com.chilkatsoft.chilkat2.Zip

Specifies a collection of wildcard exclusion patterns used when adding files to the ZIP archive.

setExeConfigParam(String, String) - Method in class com.chilkatsoft.chilkat2.Zip

(Windows only, for creating self-extracting EXE's)

setExeDefaultDir(String) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the ExeDefaultDir property; see Zip.getExeDefaultDir().

setExeFinishNotifier(boolean) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the ExeFinishNotifier property; see Zip.getExeFinishNotifier().

setExeIconFile(String) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the ExeIconFile property; see Zip.getExeIconFile().

setExeNoInterface(boolean) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the ExeNoInterface property; see Zip.getExeNoInterface().

setExeSilentProgress(boolean) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the ExeSilentProgress property; see Zip.getExeSilentProgress().

setExeTitle(String) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the ExeTitle property; see Zip.getExeTitle().

setExeUnzipCaption(String) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the ExeUnzipCaption property; see Zip.getExeUnzipCaption().

setExeUnzipDir(String) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the ExeUnzipDir property; see Zip.getExeUnzipDir().

setExeWaitForSetup(boolean) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the ExeWaitForSetup property; see Zip.getExeWaitForSetup().

setExeXmlConfig(String) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the ExeXmlConfig property; see Zip.getExeXmlConfig().

setExpect100Continue(boolean) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the Expect100Continue property; see Upload.getExpect100Continue().

setExpireNumSeconds(int) - Method in class com.chilkatsoft.chilkat2.AuthGoogle

Sets the ExpireNumSeconds property; see AuthGoogle.getExpireNumSeconds().

setExtensionRequest(Xml) - Method in class com.chilkatsoft.chilkat2.Csr

Sets the PKCS #9 extensionRequest attribute, OID 1.2.840.113549.1.9.14, for the CSR to be generated.

setExternalRefDirs(String) - Method in class com.chilkatsoft.chilkat2.XmlDSig

Sets the ExternalRefDirs property; see XmlDSig.getExternalRefDirs().

setExtraData(String, String) - Method in class com.chilkatsoft.chilkat2.Gzip

Sets optional extra binary data to include in the Gzip header when a Compress* method is called.

setFetchFromCache(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the FetchFromCache property; see Http.getFetchFromCache().

setFetchFromCache(boolean) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the FetchFromCache property; see Mht.getFetchFromCache().

setFetchFromCache(boolean) - Method in class com.chilkatsoft.chilkat2.Spider

Sets the FetchFromCache property; see Spider.getFetchFromCache().

setFileDateTimeStr(String) - Method in class com.chilkatsoft.chilkat2.ZipEntry

Sets the FileDateTimeStr property; see getFileDateTimeStr().

setFileDistList(String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the FileDistList property; see Email.getFileDistList().

setFileMode(int) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the FileMode property; see Tar.getFileMode().

setFilename(String) - Method in class com.chilkatsoft.chilkat2.Gzip

Sets the Filename property; see Gzip.getFilename().

setFilename(String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the Filename property; see Mime.getFilename().

setFileName(String) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the FileName property; see Zip.getFileName().

setFileName(String) - Method in class com.chilkatsoft.chilkat2.ZipEntry

Sets the FileName property; see getFileName().

setFilenameCharset(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the FilenameCharset property; see SFtp.getFilenameCharset().

setFileTimes(String, DateTime, DateTime, DateTime) - Method in class com.chilkatsoft.chilkat2.FileAccess

Sets the creation, last-access, and last-modified timestamps for filePath from the supplied CkDateTime objects.

setFilter(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the Filter property; see MailMan.getFilter().

setFindStartIndex(int) - Method in class com.chilkatsoft.chilkat2.JsonArray

Sets the FindStartIndex property; see JsonArray.getFindStartIndex().

setFirstChunk(boolean) - Method in class com.chilkatsoft.chilkat2.Compression

Sets the FirstChunk property; see Compression.getFirstChunk().

setFirstChunk(boolean) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the FirstChunk property; see Crypt2.getFirstChunk().

setFlag(long, boolean, String, int) - Method in class com.chilkatsoft.chilkat2.Imap

Sets or clears one flag on the message identified by msgId in the selected mailbox.

setFlag(String, boolean) - Method in class com.chilkatsoft.chilkat2.Ntlm

Turns one Chilkat flag letter on or off in Flags.

setFlags(MessageSet, String, int) - Method in class com.chilkatsoft.chilkat2.Imap

Sets or clears one flag for every identifier in the MessageSet supplied in messageSet.

setFlags(String) - Method in class com.chilkatsoft.chilkat2.Ntlm

Sets the Flags property; see Ntlm.getFlags().

setFollowRedirects(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the FollowRedirects property; see Http.getFollowRedirects().

setForceCipher(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the ForceCipher property; see SFtp.getForceCipher().

setForceCipher(String) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the ForceCipher property; see Ssh.getForceCipher().

setForcePortIpAddress(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the ForcePortIpAddress property; see Ftp2.getForcePortIpAddress().

setForceV3(boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the ForceV3 property; see SFtp.getForceV3().

setFreshnessAlgorithm(int) - Method in class com.chilkatsoft.chilkat2.Http

Sets the FreshnessAlgorithm property; see Http.getFreshnessAlgorithm().

setFrom(String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the From property; see Email.getFrom().

setFromAddress(String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the FromAddress property; see Email.getFromAddress().

setFromCharset(String) - Method in class com.chilkatsoft.chilkat2.Charset

Sets the FromCharset property; see Charset.getFromCharset().

setFromCurrentSystemTime() - Method in class com.chilkatsoft.chilkat2.DateTime

Sets the date/time from the current system time.

setFromDateTimeTicks(boolean, long) - Method in class com.chilkatsoft.chilkat2.DateTime

Sets the date/time from a .NET DateTime value represented in ticks.

setFromDosDate(boolean, long) - Method in class com.chilkatsoft.chilkat2.DateTime

Sets the date/time from a 32-bit DOS date/time bitmask.

setFromDtObj(DtObj) - Method in class com.chilkatsoft.chilkat2.DateTime

Sets the date/time from a Chilkat Dt object.

setFromEncoded(String) - Method in class com.chilkatsoft.chilkat2.Cert

Initializes the certificate object from a base64 encoded string representation of the certificate's binary DER format.

setFromMimeBd(BinData) - Method in class com.chilkatsoft.chilkat2.Email

Loads an email with the MIME stored in a BinData object.

setFromMimeSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Email

Loads an email with the MIME stored in a StringBuilder object.

setFromMimeText(String) - Method in class com.chilkatsoft.chilkat2.Email

Loads the email from MIME text contained in mimeText, such as the contents of an .eml file.

setFromName(String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the FromName property; see Email.getFromName().

setFromNtpServer(String) - Method in class com.chilkatsoft.chilkat2.DateTime

Sets the date/time by sending a query to an NTP server.

setFromNtpTime(int) - Method in class com.chilkatsoft.chilkat2.DateTime

Sets the date/time from a 32-bit NTP time value.

setFromOleDate(boolean, double) - Method in class com.chilkatsoft.chilkat2.DateTime

Sets the date/time from a Windows OLE DATE value.

setFromRfc822(String) - Method in class com.chilkatsoft.chilkat2.DateTime

Sets the date/time from an RFC822 date/time formatted string.

setFromTimestamp(String) - Method in class com.chilkatsoft.chilkat2.DateTime

Sets the date/time from an RFC 3339 timestamp format.

setFromUlid(boolean, String) - Method in class com.chilkatsoft.chilkat2.DateTime

Sets this object's date/time using the timestamp embedded in the ulid.

setFromUnixTime(boolean, long) - Method in class com.chilkatsoft.chilkat2.DateTime

Sets the date/time from a UNIX time value.

setFromUnixTime64(boolean, long) - Method in class com.chilkatsoft.chilkat2.DateTime

The same as SetFromUnixTime, except that it uses a 64-bit integer to solve the Y2038 problem.

setFromUnixTimeDbl(boolean, double) - Method in class com.chilkatsoft.chilkat2.DateTime

The same as SetFromUnixTime, except that it uses a double to solve the Y2038 problem.

setFromUrl(String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Parses a URL and sets the Path and query parameters (NumParams, GetParam, GetParamName, GetParamValue).

setFromXmlText(String) - Method in class com.chilkatsoft.chilkat2.Email

Loads an email from an XML string.

setFullTranscript(boolean) - Method in class com.chilkatsoft.chilkat2.Ai

Sets the FullTranscript property; see Ai.getFullTranscript().

setGroupId(int) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the GroupId property; see Tar.getGroupId().

setGroupName(String) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the GroupName property; see Tar.getGroupName().

setGroupSize(int) - Method in class com.chilkatsoft.chilkat2.Dsa

Sets the GroupSize property; see Dsa.getGroupSize().

setHasColumnNames(boolean) - Method in class com.chilkatsoft.chilkat2.Csv

Sets the HasColumnNames property; see Csv.getHasColumnNames().

setHashAlgorithm(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the HashAlgorithm property; see Crypt2.getHashAlgorithm().

setHashAlgorithm(String) - Method in class com.chilkatsoft.chilkat2.Csr

Sets the HashAlgorithm property; see Csr.getHashAlgorithm().

setHasUids(boolean) - Method in class com.chilkatsoft.chilkat2.MessageSet

Sets the HasUids property; see MessageSet.getHasUids().

setHavalRounds(int) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the HavalRounds property; see Crypt2.getHavalRounds().

setHeaderField(String, String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets one header field named by name.

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Ai

Sets the HeartbeatMs property; see Ai.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Bz2

Sets the HeartbeatMs property; see Bz2.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.CodeSign

Sets the HeartbeatMs property; see CodeSign.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Compression

Sets the HeartbeatMs property; see Compression.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the HeartbeatMs property; see Crypt2.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Dkim

Sets the HeartbeatMs property; see Dkim.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Dns

Sets the HeartbeatMs property; see Dns.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the HeartbeatMs property; see Ftp2.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Gzip

Sets the HeartbeatMs property; see Gzip.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Http

Sets the HeartbeatMs property; see Http.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Sets the HeartbeatMs property; see HttpCurl.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the HeartbeatMs property; see Imap.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the HeartbeatMs property; see MailMan.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Mcp

Sets the HeartbeatMs property; see Mcp.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the HeartbeatMs property; see Mht.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Pem

Sets the HeartbeatMs property; see Pem.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Rest

Sets the HeartbeatMs property; see Rest.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Scp

Sets the HeartbeatMs property; see Scp.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the HeartbeatMs property; see SFtp.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the HeartbeatMs property; see Socket.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Spider

Sets the HeartbeatMs property; see Spider.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the HeartbeatMs property; see Ssh.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Stream

Sets the HeartbeatMs property; see Stream.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the HeartbeatMs property; see Tar.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.UnixCompress

Sets the HeartbeatMs property; see UnixCompress.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the HeartbeatMs property; see Upload.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.WebSocket

Sets the HeartbeatMs property; see WebSocket.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the HeartbeatMs property; see Zip.getHeartbeatMs().

setHeartbeatMs(int) - Method in class com.chilkatsoft.chilkat2.ZipEntry

Sets the HeartbeatMs property; see getHeartbeatMs().

setHeloHostname(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the HeloHostname property; see MailMan.getHeloHostname().

setHmacKey(String, String) - Method in class com.chilkatsoft.chilkat2.XmlDSig

Sets the HMAC key to be used if the Signature used an HMAC signing algorithm.

setHmacKey(String, String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the HMAC key to be used if the Signature is to use an HMAC signing algorithm.

setHost(String) - Method in class com.chilkatsoft.chilkat2.Rest

Sets the Host property; see Rest.getHost().

setHostedConvo(boolean) - Method in class com.chilkatsoft.chilkat2.Ai

Sets the HostedConvo property; see Ai.getHostedConvo().

setHostKeyAlg(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the HostKeyAlg property; see SFtp.getHostKeyAlg().

setHostKeyAlg(String) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the HostKeyAlg property; see Ssh.getHostKeyAlg().

setHostname(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the Hostname property; see Ftp2.getHostname().

setHostname(String) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the Hostname property; see Upload.getHostname().

setHour(int) - Method in class com.chilkatsoft.chilkat2.DtObj

Sets the Hour property; see DtObj.getHour().

setHtml(String) - Method in class com.chilkatsoft.chilkat2.HtmlToXml

Sets the Html property; see HtmlToXml.getHtml().

setHtmlBd(BinData) - Method in class com.chilkatsoft.chilkat2.HtmlToXml

Replaces the current HTML source with the complete contents of bd.

setHtmlBody(String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the HTML body of an email.

setHtmlFromFile(String) - Method in class com.chilkatsoft.chilkat2.HtmlToXml

Loads HTML from filename and replaces the current Html input with the file contents.

setHtmlSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.HtmlToXml

Replaces the current HTML source with the complete contents of sb.

setHttpObj(Http) - Method in class com.chilkatsoft.chilkat2.Pdf

Sets the HTTP object to be used to communicate with the timestamp authority (TSA) server for cases where long term validation (LTV) of signatures is desired.

setHttpObj(Http) - Method in class com.chilkatsoft.chilkat2.XmlDSig

Sets the HTTP object to be used to communicate with OCSP responders, CRL distribution points, or timestamp authority (TSA) servers if needed.

setHttpObj(Http) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the HTTP object to be used to communicate with OCSP responders, CRL distribution points, or timestamp authority (TSA) servers if needed.

setHttpProxyAuthMethod(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the HttpProxyAuthMethod property; see Ftp2.getHttpProxyAuthMethod().

setHttpProxyAuthMethod(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the HttpProxyAuthMethod property; see Imap.getHttpProxyAuthMethod().

setHttpProxyAuthMethod(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the HttpProxyAuthMethod property; see MailMan.getHttpProxyAuthMethod().

setHttpProxyAuthMethod(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the HttpProxyAuthMethod property; see SFtp.getHttpProxyAuthMethod().

setHttpProxyAuthMethod(String) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the HttpProxyAuthMethod property; see Socket.getHttpProxyAuthMethod().

setHttpProxyAuthMethod(String) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the HttpProxyAuthMethod property; see Ssh.getHttpProxyAuthMethod().

setHttpProxyAuthMethod(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the HttpProxyAuthMethod property; see SshTunnel.getHttpProxyAuthMethod().

setHttpProxyDomain(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the HttpProxyDomain property; see Ftp2.getHttpProxyDomain().

setHttpProxyDomain(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the HttpProxyDomain property; see Imap.getHttpProxyDomain().

setHttpProxyDomain(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the HttpProxyDomain property; see MailMan.getHttpProxyDomain().

setHttpProxyDomain(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the HttpProxyDomain property; see SFtp.getHttpProxyDomain().

setHttpProxyDomain(String) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the HttpProxyDomain property; see Socket.getHttpProxyDomain().

setHttpProxyDomain(String) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the HttpProxyDomain property; see Ssh.getHttpProxyDomain().

setHttpProxyDomain(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the HttpProxyDomain property; see SshTunnel.getHttpProxyDomain().

setHttpProxyForHttp(boolean) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the HttpProxyForHttp property; see Socket.getHttpProxyForHttp().

setHttpProxyHostname(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the HttpProxyHostname property; see Ftp2.getHttpProxyHostname().

setHttpProxyHostname(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the HttpProxyHostname property; see Imap.getHttpProxyHostname().

setHttpProxyHostname(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the HttpProxyHostname property; see MailMan.getHttpProxyHostname().

setHttpProxyHostname(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the HttpProxyHostname property; see SFtp.getHttpProxyHostname().

setHttpProxyHostname(String) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the HttpProxyHostname property; see Socket.getHttpProxyHostname().

setHttpProxyHostname(String) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the HttpProxyHostname property; see Ssh.getHttpProxyHostname().

setHttpProxyHostname(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the HttpProxyHostname property; see SshTunnel.getHttpProxyHostname().

setHttpProxyPassword(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the HttpProxyPassword property; see Ftp2.getHttpProxyPassword().

setHttpProxyPassword(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the HttpProxyPassword property; see Imap.getHttpProxyPassword().

setHttpProxyPassword(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the HttpProxyPassword property; see MailMan.getHttpProxyPassword().

setHttpProxyPassword(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the HttpProxyPassword property; see SFtp.getHttpProxyPassword().

setHttpProxyPassword(String) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the HttpProxyPassword property; see Socket.getHttpProxyPassword().

setHttpProxyPassword(String) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the HttpProxyPassword property; see Ssh.getHttpProxyPassword().

setHttpProxyPassword(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the HttpProxyPassword property; see SshTunnel.getHttpProxyPassword().

setHttpProxyPort(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the HttpProxyPort property; see Ftp2.getHttpProxyPort().

setHttpProxyPort(int) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the HttpProxyPort property; see Imap.getHttpProxyPort().

setHttpProxyPort(int) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the HttpProxyPort property; see MailMan.getHttpProxyPort().

setHttpProxyPort(int) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the HttpProxyPort property; see SFtp.getHttpProxyPort().

setHttpProxyPort(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the HttpProxyPort property; see Socket.getHttpProxyPort().

setHttpProxyPort(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the HttpProxyPort property; see Ssh.getHttpProxyPort().

setHttpProxyPort(int) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the HttpProxyPort property; see SshTunnel.getHttpProxyPort().

setHttpProxyUsername(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the HttpProxyUsername property; see Ftp2.getHttpProxyUsername().

setHttpProxyUsername(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the HttpProxyUsername property; see Imap.getHttpProxyUsername().

setHttpProxyUsername(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the HttpProxyUsername property; see MailMan.getHttpProxyUsername().

setHttpProxyUsername(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the HttpProxyUsername property; see SFtp.getHttpProxyUsername().

setHttpProxyUsername(String) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the HttpProxyUsername property; see Socket.getHttpProxyUsername().

setHttpProxyUsername(String) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the HttpProxyUsername property; see Ssh.getHttpProxyUsername().

setHttpProxyUsername(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the HttpProxyUsername property; see SshTunnel.getHttpProxyUsername().

setHttpVerb(String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Sets the HttpVerb property; see HttpRequest.getHttpVerb().

setHttpVersion(String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Sets the HttpVersion property; see HttpRequest.getHttpVersion().

setI(int) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sets the I property; see JsonObject.getI().

setI(int) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the I property; see Xml.getI().

setIat(int) - Method in class com.chilkatsoft.chilkat2.AuthGoogle

Sets the Iat property; see AuthGoogle.getIat().

setIdleTimeoutMs(int) - Method in class com.chilkatsoft.chilkat2.Ai

Sets the IdleTimeoutMs property; see Ai.getIdleTimeoutMs().

setIdleTimeoutMs(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the IdleTimeoutMs property; see Ftp2.getIdleTimeoutMs().

setIdleTimeoutMs(int) - Method in class com.chilkatsoft.chilkat2.Mcp

Sets the IdleTimeoutMs property; see Mcp.getIdleTimeoutMs().

setIdleTimeoutMs(int) - Method in class com.chilkatsoft.chilkat2.Rest

Sets the IdleTimeoutMs property; see Rest.getIdleTimeoutMs().

setIdleTimeoutMs(int) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the IdleTimeoutMs property; see SFtp.getIdleTimeoutMs().

setIdleTimeoutMs(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the IdleTimeoutMs property; see Ssh.getIdleTimeoutMs().

setIdleTimeoutMs(int) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the IdleTimeoutMs property; see SshTunnel.getIdleTimeoutMs().

setIdleTimeoutMs(int) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the IdleTimeoutMs property; see Upload.getIdleTimeoutMs().

setIdleTimeoutMs(int) - Method in class com.chilkatsoft.chilkat2.WebSocket

Sets the IdleTimeoutMs property; see WebSocket.getIdleTimeoutMs().

setIgnoreAccessDenied(boolean) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the IgnoreAccessDenied property; see Zip.getIgnoreAccessDenied().

setIgnoreExternalRefs(boolean) - Method in class com.chilkatsoft.chilkat2.XmlDSig

Sets the IgnoreExternalRefs property; see XmlDSig.getIgnoreExternalRefs().

setIgnoreMustRevalidate(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the IgnoreMustRevalidate property; see Http.getIgnoreMustRevalidate().

setIgnoreMustRevalidate(boolean) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the IgnoreMustRevalidate property; see Mht.getIgnoreMustRevalidate().

setIgnoreNoCache(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the IgnoreNoCache property; see Http.getIgnoreNoCache().

setIgnoreNoCache(boolean) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the IgnoreNoCache property; see Mht.getIgnoreNoCache().

setImmediateDelete(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the ImmediateDelete property; see MailMan.getImmediateDelete().

setInboundSocksPassword(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the InboundSocksPassword property; see SshTunnel.getInboundSocksPassword().

setInboundSocksUsername(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the InboundSocksUsername property; see SshTunnel.getInboundSocksUsername().

setIncludeCertChain(boolean) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the IncludeCertChain property; see Crypt2.getIncludeCertChain().

setIncludeDotDirs(boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the IncludeDotDirs property; see SFtp.getIncludeDotDirs().

setIncludeNonce(boolean) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the IncludeNonce property; see OAuth2.getIncludeNonce().

setIncludeRootCert(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the IncludeRootCert property; see MailMan.getIncludeRootCert().

setIncNamespacePrefix(String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the IncNamespacePrefix property; see XmlDSigGen.getIncNamespacePrefix().

setIncNamespaceUri(String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the IncNamespaceUri property; see XmlDSigGen.getIncNamespaceUri().

setInitialCount(int) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the InitialCount property; see Crypt2.getInitialCount().

setIntAt(int, int) - Method in class com.chilkatsoft.chilkat2.JsonArray

Replaces the value at zero-based position index with the specified JSON integer value.

setIntAt(int, int) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sets the member at zero-based position index to a JSON number value.

setIntOf(String, int) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sets the value at jsonPath to an integer JSON number.

setIntValue(int) - Method in class com.chilkatsoft.chilkat2.Asn

Sets the IntValue property; see Asn.getIntValue().

setIntValue(int) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Sets the IntValue property; see StringBuilder.getIntValue().

setIterationCount(int) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the IterationCount property; see Crypt2.getIterationCount().

setJ(int) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sets the J property; see JsonObject.getJ().

setJ(int) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the J property; see Xml.getJ().

setJsonKey(String) - Method in class com.chilkatsoft.chilkat2.AuthGoogle

Sets the JsonKey property; see AuthGoogle.getJsonKey().

setJsToolTimeout(int) - Method in class com.chilkatsoft.chilkat2.Ai

Sets the JsToolTimeout property; see Ai.getJsToolTimeout().

setK(int) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sets the K property; see JsonObject.getK().

setK(int) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the K property; see Xml.getK().

setKeepAcceptLog(boolean) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the KeepAcceptLog property; see SshTunnel.getKeepAcceptLog().

setKeepAlive(boolean) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the KeepAlive property; see Socket.getKeepAlive().

setKeepResponseBody(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the KeepResponseBody property; see Http.getKeepResponseBody().

setKeepSessionLog(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the KeepSessionLog property; see Ftp2.getKeepSessionLog().

setKeepSessionLog(boolean) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the KeepSessionLog property; see Imap.getKeepSessionLog().

setKeepSessionLog(boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the KeepSessionLog property; see SFtp.getKeepSessionLog().

setKeepSessionLog(boolean) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the KeepSessionLog property; see Socket.getKeepSessionLog().

setKeepSessionLog(boolean) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the KeepSessionLog property; see Ssh.getKeepSessionLog().

setKeepTunnelLog(boolean) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the KeepTunnelLog property; see SshTunnel.getKeepTunnelLog().

setKeyExplicit(int, String, String, String, String) - Method in class com.chilkatsoft.chilkat2.Dsa

Loads a DSA private key from explicitly supplied components.

setKeyInfoId(String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the KeyInfoId property; see XmlDSigGen.getKeyInfoId().

setKeyInfoKeyName(String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the KeyInfoKeyName property; see XmlDSigGen.getKeyInfoKeyName().

setKeyInfoType(String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the KeyInfoType property; see XmlDSigGen.getKeyInfoType().

setKeyLength(int) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the KeyLength property; see Crypt2.getKeyLength().

setLargeFileMeasures(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the LargeFileMeasures property; see Ftp2.getLargeFileMeasures().

setLastAccessDt(String, boolean, DateTime) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the remote file's last-access date and time.

setLastAccessTimeStr(String, boolean, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the remote file's last-access date and time.

setLastChunk(boolean) - Method in class com.chilkatsoft.chilkat2.Compression

Sets the LastChunk property; see Compression.getLastChunk().

setLastChunk(boolean) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the LastChunk property; see Crypt2.getLastChunk().

setLastMethodSuccess(boolean) - Method in class com.chilkatsoft.chilkat2.ChilkatObject

Sets the success flag (rarely needed; see ChilkatObject.getLastMethodSuccess()).

setLastModified(String, DateTime) - Method in class com.chilkatsoft.chilkat2.FileAccess

Sets the last-modified timestamp of filePath from lastModified.

setLastModifiedDt(String, boolean, DateTime) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the remote file's last-modified date and time.

setLastModifiedTimeStr(String, boolean, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the remote file's last-modified date and time.

setLastModStr(String) - Method in class com.chilkatsoft.chilkat2.Gzip

Sets the LastModStr property; see Gzip.getLastModStr().

setLength(long) - Method in class com.chilkatsoft.chilkat2.Stream

Sets the Length property; see Stream.getLength().

setLength32(int) - Method in class com.chilkatsoft.chilkat2.Stream

Sets the Length32 property; see Stream.getLength32().

setLevel(int) - Method in class com.chilkatsoft.chilkat2.Cache

Sets the Level property; see Cache.getLevel().

setListenBindIpAddress(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the ListenBindIpAddress property; see SshTunnel.getListenBindIpAddress().

setListenPort(int) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the ListenPort property; see OAuth2.getListenPort().

setListenPortRangeEnd(int) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the ListenPortRangeEnd property; see OAuth2.getListenPortRangeEnd().

setListOption(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the ListOption property; see Ftp2.getListOption().

setListPattern(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the ListPattern property; see Ftp2.getListPattern().

setLittleEndian(boolean) - Method in class com.chilkatsoft.chilkat2.Rsa

Sets the LittleEndian property; see Rsa.getLittleEndian().

setLMFactor(int) - Method in class com.chilkatsoft.chilkat2.Http

Sets the LMFactor property; see Http.getLMFactor().

setLocalDateStr(String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the LocalDateStr property; see Email.getLocalDateStr().

setLocalHost(String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the LocalHost property; see OAuth2.getLocalHost().

setLocality(String) - Method in class com.chilkatsoft.chilkat2.Csr

Sets the Locality property; see Csr.getLocality().

setLocation(String) - Method in class com.chilkatsoft.chilkat2.Secrets

Sets the Location property; see Secrets.getLocation().

setLockFileOnOpen(boolean) - Method in class com.chilkatsoft.chilkat2.FileAccess

Sets the LockFileOnOpen property; see FileAccess.getLockFileOnOpen().

setLogin(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the Login property; see Http.getLogin().

setLogin(String) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the Login property; see Upload.getLogin().

setLoginDomain(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the LoginDomain property; see Http.getLoginDomain().

setLogMailReceivedFilename(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the LogMailReceivedFilename property; see MailMan.getLogMailReceivedFilename().

setLogMailSentFilename(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the LogMailSentFilename property; see MailMan.getLogMailSentFilename().

setLowerCaseNames(boolean) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sets the LowerCaseNames property; see JsonObject.getLowerCaseNames().

setMacAlgorithm(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the MacAlgorithm property; see Crypt2.getMacAlgorithm().

setMacKey(int, String, String) - Method in class com.chilkatsoft.chilkat2.Jws

Sets the symmetric MAC key for signature index.

setMacKeyBd(int, BinData) - Method in class com.chilkatsoft.chilkat2.Jws

Sets the symmetric MAC key for signature index from a copy of the raw bytes in key.

setMacKeyEncoded(String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the MAC key from a binary-encoded string using any Chilkat-supported encoding method (e.g., base64, hex).

setMacKeyString(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the MAC key from a string.

setMailer(String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the Mailer property; see Email.getMailer().

setMailFlag(Email, String, int) - Method in class com.chilkatsoft.chilkat2.Imap

Sets or clears a flag for the server message represented by the Email in email.

setMailHost(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the MailHost property; see MailMan.getMailHost().

setMailPort(int) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the MailPort property; see MailMan.getMailPort().

setMaintainHash(String) - Method in class com.chilkatsoft.chilkat2.SecureString

Sets the MaintainHash property; see SecureString.getMaintainHash().

setMasterPassword(String) - Method in class com.chilkatsoft.chilkat2.XmlCertVault

Sets the MasterPassword property; see XmlCertVault.getMasterPassword().

setMatchCaseSensitive(boolean) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the MatchCaseSensitive property; see Tar.getMatchCaseSensitive().

setMaxConnections(int) - Method in class com.chilkatsoft.chilkat2.Http

Sets the MaxConnections property; see Http.getMaxConnections().

setMaxCount(int) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the MaxCount property; see MailMan.getMaxCount().

setMaxDate(String) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the MaxDate property; see Zip.getMaxDate().

setMaxFreshPeriod(int) - Method in class com.chilkatsoft.chilkat2.Http

Sets the MaxFreshPeriod property; see Http.getMaxFreshPeriod().

setMaxPacketSize(int) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the MaxPacketSize property; see SFtp.getMaxPacketSize().

setMaxPacketSize(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the MaxPacketSize property; see Ssh.getMaxPacketSize().

setMaxReadIdleMs(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the MaxReadIdleMs property; see Socket.getMaxReadIdleMs().

setMaxResponseSize(int) - Method in class com.chilkatsoft.chilkat2.Spider

Sets the MaxResponseSize property; see Spider.getMaxResponseSize().

setMaxResponseSize(long) - Method in class com.chilkatsoft.chilkat2.Http

Sets the MaxResponseSize property; see Http.getMaxResponseSize().

setMaxSendIdleMs(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the MaxSendIdleMs property; see Socket.getMaxSendIdleMs().

setMaxThreads(int) - Method in class com.chilkatsoft.chilkat2.Global

Sets the MaxThreads property; see Global.getMaxThreads().

setMaxUncompressSize(long) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the MaxUncompressSize property; see Zip.getMaxUncompressSize().

setMaxUrlLen(int) - Method in class com.chilkatsoft.chilkat2.Http

Sets the MaxUrlLen property; see Http.getMaxUrlLen().

setMaxUrlLen(int) - Method in class com.chilkatsoft.chilkat2.Spider

Sets the MaxUrlLen property; see Spider.getMaxUrlLen().

setMaxWaitMs(int) - Method in class com.chilkatsoft.chilkat2.Dns

Sets the MaxWaitMs property; see Dns.getMaxWaitMs().

setMgfHashAlg(String) - Method in class com.chilkatsoft.chilkat2.Csr

Sets the MgfHashAlg property; see Csr.getMgfHashAlg().

setMicalg(String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the Micalg property; see Mime.getMicalg().

setMinDate(String) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the MinDate property; see Zip.getMinDate().

setMinFreshPeriod(int) - Method in class com.chilkatsoft.chilkat2.Http

Sets the MinFreshPeriod property; see Http.getMinFreshPeriod().

setMinute(int) - Method in class com.chilkatsoft.chilkat2.DtObj

Sets the Minute property; see DtObj.getMinute().

setModel(String) - Method in class com.chilkatsoft.chilkat2.Ai

Sets the Model property; see Ai.getModel().

setModeZ() - Method in class com.chilkatsoft.chilkat2.Ftp2

Enables MODE Z compression for subsequent data connections.

setMonth(int) - Method in class com.chilkatsoft.chilkat2.DtObj

Sets the Month property; see DtObj.getMonth().

setMultipartBodyBd(BinData) - Method in class com.chilkatsoft.chilkat2.Rest

Sets the binary body of the multipart part identified by Rest.getPartSelector() from the BinData in bodyData.

setMultipartBodySb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Rest

Sets the text body of the multipart part identified by Rest.getPartSelector() from the StringBuilder in bodySb.

setMultipartBodyStream(Stream) - Method in class com.chilkatsoft.chilkat2.Rest

Uses the Stream in stream as the body source for the multipart part identified by Rest.getPartSelector().

setMultipartBodyString(String) - Method in class com.chilkatsoft.chilkat2.Rest

Sets the text body of the multipart part identified by Rest.getPartSelector() to bodyText.

setMustMatch(String) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the MustMatch property; see Tar.getMustMatch().

setMustNotMatch(String) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the MustNotMatch property; see Tar.getMustNotMatch().

setName(String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the Name property; see Mime.getName().

setNbsp(int) - Method in class com.chilkatsoft.chilkat2.HtmlToXml

Sets the Nbsp property; see HtmlToXml.getNbsp().

setNegotiateAuth(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the NegotiateAuth property; see Http.getNegotiateAuth().

setNetBiosComputerName(String) - Method in class com.chilkatsoft.chilkat2.Ntlm

Sets the NetBiosComputerName property; see Ntlm.getNetBiosComputerName().

setNetBiosDomainName(String) - Method in class com.chilkatsoft.chilkat2.Ntlm

Sets the NetBiosDomainName property; see Ntlm.getNetBiosDomainName().

setNoAbsolutePaths(boolean) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the NoAbsolutePaths property; see Tar.getNoAbsolutePaths().

setNonce(String) - Method in class com.chilkatsoft.chilkat2.OAuth1

Sets the Nonce property; see OAuth1.getNonce().

setNonceLength(int) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the NonceLength property; see OAuth2.getNonceLength().

setNonTokenParam(String, String) - Method in class com.chilkatsoft.chilkat2.AuthAzureSAS

Adds a non-token parameter name/value.

setNoScripts(boolean) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the NoScripts property; see Mht.getNoScripts().

setNoUnpad(boolean) - Method in class com.chilkatsoft.chilkat2.Rsa

Sets the NoUnpad property; see Rsa.getNoUnpad().

setNth(int, String, String, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Sets the Nth substring in string in a list delimted by delimiterChar.

setNtlmAuth(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the NtlmAuth property; see Http.getNtlmAuth().

setNtlmAuth(boolean) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the NtlmAuth property; see Mht.getNtlmAuth().

setNtlmVersion(int) - Method in class com.chilkatsoft.chilkat2.Ntlm

Sets the NtlmVersion property; see Ntlm.getNtlmVersion().

setNullAt(int) - Method in class com.chilkatsoft.chilkat2.JsonArray

Replaces the value at zero-based position index with the JSON value null.

setNullAt(int) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sets the member at zero-based position index to a JSON null value.

setNullOf(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sets the value at jsonPath to a JSON null value.

setNumberAt(int, String) - Method in class com.chilkatsoft.chilkat2.JsonArray

Replaces the value at zero-based position index with a JSON number.

setNumberAt(int, String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sets the member at zero-based position index to a JSON number value.

setNumberOf(String, String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sets the value at jsonPath to a JSON number value.

setNumCacheLevels(int) - Method in class com.chilkatsoft.chilkat2.Http

Sets the NumCacheLevels property; see Http.getNumCacheLevels().

setNumCacheLevels(int) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the NumCacheLevels property; see Mht.getNumCacheLevels().

setOaepHash(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the OaepHash property; see Crypt2.getOaepHash().

setOaepHash(String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the OaepHash property; see Email.getOaepHash().

setOaepHash(String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the OaepHash property; see Mime.getOaepHash().

setOaepHash(String) - Method in class com.chilkatsoft.chilkat2.Rsa

Sets the OaepHash property; see Rsa.getOaepHash().

setOaepLabel(String) - Method in class com.chilkatsoft.chilkat2.Rsa

Sets the OaepLabel property; see Rsa.getOaepLabel().

setOaepMgfHash(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the OaepMgfHash property; see Crypt2.getOaepMgfHash().

setOaepMgfHash(String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the OaepMgfHash property; see Email.getOaepMgfHash().

setOaepMgfHash(String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the OaepMgfHash property; see Mime.getOaepMgfHash().

setOaepMgfHash(String) - Method in class com.chilkatsoft.chilkat2.Rsa

Sets the OaepMgfHash property; see Rsa.getOaepMgfHash().

setOaepPadding(boolean) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the OaepPadding property; see Crypt2.getOaepPadding().

setOaepPadding(boolean) - Method in class com.chilkatsoft.chilkat2.Email

Sets the OaepPadding property; see Email.getOaepPadding().

setOaepPadding(boolean) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the OaepPadding property; see Mime.getOaepPadding().

setOAuth1(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the OAuth1 property; see Http.getOAuth1().

setOAuth2AccessToken(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the OAuth2AccessToken property; see MailMan.getOAuth2AccessToken().

setOAuthBodyHash(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the OAuthBodyHash property; see Http.getOAuthBodyHash().

setOAuthCallback(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the OAuthCallback property; see Http.getOAuthCallback().

setOAuthConsumerKey(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the OAuthConsumerKey property; see Http.getOAuthConsumerKey().

setOAuthConsumerSecret(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the OAuthConsumerSecret property; see Http.getOAuthConsumerSecret().

setOauthMethod(String) - Method in class com.chilkatsoft.chilkat2.OAuth1

Sets the OauthMethod property; see OAuth1.getOauthMethod().

setOAuthRealm(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the OAuthRealm property; see Http.getOAuthRealm().

setOAuthRsaKey(PrivateKey) - Method in class com.chilkatsoft.chilkat2.Http

Sets the RSA key to be used with OAuth 1.0a authentication when the Http.getOAuthSigMethod() is RSA-SHA256 or RSA-SHA1.

setOAuthSigMethod(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the OAuthSigMethod property; see Http.getOAuthSigMethod().

setOAuthToken(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the OAuthToken property; see Http.getOAuthToken().

setOAuthTokenSecret(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the OAuthTokenSecret property; see Http.getOAuthTokenSecret().

setOauthUrl(String) - Method in class com.chilkatsoft.chilkat2.OAuth1

Sets the OauthUrl property; see OAuth1.getOauthUrl().

setOAuthVerifier(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the OAuthVerifier property; see Http.getOAuthVerifier().

setOauthVersion(String) - Method in class com.chilkatsoft.chilkat2.OAuth1

Sets the OauthVersion property; see OAuth1.getOauthVersion().

setOemCodePage(int) - Method in class com.chilkatsoft.chilkat2.Ntlm

Sets the OemCodePage property; see Ntlm.getOemCodePage().

setOemCodePage(int) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the OemCodePage property; see Zip.getOemCodePage().

setOldestDateStr(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the oldest remote modification time eligible for Ftp2.downloadTree(String).

setOob(boolean) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the Oob property; see OAuth2.getOob().

setOpaqueSigning(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the OpaqueSigning property; see MailMan.getOpaqueSigning().

setOption(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Enables or disables a named compatibility option.

setOutboundBindIpAddress(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the OutboundBindIpAddress property; see SshTunnel.getOutboundBindIpAddress().

setOutboundBindPort(int) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the OutboundBindPort property; see SshTunnel.getOutboundBindPort().

setOutputSchema(String, JsonObject, boolean) - Method in class com.chilkatsoft.chilkat2.Ai

Requests schema-constrained JSON output (structured output) for subsequent calls to Ai.ask(String).

setOverwriteExisting(boolean) - Method in class com.chilkatsoft.chilkat2.Email

Sets the OverwriteExisting property; see Email.getOverwriteExisting().

setOverwriteExisting(boolean) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the OverwriteExisting property; see Zip.getOverwriteExisting().

setOwnerAndGroup(String, boolean, String, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the owner and group of the remote item identified by pathOrHandle.

setOwnerPassword(String) - Method in class com.chilkatsoft.chilkat2.Pdf

Sets the OwnerPassword property; see Pdf.getOwnerPassword().

setP12(Pfx) - Method in class com.chilkatsoft.chilkat2.AuthGoogle

Sets the P12 private key to be used for obtaining an access token.

setP7mEncryptAttachFilename(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the P7mEncryptAttachFilename property; see MailMan.getP7mEncryptAttachFilename().

setP7mSigAttachFilename(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the P7mSigAttachFilename property; see MailMan.getP7mSigAttachFilename().

setP7sSigAttachFilename(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the P7sSigAttachFilename property; see MailMan.getP7sSigAttachFilename().

setPaddingScheme(int) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the PaddingScheme property; see Crypt2.getPaddingScheme().

setPartSelector(String) - Method in class com.chilkatsoft.chilkat2.Rest

Sets the PartSelector property; see Rest.getPartSelector().

setPassive(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the Passive property; see Ftp2.getPassive().

setPassiveUseHostAddr(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the PassiveUseHostAddr property; see Ftp2.getPassiveUseHostAddr().

setPassword(int, String) - Method in class com.chilkatsoft.chilkat2.Jwe

Sets the PBES2 password for recipient index.

setPassword(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the Password property; see Ftp2.getPassword().

setPassword(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the Password property; see Http.getPassword().

setPassword(String) - Method in class com.chilkatsoft.chilkat2.Ntlm

Sets the Password property; see Ntlm.getPassword().

setPassword(String) - Method in class com.chilkatsoft.chilkat2.SshKey

Sets the Password property; see SshKey.getPassword().

setPassword(String) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the Password property; see Upload.getPassword().

setPassword(String, SecureString) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the POP3 or SMTP password from a SecureString.

setPasswordProtect(boolean) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the PasswordProtect property; see Zip.getPasswordProtect().

setPath(String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Sets the Path property; see HttpRequest.getPath().

setPath(String) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the Path property; see Upload.getPath().

setPathPrefix(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sets the PathPrefix property; see JsonObject.getPathPrefix().

setPathPrefix(String) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the PathPrefix property; see Zip.getPathPrefix().

setPayload(String, String, boolean) - Method in class com.chilkatsoft.chilkat2.Jws

Replaces the current payload with payload converted to bytes using charset charset.

setPayloadBd(BinData) - Method in class com.chilkatsoft.chilkat2.Jws

Replaces the current JWS payload with a copy of all bytes in binData.

setPayloadSb(StringBuilder, String, boolean) - Method in class com.chilkatsoft.chilkat2.Jws

Replaces the current payload with the text in sbPayload, converted to bytes using charset charset.

setPbes2CryptAlg(String) - Method in class com.chilkatsoft.chilkat2.Pfx

Sets the Pbes2CryptAlg property; see Pfx.getPbes2CryptAlg().

setPbes2HmacAlg(String) - Method in class com.chilkatsoft.chilkat2.Pfx

Sets the Pbes2HmacAlg property; see Pfx.getPbes2HmacAlg().

setPbesAlgorithm(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the PbesAlgorithm property; see Crypt2.getPbesAlgorithm().

setPbesPassword(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the PbesPassword property; see Crypt2.getPbesPassword().

setPcscLibPath(String) - Method in class com.chilkatsoft.chilkat2.SCard

Sets the PcscLibPath property; see SCard.getPcscLibPath().

setPeekMode(boolean) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the PeekMode property; see Imap.getPeekMode().

setPercentDoneOnSend(boolean) - Method in class com.chilkatsoft.chilkat2.Rest

Sets the PercentDoneOnSend property; see Rest.getPercentDoneOnSend().

setPercentDoneScale(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the PercentDoneScale property; see Ftp2.getPercentDoneScale().

setPercentDoneScale(int) - Method in class com.chilkatsoft.chilkat2.Http

Sets the PercentDoneScale property; see Http.getPercentDoneScale().

setPercentDoneScale(int) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the PercentDoneScale property; see Imap.getPercentDoneScale().

setPercentDoneScale(int) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the PercentDoneScale property; see MailMan.getPercentDoneScale().

setPercentDoneScale(int) - Method in class com.chilkatsoft.chilkat2.Scp

Sets the PercentDoneScale property; see Scp.getPercentDoneScale().

setPercentDoneScale(int) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the PercentDoneScale property; see SFtp.getPercentDoneScale().

setPercentDoneScale(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the PercentDoneScale property; see Socket.getPercentDoneScale().

setPercentDoneScale(int) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the PercentDoneScale property; see Tar.getPercentDoneScale().

setPercentDoneScale(int) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the PercentDoneScale property; see Upload.getPercentDoneScale().

setPercentDoneScale(int) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the PercentDoneScale property; see Zip.getPercentDoneScale().

setPermissions(String, boolean, int) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the POSIX permission bits for the remote item identified by pathOrHandle.

setPG(String, int) - Method in class com.chilkatsoft.chilkat2.Dh

Sets explicit finite-field Diffie-Hellman parameters for this object.

setPin(String, String) - Method in class com.chilkatsoft.chilkat2.Pkcs11

Modifies the PIN of the user that is currently logged in, or the Normal User PIN if the session is not logged in.

setPingAutoRespond(boolean) - Method in class com.chilkatsoft.chilkat2.WebSocket

Sets the PingAutoRespond property; see WebSocket.getPingAutoRespond().

setPkcs7CryptAlg(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the Pkcs7CryptAlg property; see Crypt2.getPkcs7CryptAlg().

setPkcs7CryptAlg(String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the Pkcs7CryptAlg property; see Email.getPkcs7CryptAlg().

setPkcs7CryptAlg(String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the Pkcs7CryptAlg property; see Mime.getPkcs7CryptAlg().

setPkcs7KeyLength(int) - Method in class com.chilkatsoft.chilkat2.Email

Sets the Pkcs7KeyLength property; see Email.getPkcs7KeyLength().

setPkcs7KeyLength(int) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the Pkcs7KeyLength property; see Mime.getPkcs7KeyLength().

setPkcs8EncryptAlg(String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Sets the Pkcs8EncryptAlg property; see PrivateKey.getPkcs8EncryptAlg().

setPkcsPadding(boolean) - Method in class com.chilkatsoft.chilkat2.Rsa

Sets the PkcsPadding property; see Rsa.getPkcsPadding().

setPongAutoConsume(boolean) - Method in class com.chilkatsoft.chilkat2.WebSocket

Sets the PongAutoConsume property; see WebSocket.getPongAutoConsume().

setPop3SPA(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the Pop3SPA property; see MailMan.getPop3SPA().

setPop3Stls(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the Pop3Stls property; see MailMan.getPop3Stls().

setPop3StlsIfPossible(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the Pop3StlsIfPossible property; see MailMan.getPop3StlsIfPossible().

setPopPassword(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the PopPassword property; see MailMan.getPopPassword().

setPopPasswordBase64(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the PopPasswordBase64 property; see MailMan.getPopPasswordBase64().

setPopSsl(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the PopSsl property; see MailMan.getPopSsl().

setPopUsername(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the PopUsername property; see MailMan.getPopUsername().

setPort(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the Port property; see Ftp2.getPort().

setPort(int) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the Port property; see Imap.getPort().

setPort(int) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the Port property; see Upload.getPort().

setPrecomputedMd5(String) - Method in class com.chilkatsoft.chilkat2.AuthAws

Sets the PrecomputedMd5 property; see AuthAws.getPrecomputedMd5().

setPrecomputedSha256(String) - Method in class com.chilkatsoft.chilkat2.AuthAws

Sets the PrecomputedSha256 property; see AuthAws.getPrecomputedSha256().

setPreferCompact(boolean) - Method in class com.chilkatsoft.chilkat2.Jwe

Sets the PreferCompact property; see Jwe.getPreferCompact().

setPreferCompact(boolean) - Method in class com.chilkatsoft.chilkat2.Jws

Sets the PreferCompact property; see Jws.getPreferCompact().

setPreferFlattened(boolean) - Method in class com.chilkatsoft.chilkat2.Jwe

Sets the PreferFlattened property; see Jwe.getPreferFlattened().

setPreferFlattened(boolean) - Method in class com.chilkatsoft.chilkat2.Jws

Sets the PreferFlattened property; see Jws.getPreferFlattened().

setPreferIpv6(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the PreferIpv6 property; see Ftp2.getPreferIpv6().

setPreferIpv6(boolean) - Method in class com.chilkatsoft.chilkat2.Global

Sets the PreferIpv6 property; see Global.getPreferIpv6().

setPreferIpv6(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the PreferIpv6 property; see Http.getPreferIpv6().

setPreferIpv6(boolean) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the PreferIpv6 property; see Imap.getPreferIpv6().

setPreferIpv6(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the PreferIpv6 property; see MailMan.getPreferIpv6().

setPreferIpv6(boolean) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the PreferIpv6 property; see Mht.getPreferIpv6().

setPreferIpv6(boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the PreferIpv6 property; see SFtp.getPreferIpv6().

setPreferIpv6(boolean) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the PreferIpv6 property; see Socket.getPreferIpv6().

setPreferIpv6(boolean) - Method in class com.chilkatsoft.chilkat2.Spider

Sets the PreferIpv6 property; see Spider.getPreferIpv6().

setPreferIpv6(boolean) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the PreferIpv6 property; see Ssh.getPreferIpv6().

setPreferIpv6(boolean) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the PreferIpv6 property; see SshTunnel.getPreferIpv6().

setPreferIpv6(boolean) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the PreferIpv6 property; see Upload.getPreferIpv6().

setPreferMHTScripts(boolean) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the PreferMHTScripts property; see Mht.getPreferMHTScripts().

setPreferNlst(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the PreferNlst property; see Ftp2.getPreferNlst().

setPreferredCharset(String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the PreferredCharset property; see Email.getPreferredCharset().

setPrependHeaders(boolean) - Method in class com.chilkatsoft.chilkat2.Email

Sets the PrependHeaders property; see Email.getPrependHeaders().

setPreserveDate(boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the PreserveDate property; see SFtp.getPreserveDate().

setPreserveSignatures(boolean) - Method in class com.chilkatsoft.chilkat2.Pdf

Sets the PreserveSignatures property; see Pdf.getPreserveSignatures().

setPrivateKey(int, PrivateKey) - Method in class com.chilkatsoft.chilkat2.Jwe

Sets the private key used to decrypt recipient index.

setPrivateKey(int, PrivateKey) - Method in class com.chilkatsoft.chilkat2.Jws

Sets a private key for creating signature index.

setPrivateKey(PrivateKey) - Method in class com.chilkatsoft.chilkat2.Cert

Used to associate a private key with the certificate for subsequent (PKCS7) signature creation or decryption.

setPrivateKey(PrivateKey) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the private key to be used for creating the XML signature.

setPrivateKeyFormat(String) - Method in class com.chilkatsoft.chilkat2.Pem

Sets the PrivateKeyFormat property; see Pem.getPrivateKeyFormat().

setPrivateKeyPem(String) - Method in class com.chilkatsoft.chilkat2.Cert

Same as SetPrivateKey, but the key is provided in unencrypted PEM format.

setPrngName(String) - Method in class com.chilkatsoft.chilkat2.Prng

Sets the PrngName property; see Prng.getPrngName().

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Ai

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.AuthGoogle

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Bz2

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Cert

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.CodeSign

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Compression

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Crypt2

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Dkim

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Dns

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Ftp2

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Gzip

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Http

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Imap

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Js

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.MailMan

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Mcp

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Mht

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.OAuth2

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Pdf

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Rest

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.SCard

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Scp

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Secrets

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.SFtp

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Socket

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Spider

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Ssh

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Stream

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Tar

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.TrustedRoots

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.UnixCompress

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Upload

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.WebSocket

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.Zip

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.ZipCrc

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressListener(ProgressListener) - Method in class com.chilkatsoft.chilkat2.ZipEntry

Installs the listener that receives this object's progress events (abortCheck, percentDone, progressInfo) during its long-running methods; replaces any listener or lambda installed before; null removes it.

setProgressMonSize(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the ProgressMonSize property; see Ftp2.getProgressMonSize().

setProgressMonSize64(long) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the ProgressMonSize64 property; see Ftp2.getProgressMonSize64().

setProtectedHeader(int, JsonObject) - Method in class com.chilkatsoft.chilkat2.Jws

Sets the protected JOSE header for signature index.

setProtectedHeader(JsonObject) - Method in class com.chilkatsoft.chilkat2.Jwe

Sets the shared JWE Protected Header from json.

setProtocol(String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the Protocol property; see Mime.getProtocol().

setProtocolVersion(String) - Method in class com.chilkatsoft.chilkat2.Mcp

Sets the ProtocolVersion property; see Mcp.getProtocolVersion().

setProvider(String) - Method in class com.chilkatsoft.chilkat2.Ai

Sets the Provider property; see Ai.getProvider().

setProviderParams(JsonObject) - Method in class com.chilkatsoft.chilkat2.Ai

Sets additional provider params needed for some pre-defined providers.

setProxy(String) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the Proxy property; see Mht.getProxy().

setProxyAuthMethod(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the ProxyAuthMethod property; see Http.getProxyAuthMethod().

setProxyDirectTls(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the ProxyDirectTls property; see Http.getProxyDirectTls().

setProxyDomain(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the ProxyDomain property; see Http.getProxyDomain().

setProxyDomain(String) - Method in class com.chilkatsoft.chilkat2.Spider

Sets the ProxyDomain property; see Spider.getProxyDomain().

setProxyDomain(String) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the ProxyDomain property; see Upload.getProxyDomain().

setProxyHostname(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the ProxyHostname property; see Ftp2.getProxyHostname().

setProxyLogin(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the ProxyLogin property; see Http.getProxyLogin().

setProxyLogin(String) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the ProxyLogin property; see Mht.getProxyLogin().

setProxyLogin(String) - Method in class com.chilkatsoft.chilkat2.Spider

Sets the ProxyLogin property; see Spider.getProxyLogin().

setProxyLogin(String) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the ProxyLogin property; see Upload.getProxyLogin().

setProxyLoginDomain(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the ProxyLoginDomain property; see Http.getProxyLoginDomain().

setProxyMethod(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the ProxyMethod property; see Ftp2.getProxyMethod().

setProxyPassword(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the ProxyPassword property; see Ftp2.getProxyPassword().

setProxyPassword(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the ProxyPassword property; see Http.getProxyPassword().

setProxyPassword(String) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the ProxyPassword property; see Mht.getProxyPassword().

setProxyPassword(String) - Method in class com.chilkatsoft.chilkat2.Spider

Sets the ProxyPassword property; see Spider.getProxyPassword().

setProxyPassword(String) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the ProxyPassword property; see Upload.getProxyPassword().

setProxyPort(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the ProxyPort property; see Ftp2.getProxyPort().

setProxyPort(int) - Method in class com.chilkatsoft.chilkat2.Http

Sets the ProxyPort property; see Http.getProxyPort().

setProxyPort(int) - Method in class com.chilkatsoft.chilkat2.Spider

Sets the ProxyPort property; see Spider.getProxyPort().

setProxyPort(int) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the ProxyPort property; see Upload.getProxyPort().

setProxyUsername(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the ProxyUsername property; see Ftp2.getProxyUsername().

setPssPadding(boolean) - Method in class com.chilkatsoft.chilkat2.Csr

Sets the PssPadding property; see Csr.getPssPadding().

setPssSaltLen(int) - Method in class com.chilkatsoft.chilkat2.Rsa

Sets the PssSaltLen property; see Rsa.getPssSaltLen().

setPubKeyExplicit(int, String, String, String, String) - Method in class com.chilkatsoft.chilkat2.Dsa

Loads a DSA public key from explicitly supplied components.

setPublicKey(int, PublicKey) - Method in class com.chilkatsoft.chilkat2.Jwe

Sets the public key used to encrypt for recipient index.

setPublicKey(int, PublicKey) - Method in class com.chilkatsoft.chilkat2.Jws

Sets the public key used to validate signature index.

setPublicKey(PublicKey) - Method in class com.chilkatsoft.chilkat2.XmlDSig

Sets the public key to be used for verifying the signature indicated by the Selector property.

setPublicKeyFormat(String) - Method in class com.chilkatsoft.chilkat2.Pem

Sets the PublicKeyFormat property; see Pem.getPublicKeyFormat().

setPwdProtCharset(String) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the PwdProtCharset property; see Zip.getPwdProtCharset().

setQuota(String, String, int) - Method in class com.chilkatsoft.chilkat2.Imap

Sends the IMAP SETQUOTA command for quota root quotaRoot.

setRc2EffectiveKeyLength(int) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the Rc2EffectiveKeyLength property; see Crypt2.getRc2EffectiveKeyLength().

setReadDirMustMatch(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the ReadDirMustMatch property; see SFtp.getReadDirMustMatch().

setReadDirMustNotMatch(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the ReadDirMustNotMatch property; see SFtp.getReadDirMustNotMatch().

setReadOnly(boolean) - Method in class com.chilkatsoft.chilkat2.SecureString

Sets the ReadOnly property; see SecureString.getReadOnly().

setReadTimeout(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the ReadTimeout property; see Ftp2.getReadTimeout().

setReadTimeout(int) - Method in class com.chilkatsoft.chilkat2.Http

Sets the ReadTimeout property; see Http.getReadTimeout().

setReadTimeout(int) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the ReadTimeout property; see Imap.getReadTimeout().

setReadTimeout(int) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the ReadTimeout property; see MailMan.getReadTimeout().

setReadTimeout(int) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the ReadTimeout property; see Mht.getReadTimeout().

setReadTimeout(int) - Method in class com.chilkatsoft.chilkat2.Spider

Sets the ReadTimeout property; see Spider.getReadTimeout().

setReadTimeoutMs(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the ReadTimeoutMs property; see Ssh.getReadTimeoutMs().

setReadTimeoutMs(int) - Method in class com.chilkatsoft.chilkat2.Stream

Sets the ReadTimeoutMs property; see Stream.getReadTimeoutMs().

setRealm(String) - Method in class com.chilkatsoft.chilkat2.OAuth1

Sets the Realm property; see OAuth1.getRealm().

setReceivedCount(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the ReceivedCount property; see Socket.getReceivedCount().

setReceivedInt(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the ReceivedInt property; see Socket.getReceivedInt().

setReceivePacketSize(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the ReceivePacketSize property; see Socket.getReceivePacketSize().

setRecipientHeader(int, JsonObject) - Method in class com.chilkatsoft.chilkat2.Jwe

Sets the per-recipient unprotected header for zero-based recipient index index.

setRecurse(boolean) - Method in class com.chilkatsoft.chilkat2.DirTree

Sets the Recurse property; see DirTree.getRecurse().

setRedirectAllowHtml(String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the RedirectAllowHtml property; see OAuth2.getRedirectAllowHtml().

setRedirectDenyHtml(String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the RedirectDenyHtml property; see OAuth2.getRedirectDenyHtml().

setRedirectVerb(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the RedirectVerb property; see Http.getRedirectVerb().

setRefDataBd(int, BinData) - Method in class com.chilkatsoft.chilkat2.XmlDSig

Provides the binary data for the external reference at index.

setRefDataFile(int, String) - Method in class com.chilkatsoft.chilkat2.XmlDSig

Provides the data for the external reference at index.

setRefDataSb(int, StringBuilder, String) - Method in class com.chilkatsoft.chilkat2.XmlDSig

Provides the text data for the external reference at index.

setRefIdAttr(String, String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the Id attribute for a Reference.

setRefreshHeader(String, String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Adds or replaces an HTTP request header used by subsequent calls to OAuth2.refreshAccessToken().

setRefreshToken(String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the RefreshToken property; see OAuth2.getRefreshToken().

setRegion(String) - Method in class com.chilkatsoft.chilkat2.AuthAws

Sets the Region property; see AuthAws.getRegion().

setRejectSelfSignedCerts(boolean) - Method in class com.chilkatsoft.chilkat2.TrustedRoots

Sets the RejectSelfSignedCerts property; see TrustedRoots.getRejectSelfSignedCerts().

setRelatedFilename(int, String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the filename for a related item within the email.

setRemoteFileDateTimeStr(String, String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the last-modified time of the remote file at remoteFilename.

setRemoteFileDt(DateTime, String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the last-modified time of the remote file at remoteFilename using the CkDateTime in dt.

setReplacePattern(String, String) - Method in class com.chilkatsoft.chilkat2.Email

Defines a mail-merge replacement pair.

setReplyTo(String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the ReplyTo property; see Email.getReplyTo().

setReqExecCharset(String) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the ReqExecCharset property; see Ssh.getReqExecCharset().

setRequestHeader(String, String) - Method in class com.chilkatsoft.chilkat2.Http

Adds a header field to be included in all HTTP requests, except for those sent by the Http.httpReq(String, HttpRequest, HttpResponse) and Http.httpSReq(String, int, boolean, HttpRequest, HttpResponse) methods, which rely on header fields provided in an HttpRequest object via method arguments.

setRequireCompleteChain(boolean) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Sets the RequireCompleteChain property; see JavaKeyStore.getRequireCompleteChain().

setRequiredContentType(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the RequiredContentType property; see Http.getRequiredContentType().

setRequireHostnameMatch(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the RequireHostnameMatch property; see Http.getRequireHostnameMatch().

setRequireHostnameMatch(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the RequireHostnameMatch property; see MailMan.getRequireHostnameMatch().

setRequireSniMatch(boolean) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the RequireSniMatch property; see Socket.getRequireSniMatch().

setRequireSslCertVerify(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the RequireSslCertVerify property; see Ftp2.getRequireSslCertVerify().

setRequireSslCertVerify(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the RequireSslCertVerify property; see Http.getRequireSslCertVerify().

setRequireSslCertVerify(boolean) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the RequireSslCertVerify property; see Imap.getRequireSslCertVerify().

setRequireSslCertVerify(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the RequireSslCertVerify property; see MailMan.getRequireSslCertVerify().

setRequireSslCertVerify(boolean) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the RequireSslCertVerify property; see Mht.getRequireSslCertVerify().

setRequireSslCertVerify(boolean) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the RequireSslCertVerify property; see Socket.getRequireSslCertVerify().

setResetDateOnLoad(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the ResetDateOnLoad property; see MailMan.getResetDateOnLoad().

setResource(String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the Resource property; see OAuth2.getResource().

setResponseBodyStream(int, boolean, Stream) - Method in class com.chilkatsoft.chilkat2.Rest

Configures a Stream destination for response bodies received by the full-request convenience methods.

setResponseFilePath(String) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Sets the ResponseFilePath property; see HttpCurl.getResponseFilePath().

setResponseMode(String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the ResponseMode property; see OAuth2.getResponseMode().

setResponseType(String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the ResponseType property; see OAuth2.getResponseType().

setRestartNext(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the RestartNext property; see Ftp2.getRestartNext().

setReturnReceipt(boolean) - Method in class com.chilkatsoft.chilkat2.Email

Sets the ReturnReceipt property; see Email.getReturnReceipt().

setRightMargin(int) - Method in class com.chilkatsoft.chilkat2.HtmlToText

Sets the RightMargin property; see HtmlToText.getRightMargin().

setRsaKey(PrivateKey) - Method in class com.chilkatsoft.chilkat2.OAuth1

Sets the RSA key to be used when the SignatureMethod is set to RSA-SHA1 or RSA-SHA2.

setRsaPaddingHash(String) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Sets the RsaPaddingHash property; see ScMinidriver.getRsaPaddingHash().

setRsaPaddingScheme(String) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Sets the RsaPaddingScheme property; see ScMinidriver.getRsaPaddingScheme().

setSafeBagAttr(boolean, int, String, String, String) - Method in class com.chilkatsoft.chilkat2.Pfx

Sets a safe-bag attribute on a private key or certificate contained in this PFX.

setSaveCookies(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the SaveCookies property; see Http.getSaveCookies().

setSaveLast(boolean) - Method in class com.chilkatsoft.chilkat2.Charset

Sets the SaveLast property; see Charset.getSaveLast().

setScheme(String) - Method in class com.chilkatsoft.chilkat2.AuthAzureStorage

Sets the Scheme property; see AuthAzureStorage.getScheme().

setScope(String) - Method in class com.chilkatsoft.chilkat2.AuthGoogle

Sets the Scope property; see AuthGoogle.getScope().

setScope(String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the Scope property; see OAuth2.getScope().

setScriptFileMode(int) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the ScriptFileMode property; see Tar.getScriptFileMode().

setSearchCharset(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the SearchCharset property; see Imap.getSearchCharset().

setSecond(int) - Method in class com.chilkatsoft.chilkat2.DtObj

Sets the Second property; see DtObj.getSecond().

setSecretKey(String) - Method in class com.chilkatsoft.chilkat2.AuthAws

Sets the SecretKey property; see AuthAws.getSecretKey().

setSecurePassword(SecureString) - Method in class com.chilkatsoft.chilkat2.Ftp2

Copies the password from the SecureString in password for subsequent FTP authentication.

setSecurePassword(SecureString) - Method in class com.chilkatsoft.chilkat2.Http

Equivalent to setting the Http.getPassword() property but offers a more secure method by using a secure string object.

setSelectedConvo(String) - Method in class com.chilkatsoft.chilkat2.Ai

Sets the SelectedConvo property; see Ai.getSelectedConvo().

setSelector(int) - Method in class com.chilkatsoft.chilkat2.XmlDSig

Sets the Selector property; see XmlDSig.getSelector().

setSelectorIndex(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the SelectorIndex property; see Socket.getSelectorIndex().

setSelectorReadIndex(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the SelectorReadIndex property; see Socket.getSelectorReadIndex().

setSelectorWriteIndex(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the SelectorWriteIndex property; see Socket.getSelectorWriteIndex().

setSendBufferSize(int) - Method in class com.chilkatsoft.chilkat2.Http

Sets the SendBufferSize property; see Http.getSendBufferSize().

setSendBufferSize(int) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the SendBufferSize property; see Imap.getSendBufferSize().

setSendBufferSize(int) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SendBufferSize property; see MailMan.getSendBufferSize().

setSendCharset(boolean) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Sets the SendCharset property; see HttpRequest.getSendCharset().

setSendCookies(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the SendCookies property; see Http.getSendCookies().

setSendEncrypted(boolean) - Method in class com.chilkatsoft.chilkat2.Email

Sets the SendEncrypted property; see Email.getSendEncrypted().

setSendEnv(String) - Method in class com.chilkatsoft.chilkat2.Scp

Sets the SendEnv property; see Scp.getSendEnv().

setSendPacketSize(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the SendPacketSize property; see Socket.getSendPacketSize().

setSendSigned(boolean) - Method in class com.chilkatsoft.chilkat2.Email

Sets the SendSigned property; see Email.getSendSigned().

setSeparatorChar(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the SeparatorChar property; see Imap.getSeparatorChar().

setServerChallenge(String) - Method in class com.chilkatsoft.chilkat2.Ntlm

Sets the ServerChallenge property; see Ntlm.getServerChallenge().

setService(String) - Method in class com.chilkatsoft.chilkat2.AuthAzureStorage

Sets the Service property; see AuthAzureStorage.getService().

setServiceName(String) - Method in class com.chilkatsoft.chilkat2.AuthAws

Sets the ServiceName property; see AuthAws.getServiceName().

setSessionLogEncoding(String) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the SessionLogEncoding property; see Socket.getSessionLogEncoding().

setSessionLogFilename(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the SessionLogFilename property; see Http.getSessionLogFilename().

setSharedLibPath(String) - Method in class com.chilkatsoft.chilkat2.Pkcs11

Sets the SharedLibPath property; see Pkcs11.getSharedLibPath().

setSigAllocateSize(int) - Method in class com.chilkatsoft.chilkat2.Pdf

Sets the SigAllocateSize property; see Pdf.getSigAllocateSize().

setSigContextPin(String) - Method in class com.chilkatsoft.chilkat2.Pkcs11

Sets the SigContextPin property; see Pkcs11.getSigContextPin().

setSigId(String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the SigId property; see XmlDSigGen.getSigId().

setSigLocation(String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the SigLocation property; see XmlDSigGen.getSigLocation().

setSigLocationIdx(int) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the SigLocationIdx property; see XmlDSigGen.getSigLocationIdx().

setSigLocationMod(int) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the SigLocationMod property; see XmlDSigGen.getSigLocationMod().

setSigNamespacePrefix(String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the SigNamespacePrefix property; see XmlDSigGen.getSigNamespacePrefix().

setSigNamespaceUri(String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the SigNamespaceUri property; see XmlDSigGen.getSigNamespaceUri().

setSignatureJpeg(BinData) - Method in class com.chilkatsoft.chilkat2.Pdf

Provides an optional JPG image to be included in the signature appearance.

setSignatureMethod(String) - Method in class com.chilkatsoft.chilkat2.OAuth1

Sets the SignatureMethod property; see OAuth1.getSignatureMethod().

setSignatureVersion(int) - Method in class com.chilkatsoft.chilkat2.AuthAws

Sets the SignatureVersion property; see AuthAws.getSignatureVersion().

setSignedInfoCanonAlg(String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the SignedInfoCanonAlg property; see XmlDSigGen.getSignedInfoCanonAlg().

setSignedInfoDigestMethod(String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the SignedInfoDigestMethod property; see XmlDSigGen.getSignedInfoDigestMethod().

setSignedInfoId(String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the SignedInfoId property; see XmlDSigGen.getSignedInfoId().

setSignedInfoPrefixList(String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the SignedInfoPrefixList property; see XmlDSigGen.getSignedInfoPrefixList().

setSigningAlg(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the SigningAlg property; see Crypt2.getSigningAlg().

setSigningAlg(String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the SigningAlg property; see Email.getSigningAlg().

setSigningAlg(String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the SigningAlg property; see Mime.getSigningAlg().

setSigningAlg(String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the SigningAlg property; see XmlDSigGen.getSigningAlg().

setSigningAttributes(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the SigningAttributes property; see Crypt2.getSigningAttributes().

setSigningCert(int, Cert) - Method in class com.chilkatsoft.chilkat2.Jws

Sets the certificate whose associated private key will be used to create signature index.

setSigningCert(Cert) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the digital certificate to be used for signing.

setSigningCert(Cert) - Method in class com.chilkatsoft.chilkat2.Email

Sets the certificate in cert for creating a digital signature.

setSigningCert(Cert) - Method in class com.chilkatsoft.chilkat2.Pdf

Specifies a certificate to be used when signing the PDF.

setSigningCert2(Cert, PrivateKey) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the digital certificate and associated private key for signing.

setSigningCert2(Cert, PrivateKey) - Method in class com.chilkatsoft.chilkat2.Email

Explicitly sets the certificate in cert and the corresponding private key in key for sending digitally signed email.

setSigningCert2(Cert, PrivateKey) - Method in class com.chilkatsoft.chilkat2.Pdf

Specifies a digital certificate and private key to be used for signing the PDF.

setSigningHashAlg(String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the SigningHashAlg property; see Email.getSigningHashAlg().

setSigningHashAlg(String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the SigningHashAlg property; see Mime.getSigningHashAlg().

setSigValueId(String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the SigValueId property; see XmlDSigGen.getSigValueId().

setSinkFile(String) - Method in class com.chilkatsoft.chilkat2.Stream

Sets the SinkFile property; see Stream.getSinkFile().

setSinkFileAppend(boolean) - Method in class com.chilkatsoft.chilkat2.Stream

Sets the SinkFileAppend property; see Stream.getSinkFileAppend().

setSizeLimit(int) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SizeLimit property; see MailMan.getSizeLimit().

setSmartCardNoDialog(boolean) - Method in class com.chilkatsoft.chilkat2.Cert

Sets the SmartCardNoDialog property; see Cert.getSmartCardNoDialog().

setSmartCardPin(String) - Method in class com.chilkatsoft.chilkat2.Cert

Sets the SmartCardPin property; see Cert.getSmartCardPin().

setSmartCardPin(String) - Method in class com.chilkatsoft.chilkat2.CertStore

Sets the SmartCardPin property; see CertStore.getSmartCardPin().

setSmtpAuthMethod(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SmtpAuthMethod property; see MailMan.getSmtpAuthMethod().

setSmtpHost(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SmtpHost property; see MailMan.getSmtpHost().

setSmtpLoginDomain(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SmtpLoginDomain property; see MailMan.getSmtpLoginDomain().

setSmtpMailFrom(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SmtpMailFrom property; see MailMan.getSmtpMailFrom().

setSmtpPassword(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SmtpPassword property; see MailMan.getSmtpPassword().

setSmtpPipelining(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SmtpPipelining property; see MailMan.getSmtpPipelining().

setSmtpPort(int) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SmtpPort property; see MailMan.getSmtpPort().

setSmtpSsl(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SmtpSsl property; see MailMan.getSmtpSsl().

setSmtpUsername(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SmtpUsername property; see MailMan.getSmtpUsername().

setSniHostname(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the SniHostname property; see Http.getSniHostname().

setSniHostname(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SniHostname property; see MailMan.getSniHostname().

setSniHostname(String) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the SniHostname property; see Socket.getSniHostname().

setSocksHostname(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the SocksHostname property; see Ftp2.getSocksHostname().

setSocksHostname(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the SocksHostname property; see Http.getSocksHostname().

setSocksHostname(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the SocksHostname property; see Imap.getSocksHostname().

setSocksHostname(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SocksHostname property; see MailMan.getSocksHostname().

setSocksHostname(String) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the SocksHostname property; see Mht.getSocksHostname().

setSocksHostname(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the SocksHostname property; see SFtp.getSocksHostname().

setSocksHostname(String) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the SocksHostname property; see Socket.getSocksHostname().

setSocksHostname(String) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the SocksHostname property; see Ssh.getSocksHostname().

setSocksHostname(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the SocksHostname property; see SshTunnel.getSocksHostname().

setSocksPassword(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the SocksPassword property; see Ftp2.getSocksPassword().

setSocksPassword(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the SocksPassword property; see Http.getSocksPassword().

setSocksPassword(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the SocksPassword property; see Imap.getSocksPassword().

setSocksPassword(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SocksPassword property; see MailMan.getSocksPassword().

setSocksPassword(String) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the SocksPassword property; see Mht.getSocksPassword().

setSocksPassword(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the SocksPassword property; see SFtp.getSocksPassword().

setSocksPassword(String) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the SocksPassword property; see Socket.getSocksPassword().

setSocksPassword(String) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the SocksPassword property; see Ssh.getSocksPassword().

setSocksPassword(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the SocksPassword property; see SshTunnel.getSocksPassword().

setSocksPort(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the SocksPort property; see Ftp2.getSocksPort().

setSocksPort(int) - Method in class com.chilkatsoft.chilkat2.Http

Sets the SocksPort property; see Http.getSocksPort().

setSocksPort(int) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the SocksPort property; see Imap.getSocksPort().

setSocksPort(int) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SocksPort property; see MailMan.getSocksPort().

setSocksPort(int) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the SocksPort property; see Mht.getSocksPort().

setSocksPort(int) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the SocksPort property; see SFtp.getSocksPort().

setSocksPort(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the SocksPort property; see Socket.getSocksPort().

setSocksPort(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the SocksPort property; see Ssh.getSocksPort().

setSocksPort(int) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the SocksPort property; see SshTunnel.getSocksPort().

setSocksUsername(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the SocksUsername property; see Ftp2.getSocksUsername().

setSocksUsername(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the SocksUsername property; see Http.getSocksUsername().

setSocksUsername(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the SocksUsername property; see Imap.getSocksUsername().

setSocksUsername(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SocksUsername property; see MailMan.getSocksUsername().

setSocksUsername(String) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the SocksUsername property; see Mht.getSocksUsername().

setSocksUsername(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the SocksUsername property; see SFtp.getSocksUsername().

setSocksUsername(String) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the SocksUsername property; see Socket.getSocksUsername().

setSocksUsername(String) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the SocksUsername property; see Ssh.getSocksUsername().

setSocksUsername(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the SocksUsername property; see SshTunnel.getSocksUsername().

setSocksVersion(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the SocksVersion property; see Ftp2.getSocksVersion().

setSocksVersion(int) - Method in class com.chilkatsoft.chilkat2.Http

Sets the SocksVersion property; see Http.getSocksVersion().

setSocksVersion(int) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the SocksVersion property; see Imap.getSocksVersion().

setSocksVersion(int) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SocksVersion property; see MailMan.getSocksVersion().

setSocksVersion(int) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the SocksVersion property; see Mht.getSocksVersion().

setSocksVersion(int) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the SocksVersion property; see SFtp.getSocksVersion().

setSocksVersion(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the SocksVersion property; see Socket.getSocksVersion().

setSocksVersion(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the SocksVersion property; see Ssh.getSocksVersion().

setSocksVersion(int) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the SocksVersion property; see SshTunnel.getSocksVersion().

setSoRcvBuf(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the SoRcvBuf property; see Ftp2.getSoRcvBuf().

setSoRcvBuf(int) - Method in class com.chilkatsoft.chilkat2.Http

Sets the SoRcvBuf property; see Http.getSoRcvBuf().

setSoRcvBuf(int) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the SoRcvBuf property; see Imap.getSoRcvBuf().

setSoRcvBuf(int) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SoRcvBuf property; see MailMan.getSoRcvBuf().

setSoRcvBuf(int) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the SoRcvBuf property; see SFtp.getSoRcvBuf().

setSoRcvBuf(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the SoRcvBuf property; see Socket.getSoRcvBuf().

setSoRcvBuf(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the SoRcvBuf property; see Ssh.getSoRcvBuf().

setSoRcvBuf(int) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the SoRcvBuf property; see SshTunnel.getSoRcvBuf().

setSoReuseAddr(boolean) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the SoReuseAddr property; see Socket.getSoReuseAddr().

setSortCaseInsensitive(boolean) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the SortCaseInsensitive property; see Xml.getSortCaseInsensitive().

setSortCriteria(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the SortCriteria property; see Imap.getSortCriteria().

setSoSndBuf(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the SoSndBuf property; see Ftp2.getSoSndBuf().

setSoSndBuf(int) - Method in class com.chilkatsoft.chilkat2.Http

Sets the SoSndBuf property; see Http.getSoSndBuf().

setSoSndBuf(int) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the SoSndBuf property; see Imap.getSoSndBuf().

setSoSndBuf(int) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SoSndBuf property; see MailMan.getSoSndBuf().

setSoSndBuf(int) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the SoSndBuf property; see SFtp.getSoSndBuf().

setSoSndBuf(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the SoSndBuf property; see Socket.getSoSndBuf().

setSoSndBuf(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the SoSndBuf property; see Ssh.getSoSndBuf().

setSoSndBuf(int) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the SoSndBuf property; see SshTunnel.getSoSndBuf().

setSourceFile(String) - Method in class com.chilkatsoft.chilkat2.Stream

Sets the SourceFile property; see Stream.getSourceFile().

setSourceFilePart(int) - Method in class com.chilkatsoft.chilkat2.Stream

Sets the SourceFilePart property; see Stream.getSourceFilePart().

setSourceFilePartSize(int) - Method in class com.chilkatsoft.chilkat2.Stream

Sets the SourceFilePartSize property; see Stream.getSourceFilePartSize().

setSourceString(String, String) - Method in class com.chilkatsoft.chilkat2.Stream

Sets the stream's source to the contents of srcStr.

setSsl(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the Ssl property; see Ftp2.getSsl().

setSsl(boolean) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the Ssl property; see Imap.getSsl().

setSsl(boolean) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the Ssl property; see Socket.getSsl().

setSsl(boolean) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the Ssl property; see Upload.getSsl().

setSslAllowedCiphers(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the SslAllowedCiphers property; see Ftp2.getSslAllowedCiphers().

setSslAllowedCiphers(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the SslAllowedCiphers property; see Http.getSslAllowedCiphers().

setSslAllowedCiphers(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the SslAllowedCiphers property; see Imap.getSslAllowedCiphers().

setSslAllowedCiphers(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SslAllowedCiphers property; see MailMan.getSslAllowedCiphers().

setSslAllowedCiphers(String) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the SslAllowedCiphers property; see Socket.getSslAllowedCiphers().

setSslAllowedCiphers(String) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the SslAllowedCiphers property; see Upload.getSslAllowedCiphers().

setSslCertRequirement(String, String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Adds a required match against the FTP server certificate.

setSslCertRequirement(String, String) - Method in class com.chilkatsoft.chilkat2.Http

Enforces a requirement on the server's certificate.

setSslClientCert(Cert) - Method in class com.chilkatsoft.chilkat2.Ftp2

Configures the Cert in cert as the client certificate for FTPS servers that request mutual TLS authentication.

setSslClientCert(Cert) - Method in class com.chilkatsoft.chilkat2.Http

Facilitates the use of a client-side certificate for a TLS connection, enabling mutual authentication.

setSslClientCert(Cert) - Method in class com.chilkatsoft.chilkat2.Imap

Specifies the client certificate in cert for TLS client-certificate authentication.

setSslClientCert(Cert) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the client-side certificate to use for SSL/TLS connections.

setSslClientCert(Cert) - Method in class com.chilkatsoft.chilkat2.Socket

Configures cert as the client certificate for subsequent TLS connections.

setSslClientCertPem(String, String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Configures a client certificate and private key from PEM data or a PEM file.

setSslClientCertPem(String, String) - Method in class com.chilkatsoft.chilkat2.Http

This is identical to the Http.setSslClientCert(Cert) method, but it allows the certificate with a private key to be in PEM format.

setSslClientCertPem(String, String) - Method in class com.chilkatsoft.chilkat2.Imap

Specifies a TLS client certificate and private key from PEM data or a PEM file.

setSslClientCertPem(String, String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the client-side certificate to use for SSL/TLS connections, loading it from PEM data or from a PEM file.

setSslClientCertPem(String, String) - Method in class com.chilkatsoft.chilkat2.Socket

Loads and configures a TLS client certificate and private key from PEM data or a PEM filename supplied in pemDataOrFilename.

setSslClientCertPfx(String, String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Loads a client certificate and private key from the local PFX/P12 file at pfxFilename.

setSslClientCertPfx(String, String) - Method in class com.chilkatsoft.chilkat2.Http

This is identical to the Http.setSslClientCert(Cert) method, but enables you to provide a certificate with private key directly from a .pfx or .p12 file.

setSslClientCertPfx(String, String) - Method in class com.chilkatsoft.chilkat2.Imap

Specifies a TLS client certificate and private key from a PKCS #12/PFX file.

setSslClientCertPfx(String, String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the client-side certificate to use for SSL/TLS connections, loading it from a PFX/PKCS#12 file.

setSslClientCertPfx(String, String) - Method in class com.chilkatsoft.chilkat2.Socket

Loads and configures a TLS client certificate and private key from the PFX/P12 file pfxFilename, using pfxPassword.

setSslProtocol(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the SslProtocol property; see Ftp2.getSslProtocol().

setSslProtocol(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the SslProtocol property; see Http.getSslProtocol().

setSslProtocol(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the SslProtocol property; see Imap.getSslProtocol().

setSslProtocol(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the SslProtocol property; see MailMan.getSslProtocol().

setSslProtocol(String) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the SslProtocol property; see Socket.getSslProtocol().

setSslProtocol(String) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the SslProtocol property; see Upload.getSslProtocol().

setStandalone(boolean) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the Standalone property; see Xml.getStandalone().

setStartTls(boolean) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the StartTls property; see Imap.getStartTls().

setStartTLS(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the StartTLS property; see MailMan.getStartTLS().

setStartTLSifPossible(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the StartTLSifPossible property; see MailMan.getStartTLSifPossible().

setState(String) - Method in class com.chilkatsoft.chilkat2.Csr

Sets the State property; see Csr.getState().

setStateParam(String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the StateParam property; see OAuth2.getStateParam().

setStderrToStdout(boolean) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the StderrToStdout property; see Ssh.getStderrToStdout().

setStreaming(boolean) - Method in class com.chilkatsoft.chilkat2.Ai

Sets the Streaming property; see Ai.getStreaming().

setStreamNonChunked(boolean) - Method in class com.chilkatsoft.chilkat2.Rest

Sets the StreamNonChunked property; see Rest.getStreamNonChunked().

setStreamResponseBodyPath(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the StreamResponseBodyPath property; see Http.getStreamResponseBodyPath().

setStrict(boolean) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sets the Strict property; see JsonObject.getStrict().

setStrict(boolean) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the Strict property; see Xml.getStrict().

setString(String) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Sets this instance to a copy of the specified string.

setStringAt(int, String) - Method in class com.chilkatsoft.chilkat2.JsonArray

Replaces the value at zero-based position index with the specified JSON string value.

setStringAt(int, String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sets the member at zero-based position index to a JSON string value.

setStringBom(boolean) - Method in class com.chilkatsoft.chilkat2.Stream

Sets the StringBom property; see Stream.getStringBom().

setStringCharset(String) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the StringCharset property; see Socket.getStringCharset().

setStringCharset(String) - Method in class com.chilkatsoft.chilkat2.Stream

Sets the StringCharset property; see Stream.getStringCharset().

setStringOf(String, String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sets the value at jsonPath to a JSON string value.

setStringToSign(String) - Method in class com.chilkatsoft.chilkat2.AuthAzureSAS

Sets the StringToSign property; see AuthAzureSAS.getStringToSign().

setStripColorCodes(boolean) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the StripColorCodes property; see Ssh.getStripColorCodes().

setStructInnerDescrip(boolean) - Method in class com.chilkatsoft.chilkat2.Xmp

Sets the StructInnerDescrip property; see Xmp.getStructInnerDescrip().

setStructTmMonth(int) - Method in class com.chilkatsoft.chilkat2.DtObj

Sets the StructTmMonth property; see DtObj.getStructTmMonth().

setStructTmYear(int) - Method in class com.chilkatsoft.chilkat2.DtObj

Sets the StructTmYear property; see DtObj.getStructTmYear().

setSubEmailAddress(String) - Method in class com.chilkatsoft.chilkat2.AuthGoogle

Sets the SubEmailAddress property; see AuthGoogle.getSubEmailAddress().

setSubject(String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the Subject property; see Email.getSubject().

setSubjectField(String, String, String) - Method in class com.chilkatsoft.chilkat2.Csr

Sets a subject distinguished-name attribute identified by oid.

setSuppressLinks(boolean) - Method in class com.chilkatsoft.chilkat2.HtmlToText

Sets the SuppressLinks property; see HtmlToText.getSuppressLinks().

setSuppressOutput(boolean) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the SuppressOutput property; see Tar.getSuppressOutput().

setSyncCreateAllLocalDirs(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the SyncCreateAllLocalDirs property; see Ftp2.getSyncCreateAllLocalDirs().

setSyncCreateAllLocalDirs(boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the SyncCreateAllLocalDirs property; see SFtp.getSyncCreateAllLocalDirs().

setSyncDirectives(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the SyncDirectives property; see SFtp.getSyncDirectives().

setSyncedFiles(String) - Method in class com.chilkatsoft.chilkat2.Scp

Sets the SyncedFiles property; see Scp.getSyncedFiles().

setSyncMustMatch(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the SyncMustMatch property; see Ftp2.getSyncMustMatch().

setSyncMustMatch(String) - Method in class com.chilkatsoft.chilkat2.Scp

Sets the SyncMustMatch property; see Scp.getSyncMustMatch().

setSyncMustMatch(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the SyncMustMatch property; see SFtp.getSyncMustMatch().

setSyncMustMatchDir(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the SyncMustMatchDir property; see Ftp2.getSyncMustMatchDir().

setSyncMustMatchDir(String) - Method in class com.chilkatsoft.chilkat2.Scp

Sets the SyncMustMatchDir property; see Scp.getSyncMustMatchDir().

setSyncMustMatchDir(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the SyncMustMatchDir property; see SFtp.getSyncMustMatchDir().

setSyncMustNotMatch(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the SyncMustNotMatch property; see Ftp2.getSyncMustNotMatch().

setSyncMustNotMatch(String) - Method in class com.chilkatsoft.chilkat2.Scp

Sets the SyncMustNotMatch property; see Scp.getSyncMustNotMatch().

setSyncMustNotMatch(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the SyncMustNotMatch property; see SFtp.getSyncMustNotMatch().

setSyncMustNotMatchDir(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the SyncMustNotMatchDir property; see Ftp2.getSyncMustNotMatchDir().

setSyncMustNotMatchDir(String) - Method in class com.chilkatsoft.chilkat2.Scp

Sets the SyncMustNotMatchDir property; see Scp.getSyncMustNotMatchDir().

setSyncMustNotMatchDir(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the SyncMustNotMatchDir property; see SFtp.getSyncMustNotMatchDir().

setTag(String) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the Tag property; see Xml.getTag().

setTagNsPrefix(String) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the TagNsPrefix property; see Xml.getTagNsPrefix().

setTagUnprefixed(String) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the TagUnprefixed property; see Xml.getTagUnprefixed().

setTargetName(String) - Method in class com.chilkatsoft.chilkat2.Ntlm

Sets the TargetName property; see Ntlm.getTargetName().

setTcpNoDelay(boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the TcpNoDelay property; see SFtp.getTcpNoDelay().

setTcpNoDelay(boolean) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the TcpNoDelay property; see Socket.getTcpNoDelay().

setTcpNoDelay(boolean) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the TcpNoDelay property; see Ssh.getTcpNoDelay().

setTcpNoDelay(boolean) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the TcpNoDelay property; see SshTunnel.getTcpNoDelay().

setTempDir(String) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the TempDir property; see Zip.getTempDir().

setTextBody(String, String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the body of the email and also sets the Content-Type header field of contentType.

setTextFlag(boolean) - Method in class com.chilkatsoft.chilkat2.ZipEntry

Sets the TextFlag property; see getTextFlag().

setThreadPoolLogPath(String) - Method in class com.chilkatsoft.chilkat2.Global

Sets the ThreadPoolLogPath property; see Global.getThreadPoolLogPath().

setTimeoutSeconds(int) - Method in class com.chilkatsoft.chilkat2.Js

Sets the TimeoutSeconds property; see Js.getTimeoutSeconds().

setTimestamp(String) - Method in class com.chilkatsoft.chilkat2.OAuth1

Sets the Timestamp property; see OAuth1.getTimestamp().

setTlsPinSet(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the TlsPinSet property; see Ftp2.getTlsPinSet().

setTlsPinSet(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the TlsPinSet property; see Http.getTlsPinSet().

setTlsPinSet(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the TlsPinSet property; see Imap.getTlsPinSet().

setTlsPinSet(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the TlsPinSet property; see MailMan.getTlsPinSet().

setTlsPinSet(String) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the TlsPinSet property; see Socket.getTlsPinSet().

setTlsPinSet(String) - Method in class com.chilkatsoft.chilkat2.Upload

Sets the TlsPinSet property; see Upload.getTlsPinSet().

setTlsPref(int) - Method in class com.chilkatsoft.chilkat2.Dns

Sets the TlsPref property; see Dns.getTlsPref().

setTlsTicketKey(BinData) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the key this TLS server uses to encrypt and decrypt session tickets.

setTlsTicketLifetimeSeconds(int) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the TlsTicketLifetimeSeconds property; see Socket.getTlsTicketLifetimeSeconds().

setToCharset(String) - Method in class com.chilkatsoft.chilkat2.Charset

Sets the ToCharset property; see Charset.getToCharset().

setToken(String) - Method in class com.chilkatsoft.chilkat2.OAuth1

Sets the Token property; see OAuth1.getToken().

setTokenEndpoint(String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the TokenEndpoint property; see OAuth2.getTokenEndpoint().

setTokenParam(String, String, String) - Method in class com.chilkatsoft.chilkat2.AuthAzureSAS

Adds a token parameter name/value.

setTokenSecret(String) - Method in class com.chilkatsoft.chilkat2.OAuth1

Sets the TokenSecret property; see OAuth1.getTokenSecret().

setTokenType(String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the TokenType property; see OAuth2.getTokenType().

setTrim(boolean) - Method in class com.chilkatsoft.chilkat2.StringArray

Sets the Trim property; see StringArray.getTrim().

setTrustSystemCaRoots(boolean) - Method in class com.chilkatsoft.chilkat2.TrustedRoots

Sets the TrustSystemCaRoots property; see TrustedRoots.getTrustSystemCaRoots().

setTsa(JsonObject) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the TSA (Timestamp Authority) URL and other related settings for automatically adding an EncapsulatedTimestamp.

setTsaHttpObj(Http) - Method in class com.chilkatsoft.chilkat2.Crypt2

If timestamp server communications are needed for signing and special Internet settings like a proxy server are necessary, this method can provide an Http object configured with these settings.

setTtyMode(String, int) - Method in class com.chilkatsoft.chilkat2.Ssh

Adds or updates one TTY mode to be included in a later Ssh.sendReqPty(int, String, int, int, int, int) request.

setTunnelLog(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the TunnelLog property; see SshTunnel.getTunnelLog().

setTunnelLogPath(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the TunnelLogPath property; see SshTunnel.getTunnelLogPath().

setTypeAscii() - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the FTP representation type to ASCII for subsequent transfers.

setTypeBinary() - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the FTP representation type to binary (TYPE I) for subsequent transfers.

setUIntAt(int, long) - Method in class com.chilkatsoft.chilkat2.JsonArray

Replaces the value at zero-based position index with the specified JSON unsigned integer value.

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Ai

Sets the UncommonOptions property; see Ai.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Cert

Sets the UncommonOptions property; see Cert.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.CertChain

Sets the UncommonOptions property; see CertChain.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.CertStore

Sets the UncommonOptions property; see CertStore.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.CodeSign

Sets the UncommonOptions property; see CodeSign.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Compression

Sets the UncommonOptions property; see Compression.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the UncommonOptions property; see Crypt2.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Csv

Sets the UncommonOptions property; see Csv.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.DirTree

Sets the UncommonOptions property; see DirTree.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Dns

Sets the UncommonOptions property; see Dns.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Dsa

Sets the UncommonOptions property; see Dsa.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Email

Sets the UncommonOptions property; see Email.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the UncommonOptions property; see Ftp2.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Global

Sets the UncommonOptions property; see Global.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.HtmlToText

Sets the UncommonOptions property; see HtmlToText.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the UncommonOptions property; see Http.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Sets the UncommonOptions property; see HttpCurl.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.HttpResponse

Sets the UncommonOptions property; see HttpResponse.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Imap

Sets the UncommonOptions property; see Imap.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sets the UncommonOptions property; see JsonObject.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Jwe

Sets the UncommonOptions property; see Jwe.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Jws

Sets the UncommonOptions property; see Jws.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Jwt

Sets the UncommonOptions property; see Jwt.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the UncommonOptions property; see MailMan.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the UncommonOptions property; see Mime.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.OAuth1

Sets the UncommonOptions property; see OAuth1.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the UncommonOptions property; see OAuth2.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Pdf

Sets the UncommonOptions property; see Pdf.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Pfx

Sets the UncommonOptions property; see Pfx.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Pkcs11

Sets the UncommonOptions property; see Pkcs11.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Sets the UncommonOptions property; see PrivateKey.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Rest

Sets the UncommonOptions property; see Rest.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Rsa

Sets the UncommonOptions property; see Rsa.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Sets the UncommonOptions property; see ScMinidriver.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Scp

Sets the UncommonOptions property; see Scp.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Secrets

Sets the UncommonOptions property; see Secrets.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the UncommonOptions property; see SFtp.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the UncommonOptions property; see Socket.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the UncommonOptions property; see Ssh.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.SshKey

Sets the UncommonOptions property; see SshKey.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Sets the UncommonOptions property; see SshTunnel.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the UncommonOptions property; see Xml.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.XmlDSig

Sets the UncommonOptions property; see XmlDSig.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the UncommonOptions property; see XmlDSigGen.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Xmp

Sets the UncommonOptions property; see Xmp.getUncommonOptions().

setUncommonOptions(String) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the UncommonOptions property; see Zip.getUncommonOptions().

setUnique(boolean) - Method in class com.chilkatsoft.chilkat2.StringArray

Sets the Unique property; see StringArray.getUnique().

setUnixPermOverride(String) - Method in class com.chilkatsoft.chilkat2.Scp

Sets the UnixPermOverride property; see Scp.getUnixPermOverride().

setUnpackDirect(boolean) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the UnpackDirect property; see Mht.getUnpackDirect().

setUnpackUseRelPaths(boolean) - Method in class com.chilkatsoft.chilkat2.Email

Sets the UnpackUseRelPaths property; see Email.getUnpackUseRelPaths().

setUnpackUseRelPaths(boolean) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the UnpackUseRelPaths property; see Mht.getUnpackUseRelPaths().

setUnprotectedHeader(int, JsonObject) - Method in class com.chilkatsoft.chilkat2.Jws

Sets the optional unprotected JOSE header for signature index.

setUnprotectedHeader(JsonObject) - Method in class com.chilkatsoft.chilkat2.Jwe

Sets the shared JWE Unprotected Header from json.

setUntarCaseSensitive(boolean) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the UntarCaseSensitive property; see Tar.getUntarCaseSensitive().

setUntarDebugLog(boolean) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the UntarDebugLog property; see Tar.getUntarDebugLog().

setUntarDiscardPaths(boolean) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the UntarDiscardPaths property; see Tar.getUntarDiscardPaths().

setUntarFromDir(String) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the UntarFromDir property; see Tar.getUntarFromDir().

setUntarMaxCount(int) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the UntarMaxCount property; see Tar.getUntarMaxCount().

setUnwrapExtras(boolean) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the UnwrapExtras property; see Mime.getUnwrapExtras().

setUpdateCache(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the UpdateCache property; see Http.getUpdateCache().

setUpdateCache(boolean) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the UpdateCache property; see Mht.getUpdateCache().

setUpdateCache(boolean) - Method in class com.chilkatsoft.chilkat2.Spider

Sets the UpdateCache property; see Spider.getUpdateCache().

setUploadChunkSize(int) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the UploadChunkSize property; see SFtp.getUploadChunkSize().

setUrlVar(String, String) - Method in class com.chilkatsoft.chilkat2.Http

Sets a variable's value for URL substitutions used in any method.

setUseApop(boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sets the UseApop property; see MailMan.getUseApop().

setUseBasicAuth(boolean) - Method in class com.chilkatsoft.chilkat2.OAuth2

Sets the UseBasicAuth property; see OAuth2.getUseBasicAuth().

setUseCids(boolean) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the UseCids property; see Mht.getUseCids().

setUseCurrentDate(boolean) - Method in class com.chilkatsoft.chilkat2.Gzip

Sets the UseCurrentDate property; see Gzip.getUseCurrentDate().

setUseEpsv(boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the UseEpsv property; see Ftp2.getUseEpsv().

setUseFilename(boolean) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the UseFilename property; see Mht.getUseFilename().

setUseIEProxy(boolean) - Method in class com.chilkatsoft.chilkat2.Http

Sets the UseIEProxy property; see Http.getUseIEProxy().

setUseIEProxy(boolean) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the UseIEProxy property; see Mht.getUseIEProxy().

setUseInline(boolean) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the UseInline property; see Mht.getUseInline().

setUseMmDescription(boolean) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the UseMmDescription property; see Mime.getUseMmDescription().

setUsePkcsConstructedEncoding(boolean) - Method in class com.chilkatsoft.chilkat2.Global

Sets the UsePkcsConstructedEncoding property; see Global.getUsePkcsConstructedEncoding().

setUserAgent(String) - Method in class com.chilkatsoft.chilkat2.Http

Sets the UserAgent property; see Http.getUserAgent().

setUserAgent(String) - Method in class com.chilkatsoft.chilkat2.Spider

Sets the UserAgent property; see Spider.getUserAgent().

setUserAuthBanner(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the UserAuthBanner property; see SFtp.getUserAuthBanner().

setUserAuthBanner(String) - Method in class com.chilkatsoft.chilkat2.Ssh

Sets the UserAuthBanner property; see Ssh.getUserAuthBanner().

setUserData(String) - Method in class com.chilkatsoft.chilkat2.Socket

Sets the UserData property; see Socket.getUserData().

setUserId(int) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the UserId property; see Tar.getUserId().

setUsername(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sets the Username property; see Ftp2.getUsername().

setUserName(String) - Method in class com.chilkatsoft.chilkat2.Ntlm

Sets the UserName property; see Ntlm.getUserName().

setUserName(String) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the UserName property; see Tar.getUserName().

setUserPassword(String) - Method in class com.chilkatsoft.chilkat2.Pdf

Sets the UserPassword property; see Pdf.getUserPassword().

setUseXPkcs7(boolean) - Method in class com.chilkatsoft.chilkat2.Mime

Sets the UseXPkcs7 property; see Mime.getUseXPkcs7().

setUtc(boolean) - Method in class com.chilkatsoft.chilkat2.DtObj

Sets the Utc property; see DtObj.getUtc().

setUtcMode(boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Sets the UtcMode property; see SFtp.getUtcMode().

setUuFilename(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the UuFilename property; see Crypt2.getUuFilename().

setUuMode(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the UuMode property; see Crypt2.getUuMode().

setVar(String, String) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Sets the value of a variable to be replaced in curl commands.

setVerboseLogging(boolean) - Method in class com.chilkatsoft.chilkat2.ChilkatObject

Sets whether LastErrorText is verbose (more detail; larger logs).

setVerboseTls(boolean) - Method in class com.chilkatsoft.chilkat2.Global

Sets the VerboseTls property; see Global.getVerboseTls().

setVerifyCert(Cert) - Method in class com.chilkatsoft.chilkat2.Crypt2

Assigns the digital certificate for signature verification.

setVerifyCert(Cert) - Method in class com.chilkatsoft.chilkat2.Mime

Supplies cert as a signer-certificate fallback for subsequent signature verification.

setVerifyKeyedDigest(boolean) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Sets the VerifyKeyedDigest property; see JavaKeyStore.getVerifyKeyedDigest().

setWebSiteLogin(String) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the WebSiteLogin property; see Mht.getWebSiteLogin().

setWebSiteLoginDomain(String) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the WebSiteLoginDomain property; see Mht.getWebSiteLoginDomain().

setWebSitePassword(String) - Method in class com.chilkatsoft.chilkat2.Mht

Sets the WebSitePassword property; see Mht.getWebSitePassword().

setWindDownCount(int) - Method in class com.chilkatsoft.chilkat2.Spider

Sets the WindDownCount property; see Spider.getWindDownCount().

setWorkstation(String) - Method in class com.chilkatsoft.chilkat2.Ntlm

Sets the Workstation property; see Ntlm.getWorkstation().

setWrappingKey(int, String, String) - Method in class com.chilkatsoft.chilkat2.Jwe

Sets the symmetric key for recipient index.

setWriteFormat(String) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the WriteFormat property; see Tar.getWriteFormat().

setWriteTimeoutMs(int) - Method in class com.chilkatsoft.chilkat2.Stream

Sets the WriteTimeoutMs property; see Stream.getWriteTimeoutMs().

setX509Cert(Cert, boolean) - Method in class com.chilkatsoft.chilkat2.Rsa

Provides the private or public key indirectly through a certificate.

setX509Cert(Cert, boolean) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Specifies the X.509 certificate to be used for the KeyInfo element when the KeyInfoType equals X509Data.

setX509Type(String) - Method in class com.chilkatsoft.chilkat2.XmlDSigGen

Sets the X509Type property; see XmlDSigGen.getX509Type().

setXlsxDateFormat(String) - Method in class com.chilkatsoft.chilkat2.Csv

Sets the XlsxDateFormat property; see Csv.getXlsxDateFormat().

setXmlCharset(String) - Method in class com.chilkatsoft.chilkat2.HtmlToXml

Sets the XmlCharset property; see HtmlToXml.getXmlCharset().

setXmlListing(String) - Method in class com.chilkatsoft.chilkat2.Tar

Sets the XmlListing property; see Tar.getXmlListing().

setXMsVersion(String) - Method in class com.chilkatsoft.chilkat2.AuthAzureStorage

Sets the XMsVersion property; see AuthAzureStorage.getXMsVersion().

setYear(int) - Method in class com.chilkatsoft.chilkat2.DtObj

Sets the Year property; see DtObj.getYear().

setZipx(boolean) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the Zipx property; see Zip.getZipx().

setZipxDefaultAlg(String) - Method in class com.chilkatsoft.chilkat2.Zip

Sets the ZipxDefaultAlg property; see Zip.getZipxDefaultAlg().

SFtp - Class in com.chilkatsoft.chilkat2

<section class="sftp-summary">

SFtp() - Constructor for class com.chilkatsoft.chilkat2.SFtp

Creates a new SFtp object.

SFtpDir - Class in com.chilkatsoft.chilkat2

<section class="sftpdir-summary">

SFtpDir() - Constructor for class com.chilkatsoft.chilkat2.SFtpDir

Creates a new SFtpDir object.

SFtpFile - Class in com.chilkatsoft.chilkat2

<section class="sftpfile-summary">

SFtpFile() - Constructor for class com.chilkatsoft.chilkat2.SFtpFile

Creates a new SFtpFile object.

shareConnection(WebSocket) - Method in class com.chilkatsoft.chilkat2.WebSocket

Causes the calling WebSocket object to share the already-established WebSocket connection owned by ws.

sharedSecretENC(PrivateKey, PublicKey, String) - Method in class com.chilkatsoft.chilkat2.Ecc

Computes an elliptic-curve Diffie-Hellman shared secret from the private key in privKey and the peer's public key in pubKey.

sharedSecretENC(PrivateKey, PublicKey, String) - Method in class com.chilkatsoft.chilkat2.EdDSA

Computes a 32-byte X25519 shared secret from the private key in privkey and the peer's public key in pubkey.

sharePointOnlineAuth(String, String, SecureString, JsonObject) - Method in class com.chilkatsoft.chilkat2.Http

This method authenticates with SharePoint Online and if successful, sets a cookie which is used for all following SharePoint HTTP requests.

shorten(int) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Shortens the string by removing the last numChars chars.

signBd(BinData, String, BinData) - Method in class com.chilkatsoft.chilkat2.Rsa

Generates an RSA digital signature by first hashing the contents of bdData with the hash algorithm specified by hashAlgorithm, which can be sha256, sha384, sha512, or sha1.

signBd(BinData, String, String, PrivateKey, Prng) - Method in class com.chilkatsoft.chilkat2.Ecc

Hashes the bytes currently contained in bdData and creates an ECDSA signature with the EC private key in privKey.

signBdENC(BinData) - Method in class com.chilkatsoft.chilkat2.Crypt2

Digitally signs the content in dataToSign and returns a detached signature (PKCS#7 signed-data) as a binary-encoded string.

signBdENC(BinData, String, PrivateKey) - Method in class com.chilkatsoft.chilkat2.EdDSA

Creates an EdDSA signature over the exact byte sequence contained in bd, using the Ed25519 private key in privkey.

signBdUsingCert(BinData, String, String, Cert) - Method in class com.chilkatsoft.chilkat2.Ecc

Hashes the bytes in bdData and creates an ECDSA signature using the private key associated with the certificate in cert.

signData(int, String, String, BinData, BinData) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Signs the data passed in bdData.

signHash() - Method in class com.chilkatsoft.chilkat2.Dsa

Creates a DSA signature over the digest currently stored in Hash.

signHashENC(String, String) - Method in class com.chilkatsoft.chilkat2.Rsa

This function creates an RSA digital signature for the hash provided in encodedHash, which should be encoded according to the EncodingMode setting (e.g., base64 if EncodingMode = base64).

signHashENC(String, String, PrivateKey, Prng) - Method in class com.chilkatsoft.chilkat2.Ecc

Creates an ECDSA signature over a digest that has already been computed by the application.

signHashENC(String, String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Digitally signs a pre-computed hash and returns a detached signature (PKCS#7 signed-data) as a binary-encoded string.

signHashUsingCert(String, String, Cert) - Method in class com.chilkatsoft.chilkat2.Ecc

Creates an ECDSA signature over a digest that has already been computed.

signPdf(JsonObject, String) - Method in class com.chilkatsoft.chilkat2.Pdf

Signs the open PDF and if successful writes the signed PDF to the ARG3.

signPdf2(JsonObject) - Method in class com.chilkatsoft.chilkat2.Pdf

The same as Pdf.signPdf(JsonObject, String), except that the signed PDF stays in memory instead of being written to a file.

signPdfBd(JsonObject, BinData) - Method in class com.chilkatsoft.chilkat2.Pdf

Signs the open PDF and if successful writes the signed PDF to the bd.

signRawBd(BinData) - Method in class com.chilkatsoft.chilkat2.Rsa

This is legacy low-level raw RSA that duplicates the (now deprecated) OpenSSL rsautl utility.

signSbENC(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Crypt2

Digitally signs the text contained in sb and returns a detached signature (PKCS#7 signed-data) as a binary-encoded string.

signStringENC(String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Digitally signs a string and returns a detached signature (PKCS#7 signed-data) as a binary-encoded string.

signStringENC(String, String) - Method in class com.chilkatsoft.chilkat2.Rsa

Generates an RSA digital signature by first hashing strToBeHashed with the hash algorithm specified by hashAlgorithm, which can be sha256, sha384, sha512, or sha1.

site(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Sends a server-specific SITE command.

sizeOfArray(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns the number of elements in the JSON array at jsonPath.

skipUnspidered(int) - Method in class com.chilkatsoft.chilkat2.Spider

Moves a URL from the unspidered list to the spidered list.

sleepMs(int) - Method in class com.chilkatsoft.chilkat2.Ai

This method is provided for convenience.

sleepMs(int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Blocks the calling thread for millisec milliseconds.

sleepMs(int) - Method in class com.chilkatsoft.chilkat2.Http

This method makes the calling process sleep for a specified number of milliseconds.

sleepMs(int) - Method in class com.chilkatsoft.chilkat2.OAuth2

Suspends the calling thread for millisec milliseconds.

sleepMs(int) - Method in class com.chilkatsoft.chilkat2.Socket

Pauses the calling thread for approximately millisec milliseconds.

sleepMs(int) - Method in class com.chilkatsoft.chilkat2.Spider

Suspends the execution of the current thread until the time-out interval elapses.

sleepMs(int) - Method in class com.chilkatsoft.chilkat2.Upload

A convenience method for putting the calling process to sleep for N milliseconds.

smtpAuthenticate() - Method in class com.chilkatsoft.chilkat2.MailMan

Authenticates with the SMTP server using the current SMTP property settings, such as MailMan.getSmtpUsername(), MailMan.getSmtpPassword(), OAuth2 token settings, and other authentication-related options.

smtpConnect() - Method in class com.chilkatsoft.chilkat2.MailMan

Explicitly connects to the SMTP server.

smtpNoop() - Method in class com.chilkatsoft.chilkat2.MailMan

Sends an SMTP NOOP command to the server.

smtpReset() - Method in class com.chilkatsoft.chilkat2.MailMan

Sends an SMTP RSET command to the server.

smtpSendRawCommand(String, String, boolean) - Method in class com.chilkatsoft.chilkat2.MailMan

Sends a raw command to the SMTP server and returns the server's response.

snkToXml(String) - Method in class com.chilkatsoft.chilkat2.Rsa

Imports a .snk file to an XML document that can be imported via the ImportPrivateKey method.

Socket - Class in com.chilkatsoft.chilkat2

<section class="socket-summary">

Socket() - Constructor for class com.chilkatsoft.chilkat2.Socket

Creates a new Socket object.

sort(boolean) - Method in class com.chilkatsoft.chilkat2.StringArray

Sorts the strings in the collection in ascending or descending order.

sort(boolean, boolean) - Method in class com.chilkatsoft.chilkat2.JsonObject

Sorts this object's direct members by member name.

sort(boolean, boolean) - Method in class com.chilkatsoft.chilkat2.StringTable

Sorts the strings in the collection in ascending or descending order.

sort(String, boolean) - Method in class com.chilkatsoft.chilkat2.SFtpDir

Reorders the files and subdirectories in this listing according to field.

sortByAttribute(String, boolean) - Method in class com.chilkatsoft.chilkat2.Xml

Sorts the calling element's direct children by the string value of attribute attrName.

sortByAttributeInt(String, boolean) - Method in class com.chilkatsoft.chilkat2.Xml

Sorts the calling element's direct children numerically by the value of attribute attrName, interpreting each sort value as an integer rather than comparing the text lexicographically.

sortByColumn(String, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.Csv

Sorts the data rows using the values in the column named by columnName.

sortByColumnIndex(int, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.Csv

Sorts the data rows using the values in the column at zero-based index index.

sortByContent(boolean) - Method in class com.chilkatsoft.chilkat2.Xml

Sorts the calling element's direct children by their text content.

sortByDate(boolean) - Method in class com.chilkatsoft.chilkat2.EmailBundle

Sorts the emails in this bundle by each Email object's EmailDate property.

sortByRecipient(boolean) - Method in class com.chilkatsoft.chilkat2.EmailBundle

Sorts the emails in this bundle by the full value of each email's To header field.

sortBySender(boolean) - Method in class com.chilkatsoft.chilkat2.EmailBundle

Sorts the emails in this bundle by the full content of each email's From header field.

sortBySubject(boolean) - Method in class com.chilkatsoft.chilkat2.EmailBundle

Sorts the emails in this bundle by subject.

sortByTag(boolean) - Method in class com.chilkatsoft.chilkat2.Xml

Sorts the calling element's direct children by tag name.

sortRecordsByAttribute(String, String, boolean) - Method in class com.chilkatsoft.chilkat2.Xml

Treats each direct child as a record and sorts those records by the value of attribute attrName on the record's child identified by sortTag.

sortRecordsByContent(String, boolean) - Method in class com.chilkatsoft.chilkat2.Xml

Treats each direct child as a record and sorts those records by the text content of the record's child named sortTag.

sortRecordsByContentInt(String, boolean) - Method in class com.chilkatsoft.chilkat2.Xml

Treats each direct child as a record and sorts those records numerically by the integer content of the record's child named sortTag.

Spider - Class in com.chilkatsoft.chilkat2

<section class="spider-summary">

Spider() - Constructor for class com.chilkatsoft.chilkat2.Spider

Creates a new Spider object.

splitAndAppend(String, String) - Method in class com.chilkatsoft.chilkat2.StringArray

Splits a string at a character or substring boundary and adds each resulting string to the internal collection.

splitAndAppend(String, String, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.StringTable

Splits a string into parts based on a single character delimiterChar.

splitFile(String, String, String, int, String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Splits fileToSplit into sequential binary parts of up to partSize bytes and writes them to destDir using partPrefix and partExtension.

Ssh - Class in com.chilkatsoft.chilkat2

<section class="ssh-summary">

Ssh() - Constructor for class com.chilkatsoft.chilkat2.Ssh

Creates a new Ssh object.

sshAuthenticatePk(String, SshKey) - Method in class com.chilkatsoft.chilkat2.Imap

Authenticates the SSH tunnel using the username in sshLogin and the SshKey private key in privateKey.

sshAuthenticatePk(String, SshKey) - Method in class com.chilkatsoft.chilkat2.MailMan

Authenticates with the SSH server using public-key authentication after an SSH tunnel has been opened.

sshAuthenticatePk(String, SshKey) - Method in class com.chilkatsoft.chilkat2.Socket

Authenticates the SSH tunnel session as sshLogin using privateKey.

sshAuthenticatePw(String, String) - Method in class com.chilkatsoft.chilkat2.Imap

Authenticates the SSH tunnel using the username in sshLogin and password in sshPassword.

sshAuthenticatePw(String, String) - Method in class com.chilkatsoft.chilkat2.MailMan

Authenticates with the SSH server using an SSH username and password after an SSH tunnel has been opened.

sshAuthenticatePw(String, String) - Method in class com.chilkatsoft.chilkat2.Socket

Authenticates the SSH tunnel session using sshLogin and sshPassword.

sshCloseTunnel() - Method in class com.chilkatsoft.chilkat2.Imap

Closes the SSH tunnel opened by Imap.sshOpenTunnel(String, int).

sshCloseTunnel() - Method in class com.chilkatsoft.chilkat2.MailMan

Closes the SSH tunnel used for SMTP or POP3 communication.

sshCloseTunnel() - Method in class com.chilkatsoft.chilkat2.Socket

Closes the SSH tunnel opened by SshOpenTunnel and terminates its forwarded channels.

SshKey - Class in com.chilkatsoft.chilkat2

<section class="sshkey-summary">

SshKey() - Constructor for class com.chilkatsoft.chilkat2.SshKey

Creates a new SshKey object.

sshNewChannel(String, int, boolean, int, Socket) - Method in class com.chilkatsoft.chilkat2.Socket

Opens a new port-forwarded channel through the authenticated SSH tunnel to hostname:port and populates channel with the connected socket.

sshOpenTunnel(String, int) - Method in class com.chilkatsoft.chilkat2.Imap

Connects to the SSH server in sshHostname on port sshPort and prepares an SSH tunnel for the later IMAP connection.

sshOpenTunnel(String, int) - Method in class com.chilkatsoft.chilkat2.MailMan

Connects to an SSH server and opens an SSH tunnel for MailMan's SMTP or POP3 connections.

sshOpenTunnel(String, int) - Method in class com.chilkatsoft.chilkat2.Socket

Connects to the SSH server at sshHostname:sshPort and initializes an SSH tunneling session.

SshTunnel - Class in com.chilkatsoft.chilkat2

<section class="sshtunnel-summary">

SshTunnel() - Constructor for class com.chilkatsoft.chilkat2.SshTunnel

Creates a new SshTunnel object.

startAuth() - Method in class com.chilkatsoft.chilkat2.OAuth2

Starts an OAuth 2.0 Authorization Code flow and returns the authorization URL that the application should open in the user's browser.

startKeyboardAuth(String) - Method in class com.chilkatsoft.chilkat2.SFtp

Begins keyboard-interactive authentication for login and returns XML describing the server's prompts.

startKeyboardAuth(String) - Method in class com.chilkatsoft.chilkat2.Ssh

Begins keyboard-interactive authentication for the login in login.

startKeyboardAuth(String) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Begins keyboard-interactive authentication for login.

startsWith(String, boolean) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Returns true if the string starts with substr.

startTiming() - Method in class com.chilkatsoft.chilkat2.Socket

Starts or restarts the object's convenience timer.

stat() - Method in class com.chilkatsoft.chilkat2.Ftp2

Sends the FTP STAT command and returns the server's reply.

stopAccepting(boolean) - Method in class com.chilkatsoft.chilkat2.SshTunnel

Stops the local listener so that no new client connections are accepted.

storeFlags(long, boolean, String, int) - Method in class com.chilkatsoft.chilkat2.Imap

Sets or clears multiple flags on one message in the selected mailbox.

strAt(int) - Method in class com.chilkatsoft.chilkat2.StringArray

Returns the string at a specific index.

Stream - Class in com.chilkatsoft.chilkat2

<section class="stream-summary">

Stream() - Constructor for class com.chilkatsoft.chilkat2.Stream

Creates a new Stream object.

streamBodyFromFile(String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

Useful for sending HTTP requests where the body is a very large file.

streamChunkFromFile(String, String, String) - Method in class com.chilkatsoft.chilkat2.HttpRequest

This method is the same as StreamBodyFromFile, but allows for an offset and number of bytes to be specified.

streamingJsToolCall(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Ai

Handles a js_function_call event within a streaming Ai.ask(String) response loop by automatically executing the requested tool and adding its result to the conversation.

StringArray - Class in com.chilkatsoft.chilkat2

<section class="stringarray-summary">

StringArray() - Constructor for class com.chilkatsoft.chilkat2.StringArray

Creates a new StringArray object.

stringAt(int) - Method in class com.chilkatsoft.chilkat2.JsonArray

Returns the string value stored at zero-based position index.

stringAt(int) - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns the string value of the member at zero-based position index.

stringAt(int) - Method in class com.chilkatsoft.chilkat2.StringTable

Returns the Nth string in the table.

stringAtSb(int, StringBuilder) - Method in class com.chilkatsoft.chilkat2.StringTable

Appends the Nth string in the table to sb.

StringBuilder - Class in com.chilkatsoft.chilkat2

<section class="stringbuilder-summary">

StringBuilder() - Constructor for class com.chilkatsoft.chilkat2.StringBuilder

Creates a new StringBuilder object.

stringOf(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns the value at jsonPath as text.

stringOfEquals(String, String, boolean) - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns true if the textual value at jsonPath equals value according to the caseSensitive setting; otherwise returns false.

stringOfSb(String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.JsonObject

Retrieves the value at jsonPath as text and appends it to sb.

StringTable - Class in com.chilkatsoft.chilkat2

<section class="stringtable-summary">

StringTable() - Constructor for class com.chilkatsoft.chilkat2.StringTable

Creates a new StringTable object.

subscribe(String) - Method in class com.chilkatsoft.chilkat2.Imap

Subscribes the authenticated IMAP account to the mailbox named by mailbox.

subtract(MessageSet) - Method in class com.chilkatsoft.chilkat2.MessageSet

Removes from this message set every identifier whose raw numeric value is present in msgSet.

subtract(StringArray) - Method in class com.chilkatsoft.chilkat2.StringArray

Subtracts the strings contained within stringArrayObj from the caller's internal collection.

swap(int, int) - Method in class com.chilkatsoft.chilkat2.JsonArray

Exchanges the values at zero-based positions index1 and index2.

swap(int, int) - Method in class com.chilkatsoft.chilkat2.JsonObject

Swaps the positions of the direct members at zero-based indexes index1 and index2.

swapNode(Xml) - Method in class com.chilkatsoft.chilkat2.Xml

Swaps the calling element's tag, text content, and attributes with those of node.

swapTree(Xml) - Method in class com.chilkatsoft.chilkat2.Xml

Swaps the calling element's complete tree state with tree, including tag, text content, attributes, and children.

symLink(String, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Creates a symbolic link on the server.

symlinkCreate(String, String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Creates a symbolic link at linkPath that refers to targetPath.

symlinkTarget(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Returns the resolved target pathname for the symbolic link at linkPath.

syncDeleteRemote(String) - Method in class com.chilkatsoft.chilkat2.Ftp2

Recursively compares the remote tree rooted at the current remote directory with the local tree rooted at localRoot and deletes remote files that have no corresponding local file.

syncLocalDir(String, int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Synchronizes files from the current remote directory into the local directory at localRoot without descending into subdirectories.

syncLocalTree(String, int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Synchronizes the remote tree rooted at the current remote directory into the local directory at localRoot.

syncRemoteTree(String, int) - Method in class com.chilkatsoft.chilkat2.Ftp2

Synchronizes the local tree rooted at localRoot into the current remote directory.

syncRemoteTree2(String, int, boolean, boolean) - Method in class com.chilkatsoft.chilkat2.Ftp2

Provides the upload synchronization behavior and valid modes of Ftp2.syncRemoteTree(String, int) with traversal and preview controls.

syncTreeDownload(String, String, int, boolean) - Method in class com.chilkatsoft.chilkat2.Scp

Synchronizes files from the remote directory tree rooted at remoteRoot to the local directory rooted at localRoot.

syncTreeDownload(String, String, int, boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Synchronizes files from the remote directory remoteRoot to the local filesystem directory localRoot.

syncTreeUpload(String, String, int, boolean) - Method in class com.chilkatsoft.chilkat2.Scp

Synchronizes files from the local directory tree rooted at localBaseDir to the remote directory rooted at remoteBaseDir.

syncTreeUpload(String, String, int, boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Synchronizes files from the local filesystem directory localBaseDir to the remote directory remoteBaseDir.

syst() - Method in class com.chilkatsoft.chilkat2.Ftp2

Sends SYST and returns the server's operating-system type reply.

T

tagContent(String) - Method in class com.chilkatsoft.chilkat2.Xml

Searches the subtree rooted at the calling element for the first element whose tag equals tagName and returns that element's text content.

tagEquals(String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns true if the calling element's complete tag name, including any namespace prefix, exactly equals tag; otherwise returns false.

tagIndex(String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns the zero-based child index of the element selected by tagPath.

tagNsEquals(String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns true if this element's namespace-prefix portion exactly equals ns; otherwise returns false.

tagUnpEquals(String) - Method in class com.chilkatsoft.chilkat2.Xml

Returns true if this element's unprefixed tag exactly equals unprefixedTag; otherwise returns false.

takeConnection(Socket) - Method in class com.chilkatsoft.chilkat2.Socket

Moves the active connection from cSocket into this object.

takeSocket(Socket) - Method in class com.chilkatsoft.chilkat2.Socket

Moves the connection out of sock and into a newly created member of this object's socket set.

Tar - Class in com.chilkatsoft.chilkat2

<section class="tar-summary">

Tar() - Constructor for class com.chilkatsoft.chilkat2.Tar

Creates a new Tar object.

textReplace(String, JsonObject, JsonObject) - Method in class com.chilkatsoft.chilkat2.Pdf

Replaces text in the page content of the loaded PDF: placeholders such as {{name}}, and the values that follow labels such as Invoice #:.

threadPoolLogLine(String) - Method in class com.chilkatsoft.chilkat2.Global

Logs a line to the thread pool log file.

tlsRenegotiate() - Method in class com.chilkatsoft.chilkat2.Socket

Requests TLS renegotiation on an established TLS connection, causing another handshake to negotiate new security parameters where the protocol and peer support it.

toBd(String, BinData) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Serializes the current Java keystore and writes the complete JKS or JCEKS file image to bd.

toBd(String, BinData) - Method in class com.chilkatsoft.chilkat2.Pfx

Serializes the current PFX contents as PKCS#12 data and writes the bytes to bd, using password as the output password.

toCommaSeparatedStr() - Method in class com.chilkatsoft.chilkat2.MessageSet

Returns the unique identifiers as a comma-separated string in ascending numeric order.

toCompactString() - Method in class com.chilkatsoft.chilkat2.MessageSet

Returns the unique identifiers in ascending numeric order using compact IMAP message-set syntax.

toCRLF() - Method in class com.chilkatsoft.chilkat2.StringBuilder

Converts line endings to CRLF (Windows) format.

toDerBd(BinData) - Method in class com.chilkatsoft.chilkat2.Dsa

Writes the DER-encoded DSA private key to the BinData object passed in bd.

toDerFile(String) - Method in class com.chilkatsoft.chilkat2.Dsa

Writes the loaded DSA private key to the DER file specified by path.

toDsn(String, String, boolean, Email) - Method in class com.chilkatsoft.chilkat2.Email

Creates a new Delivery Status Notification (DSN) email in the format specified by RFC 3464.

toDtObj(boolean, DtObj) - Method in class com.chilkatsoft.chilkat2.DateTime

Copies the date/time to the dtObj.

toEncodedString(String, String) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Serializes the current Java keystore and returns the resulting JKS or JCEKS bytes encoded as text using encoding.

toEncodedString(String, String) - Method in class com.chilkatsoft.chilkat2.Pfx

Serializes the current PFX contents using password as the output password, then returns the PKCS#12 bytes encoded as text using encoding.

toEncryptedPem(String) - Method in class com.chilkatsoft.chilkat2.Dsa

Returns the loaded DSA private key as password-encrypted PEM text using password as the password.

toFile(String, String) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Serializes the current Java keystore and writes the complete JKS or JCEKS file image to path.

toFile(String, String) - Method in class com.chilkatsoft.chilkat2.Pfx

Serializes the current PFX contents and writes the resulting PKCS#12 data to path, using password as the output password.

toForward(Email) - Method in class com.chilkatsoft.chilkat2.Email

Creates an inline-forward email in fwdEmail based on this email.

toHex(long) - Method in class com.chilkatsoft.chilkat2.ZipCrc

Converts a 32-bit integer to a hex string.

toJksObj(String, String, JavaKeyStore) - Method in class com.chilkatsoft.chilkat2.Pem

This function converts this PEM to a Java KeyStore (JKS) object and stores it in jksObj.

toJksObj(String, String, JavaKeyStore) - Method in class com.chilkatsoft.chilkat2.Pfx

Populates jksObj with a Java KeyStore (JKS) representation of this PFX.

toJwkSet(String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Exports supported private-key and secret-key entries as a JSON Web Key Set and writes the JSON to sbJwkSet.

toLF() - Method in class com.chilkatsoft.chilkat2.StringBuilder

Converts line endings to LF-only (UNIX) format.

toLowercase() - Method in class com.chilkatsoft.chilkat2.StringBuilder

Converts the contents to lowercase.

toMdn(String, String, boolean, Email) - Method in class com.chilkatsoft.chilkat2.Email

Creates a new MDN (Message Disposition Notification) email in mdn using the format specified by RFC 3798.

toOpenSshPrivateKey(boolean) - Method in class com.chilkatsoft.chilkat2.SshKey

Exports the current private key as an OpenSSH-compatible private-key string.

toOpenSshPublicKey() - Method in class com.chilkatsoft.chilkat2.SshKey

Exports the public portion of the current key in one-line OpenSSH public-key format.

toPem() - Method in class com.chilkatsoft.chilkat2.Dsa

Returns the loaded DSA private key as unencrypted PEM text.

toPem() - Method in class com.chilkatsoft.chilkat2.Pem

Write the PFX to a PEM formatted string.

toPem() - Method in class com.chilkatsoft.chilkat2.Pfx

Exports all private keys and certificates currently held by this object as PEM-formatted text.

toPemEx(boolean, boolean, boolean, boolean, String, String) - Method in class com.chilkatsoft.chilkat2.Pem

Write the PFX to a PEM formatted string.

toPemEx(boolean, boolean, boolean, boolean, String, String) - Method in class com.chilkatsoft.chilkat2.Pfx

Exports selected PFX contents as PEM-formatted text.

toPemObj(String, Pem) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Converts the keystore material supported by the Pem class and loads the result into pemObj.

toPfxObj(Pfx) - Method in class com.chilkatsoft.chilkat2.Pem

Converts this PEM object, which must contain at least one private key, to PKCS12 and returns the PFX in pfxObj.

toPfxObj(String, Pfx) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Converts the certificates and recoverable private-key entries in the Java keystore and loads the result into pfxObj.

toPublicDerFile(String) - Method in class com.chilkatsoft.chilkat2.Dsa

Writes the public portion of the loaded DSA key to the DER file specified by path.

toPublicKey(PublicKey) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Extracts the public portion of the loaded private key and stores an independent copy in the PublicKey supplied in pubKey.

toPublicPem() - Method in class com.chilkatsoft.chilkat2.Dsa

Returns the public portion of the loaded DSA key as PEM text.

toPuttyPrivateKey(boolean) - Method in class com.chilkatsoft.chilkat2.SshKey

Exports the current private key as a PuTTY PPK string.

toQueryString() - Method in class com.chilkatsoft.chilkat2.Hashtable

Serializes the hashtable as a URL query string in the following form:

toRawRequest(String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Used for debugging purposes.

toReply(Email) - Method in class com.chilkatsoft.chilkat2.Email

Generates a reply email in reply with updated header and body fields to enable sending as a reply.

toRfc4716PublicKey() - Method in class com.chilkatsoft.chilkat2.SshKey

Exports the public portion of the current key in RFC 4716 SSH2 public-key format.

toSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.StringTable

Appends the entire string table to sb using CRLF line endings.

toString() - Method in class com.chilkatsoft.chilkat2.ChilkatObject

A short identification (Http[0x...]); never calls into the library, so it is safe in debuggers and on a closed object.

toText(String) - Method in class com.chilkatsoft.chilkat2.HtmlToText

Converts the HTML in html to readable plain text and returns the result.

toTextSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.HtmlToText

Converts the HTML currently contained in sb to plain text in place.

totp(String, String, String, String, int, int, int, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Implements RFC 6238: TOTP: Time-Based One-Time Password Algorithm.

toUppercase() - Method in class com.chilkatsoft.chilkat2.StringBuilder

Converts the contents to uppercase.

toXml() - Method in class com.chilkatsoft.chilkat2.HtmlToXml

Converts the current Html input to well-formed XML and returns the XML string.

toXml() - Method in class com.chilkatsoft.chilkat2.SshKey

Exports the current key as XML.

toXml(boolean) - Method in class com.chilkatsoft.chilkat2.Dsa

Returns the loaded DSA key as XML.

toXmlSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Hashtable

Serializes the current hashtable to Chilkat's hashtable XML format and appends the XML to the StringBuilder passed in sbXml.

toXmlSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.HtmlToXml

Converts the current Html input to well-formed XML and appends the generated XML to sb.

transmit(String, BinData, BinData, int) - Method in class com.chilkatsoft.chilkat2.SCard

Sends an APDU to the smart card contained in the currently connected reader.

transmitHex(String, String, BinData, int) - Method in class com.chilkatsoft.chilkat2.SCard

Sends an APDU to the smart card contained in the currently connected reader.

treeDelete(String) - Method in class com.chilkatsoft.chilkat2.FileAccess

Recursively deletes the directory tree rooted at path, including contained files and subdirectories.

trim() - Method in class com.chilkatsoft.chilkat2.StringBuilder

Trims whitespace from both ends of the string.

trimInsideSpaces() - Method in class com.chilkatsoft.chilkat2.StringBuilder

Replaces all tabs, CR's, and LF's, with SPACE chars, and removes extra SPACE's so there are no occurances of more than one SPACE char in a row.

truncate() - Method in class com.chilkatsoft.chilkat2.FileAccess

Truncates the currently open file at the current file position.

trustedCertAt(int, Cert) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Loads cert with the trusted certificate at the zero-based index index.

trustedCertOf(String, boolean, Cert) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Searches the trusted-certificate entries for an alias equal to aliasName and loads the matching certificate into cert.

TrustedRoots - Class in com.chilkatsoft.chilkat2

<section class="trustedroots-summary">

TrustedRoots() - Constructor for class com.chilkatsoft.chilkat2.TrustedRoots

Creates a new TrustedRoots object.

typeAt(int) - Method in class com.chilkatsoft.chilkat2.JsonArray

Returns an integer identifying the JSON type of the value at zero-based position index.

typeAt(int) - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns an integer identifying the JSON type of the member at zero-based position index.

U

uidlEquals(Email) - Method in class com.chilkatsoft.chilkat2.Email

Returns true if this email's UIDL equals the UIDL of the email passed in e.

uIntAt(int) - Method in class com.chilkatsoft.chilkat2.JsonArray

Returns the unsigned integer value stored at zero-based position index.

uIntOf(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Returns the unsigned integer value at jsonPath.

ulidGenerate(boolean) - Method in class com.chilkatsoft.chilkat2.DateTime

Generates and returns a new ULID using this object's date/time value.

ulidIncrement(StringBuilder) - Method in class com.chilkatsoft.chilkat2.DateTime

Increments the ULID that is passed in ulid.

ulidValidate(String) - Method in class com.chilkatsoft.chilkat2.DateTime

Validates the ulid.

uncompressBd(BinData) - Method in class com.chilkatsoft.chilkat2.Bz2

Decompresses the BZip2 stream currently contained in bd in place.

uncompressBd(BinData) - Method in class com.chilkatsoft.chilkat2.Gzip

Decompresses Gzip data contained in a BinData object in place, replacing the compressed data with the uncompressed data.

uncompressBdToFile(BinData, String) - Method in class com.chilkatsoft.chilkat2.Gzip

Decompresses Gzip data stored in a BinData object and writes the result to a file.

uncompressFile(String, String) - Method in class com.chilkatsoft.chilkat2.Bz2

Reads the BZip2 stream from the file at inFilename, decompresses it, and writes the original uncompressed bytes to the file at toPath.

uncompressFile(String, String) - Method in class com.chilkatsoft.chilkat2.Gzip

Decompresses a Gzip file and writes the result to the specified output path.

uncompressFile(String, String) - Method in class com.chilkatsoft.chilkat2.UnixCompress

Uncompresses a .Z file.

uncompressFileToString(String, String) - Method in class com.chilkatsoft.chilkat2.Gzip

Decompresses a Gzip file that contains text and returns the uncompressed text as a string.

uncompressFileToString(String, String) - Method in class com.chilkatsoft.chilkat2.UnixCompress

Uncompresses a .Z file that contains a text file.

uncompressStringENC(String, String, String) - Method in class com.chilkatsoft.chilkat2.Gzip

Decompresses Gzip data provided as an encoded string and returns the uncompressed result as text.

undropTagType(String) - Method in class com.chilkatsoft.chilkat2.HtmlToXml

Reverses a previous DropTagType setting for the specified tag name so that tag type is no longer intentionally dropped from subsequent XML output.

undropTextFormattingTags() - Method in class com.chilkatsoft.chilkat2.HtmlToXml

Configures the converter to retain the common text-formatting tags that are otherwise dropped by default:

union(StringArray) - Method in class com.chilkatsoft.chilkat2.StringArray

Performs the union set-operator.

UnixCompress - Class in com.chilkatsoft.chilkat2

<section class="unixcompress-summary">

UnixCompress() - Constructor for class com.chilkatsoft.chilkat2.UnixCompress

Creates a new UnixCompress object.

unload() - Method in class com.chilkatsoft.chilkat2.Cert

Unload the certificate, which could mean closing a PKCS11 session if the certificate was loaded from a smart card.

unlockBundle(String) - Method in class com.chilkatsoft.chilkat2.Global

Unlocks the entire Chilkat API for all classes.

unobfuscate() - Method in class com.chilkatsoft.chilkat2.StringBuilder

Unobfuscates the string.

unpackHtml(String, String, String) - Method in class com.chilkatsoft.chilkat2.Email

Unpacks an HTML email into an HTML file and separate related files, such as images and style sheets.

unpackMHT(String, String, String, String) - Method in class com.chilkatsoft.chilkat2.Mht

Extracts MHT data from mhtFilename.

unpackMHTString(String, String, String, String) - Method in class com.chilkatsoft.chilkat2.Mht

Extracts MHT data from mhtString.

unSpamify() - Method in class com.chilkatsoft.chilkat2.Email

Unobfuscates emails by undoing what spammers do to obfuscate email.

unsubscribe(String) - Method in class com.chilkatsoft.chilkat2.Imap

Removes the subscription to the mailbox named by mailbox.

untar(String) - Method in class com.chilkatsoft.chilkat2.Tar

Extracts the uncompressed TAR archive at tarPath into the directory specified by Tar.getUntarFromDir().

untarBz2(String) - Method in class com.chilkatsoft.chilkat2.Tar

Decompresses and extracts the .tar.bz2 archive at tarPath into Tar.getUntarFromDir().

untarFirstMatchingToBd(String, String, BinData) - Method in class com.chilkatsoft.chilkat2.Tar

Scans the uncompressed TAR archive at tarPath and copies the contents of the first file whose archive path matches matchPattern into the BinData object supplied in bd.

untarGz(String) - Method in class com.chilkatsoft.chilkat2.Tar

Decompresses and extracts the .tar.gz archive at tarPath into Tar.getUntarFromDir().

unTarGz(String, String, boolean) - Method in class com.chilkatsoft.chilkat2.Gzip

Extracts a .tar.gz archive to a directory.

untarZ(String) - Method in class com.chilkatsoft.chilkat2.Tar

Decompresses and extracts the .tar.Z archive at tarPath into Tar.getUntarFromDir().

unTarZ(String, String, boolean) - Method in class com.chilkatsoft.chilkat2.UnixCompress

Unpacks a .tar.Z file.

unwrapSecurity() - Method in class com.chilkatsoft.chilkat2.Mime

Removes supported S/MIME security layers and restores the underlying MIME content.

unzip(String) - Method in class com.chilkatsoft.chilkat2.Zip

Extracts all files and directories from the ZIP archive.

unzipAttachments() - Method in class com.chilkatsoft.chilkat2.Email

Unzips and replaces any Zip file attachments with the expanded contents.

unzipContent() - Method in class com.chilkatsoft.chilkat2.Xml

Reverses ZipContent: decodes and decompresses the calling element's compressed content and replaces the stored Base64-compressed representation with the original content.

unzipInto(String) - Method in class com.chilkatsoft.chilkat2.Zip

Extracts all files into a single directory.

unzipMatching(String, String, boolean) - Method in class com.chilkatsoft.chilkat2.Zip

Extracts only entries whose stored paths match a wildcard pattern.

unzipMatchingInto(String, String, boolean) - Method in class com.chilkatsoft.chilkat2.Zip

Extracts matching entries into a single directory while ignoring all stored ZIP path information.

unzipNewer(String) - Method in class com.chilkatsoft.chilkat2.Zip

Extracts only files that: Do not already exist Or have older modification timestamps than the ZIP entry

unzipToBd(BinData) - Method in class com.chilkatsoft.chilkat2.ZipEntry

Unzips this entry directly into a BinData object.

unzipToSb(int, String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.ZipEntry

Unzips this entry as text and appends the result to a StringBuilder.

unzipToStream(Stream) - Method in class com.chilkatsoft.chilkat2.ZipEntry

Unzips this entry to a stream.

unzipToString(int, String) - Method in class com.chilkatsoft.chilkat2.ZipEntry

Inflates this entry and returns the uncompressed data as a string.

unzipTree() - Method in class com.chilkatsoft.chilkat2.Xml

Reverses ZipTree: decompresses the stored representation and reconstructs the calling element's previously compressed subtree.

updateAt(String, boolean, String) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the text content of the element selected by tagPath to value.

updateAttrAt(String, boolean, String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Sets attribute attrName to attrValue on the element selected by tagPath.

updateAttribute(String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Sets attribute attrName to attrValue.

updateAttributeInt(String, int) - Method in class com.chilkatsoft.chilkat2.Xml

Sets attribute attrName to the decimal representation of integer value.

updateBd(String, String, BinData) - Method in class com.chilkatsoft.chilkat2.JsonObject

Updates the value at jsonPath to a JSON string value, or creates the member and any missing path components as needed.

updateBool(String, boolean) - Method in class com.chilkatsoft.chilkat2.JsonObject

Updates the value at jsonPath to a JSON boolean value, or creates the member and any missing path components as needed.

updateChildContent(String, String) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the text content of the child selected by tagPath to value.

updateChildContentInt(String, int) - Method in class com.chilkatsoft.chilkat2.Xml

Sets the content of the child selected by tagPath to the decimal representation of integer value.

updateExpirationDt(String, DateTime) - Method in class com.chilkatsoft.chilkat2.Cache

Replaces the expiration date and time of the cache item identified by key with the CkDateTime value supplied in expireDateTime.

updateExpirationStr(String, String) - Method in class com.chilkatsoft.chilkat2.Cache

Replaces the expiration date and time of the cache item identified by key with the RFC 822-style Internet date string supplied in expireDateTime.

updateInt(String, int) - Method in class com.chilkatsoft.chilkat2.JsonObject

Updates the value at jsonPath to a JSON number value, or creates the member and any missing path components as needed.

updateMetadata(StringBuilder, String) - Method in class com.chilkatsoft.chilkat2.Pdf

Updates or adds XMP metadata to a PDF.

updateMetadata2(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Pdf

The same as Pdf.updateMetadata(StringBuilder, String), except that the updated PDF stays in memory instead of being written to a file.

updateMetadataBd(StringBuilder, BinData) - Method in class com.chilkatsoft.chilkat2.Pdf

Updates or adds XMP metadata to a PDF.

updateNewArray(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Creates or replaces the value at jsonPath with a new empty JSON array.

updateNewObject(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Creates or replaces the value at jsonPath with a new empty JSON object.

updateNull(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Updates the value at jsonPath to a JSON null value, or creates the member and any missing path components as needed.

updateNumber(String, String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Updates the value at jsonPath to a JSON number value, or creates the member and any missing path components as needed.

updateSb(String, StringBuilder) - Method in class com.chilkatsoft.chilkat2.JsonObject

Updates the value at jsonPath to a JSON string value, or creates the member and any missing path components as needed.

updateSecretBd(JsonObject, BinData) - Method in class com.chilkatsoft.chilkat2.Secrets

Creates a binary secret if it does not yet exist, or updates an existing secret.

updateSecretJson(JsonObject, JsonObject) - Method in class com.chilkatsoft.chilkat2.Secrets

Creates a JSON secret if it does not yet exist, or updates an existing secret.

updateSecretSb(JsonObject, StringBuilder) - Method in class com.chilkatsoft.chilkat2.Secrets

Creates a string secret if it does not yet exist, or updates an existing secret.

updateSecretStr(JsonObject, String) - Method in class com.chilkatsoft.chilkat2.Secrets

Creates a string secret if it does not yet exist, or updates an existing secret.

updateString(String, String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Updates the value at jsonPath to a JSON string value, or creates the member and any missing path components as needed.

updateUInt(String, long) - Method in class com.chilkatsoft.chilkat2.JsonObject

Updates the value at jsonPath to a JSON number value, or creates the member and any missing path components as needed.

Upload - Class in com.chilkatsoft.chilkat2

<section class="upload-summary">

Upload() - Constructor for class com.chilkatsoft.chilkat2.Upload

Creates a new Upload object.

uploadBd(BinData, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Uploads all bytes in binData to the remote file at remoteFilePath.

uploadBd(String, BinData) - Method in class com.chilkatsoft.chilkat2.Scp

Uploads all bytes currently contained in the BinData object in bd to the remote file at remotePath.

uploadBinaryEncoded(String, String, String) - Method in class com.chilkatsoft.chilkat2.Scp

Decodes the text in encodedData using the binary encoding named by encoding, then uploads the resulting bytes to the remote file at remotePath.

uploadFile(String, String) - Method in class com.chilkatsoft.chilkat2.Ai

Uploads a file and returns the file_id (or uri) that can be used to reference the pre-uploaded file using InputAddFileId before an Ask.

uploadFile(String, String) - Method in class com.chilkatsoft.chilkat2.Scp

Uploads the local filesystem file at localPath to the remote path in remotePath.

uploadFile(String, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Streams the local filesystem file at fromLocalFilePath to the remote file identified by handle.

uploadFileBd(BinData, String, String) - Method in class com.chilkatsoft.chilkat2.Ai

Uploads the contents of bd and returns the file_id (or uri) that can be used to reference the pre-uploaded file using InputAddFileId before an Ask.

uploadFileByName(String, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Uploads the local filesystem file at localFilePath to remoteFilePath.

uploadFileSb(StringBuilder, String, String) - Method in class com.chilkatsoft.chilkat2.Ai

Uploads the contents of sb and returns the file_id (or uri) that can be used to reference the pre-uploaded file using InputAddFileId before an Ask.

uploadSb(StringBuilder, String, String, boolean) - Method in class com.chilkatsoft.chilkat2.SFtp

Encodes the text in sb using charset and uploads it to remoteFilePath.

uploadString(String, String, String) - Method in class com.chilkatsoft.chilkat2.Scp

Encodes the text in textData using the character encoding named by charset, then uploads the resulting bytes to the remote file at remotePath.

uploadToCloud(JsonObject, JsonObject) - Method in class com.chilkatsoft.chilkat2.Cert

This is an open-ended method to accomodate uploading the private key to a cloud service, such as AWS KMS, or Azure Key Vault.

uploadToCloud(JsonObject, JsonObject) - Method in class com.chilkatsoft.chilkat2.PrivateKey

Uploads or imports the private key to a supported cloud key-management service.

upperCase(String) - Method in class com.chilkatsoft.chilkat2.Charset

Returns the uppercase form of inStr using Chilkat’s Unicode case conversion.

Url - Class in com.chilkatsoft.chilkat2

<section class="url-summary">

Url() - Constructor for class com.chilkatsoft.chilkat2.Url

Creates a new Url object.

urlDecode(String) - Method in class com.chilkatsoft.chilkat2.Http

URL decodes a string.

urlDecodeStr(String) - Method in class com.chilkatsoft.chilkat2.Charset

Percent-decodes inStr and interprets the resulting bytes using the platform’s legacy ANSI character encoding.

urlEncode(String) - Method in class com.chilkatsoft.chilkat2.Http

URL encodes a string.

urlEncodeBody(String) - Method in class com.chilkatsoft.chilkat2.Mime

Replaces the current body with an application/x-www-form-urlencoded-style representation using the character set named by charset.

urlEncParamValue(String, String) - Method in class com.chilkatsoft.chilkat2.HttpResponse

Convenience method for parsing a param's value out of a URL-encoded param string.

useCertVault(XmlCertVault) - Method in class com.chilkatsoft.chilkat2.Cert

Adds an XML certificate vault to the object's internal list of sources to be searched for certificates for help in building certificate chains and verifying the certificate signature to the trusted root.

useCertVault(XmlCertVault) - Method in class com.chilkatsoft.chilkat2.Crypt2

Adds an XML certificate vault to the object's internal list of sources to be searched for certificates and private keys when encrypting/decrypting or signing/verifying.

useCertVault(XmlCertVault) - Method in class com.chilkatsoft.chilkat2.Email

Adds the XML certificate vault in vault to the object's internal certificate and private-key lookup sources for encryption, decryption, signing, and verification.

useCertVault(XmlCertVault) - Method in class com.chilkatsoft.chilkat2.Imap

Associates the XmlCertVault in vault with this Imap object as a source of certificates and private keys for S/MIME operations.

useCertVault(XmlCertVault) - Method in class com.chilkatsoft.chilkat2.JavaKeyStore

Adds vault to the certificate sources Chilkat searches when it needs issuer certificates to build a private-key certificate chain.

useCertVault(XmlCertVault) - Method in class com.chilkatsoft.chilkat2.MailMan

Provides an XML certificate vault to be searched for certificates and private keys when MailMan performs operations such as encryption, decryption, signing, or signature verification.

useCertVault(XmlCertVault) - Method in class com.chilkatsoft.chilkat2.Mime

Sets vault as the certificate vault used to locate certificates and private keys for S/MIME encryption, decryption, signing, and verification.

useCertVault(XmlCertVault) - Method in class com.chilkatsoft.chilkat2.Pfx

Adds the certificates currently contained in vault to the set of certificate sources available for later chain-building operations, such as Pfx.addCert(Cert, boolean).

useCertVault(XmlCertVault) - Method in class com.chilkatsoft.chilkat2.XmlDSig

Adds an XML certificate vault to the object's internal list of sources to be searched for certificates having public keys when verifying an XML signature.

useConnection(Rest) - Method in class com.chilkatsoft.chilkat2.WebSocket

Associates this WebSocket object with an existing, connected Rest object and prepares it for a client-side WebSocket session.

useConnection(Socket) - Method in class com.chilkatsoft.chilkat2.OAuth2

Associates sock with this object for HTTP connections to the token endpoint.

useConnection(Socket, boolean) - Method in class com.chilkatsoft.chilkat2.Rest

Uses the already-connected Socket in connection as the transport for REST requests.

useKnownPrime(int) - Method in class com.chilkatsoft.chilkat2.Dh

Selects one of eight built-in safe-prime MODP groups and sets the object's P and G properties.

useMcp(Mcp, String) - Method in class com.chilkatsoft.chilkat2.Ai

Registers the tools provided by the connected MCP (Model Context Protocol) server cMcp so the AI model can call them during a conversation.

usePkcs11(Pkcs11, long, long, String) - Method in class com.chilkatsoft.chilkat2.SshKey

Configures this object to use a private key held in a PKCS#11 token, smart card, or HSM for SSH public-key authentication.

usePrivateKey(PrivateKey) - Method in class com.chilkatsoft.chilkat2.Rsa

Imports a private key from privKey to use for signing or decrypting.

usePublicKey(PublicKey) - Method in class com.chilkatsoft.chilkat2.Rsa

Imports a public key from pubKey to use for encrypting or signature verification.

useSsh(Ssh) - Method in class com.chilkatsoft.chilkat2.Imap

Uses an already connected and authenticated Ssh object as the transport for subsequent IMAP connections.

useSsh(Ssh) - Method in class com.chilkatsoft.chilkat2.MailMan

Configures MailMan to use an existing SSH tunnel provided by the Ssh object in ssh for SMTP and POP3 connections.

useSsh(Ssh) - Method in class com.chilkatsoft.chilkat2.Scp

Associates this Scp object with the connected and authenticated Ssh object in sshConnection.

useSsh(Ssh) - Method in class com.chilkatsoft.chilkat2.Socket

Configures this socket to route subsequent Connect calls through the already connected and authenticated Ssh object.

useSshCertificate(String) - Method in class com.chilkatsoft.chilkat2.SshKey

Associates an OpenSSH user certificate with this object for SSH or SFTP public-key authentication.

useSshTunnel(Socket) - Method in class com.chilkatsoft.chilkat2.Imap

Uses the existing SSH tunnel represented by the Socket in tunnel for subsequent IMAP connections.

useSshTunnel(Socket) - Method in class com.chilkatsoft.chilkat2.MailMan

Configures MailMan to use an existing SSH tunnel provided by a Socket object for SMTP and POP3 connections.

V

validate(int) - Method in class com.chilkatsoft.chilkat2.Jws

Validates exactly one signature, identified by zero-based index, using the MAC key or public key configured at that same index.

validateServerHandshake() - Method in class com.chilkatsoft.chilkat2.WebSocket

Validates the server's response to the WebSocket opening handshake sent through the associated Rest object.

varDefined(String) - Method in class com.chilkatsoft.chilkat2.HttpCurl

Returns true if the varName is defined, otherwise returns false.

verify() - Method in class com.chilkatsoft.chilkat2.Dsa

Verifies the DSA signature currently stored in Signature against the digest stored in Hash, using the loaded public key.

verify() - Method in class com.chilkatsoft.chilkat2.Mime

Verifies the current CMS/PKCS #7 signed MIME entity and removes the signature wrapper.

verifyBd(BinData, String, BinData) - Method in class com.chilkatsoft.chilkat2.Rsa

Verifies the RSA signature passed in bdSig against the original data passed in bdData.

verifyBd(BinData, String, String, String, PublicKey) - Method in class com.chilkatsoft.chilkat2.Ecc

Hashes the bytes in bdData using the algorithm named by hashAlg and verifies the ECDSA signature in encodedSig with the EC public key in pubkey.

verifyBdENC(BinData, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Verifies a detached digital signature against the original data contained in data.

verifyBdENC(BinData, String, String, PublicKey) - Method in class com.chilkatsoft.chilkat2.EdDSA

Verifies the encoded EdDSA signature in encodedSig against the exact byte sequence contained in bd, using the Ed25519 public key in pubkey.

verifyCertSignatures() - Method in class com.chilkatsoft.chilkat2.CertChain

Verifies the cryptographic signature linkage of the certificates in this chain.

verifyCsr() - Method in class com.chilkatsoft.chilkat2.Csr

Verifies the digital signature on the currently loaded CSR using the public key embedded in that request.

verifyFile(String, String) - Method in class com.chilkatsoft.chilkat2.Charset

Returns true when the contents of the file at path form a valid byte sequence for the charset named by charset; otherwise returns false.

verifyHash(String, String) - Method in class com.chilkatsoft.chilkat2.SecureString

Verifies the hashVal against the hash value stored for the current value of this secure string.

verifyHashENC(String, String, String) - Method in class com.chilkatsoft.chilkat2.Rsa

Validates an RSA signature provided in encodedSig against the hash of the original data in encodedHash.

verifyHashENC(String, String, String, PublicKey) - Method in class com.chilkatsoft.chilkat2.Ecc

Verifies an ECDSA signature over a digest that was computed by the application.

verifyJwt(String, String) - Method in class com.chilkatsoft.chilkat2.Jwt

Verifies the signature of a compact JWT signed with the shared secret in password.

verifyJwtPk(String, PublicKey) - Method in class com.chilkatsoft.chilkat2.Jwt

Verifies the signature of a compact JWT using key.

verifyKey() - Method in class com.chilkatsoft.chilkat2.Dsa

Checks the mathematical validity and internal consistency of the DSA public or private key currently loaded in the object.

verifyP7M(String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Verifies an opaque digital signature contained in a .p7m file and extracts the original data to destPath.

verifyP7S(String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Verifies a detached digital signature contained in a .p7s file against the original data contained in originalDataPath.

verifyPassword() - Method in class com.chilkatsoft.chilkat2.Zip

Verifies that the current DecryptPassword value is correct for the currently opened ZIP archive.

verifyPopConnection() - Method in class com.chilkatsoft.chilkat2.MailMan

Tests whether a TCP/IP connection can be established with the configured POP3 server.

verifyPopLogin() - Method in class com.chilkatsoft.chilkat2.MailMan

Tests whether Chilkat can connect to the configured POP3 server and successfully log in using the current POP3 authentication settings.

verifyRawBd(BinData) - Method in class com.chilkatsoft.chilkat2.Rsa

This is legacy low-level raw RSA that duplicates the (now deprecated) OpenSSL rsautl utility.

verifyRecips(Email, StringArray) - Method in class com.chilkatsoft.chilkat2.MailMan

Begins the SMTP send process for email, sends the recipient addresses to the SMTP server, and then aborts before sending the message content.

verifyReferenceDigest(int) - Method in class com.chilkatsoft.chilkat2.XmlDSig

This method allows for an application to verify the digest for each reference separately.

verifySbENC(StringBuilder, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Verifies a detached digital signature against the original text contained in sb.

verifySignature() - Method in class com.chilkatsoft.chilkat2.Cert

Verifies the certificate signature, as well as the signatures of all certificates in the chain of authentication to the trusted root.

verifySignature(boolean) - Method in class com.chilkatsoft.chilkat2.XmlDSig

Verifies the signature indicated by the Selector property.

verifySignature(int, JsonObject) - Method in class com.chilkatsoft.chilkat2.Pdf

Verifies the Nth signature contained in the PDF, where the 1st signature is indicated by an index of 0.

verifySignature(String, JsonObject) - Method in class com.chilkatsoft.chilkat2.CodeSign

Verifies the embedded Microsoft Authenticode signature of the file specified by path: a Windows executable or DLL, or, starting in v11.7.0, a Windows Installer package (.msi), PowerShell file (.ps1, .psm1, .psd1), or VBScript file (.vbs).

verifySmtpConnection() - Method in class com.chilkatsoft.chilkat2.MailMan

Tests whether a TCP/IP connection can be established with the configured SMTP server.

verifySmtpLogin() - Method in class com.chilkatsoft.chilkat2.MailMan

Tests whether Chilkat can connect to the configured SMTP server and successfully authenticate using the current SMTP authentication settings.

verifyStringENC(String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Verifies a detached digital signature against the original text in str.

verifyStringENC(String, String, String) - Method in class com.chilkatsoft.chilkat2.Rsa

Verifies the encoded RSA signature passed in encodedSig against the original data passed in originalString.

verifyTar(String) - Method in class com.chilkatsoft.chilkat2.Tar

Opens the uncompressed TAR archive at tarPath and scans its headers through the end of the archive.

verifyTimestampReply(BinData, Cert) - Method in class com.chilkatsoft.chilkat2.Http

Verifies a timestamp reply received from a timestamp authority (TSA).

VERSION - Static variable in class com.chilkatsoft.chilkat2.Chilkat2Native

The Chilkat version this jar was generated for.

W

waitForChannelMessage(int) - Method in class com.chilkatsoft.chilkat2.Ssh

Waits for the next SSH channel message on any channel.

watermark(String, JsonObject, JsonObject) - Method in class com.chilkatsoft.chilkat2.Pdf

Adds, detects, lists and removes watermarks in the loaded PDF.

WebSocket - Class in com.chilkatsoft.chilkat2

<section class="websocket-summary">

WebSocket() - Constructor for class com.chilkatsoft.chilkat2.WebSocket

Creates a new WebSocket object.

wordFollowing(StringBuilder, boolean, StringBuilder) - Method in class com.chilkatsoft.chilkat2.StringTable

The method performs a case-insensitive search to return the index of a table entry matching sb, or -1 if there is no match.

writeAppendFile(String) - Method in class com.chilkatsoft.chilkat2.BinData

Appends the contents of this object to a file.

writeBd(BinData) - Method in class com.chilkatsoft.chilkat2.Asn

Appends the ASN.1 in binary DER format to bd.

writeBd(BinData) - Method in class com.chilkatsoft.chilkat2.Pdf

The same as Pdf.writeFile(String), but the PDF is written to bd (a BinData object) instead of a file.

writeBd(BinData) - Method in class com.chilkatsoft.chilkat2.Stream

Writes the contents of binData to the stream.

writeBd(BinData) - Method in class com.chilkatsoft.chilkat2.Zip

Writes the ZIP archive to a BinData object instead of a filesystem file.

writeBinaryDer(String) - Method in class com.chilkatsoft.chilkat2.Asn

Writes the ASN.1 in binary DER form to a file.

writeByte(int) - Method in class com.chilkatsoft.chilkat2.Stream

Writes a single byte to the stream.

writeBytesENC(String, String) - Method in class com.chilkatsoft.chilkat2.Stream

Writes binary bytes to a stream.

writeClose() - Method in class com.chilkatsoft.chilkat2.Stream

Indicates that no more data will be written to the stream.

writeEntireTextFile(String, String, String, boolean) - Method in class com.chilkatsoft.chilkat2.FileAccess

Creates or opens filePath, encodes textData using charset, writes the resulting bytes, and closes the file.

writeExe(String) - Method in class com.chilkatsoft.chilkat2.Zip

(Windows only, for creating self-extracting EXE's)

writeFile(String) - Method in class com.chilkatsoft.chilkat2.BinData

Writes the contents to a file.

writeFile(String) - Method in class com.chilkatsoft.chilkat2.JsonObject

Serializes this JSON and writes it to the file at path.

writeFile(String) - Method in class com.chilkatsoft.chilkat2.Pdf

Writes the loaded PDF, with every change made since it was loaded, to the file at path.

writeFile(String, String, boolean) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Writes the contents to a file.

writeFile(String, String, BinData) - Method in class com.chilkatsoft.chilkat2.ScMinidriver

Writes the entire file specified by dirName and fileName.

writeFileBd(String, BinData) - Method in class com.chilkatsoft.chilkat2.SFtp

Appends all bytes in bd to the remote file identified by handle.

writeFileIfModified(String, String, boolean) - Method in class com.chilkatsoft.chilkat2.StringBuilder

Writes the contents to a file, but only if it is a new file or if the contents are different than the existing file.

writeFileText(String, String, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Encodes textData using charset and writes the resulting bytes at the current sequential write position for handle.

writeFileText32(String, int, String, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Encodes textData using charset and writes the resulting bytes to handle at the 32-bit byte offset offset32.

writeFileText64(String, long, String, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Encodes textData using charset and writes the resulting bytes to handle at the 64-bit byte offset offset64.

writeFileText64s(String, String, String, String) - Method in class com.chilkatsoft.chilkat2.SFtp

Encodes textData using charset and writes the resulting bytes to handle at the byte offset supplied as decimal string offset64.

writeSb(StringBuilder) - Method in class com.chilkatsoft.chilkat2.Stream

Writes the contents of sb to the stream.

writeString(String) - Method in class com.chilkatsoft.chilkat2.Stream

Writes a string to a stream.

writeStringToFile(String, String, String) - Method in class com.chilkatsoft.chilkat2.Charset

Encodes the Unicode text in textData using the charset named by charset and writes the resulting bytes to the file at path.

writeTar(String) - Method in class com.chilkatsoft.chilkat2.Tar

Creates an uncompressed TAR archive at tarPath from the files and directory trees previously added with AddFile, AddFile2, AddDirRoot, and AddDirRoot2.

writeTarBz2(String) - Method in class com.chilkatsoft.chilkat2.Tar

Creates a bzip2-compressed TAR archive at bz2Path from the files and directory trees previously added to this object.

writeTarGz(String) - Method in class com.chilkatsoft.chilkat2.Tar

Creates a gzip-compressed TAR archive at gzPath from the files and directory trees previously added to this object.

writeZip() - Method in class com.chilkatsoft.chilkat2.Zip

Saves the Zip to a file and implictly re-opens it so further operations can continue.

writeZipAndClose() - Method in class com.chilkatsoft.chilkat2.Zip

Saves the Zip to a file and closes it.

X

x509PKIPathv1() - Method in class com.chilkatsoft.chilkat2.Cert

Returns the base64 representation of an X509PKIPathv1 containing just the calling certificate.

x509PKIPathv1() - Method in class com.chilkatsoft.chilkat2.CertChain

Returns the Base64 representation of a DER-encoded ASN.1 PkiPath containing the certificates in this chain.

xfdlToXml(String) - Method in class com.chilkatsoft.chilkat2.Gzip

Converts encoded and compressed XFDL data to a decompressed XML string.

xlsxGetSheets(Zip, StringTable) - Method in class com.chilkatsoft.chilkat2.Csv

Gets the worksheet names contained in an Excel .xlsx workbook.

xlsxLoadSheet(Zip, String) - Method in class com.chilkatsoft.chilkat2.Csv

Loads a worksheet from an Excel .xlsx workbook into this CSV object.

xml() - Method in class com.chilkatsoft.chilkat2.HtmlToXml

Equivalent to ToXml.

Xml - Class in com.chilkatsoft.chilkat2

<section class="xml-summary">

Xml() - Constructor for class com.chilkatsoft.chilkat2.Xml

Creates a new Xml object.

XmlCertVault - Class in com.chilkatsoft.chilkat2

<section class="xmlcertvault-summary">

XmlCertVault() - Constructor for class com.chilkatsoft.chilkat2.XmlCertVault

Creates a new XmlCertVault object.

XmlDSig - Class in com.chilkatsoft.chilkat2

<section class="xmldsig-summary">

XmlDSig() - Constructor for class com.chilkatsoft.chilkat2.XmlDSig

Creates a new XmlDSig object.

XmlDSigGen - Class in com.chilkatsoft.chilkat2

<section class="xmldsiggen-summary">

XmlDSigGen() - Constructor for class com.chilkatsoft.chilkat2.XmlDSigGen

Creates a new XmlDSigGen object.

Xmp - Class in com.chilkatsoft.chilkat2

<section class="xmp-summary">

Xmp() - Constructor for class com.chilkatsoft.chilkat2.Xmp

Creates a new Xmp object.

xtsSetDataUnitNumber(long, long) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the XTS-AES mode data unit number.

xtsSetEncodedTweakKey(String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the XTS-AES mode tweak key from an encoded string.

xtsSetEncodedTweakValue(String, String) - Method in class com.chilkatsoft.chilkat2.Crypt2

Sets the XTS-AES mode tweak value from an encoded string.

Z

Zip - Class in com.chilkatsoft.chilkat2

<section class="zip-summary">

Zip() - Constructor for class com.chilkatsoft.chilkat2.Zip

Creates a new Zip object.

zipAttachments(String) - Method in class com.chilkatsoft.chilkat2.Email

Replaces all the attachments of an email with a single Zip file attachment having the filename specified.

zipContent() - Method in class com.chilkatsoft.chilkat2.Xml

ZIP-compresses this element's text content and replaces the original content with Base64-encoded compressed data.

ZipCrc - Class in com.chilkatsoft.chilkat2

<section class="zipcrc-summary">

ZipCrc() - Constructor for class com.chilkatsoft.chilkat2.ZipCrc

Creates a new ZipCrc object.

ZipEntry - Class in com.chilkatsoft.chilkat2

<section class="zipentry-summary">

ZipEntry() - Constructor for class com.chilkatsoft.chilkat2.ZipEntry

Creates a new ZipEntry object.

zipTree() - Method in class com.chilkatsoft.chilkat2.Xml

ZIP-compresses the calling element's content together with its entire child subtree and replaces that structure with Base64-encoded compressed data.

A B C D E F G H I J L M N O P Q R S T U V W X Z
All Classes|All Packages|Constant Field Values|Serialized Form