Package ca.corefacility.bioinformatics.irida.service

Interface EmailController

    • Method Detail

      • sendWelcomeEmail

        void sendWelcomeEmail​(User user,
                      User sender,
                      PasswordReset passwordReset)
               throws org.springframework.mail.MailSendException
        Send welcome email to a user who joined the platform
        Parameters:
        user - The User that was just created
        sender - The User that created the new user
        passwordReset - A PasswordReset object to send an activation link
        Throws:
        org.springframework.mail.MailSendException - if the email failed to send

      • sendPasswordResetLinkEmail

        void sendPasswordResetLinkEmail​(User user,
                                PasswordReset passwordReset)
                         throws org.springframework.mail.MailSendException
        Send a PasswordReset link to a User
        Parameters:
        user - The user for the reset
        passwordReset - the reset object
        Throws:
        org.springframework.mail.MailSendException - if the email failed to send

      • sendSubscriptionUpdateEmail

        void sendSubscriptionUpdateEmail​(User user,
                                 java.util.List<ProjectEvent> events)
                          throws org.springframework.mail.MailSendException
        Send a subscription email to the given User containing the given ProjectEvents
        Parameters:
        user - The user to email
        events - the events to send to the user
        Throws:
        org.springframework.mail.MailSendException - if the email failed to send

      • sendFilesystemExceptionEmail

        void sendFilesystemExceptionEmail​(java.lang.String adminEmailAddress,
                                  java.lang.Exception rootCause)
                           throws org.springframework.mail.MailSendException
        Send an e-mail to the administrative user with an exception when there's a serious storage related exception.
        Parameters:
        adminEmailAddress - the address to which notifications should be sent.
        rootCause - the exception to send to the user.
        Throws:
        org.springframework.mail.MailSendException - if the email failed to send

      • sendNCBIUploadExceptionEmail

        void sendNCBIUploadExceptionEmail​(java.lang.String adminEmailAddress,
                                  java.lang.Exception rootCause,
                                  java.lang.Long submissionId)
                           throws org.springframework.mail.MailSendException
        Send an email to the administrators with an exception when there's an error uploading data or getting upload status from NCBI's SRA.
        Parameters:
        adminEmailAddress - Address of the admin to email to
        rootCause - exception to display in the email
        submissionId - the ID of the NCBI export submission that failed
        Throws:
        org.springframework.mail.MailSendException - If there's an error sending the message

      • isMailConfigured

        java.lang.Boolean isMailConfigured()
        Is the mail server configured?
        Returns:
        Boolean.TRUE if configured, Boolean.FALSE if not.

      • sendPipelineStatusEmail

        void sendPipelineStatusEmail​(AnalysisSubmission submission)
                      throws org.springframework.mail.MailSendException
        Send pipeline status email to a user when a pipeline that they have launched is completed or has an error
        Parameters:
        submission - The AnalysisSubmission that the pipeline status email will be sent for
        Throws:
        org.springframework.mail.MailSendException - if the email failed to send

      • sendProjectSyncUnauthorizedEmail

        void sendProjectSyncUnauthorizedEmail​(Project project)
        Email user responsible for a synchronized project when the sync job's credentials expire
        Parameters:
        project - The project that sync failed for