[FOLIO-1371] API Design: A Folio module to send and format emails. Created: 23/Jul/18  Updated: 09/Jun/23  Resolved: 17/Aug/18

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Story Priority: P3
Reporter: Khalilah Gambrell Assignee: Khalilah Gambrell
Resolution: Done Votes: 0
Labels: epam-folijet, no-epic-needed
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Attachments: PDF File FOLIO_Notification_subsystem.pdf    
Issue links:
Blocks
blocks MODTEMPENG-1 Generate a Change Password email Closed
Relates
relates to CIRCSTORE-68 endpoint for patron notice templates Closed
relates to UICIRC-70 Settings for patron notice templates Closed
relates to UXPROD-39 Local password management Closed
relates to FOLIO-1442 Create user stories by FOLIO-1371 API... Closed
relates to MODEMAIL-1 Create mod-email for sending email no... Closed
relates to MODEVENTC-1 Create mod-event-config Closed
relates to MODEVENTC-2 Add CRUD REST implementation to mod-e... Closed
relates to MODSENDER-1 Create mod-sender module Closed
relates to MODSENDER-2 Create sender component in mod-sender Closed
relates to UXPROD-596 Emailer and Message Formatter Closed
relates to MODLOGIN-55 Create mod-template-engine module Closed
relates to MODLOGIN-56 Add CRUD REST to mod-template-engine Closed
relates to MODNOTIFY-41 Change "mod-notify" for preparing and... Closed
relates to MODTEMPENG-1 Generate a Change Password email Closed
relates to MODTEMPENG-2 Add template processing component Closed
Sprint: EPAM Sprint 1, EPAM Sprint 2
Story Points: 8
Development Team: Folijet
Tester Assignee: Khalilah Gambrell

 Description   

As a Folio system administrator
I want an email(s) to be sent to a Folio user when his/her password is created/reset/changed.

API Design Requirement (Per Jakub)

  • Create a RESTful JSON API design of a Folio module (maybe called mod-email) to send and format emails.
    • (with FOLIO SMTP configuration stored in mod-config)
    • and formatting e-mails with a selected templating language

Business Requirements

  • Design an api for a module (maybe called mod-email) that supports the following
    • Storing email templates
    • Formatting email templates
    • Sending emails

Template Requirements

  • Templates will be HTML
  • Will support the following templates: Create a password, Reset a password, Change my password, Forgot my username, and Your FOLIO account has been blocked
  • SMTP server and configuration
  • Email Styling
    Email Address should be associated per template
  • Configurable whether user can reply to email
  • Templates should be localized?


 Comments   
Comment by Khalilah Gambrell [ 24/Jul/18 ]

Oleksii Kuzminov - I am still adding details to this story but hopefully it is enough to get started.

Comment by Khalilah Gambrell [ 25/Jul/18 ]

Note from Mike Taylor - "For the benefit of the people who will be implementing this ...

If you're not already familiar with it, can I recommend that you read Jeff Atwood's blog-post So You'd Like to Send Some Email (Through Code)? He talks about a lot of potential pitfalls that are really easy to overlook."

Comment by Mike Taylor [ 25/Jul/18 ]

That post is at https://blog.codinghorror.com/so-youd-like-to-send-some-email-through-code/

Comment by Oleksii Kuzminov [ 02/Aug/18 ]

I added a draft vision of API Design
Can you plz review it Khalilah Gambrell Jakub Skoczen Kurt Nordstrom Mike Taylor
Waiting for comments

https://docs.google.com/document/d/1rSAqPOBqxScnDKYkcGHyPppUXnpooOZ9XWZ8uk1yQSE/edit

Comment by Oleksii Kuzminov [ 09/Aug/18 ]

FOLIO_Notification_subsystem.pdf
Last version of API Design

Comment by Ann-Marie Breaux (Inactive) [ 15/Aug/18 ]

Khalilah Gambrell Oleksii Kuzminov Should this be In Review or In Code Review? If In Review, the manual testers will need some scenarios to test. Thanks

Generated at Thu Feb 08 23:12:51 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.