From 3fcc0cda22b6cc60cee4a1818944a1891b067c9c Mon Sep 17 00:00:00 2001 From: rt00492 <rt00492@surrey.ac.uk> Date: Tue, 26 Apr 2022 23:20:38 +0100 Subject: [PATCH] Adding explaination of get_emails to readme --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 33090e9..3a7e8b3 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,12 @@ log_out is a method that sends a delete http request containing the JWT token of session[:logged_in] is set to false by this method +#### get_emails + +get_emails is a method that takes as inputs an array of user_ids and retrives the email addresses of the corresponding users if the current user is authenticated + +session[:logged_in] is set to false if the user is not autheticated by the auth microservice + ## Mailer Microservice The Mailer Microservice is run inside a docker container that is booted up by using [this](#creating-the-image) command. -- GitLab