Transaction Engine 3 Application Programming Interface
[ class tree: Transaction Engine 3 Application Programming Interface ] [ index: Transaction Engine 3 Application Programming Interface ] [ all elements ]
Packages:
Transaction Engine 3 Application Programming Interface


Files:
KT_functions.inc.php
KT_ResourcesFunctions.inc.php
tNG_defTrigg.inc.php
tNG_functions.inc.php

Classes:
KT_Connection
KT_Email
KT_fakeADORecordset
KT_FakeRecordset
KT_file
KT_fileUpload
KT_folder
KT_image
KT_Recordset
KT_shell
tNG
tNG_CheckDetailRecord
tNG_CheckMasterRecord
tNG_CheckTableField
tNG_CheckUnique
tNG_CSVImport
tNG_custom
tNG_delete
tNG_DeleteDetailRec
tNG_dispatcher
tNG_Email
tNG_EmailPageSection
tNG_EmailRecordset
tNG_fields
tNG_FileDelete
tNG_FileUpload
tNG_FormValidation
tNG_ImageUpload
tNG_import
tNG_insert
tNG_LinkedTrans
tNG_log
tNG_login
tNG_Logout
tNG_ManyToMany
tNG_multiple
tNG_multipleDelete
tNG_multipleInsert
tNG_multipleUpdate
tNG_Redirect
tNG_RestrictAccess
tNG_SetOrderField
tNG_ThrowError
tNG_update
tNG_UserLoggedIn
tNG_XMLImport

Class: tNG_Email

Source Location: /tNG3/triggers/tNG_Email.class.php

Class Overview




Send Email trigger class.




Author(s):


    
        





    






Variables







Methods















Child classes:






tNG_EmailRecordset

	
send Email Recordset trigger class.

















Class Details



[line 11]

Send Email trigger class.

This is also the base class for tNG_EmailRecordset





Tags:





  

    access:  public
  










[ Top ]







Class Variables



	
	

	
$bcc = 

	
[line 46]

  blind copy carbon mail;





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$cc = 

	
[line 39]

  copy carbon mail;





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$content = 

	
[line 60]

  body of the email;





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$contentFile = 

	
[line 67]

  the file from which the content is read and sent;





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$encoding = 

	
[line 82]

  encoding type;





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$escapeMethod = 

	
[line 103]

  escap method to use in KT_dynamicvalue() default 'none';


  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$file = 

	
[line 75]

  the file from which the content is read and sent if is set setContentFile

or the __FILE__;





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$format = 

	
[line 89]

  format of the email: text or html/text;





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$from = 

	
[line 25]

  from whom the email is send;





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$importance = 

	
[line 96]

  importance of the email: Normal, Low, High;





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$subject = 

	
[line 53]

  subject of the email;





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$tNG = 

	
[line 18]

  transaction in which the trigger will be executed;





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$to = 

	
[line 32]

  to whom send the email;





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$useSavedData = 

	
[line 110]

  if it must be used the saveData or not;


  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]










Class Methods



  

	
	
constructor tNG_Email [line 117]

	

    

    

		tNG_Email tNG_Email(
object
&$tNG)
    

    


	
		Constructor. Set transaction.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        object  
        $tNG  
        the transaction
      

        

    


        
[ Top ]

  

  

	
	
method Execute [line 395]

	

    

    

		void Execute(
)
    

    


	
		the main method, execute the code of the class;





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
tNG_EmailRecordset::Execute()

		
the main method, execute the code of the class;

	

	


        
[ Top ]

  

  

	
	
method getBcc [line 279]

	

    

    

		string getBcc(
)
    

    


	
		Getter. Get bcc.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getCc [line 269]

	

    

    

		string getCc(
)
    

    


	
		Getter. Get cc.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getEncoding [line 299]

	

    

    

		string getEncoding(
)
    

    


	
		Getter. Get encoding.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getFrom [line 249]

	

    

    

		string getFrom(
)
    

    


	
		Getter. Get From.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getHtmlBody [line 322]

	

    

    

		string getHtmlBody(
)
    

    


	
		Getter. Get htmlBody.





Tags:





  

    return:  the content of the email (can have any html tags but <script>)
  

  

    access:  protected
  










        
[ Top ]

  

  

	
	
method getSubject [line 289]

	

    

    

		string getSubject(
)
    

    


	
		Getter. Get subject.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getTextBody [line 309]

	

    

    

		string getTextBody(
)
    

    


	
		Getter. Get textBody.





Tags:





  

    return:  the text body of the email, stripped by all html tags;
  

  

    access:  protected
  










        
[ Top ]

  

  

	
	
method getTng [line 239]

	

    

    

		object transaction getTng(
)
    

    


	
		Getter. Get tNG object.





Tags:





  

    return:  object
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getTo [line 259]

	

    

    

		string getTo(
)
    

    


	
		Getter. Get to.





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
tNG_EmailRecordset::getTo()

		
Getter. Get to.

	

	


        
[ Top ]

  

  

	
	
method getUseSavedData [line 379]

	

    

    

		boolean getUseSavedData(
)
    

    


	
		Getter. Get useSavedData.





Tags:





  

    return:  true if the transaction was a delete one;
  

  

    access:  protected
  










        
[ Top ]

  

  

	
	
method removeScript [line 340]

	

    

    

		string removeScript(
string
$text)
    

    


	
		Remove the <script></script> or <script > tags from the





Tags:





  

    return:  the stripped text
  

  

    access:  protected
  










        
Parameters:

    

    

          

        string  
        $text  
        the text to be stripped
      

        

    


        
[ Top ]

  

  

	
	
method setBCC [line 168]

	

    

    

		void setBCC(
string
$bcc)
    

    


	
		Setter. Set bcc.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $bcc  
        the blind carbon copy string from which to retrieve the email address
      

        

    


        
[ Top ]

  

  

	
	
method setCC [line 158]

	

    

    

		void setCC(
string
$cc)
    

    


	
		Setter. Set cc.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $cc  
        the carbon copy string from which to retrieve the email address
      

        

    


        
[ Top ]

  

  

	
	
method setContent [line 188]

	

    

    

		void setContent(
string
$content)
    

    


	
		Setter. Set content.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $content  
        set the content from which the body of the email will be retrieved.
      

        

    


        
[ Top ]

  

  

	
	
method setContentFile [line 198]

	

    

    

		void setContentFile(
string
$contentFile)
    

    


	
		Setter. Set contentFile.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $contentFile  
        the file from which the email body is retrieved.
      

        

    


        
[ Top ]

  

  

	
	
method setEncoding [line 209]

	

    

    

		void setEncoding(
string
$encoding)
    

    


	
		Setter. encoding.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $encoding  
        the encoding to use for encoding the email;
      

        

    


        
[ Top ]

  

  

	
	
method setFormat [line 219]

	

    

    

		void setFormat(
string
$format)
    

    


	
		Setter. Set format.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $format  
        the format text or html/text of the email
      

        

    


        
[ Top ]

  

  

	
	
method setFrom [line 138]

	

    

    

		void setFrom(
string
$from)
    

    


	
		Setter. Set from.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $from  
        the from string to use in header
      

        

    


        
[ Top ]

  

  

	
	
method setImportance [line 229]

	

    

    

		void setImportance(
string
$importance)
    

    


	
		Setter. Set importance.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $importance  
        set the importance of the email: Normal, High or Low;
      

        

    


        
[ Top ]

  

  

	
	
method setSubject [line 178]

	

    

    

		void setSubject(
string
$subject)
    

    


	
		Setter. Set subject.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $subject  
        set the subject of the email or the string from which to retrieve the subject
      

        

    


        
[ Top ]

  

  

	
	
method setTo [line 148]

	

    

    

		void setTo(
string
$to)
    

    


	
		Setter. Set to.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $to  
        the string from which to retrieve the email to which the email is send;
      

        

    


        
[ Top ]

  






        

	



	
	Login to Add New Note
	






		    

		    Documentation generated on Tue,  6 Dec 2005 15:11:40 +0200 by phpDocumentor 1.3.0RC3