| [ Index ] |
|
Code source de eGroupWare 1.2.106-2 |
[Code source] [Imprimer] [Statistiques]
* Mail-SMTP Agent : business layer * * This class connects the workflow agent to the egroupware phpmailer and emailadmin * This let the workflow activities send emails. It contains some logic to replace * known tokens by workflow information (user, owner, activity name, etc...) * * @package workflow * @author regis.leroy@glconseil.com * GPL
| Poids: | 825 lignes (30 kb) |
| Inclus ou requis: | 0 fois |
| Référencé: | 0 fois |
| Nécessite: | 0 fichiers |
bo_agent_mail_smtp:: (17 méthodes):
bo_agent_mail_smtp()
load()
save()
getAdminActivityOptions()
listProcessConfigurationFields()
getSMTPConfiguration()
init()
sendOnPosted()
send_start()
send_end()
send_post()
send_completed()
prepare_mail()
decode_fields_in_final_fields()
cleanup_adress_string()
replace_tokens()
Send()
Classe: bo_agent_mail_smtp - X-Ref
| bo_agent_mail_smtp() X-Ref |
| Pas de description |
| load($agent_id, $really_load=true) X-Ref |
| * Factory: Load the agent values stored somewhere in the agent object and retain the agent id * @param $agent_id is the agent id * @param $really_load boolean, true by default, if false the data wont be loaded from database and * the only thing done by this function is storing the agent_id (usefull if you know you wont need actual data) * @return false if the agent cannot be loaded, true else |
| save() X-Ref |
| * Save the agent * @return false if the agent cannot be saved, true else |
| getAdminActivityOptions() X-Ref |
| * this function lists activity level options avaible for the agent * @return an associative array which can be empty |
| listProcessConfigurationFields() X-Ref |
| * This function tell the engine which process level options have to be set * for the agent. Theses options will be initialized for all processes by the engine * and can be different for each process. * @return an array which can be empty |
| getSMTPConfiguration() X-Ref |
| * return the SMTP config values stored by the emailadmin egw application * @return an associative array containing the'emailConfigValid' token at true if * it was ok, and at false else |
| init() X-Ref |
| Pas de description |
| sendOnPosted() X-Ref |
| * @return true if the conf says that we send email on POSTed forms, else false. |
| send_start() X-Ref |
| * If this activity is defined as an activity sending the email when starting we'll send it now * WARNING : on interactive queries the user code is parsed several times and this function is called * each time you reach the begining of the code, this means at least the first time when you show the form * and every time you loop on the form + the last time when you complete the code (if the user did not cancel). * @return true if everything was ok, false if something went wrong |
| send_end() X-Ref |
| * If this activity is defined as an activity sending the email when finishing the code we'll send it now * WARNING : on interactive queries the user code is parsed several times and this function is called * each time you reach the end of the code without completing, this means at least the first time * and every time you loop on the form. * @return true if everything was ok, false if something went wrong |
| send_post() X-Ref |
| * If this activity is defined as an activity sending the email when the user post a command for it * we'll send it now * @return true if everything was ok, false if something went wrong |
| send_completed() X-Ref |
| * If this activity is defined as an activity sending the email when completing we'll send it now * @return true if everything was ok, false if something went wrong |
| prepare_mail() X-Ref |
| Pas de description |
| decode_fields_in_final_fields($defaultDomain, $force=false) X-Ref |
| * This function is used to decode admin instructions about the final value or the activity * fields. i.e.: decoding %user% in toto@foo.com for example * * If you call this function twice the final result will NOT be recalculated. except with the $force * parameter. This is done so that you can call this function sooner than the engine and add or remove * emails from final fields. The engine will not recompute automatically theses fields if you done it already. * @param $defaultDomain is the default mail Domain, used with empty domains * @param $force is falmse by default, if true the final are recalculated even if they are already there * @return true/false and set the $this->final_fields array containing the fields with the 'real' final value and for * the wf_to, wf_bcc and wf_cc fields you'll have arrays with email values. |
| cleanup_adress_string($address_string) X-Ref |
| * This function will clean ',,' or ', ,' or starting or ending by ',' * in the email address string list. * @param $address_string is the string we should clean * @return the cleaned up string |
| replace_tokens(&$string) X-Ref |
| * This function is used to find and replace tokens in the fields * @param $string is the string to analyse * @return the modified string |
| Send() X-Ref |
| Pas de description |
| Généré le : Sun Feb 25 17:20:01 2007 | par Balluche grâce à PHPXref 0.7 |