Package de.xima.fc.api.system

Class MailAPI

  • public class MailAPI
extends ASubAPI
    API class for sending of system mails.
    Author:
    XIMA MEDIA GmbH

    • Constructor Detail

      • MailAPI

        public MailAPI()

    • Method Detail

      • sendClientMail

        public boolean sendClientMail​(Mandant client,
                              IBaseMailData mailData)
        Sends an email as the given client
        Parameters:
        client - Mandant sending the email
        mailData - IBaseMailData content of the mail
        Returns:
        Boolean whether or not the email could be sent successfully
        Since:
        6.0.0

      • sendOptInMail

        public boolean sendOptInMail​(UserContext uc,
                             Vorgang vorgang)
        Sends an email as the given client
        Parameters:
        uc - UserContext the user context in which the action is to be performed.
        vorgang - Vorgang sending the email
        Returns:
        Boolean whether or not the email could be sent successfully
        Since:
        6.0.0

      • sendSupportMail

        public boolean sendSupportMail​(UserContext uc,
                               Mandant client,
                               ISupportInquiryData supportInquiryData)
        Send a support mail from the given client. If no client is given tries using the system mail settings
        Parameters:
        uc - UserContext the user context in which the action is to be performed.
        client - Mandant for which to send the mail
        supportInquiryData - SupportInquiryData containing support inquiry information
        Returns:
        Whether the email was sent successfully
        Since:
        6.0.0

      • sendFeedbackMail

        public boolean sendFeedbackMail​(UserContext uc,
                                Mandant client,
                                IFeedbackMailData feedbackMailData)
        Send a feedback mail from the given client. If no client is attempt to use the system mail settings
        Parameters:
        uc - UserContext the user context in which the action is to be performed.
        client - Mandant for which to send the mail
        feedbackMailData - SupportInquiryData containing feedback information
        Returns:
        Whether the email was sent successfully
        Since:
        6.0.0

      • sendUserCredentialsResetMail

        public boolean sendUserCredentialsResetMail​(UserContext uc,
                                            UserProfile profile,
                                            String baseUrl)
        Sends a mail with a user credentials set/reset link. The mail will be send to the users primary email address.
        Parameters:
        uc - UserContext to use.
        profile - for which to send the credentials mail.
        baseUrl - base URL to use when building the credentials mail.
        Returns:
        Whether an email was sent successfully.
        Since:
        8.0.0

      • sendUserCredentialsResetMail

        public boolean sendUserCredentialsResetMail​(UserContext uc,
                                            UserProfile profile,
                                            String baseUrl,
                                            String verifiedTargetEmailAddress)
        Sends a mail with a user credentials set/reset link. The mail will be send to the users primary email address.
        Parameters:
        uc - UserContext to use.
        profile - for which to send the credentials mail.
        baseUrl - base URL to use when building the credentials mail.
        verifiedTargetEmailAddress - email address that should receive the user credentials reset request. This email needs to exists in the given user profile and it needs to be verified. A user credentials reset mail cannot be send otherwise!
        Returns:
        Whether an email was sent successfully.
        Since:
        8.0.0

      • sendEmailVerificationMail

        public boolean sendEmailVerificationMail​(UserContext uc,
                                         UserEmail email,
                                         String baseUrl)
        Sends a mail with a user email verification link
        Parameters:
        uc - UserContext to use.
        email - Email to send the verification request to.
        baseUrl - base URL to use when building the verification URL
        Returns:
        Whether or no an email was sent successfully.
        Since:
        8.0.0

      • sendPrimaryEmailChangeMail

        public boolean sendPrimaryEmailChangeMail​(UserContext uc,
                                          UserEmail email,
                                          String baseUrl)
        Sends a mail with a link to change the primary email of the user profile to the UserEmail given.
        Parameters:
        uc - UserContext to use.
        email - Email to send the verification request to and change to primary mail.
        baseUrl - base URL to use when building the verification URL
        Returns:
        Whether or no an email was sent successfully.
        Since:
        8.0.0

      • sendUserIdentityConnectedMail

        public boolean sendUserIdentityConnectedMail​(UserContext uc,
                                             UserIdentity identity,
                                             String connectorEmail,
                                             Instant isntant,
                                             String remoteAddr,
                                             String userAgent,
                                             String baseUrl)
        Sends a mail informing the user profile owner about the connection of a new account with the option to remove the account.
        Parameters:
        uc - UserContext to use.
        identity - that has been connected to the user profile
        connectorEmail - that was used to connect the identity with the user profile
        isntant - when the connection was made
        remoteAddr - of the client that triggered the connection
        userAgent - of the client that triggered the connection
        baseUrl - base URL to use when building URLs
        Returns:
        Whether an email was sent successfully.
        Since:
        8.0.0

      • sendUserIdentityRemovalMail

        public boolean sendUserIdentityRemovalMail​(UserContext uc,
                                           UserIdentity identity,
                                           String baseUrl)
        Sends a mail with a link to remove the given user identity to the primary UserEmail of the identity's profile.
        Parameters:
        uc - UserContext to use.
        identity - Identity to send the removal request for.
        baseUrl - base URL to use when building the verification URL
        Returns:
        Whether an email was sent successfully.
        Since:
        8.0.0

      • sendUserProfileWelcomeMail

        public boolean sendUserProfileWelcomeMail​(UserContext uc,
                                          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:
        uc - UserContext to use.
        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 boolean sendUserProfileMergeRequestMail​(UserContext uc,
                                               UserProfile userProfile,
                                               UserProfile toBeMerged,
                                               String baseUrl)
        Sends a mail with a user profile merge link.
        Parameters:
        uc - UserContext to use.
        userProfile - user profile that will receive the merge request via email.
        toBeMerged - user profile that should be merged into the profile that will receive the merge request.
        Returns:
        Whether or no an email was sent successfully.
        Since:
        8.0.0

      • sendUserProfileDeleteRequestMail

        public boolean sendUserProfileDeleteRequestMail​(UserContext uc,
                                                UserProfile userProfile,
                                                String baseUrl)
        Sends a mail with a user profile delete request containing a link to delete the user profile.
        Parameters:
        uc - UserContext to use.
        userProfile - to be deleted.
        baseUrl - base URL to use when building the delete URL.
        Returns:
        true if the mail has been send successfully and false otherwise.
        Since:
        8.0.0

      • sendUserMfaTotpRegistrationMail

        public boolean sendUserMfaTotpRegistrationMail​(UserContext uc,
                                               UserProfileMfa mfaConfig,
                                               String baseUrl)
        Sends a mail with an MFA TOTP registration link to the users primary email address.
        Parameters:
        uc - UserContext to use.
        mfaConfig - to send MFA registration mail for.
        baseUrl - base URL to use when building the registration URL
        Returns:
        Whether an email was sent successfully.
        Since:
        8.0.0

      • sendUserMfaRemovalMail

        public boolean sendUserMfaRemovalMail​(UserContext uc,
                                      UserProfileMfa mfaConfig,
                                      String baseUrl)
        Sends a mail with an MFA removal link to the users primary email address. Is intended for users to confirm the removal of the MFA from their account.
        Parameters:
        uc - UserContext to use.
        mfaConfig - to send MFA removal mail for.
        baseUrl - base URL to use when building the removal URL
        Returns:
        Whether an email was sent successfully.
        Since:
        8.0.0

      • sendUserMfaEmailCodeMail

        public boolean sendUserMfaEmailCodeMail​(IUser user,
                                        Locale defaultLocale)
        Sends a mail with an MFA code. This is for MFAs of type EMultiFactorAuthenticationType.EMAIL.
        Parameters:
        user - to send email with authentication code to.
        defaultLocale - locale to use for localization of the email message if the user does not have a default locale.
        Returns:
        Whether an email was sent successfully.
        Since:
        8.0.0