Abstract Class JHtmlEmail

Description
Description | Methods (details)

Utility class for cloaking email addresses

  • abstract:
  • since: 1.5

Located in /libraries/cms/html/email.php (line 19) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

											
				

					 
					static 						string
										cloak
											(string $mail, [boolean $mailto = true], [string $text = ''], [boolean $email = true])
									

															
				

					 
					static 						string
										convertEncoding
											(string $text)
									

																															

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		
		static cloak (line 35)
	
 
	
	

Simple JavaScript email cloaker


By default replaces an email with a mailto link with email cloaked

	
    
				
  • return: The cloaked email.
    • 
				
  • since: 1.5
    • 
				
  • access: public
    • 
			

	
	

		static string
		
			cloak
		
					(string $mail, [boolean $mailto = true], [string $text = ''], [boolean $email = true])
			

	
			
    
					
  • 
				string
				$mail: The -mail address to cloak.			
    • 
					
  • 
				boolean
				$mailto: True if text and mailing address differ			
    • 
					
  • 
				string
				$text: Text for the link			
    • 
					
  • 
				boolean
				$email: True if text is an e-mail address			
    • 
				

		
			
	




	
	

		
		static convertEncoding (line 118)
	
 
	
	

Convert encoded text

	
    
				
  • return: The converted text.
    • 
				
  • since: 1.5
    • 
				
  • access: protected
    • 
			

	
	

		static string
		
			convertEncoding
		
					(string $text)
			

	
			
    
					
  • 
				string
				$text: Text to convert			
    • 
				

		
			
	

						
		

	


	
	

		Documentation generated on Tue, 19 Nov 2013 15:02:25 +0100 by phpDocumentor 1.4.3