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: KT_Email

Source Location: /common/lib/email/KT_Email.class.php

Class Overview




This class is sending simple emails; (it was designed to be use internal);




Author(s):


    
        





    








Methods
























Class Details



[line 11]

This class is sending simple emails; (it was designed to be use internal);

Currently it is useing the PEAR Email classes;





Tags:





  

    access:  public
  










[ Top ]








Class Methods



  

	
	
constructor KT_Email [line 128]

	

    

    

		KT_Email KT_Email(
)
    

    


	
		Constructor. Doing nothing.






        
[ Top ]

  

  

	
	
method getError [line 542]

	

    

    

		array getError(
)
    

    


	
		Getter. 	return the errors setted.





Tags:





  

    return:  array - 0=>error for user, 1=>error for developer;
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method hasError [line 529]

	

    

    

		boolean hasError(
)
    

    


	
		check if an error was setted.





Tags:





  

    return:  true if error is set or false if not;
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method sendEmail [line 149]

	

    

    

		string sendEmail(
string
$server, string
$port, string
$user, string
$password, string
$from, string
$to, string
$cc, string
$bcc, mixed
$subject, string
$encoding, string
$textBody, string
$htmlBody)
    

    


	
		send the email





Tags:





  

    return:  empty on succes, error message on error;
  

  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $server  
        server name
      

          

        string  
        $port  
        port number
      

          

        string  
        $user  
        username
      

          

        string  
        $password  
        the password
      

          

        string  
        $from  
        from address
      

          

        string  
        $to  
        to address
      

          

        string  
        $cc  
        copy carbon address
      

          

        string  
        $bcc  
        blind copy carbon address
      

          

        string  
        $encoding  
        encoding of the email
      

          

        string  
        $textBody  
        text body of the email
      

          

        string  
        $htmlBody  
        the HTML body of the email
      

        

    


        
[ Top ]

  

  

	
	
method setCrlf [line 461]

	

    

    

		nothing; setCrlf(
mixed
$Crlf)
    

    


	
		Setter. set the end of line chars





Tags:





  

    var:  end of line chars;
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method setPriority [line 223]

	

    

    

		nothing setPriority(
[mixed
$priority = ''])
    

    


	
		setter. et the priority





Tags:





  

    var:  priority of the email: high, low, normal
  

  

    access:  public
  










        
[ Top ]

  






        

	



	
	Login to Add New Note
	






		    

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