[ Index ]

MailPress 7.2

[ Index ]     [ Classes ]     [ Functions ]     [ Variables ]     [ Constants ]     [ Statistics ]    

title

Body

[close]

/mp-includes/composer/vendor/swiftmailer/swiftmailer/lib/classes/Swift/Mime/ -> SimpleMimeEntity.php (summary)

(no description)

File Size: 820 lines (23 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Swift_Mime_SimpleMimeEntity:: (50 methods):
  __construct()
  generateId()
  getHeaders()
  getNestingLevel()
  getContentType()
  getBodyContentType()
  setContentType()
  getId()
  setId()
  getDescription()
  setDescription()
  getMaxLineLength()
  setMaxLineLength()
  getChildren()
  setChildren()
  getBody()
  setBody()
  getEncoder()
  setEncoder()
  getBoundary()
  setBoundary()
  charsetChanged()
  encoderChanged()
  toString()
  bodyToString()
  __toString()
  toByteStream()
  bodyToByteStream()
  getIdField()
  getHeaderFieldModel()
  setHeaderFieldModel()
  getHeaderParameter()
  setHeaderParameter()
  fixHeaders()
  getCache()
  getIdGenerator()
  clearCache()
  readStream()
  setEncoding()
  assertValidBoundary()
  setContentTypeInHeaders()
  setNestingLevel()
  getCompoundLevel()
  getNeededChildLevel()
  createChild()
  notifyEncoderChanged()
  notifyCharsetChanged()
  sortChildren()
  __destruct()
  __clone()


Class: Swift_Mime_SimpleMimeEntity  - X-Ref

A MIME entity, in a multipart message.

__construct(Swift_Mime_SimpleHeaderSet $headers, Swift_Mime_ContentEncoder $encoder, Swift_KeyCache $cache, Swift_IdGenerator $idGenerator)   X-Ref
Create a new SimpleMimeEntity with $headers, $encoder and $cache.


generateId()   X-Ref
Generate a new Content-ID or Message-ID for this MIME entity.

return: string

getHeaders()   X-Ref
Get the {@link Swift_Mime_SimpleHeaderSet} for this entity.

return: Swift_Mime_SimpleHeaderSet

getNestingLevel()   X-Ref
Get the nesting level of this entity.

return: int

getContentType()   X-Ref
Get the Content-type of this entity.

return: string

getBodyContentType()   X-Ref
Get the Body Content-type of this entity.

return: string

setContentType($type)   X-Ref
Set the Content-type of this entity.

param: string $type
return: $this

getId()   X-Ref
Get the CID of this entity.

The CID will only be present in headers if a Content-ID header is present.

return: string

setId($id)   X-Ref
Set the CID of this entity.

param: string $id
return: $this

getDescription()   X-Ref
Get the description of this entity.

This value comes from the Content-Description header if set.

return: string

setDescription($description)   X-Ref
Set the description of this entity.

This method sets a value in the Content-ID header.

param: string $description
return: $this

getMaxLineLength()   X-Ref
Get the maximum line length of the body of this entity.

return: int

setMaxLineLength($length)   X-Ref
Set the maximum line length of lines in this body.

Though not enforced by the library, lines should not exceed 1000 chars.

param: int $length
return: $this

getChildren()   X-Ref
Get all children added to this entity.

return: Swift_Mime_SimpleMimeEntity[]

setChildren(array $children, $compoundLevel = null)   X-Ref
Set all children of this entity.

param: Swift_Mime_SimpleMimeEntity[] $children
param: int                           $compoundLevel For internal use only
return: $this

getBody()   X-Ref
Get the body of this entity as a string.

return: string

setBody($body, $contentType = null)   X-Ref
Set the body of this entity, either as a string, or as an instance of
{@link Swift_OutputByteStream}.

param: mixed  $body
param: string $contentType optional
return: $this

getEncoder()   X-Ref
Get the encoder used for the body of this entity.

return: Swift_Mime_ContentEncoder

setEncoder(Swift_Mime_ContentEncoder $encoder)   X-Ref
Set the encoder used for the body of this entity.

return: $this

getBoundary()   X-Ref
Get the boundary used to separate children in this entity.

return: string

setBoundary($boundary)   X-Ref
Set the boundary used to separate children in this entity.

param: string $boundary
return: $this

charsetChanged($charset)   X-Ref
Receive notification that the charset of this entity, or a parent entity
has changed.

param: string $charset

encoderChanged(Swift_Mime_ContentEncoder $encoder)   X-Ref
Receive notification that the encoder of this entity or a parent entity
has changed.


toString()   X-Ref
Get this entire entity as a string.

return: string

bodyToString()   X-Ref
Get this entire entity as a string.

return: string

__toString()   X-Ref
Returns a string representation of this object.

return: string

toByteStream(Swift_InputByteStream $is)   X-Ref
Write this entire entity to a {@see Swift_InputByteStream}.


bodyToByteStream(Swift_InputByteStream $is)   X-Ref
Write this entire entity to a {@link Swift_InputByteStream}.


getIdField()   X-Ref
Get the name of the header that provides the ID of this entity.


getHeaderFieldModel($field)   X-Ref
Get the model data (usually an array or a string) for $field.


setHeaderFieldModel($field, $model)   X-Ref
Set the model data for $field.


getHeaderParameter($field, $parameter)   X-Ref
Get the parameter value of $parameter on $field header.


setHeaderParameter($field, $parameter, $value)   X-Ref
Set the parameter value of $parameter on $field header.


fixHeaders()   X-Ref
Re-evaluate what content type and encoding should be used on this entity.


getCache()   X-Ref
Get the KeyCache used in this entity.

return: Swift_KeyCache

getIdGenerator()   X-Ref
Get the ID generator.

return: Swift_IdGenerator

clearCache()   X-Ref
Empty the KeyCache for this entity.


readStream(Swift_OutputByteStream $os)   X-Ref
No description

setEncoding($encoding)   X-Ref
No description

assertValidBoundary($boundary)   X-Ref
No description

setContentTypeInHeaders($type)   X-Ref
No description

setNestingLevel($level)   X-Ref
No description

getCompoundLevel($children)   X-Ref
No description

getNeededChildLevel($child, $compoundLevel)   X-Ref
No description

createChild()   X-Ref
No description

notifyEncoderChanged(Swift_Mime_ContentEncoder $encoder)   X-Ref
No description

notifyCharsetChanged($charset)   X-Ref
No description

sortChildren()   X-Ref
No description

__destruct()   X-Ref
Empties it's own contents from the cache.


__clone()   X-Ref
Make a deep copy of object.




Generated: Tue May 19 15:55:14 2020 Cross-referenced by PHPXref 0.7.1