• 홈
• Horde_Mime_Part

PHP 클래스 Horde_Mime_Part, horde

파일 보기 프로젝트 열기: horde/horde 1 사용 예제들

공개 프로퍼티들

프로퍼티	타입	설명
$defaultCharset	string	The default charset to use when parsing text parts with no charset information.
$encodingTypes
$memoryLimit	integer	The memory limit for use with the PHP temp stream.
$mimeTypes
$parent	Horde_Mime_Part	Parent object. Value only accurate when iterating.

보호된 프로퍼티들

프로퍼티	타입	설명
$_bytes	integer	Default value for this Part's size.
$_contents	resource	The body of the part. Always stored in binary format.
$_eol	string	The default is currently to output the EOL sequence internally as just "\n" instead of the canonical "\r\n" required in RFC 822 & 2045. To be RFC complaint, the full EOL combination should be used when sending a message.
$_failed	boolean	Flag to detect if a message failed to send at least once.
$_hdrCharset	string	The charset to output the headers in.
$_headers	Horde_Mime_Headers	The MIME headers for this part.
$_metadata	array	Metadata.
$_mimeid	string	The MIME ID of this part.
$_parts	array	The subparts of this part.
$_status	integer	Status mask for this part.
$_temp	array	Temporary array.
$_transferEncoding	string	The desired transfer encoding of this part.

공개 메소드들

메소드	설명
__clone ( )	Function to run on clone.
__construct ( )	Constructor.
addMimeHeaders ( array $options = [] ) : Horde_Mime_Headers	Returns a Horde_Mime_Header object containing all MIME headers needed for the part.
addPart ( $mime_part )
alterPart ( $id, $mime_part )
appendContents ( mixed $contents, $options = [] )	Add to the body contents of this part.
buildMimeIds ( string $id = null, boolean $rfc822 = false )	Build the MIME IDs for this part and all subparts.
clearContentTypeParameter ( $label )
clearContents ( )	Clears the body contents of this part.
contentTypeMap ( $sort = true )
count ( ) : integer	Returns the number of child message parts (doesn't include grandchildren or more remote ancestors).
current ( )
findBody ( string $subtype = null ) : mixed	Finds the main "body" text part (if any) in a message.
getAllContentTypeParameters ( ) : array	Get all parameters from the Content-Type header.
getAllDispositionParameters ( ) : array	Get all parameters from the Content-Disposition header.
getBytes ( boolean $approx = false ) : integer	Determine the size of this MIME part and its child members.
getCharset ( ) : string	Get the character set to use for this part.
getChildren ( )
getContentId ( ) : string	Returns the Content-ID for this part.
getContentTypeParameter ( string $label ) : string	Get a content type parameter from this part.
getContents ( array $options = [] ) : mixed	Return the body of the part.
getDefaultType ( ) : string	If the subtype of a MIME part is unrecognized by an application, the default type should be used instead (See RFC 2046). This method returns the default subtype for a particular primary MIME type.
getDescription ( boolean $default = false ) : string	Get the description of this part.
getDisposition ( ) : string	Get the content-disposition of this part.
getDispositionParameter ( string $label ) : string	Get a disposition parameter from this part.
getDuration ( ) : integer	Get the content duration of the data contained in this part (see RFC 3803).
getEOL ( ) : string	Get the string to use for EOLs.
getHeaderCharset ( ) : string	Get the character set to use when outputting MIME headers.
getLanguage ( )	Get the language(s) of this part.
getMetadata ( string $key ) : mixed	Retrieves metadata from this object.
getMimeId ( ) : string	Returns the MIME ID of this part.
getName ( boolean $default = false ) : string	Get the name of this part.
getPart ( $id )
getPartByIndex ( $index ) : Horde_Mime_Part	Returns a subpart by index.
getParts ( ) : array	Get a list of all MIME subparts.
getPrimaryType ( ) : string	Get the primary type of this part.
getRawPartText ( mixed $text, string $type, string $id ) : string	Attempts to obtain the raw text of a MIME part.
getSize ( boolean $approx = false ) : string	Output the size of this MIME part in KB.
getSubType ( ) : string	Get the subtype of this part.
getType ( boolean $charset = false ) : string	Get the full MIME Content-Type of this part.
hasChildren ( )
isAttachment ( ) : boolean	Determines if this MIME part is an attachment for display purposes.
isBasePart ( boolean $base )	Is this the base MIME part?
key ( )
next ( )
offsetExists ( $offset )
offsetGet ( $offset )
offsetSet ( $offset, $value )
offsetUnset ( $offset )
parseMessage ( string $text, array $opts = [] ) : Horde_Mime_Part	Attempts to build a Horde_Mime_Part object from message text.
partIterator ( boolean $current = true ) : Iterator	Returns the recursive iterator needed to iterate through this part.
removePart ( $id )
replaceEOL ( mixed $text, string $eol = null, boolean $stream = false ) : string	Replace newlines in this part's contents with those specified by either the given newline sequence or the part's current EOL setting.
rewind ( )
send ( string $email, Horde_Mime_Headers $headers, Horde_Mail_Transport $mailer, array $opts = [] )	Sends this message.
serialize ( ) : string	Serialization.
setBytes ( integer $bytes )	Explicitly set the size (in bytes) of this part. This value will only be returned (via getBytes()) if there are no contents currently set.
setCharset ( string $charset )	Set the character set of this part.
setContentId ( string $cid = null ) : string	Sets the Content-ID header for this part.
setContentTypeParameter ( string $label, string $data )	Add/remove a content type parameter to this part.
setContents ( mixed $contents, array $options = [] )	Set the body contents of this part.
setDescription ( string $description )	Set the description of this part.
setDisposition ( string $disposition = null )	Set the content-disposition of this part.
setDispositionParameter ( string $label, string $data )	Add a disposition parameter to this part.
setDuration ( integer $duration )	Set the content duration of the data contained in this part (see RFC 3803).
setEOL ( string $eol )	Sets a new string to use for EOLs.
setHeaderCharset ( string $charset )	Set the character set to use when outputting MIME headers.
setLanguage ( mixed $lang )	Set the language(s) of this part.
setMetadata ( string $key, mixed $data = null )	Set a piece of metadata on this object.
setMimeId ( string $mimeid )	Alter the MIME ID of this part.
setName ( string $name )	Set the name of this part.
setTransferEncoding ( string $encoding, array $options = [] )	Set the transfer encoding to use for this part.
setType ( string $type )	Set the MIME type of this part.
toString ( array $options = [] ) : mixed	Return the entire part in MIME format.
unserialize ( string $data )	Unserialization.
valid ( )

보호된 메소드들

메소드	설명
_findBoundary ( string $text, integer $pos, string $boundary, integer $end = null ) : array	Find the location of the next boundary string.
_findHeader ( string $text, string $eol ) : integer	Find the location of the end of the header text.
_getStructure ( string $header, string $body, array $opts = [] ) : Horde_Mime_Part	Creates a MIME object from the text of one part of a MIME message.
_getTransferEncoding ( integer $encode = self::ENCODE_7BIT ) : string	Get the transfer encoding for the part based on the user requested transfer encoding and the current contents of the part.
_reEncodeMessageAttachment ( Horde_Mime_Part $part )	Rebuilds $part and forces it to be a base64 encoded application/octet-stream part.
_readStream ( resource $fp, boolean $close = false ) : string	Read data from a stream.
_reindex ( boolean $force = false )	Reindexes the MIME IDs, if necessary.
_sanityCheckRfc822Attachments ( )	Re-enocdes message/rfc822 parts in case there was e.g., some broken line length in the headers of the message in the part. Since we shouldn't alter the original message in any way, we simply reset cause the part to be encoded as base64 and sent as a application/octet part.
_scanStream ( resource $fp )	Scans a stream for content type.
_transferDecode ( resource $fp, string $encoding ) : resource	Decodes the contents of the part to binary encoding.
_transferEncode ( resource $fp, string $encoding ) : resource	Encodes the contents of the part as necessary for transport.
_writeStream ( array $data, array $options = [] ) : resource	Write data to a stream.

메소드 상세

프로퍼티 상세