Email Templates: Difference between revisions

From MiRTA PBX documentation
Jump to navigation Jump to search
No edit summary
No edit summary
 
(12 intermediate revisions by the same user not shown)
Line 15: Line 15:
* Conference report
* Conference report
* Notify abandoned call in queue
* Notify abandoned call in queue
* Fax relay accepted
* Abuse Detected
* Warning for cost warning exceeded
* Report
* Report
* Low balance
* Low balance
* User details - update
* Extension details - update


Each one of these email template has its own set of variables to be used. They can be seen by hovering the mouse on the "Email Template" label, after having selected the template to edit.
Each one of these email template has its own set of variables to be used. They can be seen by hovering the mouse on the "Email Template" label, after having selected the template to edit.


; Voicemail : ${VM_NAME} ${VM_DUR} ${VM_MSGNUM} ${VM_CONTEXT} ${VM_MAILBOX} ${VM_CALLERID} ${VM_CIDNAME} ${VM_CIDNUM} ${VM_DATE} ${VM_USDATE} ${VM_EUDATE} ${VM_12TIME} ${VM_24TIME} ${VM_CATEGORY} ${VM_FLAG} ${VM_TRANSCRIPT}
; Voicemail : ${VM_NAME} ${VM_DUR} ${VM_MSGNUM} ${VM_CONTEXT} ${VM_MAILBOX} ${VM_CALLERID} ${VM_CIDNAME} ${VM_CIDNUM} ${VM_DATE} ${VM_USDATE} ${VM_EUDATE} ${VM_LOCALDATE} ${VM_12TIME} ${VM_24TIME} ${VM_CATEGORY} ${VM_FLAG} ${VM_TRANSCRIPT} ${VM_TENANTID} ${VM_TENANTCODE} ${VM_TRANSLATEDFLAG} ${VM_MSGID}


; Sending Fax success, Sending Fax Failed : ${FAXSOURCENAME} ${FAXSOURCENUM} ${FAXDESTNUM} ${FAXSTATUS} ${FAXERROR} ${PAGES} plus any other variable defined in asterisk
; Sending Fax success, Sending Fax Failed : ${FAXSOURCENAME} ${FAXSOURCENUM} ${FAXDESTNUM} ${FAXSTATUS} ${FAXERROR} ${PAGES} plus any other variable defined in asterisk
Line 30: Line 35:
; Received a SMS : ${SMSMESSAGEFROM} ${SMSMESSAGETO} ${SMSMESSAGEBODY}
; Received a SMS : ${SMSMESSAGEFROM} ${SMSMESSAGETO} ${SMSMESSAGEBODY}


; Recording : ${START} ${SIZEKB} ${SOURCE} ${REALSRC} ${FIRSTDEST} ${LASTDEST}
; Recording : ${START} ${SIZEKB} ${SOURCE} ${REALSRC} ${FIRSTDEST} ${LASTDEST} ${WHERELANDED}


; Mail2fax scheduled, Mail2fax refused : ${FAXSOURCENUM} ${FAXDESTNUM} ${PAGES} ${DATE} ${LOCALDATE}
; Mail2fax scheduled, Mail2fax refused : ${FAXSOURCENUM} ${FAXDESTNUM} ${PAGES} ${DATE} ${LOCALDATE}
Line 38: Line 43:
; Conference report : ${TENANTNAME} ${START} ${END} ${CONFERENCENAME}
; Conference report : ${TENANTNAME} ${START} ${END} ${CONFERENCENAME}


; Notify abandoned call in queue : ${CALLERNUM} ${QUEUENAME} ${QUEUEWAITING} ${DATE} ${LOCALDATE}
; Notify abandoned call in queue : ${CALLERNUM} ${CALLERNAME} ${QUEUENAME} ${QUEUEWAITING} ${DATE} ${LOCALDATE}


; Report : ${REPORTNAME} ${REPORTSTART} ${REPORTEND}
; Fax relay accepted : ${EXTNAME} ${EXTNUMBER} ${DESTNUMBER} ${PAGES} ${DATE} ${LOCALDATE}
 
; Abuse detected : ${EXTENSION} ${CALLED} ${DATE} ${LOCALDATE}
 
; Warning for cost warning exceeded : ${EXTENSION} ${CALLED} ${DATE} ${LOCALDATE} ${TYPE} ${TENANTNAME} ${TENANTCODE}
 
; Report : ${REPORTNAME} ${REPORTSTART} ${REPORTEND} ${TENANTNAME}


; Low balance : ${TENANTNAME} ${BILLINGCODE} ${CREDITLEFT}
; Low balance : ${TENANTNAME} ${BILLINGCODE} ${CREDITLEFT}
;  User details - update : ${USERNAME} ${PASSWORD} ${DESCRIPTION}
;  Extension details - update : ${EXTENSION} ${USERNAME} ${PASSWORD} ${NAME} ${WEBUSER} ${WEBPASSWORD}


Some templates can use any variable defined in Asterisk. Here the list of useful variables:
Some templates can use any variable defined in Asterisk. Here the list of useful variables:
Line 53: Line 68:
* ${TENANTCODE}
* ${TENANTCODE}
* ${DIALEDNUMBER}
* ${DIALEDNUMBER}
== Default values ==
; Voicemail subject : [PBX]: New message ${VM_MSGNUM} in mailbox ${VM_MAILBOX} // Dear ${VM_NAME}: just wanted to let you know you were just left a ${VM_DUR} long message (number ${VM_MSGNUM}) in mailbox ${VM_MAILBOX} from ${VM_CALLERID}, on ${VM_DATE}), so you might want to check it when you get a chance.  Thanks! --Asterisk
; Sending a fax failed : Max transmission attempts failed for fax to ${FAXDESTNUM} // It was not possible to deliver the fax to ${FAXDESTNUM}. The max number of attempts has been failed
; Received a fax : New FAX from ${REMOTESTATIONID} ${CALLERID} ${CALLERIDNAME} // A new ${PAGES} page(s) FAX was received at ${DATE}
; Fax relay accepted : A FAX has been accepted for delivery to ... // A new FAX has been scheduled for transmission to ...

Latest revision as of 11:34, 9 August 2024

For each type of email sent by the system you can customize the details of the subject, content, sender name and address of the email. There are several type of templates you can create

Emailtemplates.png
  • Voicemail
  • Sending Fax success
  • Sending Fax failed
  • Received a Fax
  • Max transmission attempts failed for a fax
  • Received a SMS
  • Recording
  • Mail2fax scheduled
  • Mail2fax refused
  • Missed call
  • Conference report
  • Notify abandoned call in queue
  • Fax relay accepted
  • Abuse Detected
  • Warning for cost warning exceeded
  • Report
  • Low balance
  • User details - update
  • Extension details - update

Each one of these email template has its own set of variables to be used. They can be seen by hovering the mouse on the "Email Template" label, after having selected the template to edit.

Voicemail
${VM_NAME} ${VM_DUR} ${VM_MSGNUM} ${VM_CONTEXT} ${VM_MAILBOX} ${VM_CALLERID} ${VM_CIDNAME} ${VM_CIDNUM} ${VM_DATE} ${VM_USDATE} ${VM_EUDATE} ${VM_LOCALDATE} ${VM_12TIME} ${VM_24TIME} ${VM_CATEGORY} ${VM_FLAG} ${VM_TRANSCRIPT} ${VM_TENANTID} ${VM_TENANTCODE} ${VM_TRANSLATEDFLAG} ${VM_MSGID}
Sending Fax success, Sending Fax Failed
${FAXSOURCENAME} ${FAXSOURCENUM} ${FAXDESTNUM} ${FAXSTATUS} ${FAXERROR} ${PAGES} plus any other variable defined in asterisk
Received a Fax
${REMOTESTATIONID} ${CALLERID} ${CALLERIDNAME} ${DID} ${PAGES} ${DATE} ${LOCALDATE} plus any other variable defined in asterisk
Max transmission attempts failed for a fax
${FAXDESTNUM}
Received a SMS
${SMSMESSAGEFROM} ${SMSMESSAGETO} ${SMSMESSAGEBODY}
Recording
${START} ${SIZEKB} ${SOURCE} ${REALSRC} ${FIRSTDEST} ${LASTDEST} ${WHERELANDED}
Mail2fax scheduled, Mail2fax refused
${FAXSOURCENUM} ${FAXDESTNUM} ${PAGES} ${DATE} ${LOCALDATE}
Missed call
In this template you can use all the variables defined in Asterisk plus ${DATE} and ${LOCALDATE}
Conference report
${TENANTNAME} ${START} ${END} ${CONFERENCENAME}
Notify abandoned call in queue
${CALLERNUM} ${CALLERNAME} ${QUEUENAME} ${QUEUEWAITING} ${DATE} ${LOCALDATE}
Fax relay accepted
${EXTNAME} ${EXTNUMBER} ${DESTNUMBER} ${PAGES} ${DATE} ${LOCALDATE}
Abuse detected
${EXTENSION} ${CALLED} ${DATE} ${LOCALDATE}
Warning for cost warning exceeded
${EXTENSION} ${CALLED} ${DATE} ${LOCALDATE} ${TYPE} ${TENANTNAME} ${TENANTCODE}
Report
${REPORTNAME} ${REPORTSTART} ${REPORTEND} ${TENANTNAME}
Low balance
${TENANTNAME} ${BILLINGCODE} ${CREDITLEFT}
User details - update
${USERNAME} ${PASSWORD} ${DESCRIPTION}
Extension details - update
${EXTENSION} ${USERNAME} ${PASSWORD} ${NAME} ${WEBUSER} ${WEBPASSWORD}

Some templates can use any variable defined in Asterisk. Here the list of useful variables:

  • ${CALLERID(name)}
  • ${CALLERID(num)}
  • ${INCOMINGDID}
  • ${INCOMINGCALLERIDNUM}
  • ${INCOMINGCALLERIDNAME}
  • ${TENANTCODE}
  • ${DIALEDNUMBER}

Default values

Voicemail subject
[PBX]: New message ${VM_MSGNUM} in mailbox ${VM_MAILBOX} // Dear ${VM_NAME}: just wanted to let you know you were just left a ${VM_DUR} long message (number ${VM_MSGNUM}) in mailbox ${VM_MAILBOX} from ${VM_CALLERID}, on ${VM_DATE}), so you might want to check it when you get a chance. Thanks! --Asterisk
Sending a fax failed
Max transmission attempts failed for fax to ${FAXDESTNUM} // It was not possible to deliver the fax to ${FAXDESTNUM}. The max number of attempts has been failed
Received a fax
New FAX from ${REMOTESTATIONID} ${CALLERID} ${CALLERIDNAME} // A new ${PAGES} page(s) FAX was received at ${DATE}
Fax relay accepted
A FAX has been accepted for delivery to ... // A new FAX has been scheduled for transmission to ...