Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.notifications

Class EMailNotifier

java.lang.Object

page.codeberg.friedolyn.notifications.Notifier

page.codeberg.friedolyn.notifications.EMailNotifier

All Implemented Interfaces:

Copyable<EMailNotifier>, Redactable

public class EMailNotifier
extends Notifier
implements Redactable, Copyable<EMailNotifier>

A Notifier that sends e-mail notifications via the university's SMTP server. In order to send e-mails, the user's university e-mail address is needed. In order to be notified of incoming e-mails, the user must have set up an e-mail client that regularly checks the inbox. The following e-mail clients are particularly recommended:

• Mozilla Thunderbird (all desktop platforms)
• GNOME Evolution (Linux)
• K-9 Mail (Android)

Nested Class Summary

Nested classes/interfaces inherited from class page.codeberg.friedolyn.notifications.Notifier

Notifier.Mood

Field Summary

Fields

Modifier and Type	Field	Description
private @NonNull Configuration	configuration	The student's settings, including the e-mail address and password (both must be set) that will be used to authenticate with the university's SMTP server.
private @NonNull EMailSender	eMailSender	Used to actually submit notifications via SMTP.
private boolean	encryptMailWithPGP	Whether e-mail notifications should be encrypted with PGP, using the student's public key as specified in configuration.getContactMethods().getPgpPublicKey().

Constructor Summary

Constructors

Modifier	Constructor	Description
private	EMailNotifier(boolean enablePgpEncryption)	Deprecated. This constructor is only for Jackson to (de-)serialize this class.
	EMailNotifier(@NonNull Configuration configuration)	Creates a new EMailNotifier with the given Configuration providing the student's SMTP credentials.
	EMailNotifier(@NonNull Configuration configuration, boolean enablePgpEncryption)	Creates a new EMailNotifier with the given Configuration providing the student's SMTP credentials.

Method Summary

Modifier and Type	Method	Description
@NonNull EMailNotifier	copy()
boolean	equals(Object object)	Compares this EMailNotifier with the given Object.
@NonNull Configuration	getConfiguration()
boolean	getEncryptMailWithPGP()
@NonNull Configuration	getReferenceToConfiguration()
void	sendNotification(@NonNull String subject, @NonNull String summary, @NonNull String message, File attachment, @NonNull Notifier.Mood mood)	Sends an e-mail to the user, notifying them about the given subject, summary and message, with the given file attached.
void	sendNotification(@NonNull String subject, @NonNull String summary, @NonNull String message, @NonNull Notifier.Mood mood)	Sends an e-mail to the user, notifying them about the given subject, summary and message, but without any attachment.
@NonNull String	toString()
@NonNull String	toStringRedacted()

Methods inherited from class page.codeberg.friedolyn.notifications.Notifier

sendNotification

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

configuration

@NonNull
private @NonNull Configuration configuration

The student's settings, including the e-mail address and password (both must be set) that will be used to authenticate with the university's SMTP server.

encryptMailWithPGP

private boolean encryptMailWithPGP

Whether e-mail notifications should be encrypted with PGP, using the student's public key as specified in configuration.getContactMethods().getPgpPublicKey().

eMailSender

@NonNull
private @NonNull EMailSender eMailSender

Used to actually submit notifications via SMTP.

Constructor Details

EMailNotifier

@Deprecated
private EMailNotifier(boolean enablePgpEncryption)
               throws jakarta.mail.internet.AddressException

Deprecated.

This constructor is only for Jackson to (de-)serialize this class.

Parameters:

enablePgpEncryption - See encryptMailWithPGP.

Throws:

jakarta.mail.internet.AddressException - Never thrown in practice.

EMailNotifier

public EMailNotifier(@NonNull
 @NonNull Configuration configuration)
              throws IllegalArgumentException

Creates a new EMailNotifier with the given Configuration providing the student's SMTP credentials.

Parameters:

configuration - The student's settings, including the e-mail address and password (both must be set) that will be used to authenticate with the university's SMTP server. The exact reference to the object will be used instead of a deep copy.

Throws:

IllegalArgumentException - If the password is null or empty.

EMailNotifier

public EMailNotifier(@NonNull
 @NonNull Configuration configuration,
 boolean enablePgpEncryption)
              throws IllegalArgumentException

Creates a new EMailNotifier with the given Configuration providing the student's SMTP credentials.

Parameters:

configuration - The student's settings, including the e-mail address and password (both must be set) that will be used to authenticate with the university's SMTP server. The exact reference to the object will be used instead of a deep copy.

enablePgpEncryption - Whether e-mail notifications should be encrypted with PGP, using the student's public key as specified in configuration.getContactMethods().getPgpPublicKey(). If no public key is set, e-mail notifications will not be encrypted.

Throws:

IllegalArgumentException - If the password is null or empty.

Method Details

sendNotification

public void sendNotification(@NonNull
 @NonNull String subject,
 @NonNull
 @NonNull String summary,
 @NonNull
 @NonNull String message,
 @NonNull
 @NonNull Notifier.Mood mood)
                      throws RuntimeException

Sends an e-mail to the user, notifying them about the given subject, summary and message, but without any attachment.

Specified by:

sendNotification in class Notifier

Parameters:

subject - What the notification is about.

summary - Will be ignored.

message - The full text of the e-mail that should be sent to the user.

mood - Whether the content of the message contains news that the user will likely perceive as positive, or negative (or neither – in which case the mood is neutral).

Throws:

RuntimeException - If the notification could not be sent or if the subject or message is blank.

See Also:

• Notifier.sendNotification(String, String, String)

sendNotification

public void sendNotification(@NonNull
 @NonNull String subject,
 @NonNull
 @NonNull String summary,
 @NonNull
 @NonNull String message,
 File attachment,
 @NonNull
 @NonNull Notifier.Mood mood)
                      throws RuntimeException

Sends an e-mail to the user, notifying them about the given subject, summary and message, with the given file attached.

Parameters:

subject - What the notification is about.

summary - Will be ignored.

message - The full text of the e-mail that should be sent to the user.

attachment - The file that should be attached to the e-mail. Will be ignored if null.

mood - Whether the content of the message contains news that the user will likely perceive as positive, or negative (or neither – in which case the mood is neutral).

Throws:

RuntimeException - If the notification could not be sent or if the subject or message is blank.

getEncryptMailWithPGP

public boolean getEncryptMailWithPGP()

Returns:

Whether e-mail notifications should be encrypted with PGP, using the student's public key as specified in configuration.getContactMethods().getPgpPublicKey().

getConfiguration

@NonNull
public @NonNull Configuration getConfiguration()

Returns:

A deep copy of the configuration that provides the student's SMTP credentials in configuration.getEmail() and configuration.getPassword().

getReferenceToConfiguration

@NonNull
public @NonNull Configuration getReferenceToConfiguration()

Returns:

The exact reference to the configuration that provides the student's SMTP credentials in configuration.getEmail() and configuration.getPassword().

toString

@NonNull
public @NonNull String toString()

Specified by:

toString in interface Redactable

Specified by:

toString in class Notifier

Returns:

A string representation of this object including all fields, even sensitive ones.

toStringRedacted

@NonNull
public @NonNull String toStringRedacted()

Specified by:

toStringRedacted in interface Redactable

Specified by:

toStringRedacted in class Notifier

Returns:

A string representation of this object including all fields. However, sensitive fields will be removed or replaced with a placeholder. The exact behaviour is implementation-specific and may depend on the debug level currently in effect.

copy

@NonNull
public @NonNull EMailNotifier copy()

Specified by:

copy in interface Copyable<EMailNotifier>

Returns:

A deep copy of the object, i.e. a clone that has the exact same values as the original object, but is a different instance (new reference).

equals

public boolean equals(Object object)

Compares this EMailNotifier with the given Object.

Overrides:

equals in class Object

Parameters:

object - The Object to compare this EMailNotifier with.

Returns:

• true if the given object is an EMailNotifier whose fields' values match their equivalents in this EMailNotifier, especially (but not exclusively) if the given EMailNotifier is the exact same reference as this EMailNotifier.
• false if the given object is not a EMailNotifier or if any of the fields' values differ from their equivalents in this EMailNotifier.