Mail_Mime
[ class tree: Mail_Mime ] [ index: Mail_Mime ] [ all elements ]
Packages:
Mail_Mime


Classes:
Mail_mime
Mail_mimePart
Files:
mime.php
mimePart.php
phail.php

Class: Mail_mimePart

Source Location: /Mail_Mime-1.5.2/mimePart.php

Class Overview




The Mail_mimePart class is used to create MIME E-mail messages




Author(s):






                
          
          

Version:


    
  
  • Release: @package_version@
    • 




Copyright:


    
  
  • 2003-2006 PEAR <pear-group@php.net>
    • 








Methods
















Inherited Variables





Inherited Methods














Class Details



[line 74]

The Mail_mimePart class is used to create MIME E-mail messages
This class enables you to manipulate and build a mime email  from the ground up. The Mail_Mime class is a userfriendly api  to this class for people who aren't interested in the internals  of mime mail.  This class however allows full control over the email.









[ Top ]








Method Detail



	
	
Mail_mimePart (Constructor)   [line 132]

	

    

    

		Mail_mimePart Mail_mimePart(
[$body
$body = ''], [$params
$params = array()])
    

    


	
		Constructor.
Sets up the object.


    

  • Access: public
    • 








        
Parameters:

    

    

          

        $body  
        $body  
        —
          - The body of the mime part if any.
      

          

        $params  
        $params  
        —
          - An associative array of parameters:                   content_type - The content type for this part eg multipart/mixed                   encoding     - The encoding to use, 7bit, 8bit, base64, or quoted-printable                   cid          - Content ID to apply                   disposition  - Content disposition, inline or attachment                   dfilename    - Optional filename parameter for content disposition                   description  - Content description                   charset      - Character set to use
      

        

    


        
[ Top ]

  

  
  
	
	
addSubPart   [line 286]

	

    

    

		A &addSubPart(
$body
$body, $params
$params)
    

    


	
		&addSubPart()
Adds a subpart to current mime part and returns  a reference to it


    

  • Return: reference to the part you just added. It is          crucial if using multipart/* in your subparts that          you use =& in your script when calling this function,          otherwise you will not be able to add further subparts.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        $body  
        $body  
        —
          The body of the subpart, if any.
      

          

        $params  
        $params  
        —
          The parameters for the subpart, same                 as the $params argument for constructor.
      

        

    


        
[ Top ]

  

  
  
	
	
encode   [line 238]

	

    

    

		An encode(
)
    

    


	
		encode()
Encodes and returns the email. Also stores  it in the encoded member variable


    

  • Return: associative array containing two elements,          body and headers. The headers element is itself          an indexed array.
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Thu, 21 Jun 2007 15:30:06 -0400 by phpDocumentor 1.3.2. PEAR Logo Copyright ©  PHP Group 2004.