Index (net.markenwerk:utils-mail-dkim 2.0.1 API)

A B C D E F G I K N O R S T V W
All Classes All Packages

A

AbstractBufferedDataFetcher - Class in net.markenwerk.utils.data.fetcher: AbstractBufferedDataFetcher is a sensible base implementation of DataFetcher that uses a byte[] as buffer, to while copying all bytes from an InputStream to an OutputStream by sequentially reading from the InputStream into the buffer and then writing from the buffer to the OutputStream.
AbstractBufferedDataFetcher() - Constructor for class net.markenwerk.utils.data.fetcher.AbstractBufferedDataFetcher
AbstractDataFetcher - Class in net.markenwerk.utils.data.fetcher: AbstractDataFetcher is a sensible base implementation of DataFetcher.
AbstractDataFetcher() - Constructor for class net.markenwerk.utils.data.fetcher.AbstractDataFetcher
addHeaderToSign(String) - Method in class net.markenwerk.utils.mail.dkim.DkimSigner: Adds a header to the set of headers that will be included in the signature, if present.

B

BufferedDataFetcher - Class in net.markenwerk.utils.data.fetcher: AbstractBufferedDataFetcher is a sensible base implementation of DataFetcher that uses a byte[] as buffer, while copying all bytes from an InputStream to an OutputStream by sequentially reading from the InputStream into the buffer and then writing from the buffer to the OutputStream.
BufferedDataFetcher() - Constructor for class net.markenwerk.utils.data.fetcher.BufferedDataFetcher: Creates a new BufferedDataFetcher with the default buffer size of 1024 bytes.
BufferedDataFetcher(int) - Constructor for class net.markenwerk.utils.data.fetcher.BufferedDataFetcher: Creates a new BufferedDataFetcher with the given buffer size.

C

Canonicalization - Enum in net.markenwerk.utils.mail.dkim: Provides "simple" and "relaxed" canonicalization according to RFC 4871.
canonicalizeBody(String) - Method in enum net.markenwerk.utils.mail.dkim.Canonicalization
canonicalizeHeader(String, String) - Method in enum net.markenwerk.utils.mail.dkim.Canonicalization
check(String, PrivateKey) - Method in class net.markenwerk.utils.mail.dkim.DomainKey: Checks, whether this DomainKey fits to the given identity and RSAPrivateKey.
close() - Method in class net.markenwerk.commons.nulls.NullReader
close() - Method in class net.markenwerk.commons.nulls.NullWriter
copy(InputStream, OutputStream) - Method in class net.markenwerk.utils.data.fetcher.AbstractDataFetcher
copy(InputStream, OutputStream) - Method in interface net.markenwerk.utils.data.fetcher.DataFetcher: Copies the content of a given InputStream into a given OutputStream.
copy(InputStream, OutputStream, boolean, boolean) - Method in class net.markenwerk.utils.data.fetcher.AbstractDataFetcher
copy(InputStream, OutputStream, boolean, boolean) - Method in interface net.markenwerk.utils.data.fetcher.DataFetcher: Copies the content of a given InputStream into a given OutputStream.
copy(InputStream, OutputStream, DataFetchProgressListener) - Method in class net.markenwerk.utils.data.fetcher.AbstractDataFetcher
copy(InputStream, OutputStream, DataFetchProgressListener) - Method in interface net.markenwerk.utils.data.fetcher.DataFetcher: Copies the content of a given InputStream into a given OutputStream.
copy(InputStream, OutputStream, DataFetchProgressListener, boolean, boolean) - Method in class net.markenwerk.utils.data.fetcher.AbstractDataFetcher
copy(InputStream, OutputStream, DataFetchProgressListener, boolean, boolean) - Method in interface net.markenwerk.utils.data.fetcher.DataFetcher: Copies the content of a given InputStream into a given OutputStream.
createBuffer(int) - Static method in class net.markenwerk.utils.data.fetcher.AbstractBufferedDataFetcher: Safely creates a new byte[] to be used as a buffer.

D

DataFetcher - Interface in net.markenwerk.utils.data.fetcher: A DataFetcher can fetch the entire content of a given InputStream into a fresh byte[] or copy it into a given OutputStream.
DataFetchException - Exception in net.markenwerk.utils.data.fetcher: A DataFetchException is a specialized IOException that indicates that a fetch operation of a DataFetcher has failed.
DataFetchException(String) - Constructor for exception net.markenwerk.utils.data.fetcher.DataFetchException: Creates a new DataFetchException with the given message.
DataFetchException(String, Throwable) - Constructor for exception net.markenwerk.utils.data.fetcher.DataFetchException: Creates a new DataFetchException with the given message and cause.
DataFetchException(Throwable) - Constructor for exception net.markenwerk.utils.data.fetcher.DataFetchException: Creates a new DataFetchException with the given cause.
DataFetchProgressListener - Interface in net.markenwerk.utils.data.fetcher
DEFAULT_BUFEFR_SIZE - Static variable in class net.markenwerk.utils.data.fetcher.AbstractBufferedDataFetcher: The default buffer size of 1024 bytes.
DkimAcceptanceException - Exception in net.markenwerk.utils.mail.dkim: A DkimSigningException that is used to indicate that an attempt to sign a DkimMessage failed, because the DkimSigner configuration is incompatible with the values retrieved from the DNS.
DkimAcceptanceException(String) - Constructor for exception net.markenwerk.utils.mail.dkim.DkimAcceptanceException: Constructs a DkimAcceptanceException with the given message.
DkimAcceptanceException(String, Exception) - Constructor for exception net.markenwerk.utils.mail.dkim.DkimAcceptanceException: Constructs a DkimAcceptanceException with the given message and cause.
DkimException - Exception in net.markenwerk.utils.mail.dkim: A RuntimeException that is used to indicate DKIM specific missbehaviors or to wrap other Exceptions that were thrown during the processing of DKIM specific operations.
DkimException(String) - Constructor for exception net.markenwerk.utils.mail.dkim.DkimException: Constructs a DkimException with the given message.
DkimException(String, Exception) - Constructor for exception net.markenwerk.utils.mail.dkim.DkimException: Constructs a DkimException with the given message and cause.
DkimMessage - Class in net.markenwerk.utils.mail.dkim: Extension of SMTPMessage for the inclusion of a DKIM signature.
DkimMessage(MimeMessage, DkimSigner) - Constructor for class net.markenwerk.utils.mail.dkim.DkimMessage: Created a new DkimMessage from the given MimeMessage and DkimSigner.
DkimSigner - Class in net.markenwerk.utils.mail.dkim: Main class providing a signature according to DKIM RFC 4871.
DkimSigner(String, String, File) - Constructor for class net.markenwerk.utils.mail.dkim.DkimSigner: Created a new DkimSigner for the given signing domain and selector with the given DER encoded RSA private Key.
DkimSigner(String, String, InputStream) - Constructor for class net.markenwerk.utils.mail.dkim.DkimSigner: Created a new DkimSigner for the given signing domain and selector with the given DER encoded RSA private Key.
DkimSigner(String, String, RSAPrivateKey) - Constructor for class net.markenwerk.utils.mail.dkim.DkimSigner: Created a new DkimSigner for the given signing domain and selector with the given RSAPrivateKey.
DkimSigner(String, String, EdDSAPrivateKey) - Constructor for class net.markenwerk.utils.mail.dkim.DkimSigner: Created a new DkimSigner for the given signing domain and selector with the given RSAPrivateKey.
DkimSigningException - Exception in net.markenwerk.utils.mail.dkim: A MessagingException that is used to indicate DKIM specific missbehaviors or to wrap other Exceptions that were thrown during the processing of a DKIM signature, or operations necessary for DKIM signatures.
DkimSigningException(String) - Constructor for exception net.markenwerk.utils.mail.dkim.DkimSigningException: Constructs a DkimSigningException with the given message.
DkimSigningException(String, Exception) - Constructor for exception net.markenwerk.utils.mail.dkim.DkimSigningException: Constructs a DkimSigningException with the given message and cause.
doCopy(InputStream, OutputStream, DataFetchProgressListener) - Method in class net.markenwerk.utils.data.fetcher.AbstractBufferedDataFetcher
doCopy(InputStream, OutputStream, DataFetchProgressListener) - Method in class net.markenwerk.utils.data.fetcher.AbstractDataFetcher: Copies the content of a given InputStream into a given OutputStream.
DomainKey - Class in net.markenwerk.utils.mail.dkim: A DomainKey holds the information about a domain key.
DomainKey(Map<Character, String>) - Constructor for class net.markenwerk.utils.mail.dkim.DomainKey: Creates a new DomainKey from the given tags.
DomainKeyUtil - Class in net.markenwerk.utils.mail.dkim

E

ED25519 - net.markenwerk.utils.mail.dkim.KeyPairType

F

fetch(InputStream) - Method in class net.markenwerk.utils.data.fetcher.AbstractDataFetcher
fetch(InputStream) - Method in interface net.markenwerk.utils.data.fetcher.DataFetcher: Fetches the content of a given InputStream into a fresh byte[].
fetch(InputStream, boolean) - Method in class net.markenwerk.utils.data.fetcher.AbstractDataFetcher
fetch(InputStream, boolean) - Method in interface net.markenwerk.utils.data.fetcher.DataFetcher: Fetches the content of a given InputStream into a fresh byte[].
fetch(InputStream, DataFetchProgressListener) - Method in class net.markenwerk.utils.data.fetcher.AbstractDataFetcher
fetch(InputStream, DataFetchProgressListener) - Method in interface net.markenwerk.utils.data.fetcher.DataFetcher: Fetches the content of a given InputStream into a fresh byte[].
fetch(InputStream, DataFetchProgressListener, boolean) - Method in class net.markenwerk.utils.data.fetcher.AbstractDataFetcher
fetch(InputStream, DataFetchProgressListener, boolean) - Method in interface net.markenwerk.utils.data.fetcher.DataFetcher: Fetches the content of a given InputStream into a fresh byte[].
flush() - Method in class net.markenwerk.commons.nulls.NullWriter

G

getBodyCanonicalization() - Method in class net.markenwerk.utils.mail.dkim.DkimSigner: Returns the configured Canonicalization to be used for the body.
getCacheTtl() - Static method in class net.markenwerk.utils.mail.dkim.DomainKeyUtil: Returns the configured TTL (time to live) for retrieved DomainKey s.
getDefaultSigningAlgorithm() - Method in enum net.markenwerk.utils.mail.dkim.KeyPairType
getDkimNotation() - Method in enum net.markenwerk.utils.mail.dkim.KeyPairType
getDkimNotation() - Method in enum net.markenwerk.utils.mail.dkim.SigningAlgorithm
getDomainKey(String, String) - Static method in class net.markenwerk.utils.mail.dkim.DomainKeyUtil: Retrieves the DomainKey for the given signing domain and selector.
getEncodedBody() - Method in class net.markenwerk.utils.mail.dkim.DkimMessage: Returns the encoded body.
getGranularity() - Method in class net.markenwerk.utils.mail.dkim.DomainKey: Returns a Pattern that matches the granularity of this DomainKey, as described in the 'g' tag.
getHashNotation() - Method in enum net.markenwerk.utils.mail.dkim.SigningAlgorithm
getHeaderCanonicalization() - Method in class net.markenwerk.utils.mail.dkim.DkimSigner: Returns the configured Canonicalization to be used for the headers.
getIdentity() - Method in class net.markenwerk.utils.mail.dkim.DkimSigner: Returns the configured identity parameter.
getJavaNotation() - Method in enum net.markenwerk.utils.mail.dkim.KeyPairType
getJavaNotation() - Method in enum net.markenwerk.utils.mail.dkim.SigningAlgorithm
getLengthParam() - Method in class net.markenwerk.utils.mail.dkim.DkimSigner: Returns the configured length parameter.
getPublicKey() - Method in class net.markenwerk.utils.mail.dkim.DomainKey: Returns the public key of this DomainKey, as provided by the 'p' tag.
getPublicKeyType() - Method in class net.markenwerk.utils.mail.dkim.DomainKey: Returns the type of public key of this DomainKey, as provided by the 'p' tag.
getServiceTypes() - Method in class net.markenwerk.utils.mail.dkim.DomainKey: Returns the set of service types supported by this DomainKey, as described in the 's' tag.
getSigningAlgorithm() - Method in class net.markenwerk.utils.mail.dkim.DkimSigner: Returns the configured SigningAlgorithm.
getTags() - Method in class net.markenwerk.utils.mail.dkim.DomainKey: Returns the unmodifiable map of tags, this DomainKey was constructed from.
getTags(String, String) - Static method in class net.markenwerk.utils.mail.dkim.DomainKeyUtil: Retrieves the tags of a domain key for the given signing domain and selector.
getTimestamp() - Method in class net.markenwerk.utils.mail.dkim.DomainKey: Returns the construction time of this DomainKey as a timestamp.
getType() - Method in enum net.markenwerk.utils.mail.dkim.Canonicalization
getValue(String, String) - Static method in class net.markenwerk.utils.mail.dkim.DomainKeyUtil: Retrieves the raw domain key for the given signing domain and selector.

I

IdleDataFetchProgressListener - Class in net.markenwerk.utils.data.fetcher: An IdleDataFetchProgressListener is a DataFetchProgressListener with empty methods.
IdleDataFetchProgressListener() - Constructor for class net.markenwerk.utils.data.fetcher.IdleDataFetchProgressListener
initialize() - Method in enum net.markenwerk.utils.mail.dkim.KeyPairType
isCheckDomainKey() - Method in class net.markenwerk.utils.mail.dkim.DkimSigner: Returns whether the domain key should be retrieved and checked.
isCopyHeaderFields() - Method in class net.markenwerk.utils.mail.dkim.DkimSigner: Returns the configured z parameter.
isZParam() - Method in class net.markenwerk.utils.mail.dkim.DkimSigner: Deprecated.
Use DkimSigner.isCopyHeaderFields() instead.

K

KeyPairType - Enum in net.markenwerk.utils.mail.dkim

N

net.markenwerk.commons.nulls - package net.markenwerk.commons.nulls
net.markenwerk.utils.data.fetcher - package net.markenwerk.utils.data.fetcher
net.markenwerk.utils.mail.dkim - package net.markenwerk.utils.mail.dkim
NullInputStream - Class in net.markenwerk.commons.nulls: A NullInputStream is an InputStream that does nothing.
NullInputStream() - Constructor for class net.markenwerk.commons.nulls.NullInputStream: Creates a new NullInputStream.
NullOutputStream - Class in net.markenwerk.commons.nulls: A NullOutputStream is an OutputStream that does nothing.
NullOutputStream() - Constructor for class net.markenwerk.commons.nulls.NullOutputStream: Creates a new NullOutputStream.
NullReader - Class in net.markenwerk.commons.nulls: A NullReader is an Reader that does nothing.
NullReader() - Constructor for class net.markenwerk.commons.nulls.NullReader: Creates a new NullReader.
NullWriter - Class in net.markenwerk.commons.nulls: A NullWriter is a Writer that does nothing.
NullWriter() - Constructor for class net.markenwerk.commons.nulls.NullWriter: Creates a new NullWriter.

O

obtainBuffer() - Method in class net.markenwerk.utils.data.fetcher.AbstractBufferedDataFetcher: Called by AbstractBufferedDataFetcher.doCopy(InputStream, OutputStream, DataFetchProgressListener) to obtain a byte[] to be used as a buffer.
obtainBuffer() - Method in class net.markenwerk.utils.data.fetcher.BufferedDataFetcher
onFailed(DataFetchException, Long) - Method in interface net.markenwerk.utils.data.fetcher.DataFetchProgressListener: Indicates that the process of fetching bytes from an InputStream has failed.
onFailed(DataFetchException, Long) - Method in class net.markenwerk.utils.data.fetcher.IdleDataFetchProgressListener
onFinished() - Method in interface net.markenwerk.utils.data.fetcher.DataFetchProgressListener: Indicates that the process of fetching bytes from an InputStream has finished.
onFinished() - Method in class net.markenwerk.utils.data.fetcher.IdleDataFetchProgressListener
onProgress(long) - Method in interface net.markenwerk.utils.data.fetcher.DataFetchProgressListener: Indicates that the process of fetching bytes from an InputStream has progressed.
onProgress(long) - Method in class net.markenwerk.utils.data.fetcher.IdleDataFetchProgressListener
onStarted() - Method in interface net.markenwerk.utils.data.fetcher.DataFetchProgressListener: Indicates that the process of fetching bytes from an InputStream has started.
onStarted() - Method in class net.markenwerk.utils.data.fetcher.IdleDataFetchProgressListener
onSuccedded(Long) - Method in interface net.markenwerk.utils.data.fetcher.DataFetchProgressListener: Indicates that the process of fetching bytes from an InputStream has succeeded.
onSuccedded(Long) - Method in class net.markenwerk.utils.data.fetcher.IdleDataFetchProgressListener

R

read() - Method in class net.markenwerk.commons.nulls.NullInputStream
read(char[], int, int) - Method in class net.markenwerk.commons.nulls.NullReader
RELAXED - net.markenwerk.utils.mail.dkim.Canonicalization: The "relaxed" canonicalization algorithm.
removeHeaderToSign(String) - Method in class net.markenwerk.utils.mail.dkim.DkimSigner: Removes a header from the set of headers that will be included in the signature, unless it is one of the required headers ('From', 'To', 'Subject').
returnBuffer(byte[]) - Method in class net.markenwerk.utils.data.fetcher.AbstractBufferedDataFetcher: Called by AbstractBufferedDataFetcher.doCopy(InputStream, OutputStream, DataFetchProgressListener) to return a byte[] that has previously been obtained from AbstractBufferedDataFetcher.obtainBuffer().
returnBuffer(byte[]) - Method in class net.markenwerk.utils.data.fetcher.BufferedDataFetcher
RSA - net.markenwerk.utils.mail.dkim.KeyPairType

S

setAllow8bitMIME(boolean) - Method in class net.markenwerk.utils.mail.dkim.DkimMessage
setBodyCanonicalization(Canonicalization) - Method in class net.markenwerk.utils.mail.dkim.DkimSigner: Sets the Canonicalization to be used for the body.
setCacheTtl(long) - Static method in class net.markenwerk.utils.mail.dkim.DomainKeyUtil: Sets the TTL (time to live) for retrieved DomainKeys.
setCheckDomainKey(boolean) - Method in class net.markenwerk.utils.mail.dkim.DkimSigner: Sets, whether the domain key should be retrieved and checked.
setCopyHeaderFields(boolean) - Method in class net.markenwerk.utils.mail.dkim.DkimSigner: Sets the z parameter to be used.
setHeaderCanonicalization(Canonicalization) - Method in class net.markenwerk.utils.mail.dkim.DkimSigner: Sets the Canonicalization to be used for the headers.
setIdentity(String) - Method in class net.markenwerk.utils.mail.dkim.DkimSigner: Sets the identity parameter to be used.
setLengthParam(boolean) - Method in class net.markenwerk.utils.mail.dkim.DkimSigner: Sets the length parameter to be used.
setSigningAlgorithm(SigningAlgorithm) - Method in class net.markenwerk.utils.mail.dkim.DkimSigner: Sets the SigningAlgorithm to be used.
setZParam(boolean) - Method in class net.markenwerk.utils.mail.dkim.DkimSigner: Deprecated.
Use DkimSigner.setCopyHeaderFields(boolean) instead.
SHA1_WITH_RSA - net.markenwerk.utils.mail.dkim.SigningAlgorithm: The rsa-sha1 signing algorithm.
SHA256_WITH_ED25519 - net.markenwerk.utils.mail.dkim.SigningAlgorithm: The rsa-sha1 signing algorithm.
SHA256_WITH_RSA - net.markenwerk.utils.mail.dkim.SigningAlgorithm: The rsa-sha256 signing algorithm.
sign(DkimMessage) - Method in class net.markenwerk.utils.mail.dkim.DkimSigner: Returns the DKIM signature header line.
SigningAlgorithm - Enum in net.markenwerk.utils.mail.dkim: Allowed signing algorithms by RFC 4871 with translation to different Java notations.
SIMPLE - net.markenwerk.utils.mail.dkim.Canonicalization: The "simple" canonicalization algorithm.
supportsSigningAlgorithm(SigningAlgorithm) - Method in enum net.markenwerk.utils.mail.dkim.KeyPairType

T

toString() - Method in class net.markenwerk.utils.mail.dkim.DomainKey

V

valueOf(String) - Static method in enum net.markenwerk.utils.mail.dkim.Canonicalization: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.markenwerk.utils.mail.dkim.KeyPairType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.markenwerk.utils.mail.dkim.SigningAlgorithm: Returns the enum constant of this type with the specified name.
values() - Static method in enum net.markenwerk.utils.mail.dkim.Canonicalization: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.markenwerk.utils.mail.dkim.KeyPairType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.markenwerk.utils.mail.dkim.SigningAlgorithm: Returns an array containing the constants of this enum type, in the order they are declared.

W

write(char[], int, int) - Method in class net.markenwerk.commons.nulls.NullWriter
write(int) - Method in class net.markenwerk.commons.nulls.NullOutputStream
writeTo(OutputStream, String[]) - Method in class net.markenwerk.utils.mail.dkim.DkimMessage: Output the message as an RFC 822 format stream, without specified headers.

A B C D E F G I K N O R S T V W
All Classes All Packages