Index

A B C D E F G H I K L M P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

A

addAttachments(Set<File>) - Method in class de.gustavblass.commons.email.DraftEmail

Appends the given files to the already specified ones.

addBccRecipients(Set<InternetAddress>) - Method in class de.gustavblass.commons.email.DraftEmail

Appends the given recipients to the already specified ones.

addCcRecipients(Set<InternetAddress>) - Method in class de.gustavblass.commons.email.DraftEmail

Appends the given recipients to the already specified ones.

addPublicKeys(Set<String>) - Method in class de.gustavblass.commons.email.DraftEmail

Appends the given keys to the already specified ones.

addRecipients(Set<InternetAddress>) - Method in class de.gustavblass.commons.email.DraftEmail

Appends the given recipients to the already specified ones.

attachments - Variable in class de.gustavblass.commons.email.DraftEmail

Any number of files to send along with the message.

B

bccRecipients - Variable in class de.gustavblass.commons.email.DraftEmail

Whom the e-mail shall be blind-carbon-copied to.

BOUNDARY_PATTERN - Static variable in class de.gustavblass.commons.email.EMailSender

The regular expression pattern to extract the boundary from the Content-Type header of a MIME message.

bucket - Variable in class de.gustavblass.commons.email.EMailSender

Rate-limits all requests to the e-mail server to prevent spamming it and potentially getting banned.

C

ccRecipients - Variable in class de.gustavblass.commons.email.DraftEmail

Whom the e-mail shall be carbon-copied to.

constructEmail(DraftEmail) - Method in class de.gustavblass.commons.email.EMailSender

Constructs a new MimeMessage from the specified DraftEmail

constructMultipart(String, Iterable<File>) - Method in class de.gustavblass.commons.email.EMailSender

Constructs a MIME multipart from the given e-mail message and files attached.

copy() - Method in class de.gustavblass.commons.email.EMailSender

D

de.gustavblass.commons.email - package de.gustavblass.commons.email

DEFAULT_USER_AGENT - Static variable in class de.gustavblass.commons.email.EMailSender

The default user-agent string sent with the e-mail.

DraftEmail - Class in de.gustavblass.commons.email

DraftEmail(String, String, Set<InternetAddress>) - Constructor for class de.gustavblass.commons.email.DraftEmail

Creates a new draft e-mail.

DraftEmail(String, String, Set<InternetAddress>, Set<File>) - Constructor for class de.gustavblass.commons.email.DraftEmail

Creates a new draft e-mail.

E

email - Variable in class de.gustavblass.commons.email.EMailSender

The user's e-mail address at the e-mail server.

EMailSender - Class in de.gustavblass.commons.email

Helper tool to send e-mails via an SMTP server.

EMailSender(String, String, InternetAddress, char[]) - Constructor for class de.gustavblass.commons.email.EMailSender

Constructs a new EMailSender with the given SMTP credentials for the given e-mail server.

EMailSender(String, Integer, String, int, InternetAddress, char[]) - Constructor for class de.gustavblass.commons.email.EMailSender

Constructs a new EMailSender with the given SMTP credentials for the given e-mail server.

EMailSender.SentEmail - Record Class in de.gustavblass.commons.email

Represents an e-mail that has been sent.

enableSigning(byte[]) - Method in class de.gustavblass.commons.email.EMailSender

Specifies that the encrypted message should be signed with the given secret key.

enableSigning(byte[], byte[]) - Method in class de.gustavblass.commons.email.EMailSender

Specifies that the encrypted message should be signed with the given secret key.

encryptedEmail - Variable in record class de.gustavblass.commons.email.EMailSender.SentEmail

The field for the encryptedEmail record component.

encryptedEmail() - Method in record class de.gustavblass.commons.email.EMailSender.SentEmail

Returns the value of the encryptedEmail record component.

encryptMessage(DraftEmail, MimeMessage) - Method in class de.gustavblass.commons.email.EMailSender

encryptMessage(MimeMultipart, Set<String>, String) - Method in class de.gustavblass.commons.email.EMailSender

Encrypts the given MIME message for the given PGP public keys, following the PGP/MIME standard.

equals(Object) - Method in class de.gustavblass.commons.email.EMailSender

Compares this EMailSender with the given Object.

equals(Object) - Method in record class de.gustavblass.commons.email.EMailSender.SentEmail

Indicates whether some other object is "equal to" this one.

F

fallBackToUnencrypted - Variable in class de.gustavblass.commons.email.DraftEmail

If the e-mail could not be encrypted, should it be sent unencrypted?

G

getAttachments() - Method in class de.gustavblass.commons.email.DraftEmail

Returns the attachments of the e-mail.

getBccRecipients() - Method in class de.gustavblass.commons.email.DraftEmail

Returns the bccRecipients of the e-mail.

getCcRecipients() - Method in class de.gustavblass.commons.email.DraftEmail

Returns the ccRecipients of the e-mail.

getPublicKeys() - Method in class de.gustavblass.commons.email.DraftEmail

Returns the publicKeys of the e-mail.

getRecipients() - Method in class de.gustavblass.commons.email.DraftEmail

Returns the recipients of the e-mail.

H

hashCode() - Method in record class de.gustavblass.commons.email.EMailSender.SentEmail

Returns a hash code value for this object.

I

IMAP_PORT - Static variable in class de.gustavblass.commons.email.EMailSender

The default port of the IMAP server that will be used to store the sent e-mails in the sent-folder of the user's inbox.

imapHost - Variable in class de.gustavblass.commons.email.EMailSender

The domain name of the IMAP server that will be used to store the sent e-mails in the sent-folder of the user's inbox.

imapPort - Variable in class de.gustavblass.commons.email.EMailSender

The port of the IMAP server that will be used to store the sent e-mails in the sent-folder of the user's inbox.

initialiseProperties() - Method in class de.gustavblass.commons.email.EMailSender

Initialises the EMailSender.properties with the default settings for sending e-mails via the SMTP server.

K

keyPassword - Variable in class de.gustavblass.commons.email.EMailSender

The passphrase to decrypt the EMailSender.secretKey.

L

LOG - Static variable in class de.gustavblass.commons.email.DraftEmail

LOG - Static variable in class de.gustavblass.commons.email.EMailSender

M

MAXIMUM_PORT_NUMBER - Static variable in class de.gustavblass.commons.email.EMailSender

Port numbers are 16-bit unsigned integers, thus ranging from 0 to 65535.

message - Variable in class de.gustavblass.commons.email.DraftEmail

The actual content of the e-mail.

P

parseBoundary(String) - Static method in class de.gustavblass.commons.email.EMailSender

Parses the boundary from the given Content-Type header of a MIME message.

password - Variable in class de.gustavblass.commons.email.EMailSender

The password for the e-mail server (both EMailSender.smtpHost and EMailSender.imapHost).

PRODUCT_NAME - Static variable in class de.gustavblass.commons.email.EMailSender

The branded name of this library (instead of the generic name “EMailSender”).

properties - Variable in class de.gustavblass.commons.email.EMailSender

The configuration for sending the e-mails.

publicKeys - Variable in class de.gustavblass.commons.email.DraftEmail

Any number of PGP public keys to encrypt the message with.

R

recipients - Variable in class de.gustavblass.commons.email.DraftEmail

Whom the e-mail shall be sent to.

removeAttachments() - Method in class de.gustavblass.commons.email.DraftEmail

Deletes all attachments.

removeBccRecipients() - Method in class de.gustavblass.commons.email.DraftEmail

Deletes all bccRecipients.

removeCcRecipients() - Method in class de.gustavblass.commons.email.DraftEmail

Deletes all ccRecipients.

removePublicKeys() - Method in class de.gustavblass.commons.email.DraftEmail

Deletes all publicKeys.

replaceAttachments(Set<File>) - Method in class de.gustavblass.commons.email.DraftEmail

Deletes all attachments and adds the given ones instead.

replaceBccRecipients(Set<InternetAddress>) - Method in class de.gustavblass.commons.email.DraftEmail

Deletes all bccRecipients and adds the given ones instead.

replaceCcRecipients(Set<InternetAddress>) - Method in class de.gustavblass.commons.email.DraftEmail

Deletes all ccRecipients and adds the given ones instead.

replacePublicKeys(Set<String>) - Method in class de.gustavblass.commons.email.DraftEmail

Deletes all publicKeys and adds the given ones instead.

replaceRecipients(Set<InternetAddress>) - Method in class de.gustavblass.commons.email.DraftEmail

Deletes all recipients and adds the given ones instead.

resetUserAgent() - Method in class de.gustavblass.commons.email.EMailSender

Deletes the EMailSender.userAgent.

S

saveEmailToSentFolder(MimeMessage) - Method in class de.gustavblass.commons.email.EMailSender

Tries to store the given e-mail in the sent-folder of the user's e-mail account, using the IMAP protocol.

saveToSentFolder - Variable in class de.gustavblass.commons.email.DraftEmail

Whether the e-mail should be stored in the “sent” folder of the user's inbox.

secretKey - Variable in class de.gustavblass.commons.email.EMailSender

The secret (a.k.a. private) OpenPGP key to sign the e-mails with (regardless of encryption).

send(DraftEmail) - Method in class de.gustavblass.commons.email.EMailSender

Sends an e-mail from the sender using the EMailSender.password specified in the constructor to log in at the SMTP server.

sendEncryptedEmail(DraftEmail) - Method in class de.gustavblass.commons.email.EMailSender

SENT_FOLDER_NAMES - Static variable in class de.gustavblass.commons.email.EMailSender

Common names for the sent-folder in various IMAP servers.

SentEmail(Optional<ByteArrayOutputStream>, Optional<ByteArrayOutputStream>) - Constructor for record class de.gustavblass.commons.email.EMailSender.SentEmail

Creates an instance of a SentEmail record class.

session - Variable in class de.gustavblass.commons.email.EMailSender

The e-mail session that is used to send the e-mails.

setImapHost(String) - Method in class de.gustavblass.commons.email.EMailSender

Updates the EMailSender.imapHost with the given domain name.

setImapPort(int) - Method in class de.gustavblass.commons.email.EMailSender

Updates the EMailSender.imapPort with the given port number.

setMessage(String) - Method in class de.gustavblass.commons.email.DraftEmail

Updates the actual content of the e-mail.

setSecretKey(byte[]) - Method in class de.gustavblass.commons.email.EMailSender

Updates the EMailSender.secretKey used to sign the message and deletes the EMailSender.keyPassword.

setSecretKey(byte[], byte[]) - Method in class de.gustavblass.commons.email.EMailSender

Updates the EMailSender.secretKey used to sign the message and sets the EMailSender.keyPassword.

setSmtpHost(String) - Method in class de.gustavblass.commons.email.EMailSender

Updates the EMailSender.smtpHost with the given domain name.

setSmtpPort(int) - Method in class de.gustavblass.commons.email.EMailSender

Updates the EMailSender.smtpPort with the given port number.

setSubject(String) - Method in class de.gustavblass.commons.email.DraftEmail

Updates the subject of the e-mail.

setUserAgent(String) - Method in class de.gustavblass.commons.email.EMailSender

Updates the EMailSender.userAgent.

SMTP_PORT - Static variable in class de.gustavblass.commons.email.EMailSender

The default port of the SMTP server that will be used to send the e-mails.

SmtpConnectionSecurity - Enum Class in de.gustavblass.commons.email

Indicates how SMTP connections should be secured from wiretapping and manipulation.

SmtpConnectionSecurity(String) - Constructor for enum class de.gustavblass.commons.email.SmtpConnectionSecurity

smtpHost - Variable in class de.gustavblass.commons.email.EMailSender

The domain name of the SMTP server that will be used to send the e-mails.

smtpPort - Variable in class de.gustavblass.commons.email.EMailSender

The port of the SMTP server that will be used to send the e-mails.

SSL - Enum constant in enum class de.gustavblass.commons.email.SmtpConnectionSecurity

The SMTP connection should be secured using SSL.

STARTTLS - Enum constant in enum class de.gustavblass.commons.email.SmtpConnectionSecurity

The SMTP connection should be secured using STARTTLS.

subject - Variable in class de.gustavblass.commons.email.DraftEmail

What the e-mail is about.

T

toString() - Method in record class de.gustavblass.commons.email.EMailSender.SentEmail

Returns a string representation of this record class.

toString() - Method in class de.gustavblass.commons.email.EMailSender

U

unencryptedEmail - Variable in record class de.gustavblass.commons.email.EMailSender.SentEmail

The field for the unencryptedEmail record component.

unencryptedEmail() - Method in record class de.gustavblass.commons.email.EMailSender.SentEmail

Returns the value of the unencryptedEmail record component.

updateSmtpConnection(SmtpConnectionSecurity) - Method in class de.gustavblass.commons.email.EMailSender

Updates the EMailSender.properties to use the given SmtpConnectionSecurity for sending e-mails.

userAgent - Variable in class de.gustavblass.commons.email.EMailSender

The user-agent string to send with the e-mail.

V

valueOf(String) - Static method in enum class de.gustavblass.commons.email.SmtpConnectionSecurity

Returns the enum constant of this class with the specified name.

values() - Static method in enum class de.gustavblass.commons.email.SmtpConnectionSecurity

Returns an array containing the constants of this enum class, in the order they are declared.

VERSION - Static variable in class de.gustavblass.commons.email.EMailSender

The current version of this library.

W

writeEmail(Message) - Static method in class de.gustavblass.commons.email.EMailSender

Converts the given e-mail to its binary representation (in MIME format).

A B C D E F G H I K L M P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values