User Tools


Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
en:devel:helperscripts [2019/07/05 16:36]
joebordes [addActionLink.php]
en:devel:helperscripts [2019/07/05 16:43] (current)
joebordes [composer2readme and module2wiki]
Line 73: Line 73:
 ===== composer2readme and module2wiki ===== ===== composer2readme and module2wiki =====
  
-These php scripts will connect to a standard coreBOS module or extension directory structure and output a dokuwiki ​syntax page with a summary of the module or extension which you can use as a starting point to document it in [[en:​extensions:​extensions|our extensions section]].+These PHP scripts will connect to a standard coreBOS module or extension directory structure and output a DokuWiki ​syntax page with a summary of the module or extension which you can use as a starting point to document it in [[en:​extensions:​extensions|our extensions section]].
  
 <​code>​ <​code>​
Line 80: Line 80:
 </​code>​ </​code>​
  
 +===== setEmailOptOut =====
 +
 +This script permits you to easily set the emailoptout field on or off by calling a simple link. This is an easy, yet insecure way of being able to add an "​unsubscribe"​ link to the body of your emails.
 +
 +As with most of the HelperScripts,​ copy the script to the root of your install and set the URL to
 +
 +<​code>​
 +https://​your_server/​your_corebos/​setEmailOptOut.php?​email={email}&​optout={0|1}&​appkey={appkey}
 +</​code>​
 +
 +this script triggers workflows accordingly.
 +
 +**The correct and secure way to do this is using Web Services**