More standard-conform emails

messages/uniworx/de.msg

@@ -510,6 +510,7 @@ MailLecturerRights n@Int: Als Dozent dürfen Sie Veranstaltungen innerhalb #{plu
 
 MailEditNotifications: Benachrichtigungen ein-/ausschalten
 MailSubjectSupport: Supportanfrage
+MailSubjectSupportCustom customSubject@Text: [Support] #{customSubject}
 
 SheetGrading: Bewertung
 SheetGradingPoints maxPoints@Points: #{tshow maxPoints} Punkte
@@ -584,6 +585,7 @@ HelpAnswer: Antworten an
 HelpUser: Meinen Benutzeraccount
 HelpAnonymous: Keine Antwort (Anonym)
 HelpEmail: E-Mail
+HelpSubject: Betreff
 HelpRequest: Supportanfrage / Verbesserungsvorschlag
 HelpProblemPage: Problematische Seite
 HelpIntroduction: Wenn Ihnen die Benutzung dieser Webseite Schwierigkeiten bereitet oder Sie einen verbesserbaren Umstand entdecken bitten wir Sie uns das zu melden, auch wenn Sie Ihr Problem bereits selbst lösen konnten. Wir passen die Seite ständig an und versuchen sie auch für zukünftige Benutzer so einsichtig wie möglich zu halten.

src/Foundation.hs

@@ -2221,7 +2221,7 @@ instance YesodMail UniWorX where
   mailT ctx mail = defMailT ctx $ do
     void setMailObjectId
     setDateCurrent
-    replaceMailHeader "Auto-Submitted" $ Just "auto-generated"
+    replaceMailHeader "Sender" . Just . addressEmail =<< getsYesod (view _appMailFrom)
 
     ret <- mail
 

src/Handler/Help.hs

@@ -16,16 +16,18 @@ nullaryPathPiece ''HelpIdentOptions (camelToPathPiece' 1)
 embedRenderMessage ''UniWorX ''HelpIdentOptions (("Help" <>) . dropPrefix "HI")
 
 data HelpForm = HelpForm
-  { hfReferer:: Maybe (Route UniWorX)
+  { hfReferer :: Maybe (Route UniWorX)
-  , hfUserId :: Either (Maybe Address) UserId
+  , hfUserId  :: Either (Maybe Address) UserId
-  , hfRequest:: Text
+  , hfSubject :: Maybe Text
+  , hfRequest :: Text
   }
 
-helpForm :: Maybe (Route UniWorX) -> Maybe UserId -> AForm _ HelpForm
+helpForm :: (forall msg. RenderMessage UniWorX msg => msg -> Text) -> Maybe (Route UniWorX) -> Maybe UserId -> AForm _ HelpForm
-helpForm mReferer mUid = HelpForm
+helpForm mr mReferer mUid = HelpForm
     <$> aopt routeField (fslI MsgHelpProblemPage & inputReadonly) (Just <$> mReferer)
     <*> multiActionA (fslI MsgHelpAnswer) identActions (HIUser <$ mUid)
-    <*> (unTextarea <$> areq textareaField (fslI MsgHelpRequest) Nothing)
+    <*> aopt textField (fslpI MsgHelpSubject $ mr MsgHelpSubject) Nothing
+    <*> (unTextarea <$> areq textareaField (fslpI MsgHelpRequest $ mr MsgHelpRequest) Nothing)
   where
     identActions :: Map _ (AForm _ (Either (Maybe Address) UserId))
     identActions = Map.fromList $ case mUid of
@@ -33,7 +35,7 @@ helpForm mReferer mUid = HelpForm
       Nothing    -> defaultActions
 
     defaultActions =
-      [ (HIEmail, Left . Just <$> (Address <$> aopt textField (fslI MsgName) Nothing <*> apreq emailField (fslI MsgEMail) Nothing))
+      [ (HIEmail, Left . Just <$> (Address <$> aopt textField (fslpI MsgName $ mr MsgName) Nothing <*> apreq emailField (fslpI MsgEMail $ mr MsgEMail) Nothing))
       , (HIAnonymous, pure $ Left Nothing)
       ]
 
@@ -43,8 +45,9 @@ postHelpR = do
   mUid <- maybeAuthId
   mReferer <- flip formResultMaybe return <=< runInputGetResult $ iopt routeField (toPathPiece GetReferer)
   isModal <- hasCustomHeader HeaderIsModal
+  MsgRenderer mr <- getMsgRenderer
 
-  ((res,formWidget),formEnctype) <- runFormPost $ renderAForm FormStandard $ helpForm mReferer mUid
+  ((res,formWidget),formEnctype) <- runFormPost $ renderAForm FormStandard $ helpForm mr mReferer mUid
   let form = wrapForm formWidget def
         { formAction = Just $ SomeRoute HelpR
         , formEncoding = formEnctype
@@ -56,6 +59,7 @@ postHelpR = do
     hfReferer' <- traverse toTextUrl hfReferer
     queueJob' JobHelpRequest
       { jSender      = hfUserId
+      , jHelpSubject = hfSubject
       , jHelpRequest = hfRequest
       , jRequestTime = now
       , jReferer     = hfReferer'

src/Jobs/Handler/HelpRequest.hs

@@ -16,10 +16,11 @@ import Data.Bitraversable
 
 dispatchJobHelpRequest :: Either (Maybe Address) UserId
                        -> UTCTime
+                       -> Maybe Text -- ^ Help Subject
                        -> Text -- ^ Help Request
                        -> Maybe Text -- ^ Referer
                        -> Handler ()
-dispatchJobHelpRequest jSender jRequestTime jHelpRequest jReferer = do
+dispatchJobHelpRequest jSender jRequestTime jHelpSubject jHelpRequest jReferer = do
   supportAddress <- getsYesod $ appMailSupport . appSettings
   userInfo <- bitraverse return (runDB . getEntity) jSender
   let userAddress = either
@@ -28,8 +29,9 @@ dispatchJobHelpRequest jSender jRequestTime jHelpRequest jReferer = do
         userInfo
   mailT def $ do
     _mailTo .= [supportAddress]
-    whenIsJust userAddress $ addMailHeader "Reply-To" . renderAddress
+    whenIsJust userAddress (_mailFrom .=)
-    setSubjectI MsgMailSubjectSupport
+    replaceMailHeader "Auto-Submitted" $ Just "no"
+    setSubjectI $ maybe MsgMailSubjectSupport MsgMailSubjectSupportCustom jHelpSubject
     setDate jRequestTime
     rtime <- formatTimeMail SelFormatDateTime jRequestTime
     addPart ($(ihamletFile "templates/mail/support.hamlet") :: HtmlUrlI18n UniWorXMessage (Route UniWorX))

src/Jobs/Handler/SendNotification/CorrectionsAssigned.hs

@@ -22,6 +22,7 @@ dispatchNotificationCorrectionsAssigned  nUser nSheet jRecipient = do
                      ]
     return (course, sheet, nbrSubs)
   when (nbrSubs > 0) . userMailT jRecipient $ do 
+    replaceMailHeader "Auto-Submitted" $ Just "auto-generated"
     setSubjectI $ MsgMailSubjectCorrectionsAssigned courseShorthand sheetName
 
     MsgRenderer mr <- getMailMsgRenderer

src/Jobs/Handler/SendNotification/CorrectionsNotDistributed.hs

@@ -19,6 +19,7 @@ dispatchNotificationCorrectionsNotDistributed nSheet jRecipient = do
                      ]
     return (course, sheet, nbrSubs)
   when (nbrSubs > 0) . userMailT jRecipient $ do 
+    replaceMailHeader "Auto-Submitted" $ Just "auto-generated"
     setSubjectI $ MsgMailSubjectSubmissionsUnassigned courseShorthand sheetName
     MsgRenderer mr <- getMailMsgRenderer
     let termDesc = mr . ShortTermIdentifier $ unTermKey courseTerm

src/Jobs/Handler/SendNotification/SheetActive.hs

@@ -17,6 +17,7 @@ dispatchNotificationSheetActive nSheet jRecipient = userMailT jRecipient $ do
     sheet <- getJust nSheet
     course <- belongsToJust sheetCourse sheet
     return (course, sheet)
+  replaceMailHeader "Auto-Submitted" $ Just "auto-generated"
   setSubjectI $ MsgMailSubjectSheetActive courseShorthand sheetName
 
   MsgRenderer mr <- getMailMsgRenderer

src/Jobs/Handler/SendNotification/SheetInactive.hs

@@ -20,6 +20,7 @@ dispatchNotificationSheetSoonInactive nSheet jRecipient = userMailT jRecipient $
     sheet <- getJust nSheet
     course <- belongsToJust sheetCourse sheet
     return (course, sheet)
+  replaceMailHeader "Auto-Submitted" $ Just "auto-generated"
   setSubjectI $ MsgMailSubjectSheetSoonInactive courseShorthand sheetName
 
   MsgRenderer mr <- getMailMsgRenderer
@@ -45,6 +46,7 @@ dispatchNotificationSheetInactive nSheet jRecipient = userMailT jRecipient $ do
         -- E.distinctOn [E.don (subUser E.^. SubmissionUserUser)] -- Not necessary due to UniqueSubmisionUser
         return (E.countRows :: E.SqlExpr (E.Value Int64))
     return (course, sheet, nrSubs, nrSubmitters)
+  replaceMailHeader "Auto-Submitted" $ Just "auto-generated"
   setSubjectI $ MsgMailSubjectSheetInactive courseShorthand sheetName
 
   MsgRenderer mr <- getMailMsgRenderer

src/Jobs/Handler/SendNotification/SubmissionRated.hs

@@ -22,6 +22,7 @@ dispatchNotificationSubmissionRated nSubmission jRecipient = userMailT jRecipien
     course <- belongsToJust sheetCourse sheet
     corrector <- traverse getJust submissionRatingBy
     return (course, sheet, submission, corrector)
+  replaceMailHeader "Auto-Submitted" $ Just "auto-generated"
   setSubjectI $ MsgMailSubjectSubmissionRated courseShorthand
 
   csid <- encrypt nSubmission

src/Jobs/Handler/SendNotification/UserRightsUpdate.hs

@@ -19,6 +19,7 @@ dispatchNotificationUserRightsUpdate  nUser _originalRights jRecipient = userMai
       adminSchools    <- getSchoolsOf nUser UserAdminSchool    UserAdminUser
       lecturerSchools <- getSchoolsOf nUser UserLecturerSchool UserLecturerUser
       return (user,adminSchools,lecturerSchools)
+    replaceMailHeader "Auto-Submitted" $ Just "auto-generated"
     setSubjectI $ MsgMailSubjectUserRightsUpdate userDisplayName
     -- MsgRenderer mr <- getMailMsgRenderer
     addAlternatives $ do

src/Jobs/Handler/SendTestEmail.hs

@@ -13,6 +13,7 @@ import Utils.Lens
 dispatchJobSendTestEmail :: Email -> MailContext -> Handler ()
 dispatchJobSendTestEmail jEmail jMailContext = mailT jMailContext $ do
   _mailTo .= [Address Nothing jEmail]
+  replaceMailHeader "Auto-Submitted" $ Just "auto-generated"
   setSubjectI MsgMailTestSubject
   now <- liftIO getCurrentTime
   nDT <- formatTimeMail SelFormatDateTime now

src/Jobs/Types.hs

@@ -17,7 +17,10 @@ data Job = JobSendNotification { jRecipient :: UserId, jNotification :: Notifica
          | JobQueueNotification { jNotification :: Notification }
          | JobHelpRequest { jSender :: Either (Maybe Address) UserId
                           , jRequestTime :: UTCTime
-                          , jHelpRequest :: Text, jReferer :: Maybe Text }
+                          , jHelpSubject :: Maybe Text
+                          , jHelpRequest :: Text
+                          , jReferer :: Maybe Text
+                          }
          | JobSetLogSettings { jInstance :: InstanceId, jLogSettings :: LogSettings }
          | JobDistributeCorrections { jSheet :: SheetId }
   deriving (Eq, Ord, Show, Read, Generic, Typeable)

src/Mail.hs

@@ -27,7 +27,7 @@ module Mail
   , setSubjectI, setMailObjectId, setMailObjectId'
   , setDate, setDateCurrent
   , setMailSmtpData
-  , _mailFrom, _mailTo, _mailCc, _mailBcc, _mailHeaders, _mailParts
+  , _mailFrom, _mailTo, _mailCc, _mailBcc, _mailHeaders, _mailHeader, _mailParts
   , _partType, _partEncoding, _partFilename, _partHeaders, _partContent
   ) where
 
@@ -99,9 +99,18 @@ import Data.Universe.Instances.Reverse.Hashable ()
 
 import GHC.Exts (IsList)
 
+import Control.Monad.Trans.Maybe (MaybeT(..))
+
+import Data.CaseInsensitive (CI)
+import qualified Data.CaseInsensitive as CI
+  
+
 makeLenses_ ''Mail
 makeLenses_ ''Part
 
+_mailHeader :: CI ByteString -> Traversal' Mail Text
+_mailHeader hdrName = _mailHeaders . traverse . filtered (views _1 $ (== hdrName) . CI.mk) . _2
+
 
 newtype MailT m a = MailT { _unMailT :: RWST MailContext MailSmtpData Mail m a }
   deriving newtype ( MonadTrans, Monad, Functor, MonadFail, Applicative, Alternative, MonadPlus
@@ -443,7 +452,10 @@ setDate time = do
 
 setMailSmtpData :: (MonadHandler m, YesodMail (HandlerSite m)) => MailT m ()
 setMailSmtpData = do
-  Address _ from <- use _mailFrom
+  Just (Address _ from) <- runMaybeT $ asum
+    [ MaybeT . preuses (_mailHeader "Sender") $ fromString . unpack
+    , use _mailFrom
+    ]
   recps <- Set.fromList . map addressEmail . concat <$> forM [_mailTo, _mailCc, _mailBcc] use
 
   tell $ mempty { smtpRecipients = recps }