Merge pull request #7033 from WZBSocialScienceCenter/6915-feature-bui…

…ltin-users-sendEmailNotification-new-optionalParameter

6915-feature-builtin-users-sendEmailNotification-new-optionalParameter

doc/sphinx-guides/source/api/native-api.rst

@@ -2311,6 +2311,8 @@ Place this ``user-add.json`` file in your current directory and run the followin
 
   curl -d @user-add.json -H "Content-type:application/json" "$SERVER_URL/api/builtin-users?password=$NEWUSER_PASSWORD&key=$BUILTIN_USERS_KEY"
 
+Optionally, you may use a third query parameter "sendEmailNotification=false" to explicitly disable sending an email notification to the new user.
+
 Roles
 -----
 

src/main/java/edu/harvard/iq/dataverse/api/BuiltinUsers.java

@@ -84,8 +84,11 @@ public Response getApiToken( @PathParam("username") String username, @QueryParam
     //and use the values to create BuiltinUser/AuthenticatedUser.
     //--MAD 4.9.3
     @POST
-    public Response save(BuiltinUser user, @QueryParam("password") String password, @QueryParam("key") String key) {
-        return internalSave(user, password, key);
+    public Response save(BuiltinUser user, @QueryParam("password") String password, @QueryParam("key") String key, @QueryParam("sendEmailNotification") Boolean sendEmailNotification) {   
+        if( sendEmailNotification == null )
+            sendEmailNotification = true;
+
+        return internalSave(user, password, key, sendEmailNotification);
     }
 
     /**
@@ -105,7 +108,29 @@ public Response create(BuiltinUser user, @PathParam("password") String password,
         return internalSave(user, password, key);
     }
 
+    /**
+     * Created this new endpoint to resolve issue #6915, optionally preventing 
+     * the email notification to the new user on account creation by adding 
+     * "false" as the third path parameter.
+     *
+     * @param user
+     * @param password
+     * @param key
+     * @param sendEmailNotification
+     * @return
+     */
+    @POST
+    @Path("{password}/{key}/{sendEmailNotification}")
+    public Response create(BuiltinUser user, @PathParam("password") String password, @PathParam("key") String key, @PathParam("sendEmailNotification") Boolean sendEmailNotification) {
+        return internalSave(user, password, key, sendEmailNotification);
+    }
+
+    // internalSave without providing an explicit "sendEmailNotification"
     private Response internalSave(BuiltinUser user, String password, String key) {
+        return internalSave(user, password, key, true);
+    }
+
+    private Response internalSave(BuiltinUser user, String password, String key, Boolean sendEmailNotification) {
         String expectedKey = settingsSvc.get(API_KEY_IN_SETTINGS);
 
         if (expectedKey == null) {
@@ -149,7 +174,7 @@ private Response internalSave(BuiltinUser user, String password, String key) {
             } catch (Exception e) {
                 logger.info("The root dataverse is not present. Don't send a notification to dataverseAdmin.");
             }
-            if (rootDataversePresent) {
+            if (rootDataversePresent && sendEmailNotification) {
                 userNotificationSvc.sendNotification(au,
                         new Timestamp(new Date().getTime()),
                         UserNotification.Type.CREATEACC, null);
@@ -188,3 +213,16 @@ private Response internalSave(BuiltinUser user, String password, String key) {
     }
 
 }
+
+
+
+
+
+
+
+
+
+
+
+
+