Package de.xima.fc.mail.utils

Class UserMailUtil

java.lang.Object

de.xima.fc.mail.utils.UserMailUtil

public class UserMailUtil
extends Object

E-Mail zur Benachrichtigung eines Benutzers über die Erstellung/Änderung seines Kontos.

Method Summary

Modifier and Type	Method	Description
static String	readDefaultSystemEmailTemplate()
static boolean	sendEmailVerificationMail(IEntityContext ec, UserEmail email, String baseUrl)
static boolean	sendLDAPLogin(IEntityContext ec, Benutzer user)	Deprecated. Use sendUserCredentialsResetMail(IEntityContext, UserProfile, String) instead.
static boolean	sendLoginData(IEntityContext ec, Benutzer user, String password)	Deprecated. Use sendUserCredentialsResetMail(IEntityContext, UserProfile, String) instead.
static boolean	sendPrimaryEmailChangeMail(IEntityContext ec, UserEmail email, String baseUrl)
static boolean	sendResetPassword(IEntityContext ec, Benutzer user, String resetPasswordUrl)	Deprecated. Use sendUserCredentialsResetMail(IEntityContext, UserProfile, String) instead.
static boolean	sendSystemLogin(IEntityContext ec, Benutzer user, String password)	Deprecated. Use sendUserCredentialsResetMail(IEntityContext, UserProfile, String) instead.
static boolean	sendUserCredentialsResetMail(IEntityContext ec, UserProfile profile, String baseUrl)
static boolean	sendUserCredentialsResetMail(IEntityContext ec, UserProfile profile, String baseUrl, String verifiedTargetEmailAddress)
static boolean	sendUserIdentityConnectedMail(IEntityContext ec, UserIdentity identity, String connectorEmail, Instant isntant, String remoteAddr, String userAgent, String baseUrl)
static boolean	sendUserIdentityRemovalMail(IEntityContext ec, UserIdentity identity, String baseUrl)
static boolean	sendUserInvitationMail(IEntityContext ec, DirectClientAuthorization authorization)	Sends an invitation mail to an DirectClientAuthorization.
static boolean	sendUserInvitationMail(IEntityContext ec, DirectClientAuthorization authorization, String baseUrl)	Deprecated. use sendUserInvitationMail(IEntityContext, DirectClientAuthorization)
static boolean	sendUserMfaEmailCodeMail(IUser user, Locale defaultLocale)
static boolean	sendUserMfaRemovalMail(IEntityContext ec, UserProfileMfa mfaConfig, String baseUrl)
static boolean	sendUserMfaTotpRegistrationMail(IEntityContext ec, UserProfileMfa mfaConfig, String baseUrl)
static boolean	sendUserProfileDeleteRequestMail(IEntityContext ec, UserProfile userProfile, String baseUrl)
static boolean	sendUserProfileMergeRequestMail(IEntityContext ec, UserProfile userProfile, UserProfile toBeMerged, String baseUrl)
static boolean	sendUserProfileWelcomeMail(IEntityContext ec, UserProfile userProfile, String baseUrl)	Sends an email to the primary email address of the user welcoming them and informing them that their profile has been created.
static boolean	sendUserSetPassword(IEntityContext ec, Benutzer user, String setPasswordUrl)	Deprecated. Use sendUserCredentialsResetMail(IEntityContext, UserProfile, String) instead.

Methods inherited from class java.lang.Object

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

Method Details

sendUserCredentialsResetMail

public static boolean sendUserCredentialsResetMail(IEntityContext ec,
 UserProfile profile,
 String baseUrl)

sendUserCredentialsResetMail

public static boolean sendUserCredentialsResetMail(IEntityContext ec,
 UserProfile profile,
 String baseUrl,
 String verifiedTargetEmailAddress)

sendEmailVerificationMail

public static boolean sendEmailVerificationMail(IEntityContext ec,
 UserEmail email,
 String baseUrl)

sendPrimaryEmailChangeMail

public static boolean sendPrimaryEmailChangeMail(IEntityContext ec,
 UserEmail email,
 String baseUrl)

sendUserIdentityConnectedMail

public static boolean sendUserIdentityConnectedMail(IEntityContext ec,
 UserIdentity identity,
 String connectorEmail,
 Instant isntant,
 String remoteAddr,
 String userAgent,
 String baseUrl)

sendUserIdentityRemovalMail

public static boolean sendUserIdentityRemovalMail(IEntityContext ec,
 UserIdentity identity,
 String baseUrl)

sendUserProfileWelcomeMail

public static boolean sendUserProfileWelcomeMail(IEntityContext ec,
 UserProfile userProfile,
 String baseUrl)

Sends an email to the primary email address of the user welcoming them and informing them that their profile has been created.

Parameters:

ec - entity context for database transactions.

userProfile - that has been created with the primary email address of the user.

baseUrl - base URL to use when building URLs.

Returns:

true if the email was sent successfully and false otherwise.

Since:

8.0.4

sendUserProfileMergeRequestMail

public static boolean sendUserProfileMergeRequestMail(IEntityContext ec,
 UserProfile userProfile,
 UserProfile toBeMerged,
 String baseUrl)

sendUserProfileDeleteRequestMail

public static boolean sendUserProfileDeleteRequestMail(IEntityContext ec,
 UserProfile userProfile,
 String baseUrl)

sendUserMfaTotpRegistrationMail

public static boolean sendUserMfaTotpRegistrationMail(IEntityContext ec,
 UserProfileMfa mfaConfig,
 String baseUrl)

sendUserMfaRemovalMail

public static boolean sendUserMfaRemovalMail(IEntityContext ec,
 UserProfileMfa mfaConfig,
 String baseUrl)

sendUserMfaEmailCodeMail

public static boolean sendUserMfaEmailCodeMail(IUser user,
 Locale defaultLocale)

sendUserInvitationMail

public static boolean sendUserInvitationMail(IEntityContext ec,
 DirectClientAuthorization authorization)

Sends an invitation mail to an DirectClientAuthorization.

Parameters:

ec - entity context

authorization - authorization with data for mail

Returns:

if the sending was successful or not.

readDefaultSystemEmailTemplate

public static String readDefaultSystemEmailTemplate()

sendLoginData

@Deprecated
public static boolean sendLoginData(IEntityContext ec,
 Benutzer user,
 String password)

Deprecated.

Use sendUserCredentialsResetMail(IEntityContext, UserProfile, String) instead.

Verschickt die E-Mail.

Parameters:

ec - the entity context to user

user - Der betreffende Benutzer.

sendSystemLogin

@Deprecated
public static boolean sendSystemLogin(IEntityContext ec,
 Benutzer user,
 String password)

Deprecated.

Use sendUserCredentialsResetMail(IEntityContext, UserProfile, String) instead.

sendLDAPLogin

@Deprecated
public static boolean sendLDAPLogin(IEntityContext ec,
 Benutzer user)

Deprecated.

Use sendUserCredentialsResetMail(IEntityContext, UserProfile, String) instead.

sendResetPassword

@Deprecated
public static boolean sendResetPassword(IEntityContext ec,
 Benutzer user,
 String resetPasswordUrl)

Deprecated.

Use sendUserCredentialsResetMail(IEntityContext, UserProfile, String) instead.

Parameters:

user - der Benutzer

resetPasswordUrl - die URL zum Reset des Passwortes

Returns:

Boolean if the mail was send successfully

sendUserSetPassword

@Deprecated
public static boolean sendUserSetPassword(IEntityContext ec,
 Benutzer user,
 String setPasswordUrl)

Deprecated.

Use sendUserCredentialsResetMail(IEntityContext, UserProfile, String) instead.

sendUserInvitationMail

@Deprecated
public static boolean sendUserInvitationMail(IEntityContext ec,
 DirectClientAuthorization authorization,
 String baseUrl)

Deprecated.

use sendUserInvitationMail(IEntityContext, DirectClientAuthorization)

Sends an invitation mail to an DirectClientAuthorization.

Parameters:

ec - entity context

authorization - authorization with data for mail

baseUrl - base url for links in the mail

Returns:

if the sending was successful or not.