Mail Configuration


The mail configuration allows you to set up standard mail messages. The following macros can be used

  • _to.firstName_
  • _to.lastName_
  • _me.firstName_
  • _me.lastName_
  • _link_: a hyperlink to the item
  • _linkv_: a hyperlink to a specific version of an item 
  • _title_: the title of an item 
  • _id_: the id of the item

Canned messages

There are several canned messages which can be overwritten

idavailabilitymessage
look_at available for any item through the send to menuto.firstName_<br/><br/>please have a look at <b>_link_ _title_</b>.<br/><br/>_me.firstName_
please_signavailable for SIGNed item through the "Request Signatures" buttonHello,<br/><br/>please review and sign the following document <b>_link_ _title_</b><br/><br/>_me.firstName_
release_noteavailable for SIGNed item after item has been signed completely the "Send Release Mail" buttonHello,<br/><br/>the document <b>_link_ _title_</b> has been released!<br/><br/>_me.firstName
new_user available in the admin client, will be send to matrix in order to create new user accountsPlease create the following user:<br/><br/>_userinfo_<br/>The user should have access to these projects:<br/><br/>_projectlist_<br/>_me.firstName_

Custom messages

Custom messages appear int he "Send To" menu of items. They can be used to quickly send canned messages to user groups. they are configured by providing

Mail Configuration - Typescript
interface IMailConfig { 
    canned?:IMailConfigCanned, // can be used to overwrite standard email messages send / proposed by the system
    custom?:IMailConfigCustom[] // allows to add entries to the send mail tool menu to quickly send pre-configured messages
}

interface IMailConfigCanned { 
    please_sign?:string, // replacement for please sign message (in SIGN page)
    look_at?:string, // replacement for look at item message (in tool menu)
    release_note?:string, // replacement for document released message (in SIGN page)
    new_user?:string  // replacement for mail to new user (admin client)
}

interface IMailConfigCustom { 
    name:string, // name of this mail in send to menu 
    categories:string[], // categories for which message should be available
    to:string[], // a list of users who should get the message
    subject:string, // the subject
    message:string // the message
}


Configuration example

{
  "canned":{
    "please_sign":"Hello _to.firstName_<br/><br/>please have a look at <b>_link_ _title_</b><br/>Please mark it as read afterwards!.<br/><br/>_me.firstName_"
  },
  "custom": [
    {
      "name": "name in send to menu",
      "categories":[
        "REQ",
        "SPEC"],
      "to":[
        "bbbb"],
      "subject": "mail to you",
      "message": "hello, look at _title_"
    }  
  ]
}