allow to activate/desactivate email sending in .ini file (with parameter email.notification.activated = true/false)

README.md

@@ -272,6 +272,7 @@ The reset password related parameters are the follwoing ones :
 
 The main parameters for notifications are the following ones:
 
+    email.notification.activated = true
     email.notification.from = Tracim Notification <tracim@tmycompany.com>
     email.notification.smtp.server = smtp.mycompany.com
     email.notification.smtp.port = 25
@@ -359,4 +360,4 @@ Example of Apache WSGI configuration. This configuration refers to productionapp
 
 Building the community is a work in progress.
 
-Need help ? Do not hesitate to contact me : damien.accorsi@free.fr
+Need help ? Do not hesitate to contact me : damien.accorsi@free.fr

tracim/development.ini.base

@@ -127,6 +127,7 @@ website.home.below_login_form = in case of problem, please contact the administr
 # integrated in the email notifcations
 website.base_url = http://127.0.0.1:8080
     
+email.notification.activated = False
 email.notification.from = Tracim Notification <noreply@trac.im>
 email.notification.content_update.template.html = ./tracim/templates/mail/content_update_body_html.mak
 email.notification.content_update.template.text = ./tracim/templates/mail/content_update_body_text.mak

tracim/tracim/config/app_cfg.py

@@ -14,6 +14,8 @@ convert them into boolean, for example, you should use the
 """
 
 import tg
+from paste.deploy.converters import asbool
+
 from tg.configuration import AppConfig
 from tgext.pluggable import plug
 from tgext.pluggable import replace_template
@@ -211,6 +213,7 @@ class CFG(object):
         self.EMAIL_NOTIFICATION_PROCESSING_MODE = tg.config.get('email.notification.processing_mode')
 
 
+        self.EMAIL_NOTIFICATION_ACTIVATED = asbool(tg.config.get('email.notification.activated'))
         self.EMAIL_NOTIFICATION_SMTP_SERVER = tg.config.get('email.notification.smtp.server')
         self.EMAIL_NOTIFICATION_SMTP_PORT = tg.config.get('email.notification.smtp.port')
         self.EMAIL_NOTIFICATION_SMTP_USER = tg.config.get('email.notification.smtp.user')

tracim/tracim/lib/email.py

@@ -24,9 +24,10 @@ class EmailSender(object):
     this class allow to send emails and has no relations with SQLAlchemy and other tg HTTP request environment
     This means that it can be used in any thread (even through a asyncjob_perform() call
     """
-    def __init__(self, config: SmtpConfiguration):
+    def __init__(self, config: SmtpConfiguration, really_send_messages):
         self._smtp_config = config
         self._smtp_connection = None
+        self._is_active = really_send_messages
 
     def connect(self):
         if not self._smtp_connection:
@@ -52,6 +53,9 @@ class EmailSender(object):
 
 
     def send_mail(self, message: MIMEMultipart):
-        self.connect() # Acutally, this connects to SMTP only if required
-        logger.info(self, 'Sending email to {}'.format(message['To']))
-        self._smtp_connection.send_message(message)
+        if not self._is_active:
+            logger.info(self, 'Not sending email to {} (service desactivated)'.format(message['To']))
+        else:
+            self.connect() # Acutally, this connects to SMTP only if required
+            logger.info(self, 'Sending email to {}'.format(message['To']))
+            self._smtp_connection.send_message(message)

tracim/tracim/lib/helpers.py

@@ -64,6 +64,12 @@ class ICON(object):
   Shared = '<i class="fa fa-group"></i>'
   Private = '<i class="fa fa-key"></i>'
 
+def show_email_stuff():
+    """
+    this function is used in order to show/hide link for sending password reset through email
+    """
+    return CFG.get_instance().EMAIL_NOTIFICATION_ACTIVATED
+
 def tracker_js():
     return CFG.get_instance().TRACKER_JS_CONTENT
 

tracim/tracim/lib/notifications.py

@@ -126,7 +126,7 @@ class EmailNotifier(object):
         # In the other thread.
         #
         # This way, the webserver will return sooner (actually before notification emails are sent
-        async_email_sender = EmailSender(self._smtp_config)
+        async_email_sender = EmailSender(self._smtp_config, self._global_config.EMAIL_NOTIFICATION_ACTIVATED)
 
         for role in notifiable_roles:
             logger.info(self, 'Sending email to {}'.format(role.user.email))

tracim/tracim/templates/index.mak

@@ -49,10 +49,11 @@
                                 <button type="submit" class="btn btn-small btn-success text-right">
                                     <i class="fa fa-check"></i> ${_('Login')}
                                 </button>
-                                <div class="pull-left">
-                                    <a class="btn btn-link" href="${tg.url('/reset_password')}"><i class="fa fa-magic"></i> ${_('Forgot password?')}</a>
-                                </div>
-
+                                % if h.show_email_stuff():
+                                    <div class="pull-left">
+                                        <a class="btn btn-link" href="${tg.url('/reset_password')}"><i class="fa fa-magic"></i> ${_('Forgot password?')}</a>
+                                    </div>
+                                % endif
                             </div>
                         </form>
                     </div>