[ Index ]

MailPress 544

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

title

Body

[close]

/mp-includes/Swiftmailer/classes/Swift/Mime/ -> SimpleHeaderSet.php (summary)

(no description)

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

Defines 1 class

Swift_Mime_SimpleHeaderSet:: (27 methods):
  __construct()
  setCharset()
  addMailboxHeader()
  addDateHeader()
  addTextHeader()
  addParameterizedHeader()
  addIdHeader()
  addPathHeader()
  has()
  set()
  get()
  getAll()
  listAll()
  remove()
  removeAll()
  newInstance()
  defineOrdering()
  setAlwaysDisplayed()
  charsetChanged()
  toString()
  __toString()
  _storeHeader()
  _canSort()
  _sortHeaders()
  _isDisplayed()
  _notifyHeadersOfCharset()
  __clone()


Class: Swift_Mime_SimpleHeaderSet  - X-Ref

A collection of MIME headers.

__construct(Swift_Mime_HeaderFactory $factory, $charset = null)   X-Ref
Create a new SimpleHeaderSet with the given $factory.

param: Swift_Mime_HeaderFactory $factory
param: string                   $charset

setCharset($charset)   X-Ref
Set the charset used by these headers.

param: string $charset

addMailboxHeader($name, $addresses = null)   X-Ref
Add a new Mailbox Header with a list of $addresses.

param: string       $name
param: array|string $addresses

addDateHeader($name, $timestamp = null)   X-Ref
Add a new Date header using $timestamp (UNIX time).

param: string $name
param: int    $timestamp

addTextHeader($name, $value = null)   X-Ref
Add a new basic text header with $name and $value.

param: string $name
param: string $value

addParameterizedHeader($name, $value = null, $params = array()   X-Ref
Add a new ParameterizedHeader with $name, $value and $params.

param: string $name
param: string $value
param: array  $params

addIdHeader($name, $ids = null)   X-Ref
Add a new ID header for Message-ID or Content-ID.

param: string       $name
param: string|array $ids

addPathHeader($name, $path = null)   X-Ref
Add a new Path header with an address (path) in it.

param: string $name
param: string $path

has($name, $index = 0)   X-Ref
Returns true if at least one header with the given $name exists.

If multiple headers match, the actual one may be specified by $index.

param: string $name
param: int    $index
return: bool

set(Swift_Mime_Header $header, $index = 0)   X-Ref
Set a header in the HeaderSet.

The header may be a previously fetched header via {@link get()} or it may
be one that has been created separately.

If $index is specified, the header will be inserted into the set at this
offset.

param: Swift_Mime_Header $header
param: int               $index

get($name, $index = 0)   X-Ref
Get the header with the given $name.

If multiple headers match, the actual one may be specified by $index.
Returns NULL if none present.

param: string $name
param: int    $index
return: Swift_Mime_Header

getAll($name = null)   X-Ref
Get all headers with the given $name.

param: string $name
return: array

listAll()   X-Ref
Return the name of all Headers.

return: array

remove($name, $index = 0)   X-Ref
Remove the header with the given $name if it's set.

If multiple headers match, the actual one may be specified by $index.

param: string $name
param: int    $index

removeAll($name)   X-Ref
Remove all headers with the given $name.

param: string $name

newInstance()   X-Ref
Create a new instance of this HeaderSet.

return: Swift_Mime_HeaderSet

defineOrdering(array $sequence)   X-Ref
Define a list of Header names as an array in the correct order.

These Headers will be output in the given order where present.

param: array $sequence

setAlwaysDisplayed(array $names)   X-Ref
Set a list of header names which must always be displayed when set.

Usually headers without a field value won't be output unless set here.

param: array $names

charsetChanged($charset)   X-Ref
Notify this observer that the entity's charset has changed.

param: string $charset

toString()   X-Ref
Returns a string with a representation of all headers.

return: string

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

return: string

_storeHeader($name, Swift_Mime_Header $header, $offset = null)   X-Ref
No description

_canSort()   X-Ref
No description

_sortHeaders($a, $b)   X-Ref
No description

_isDisplayed(Swift_Mime_Header $header)   X-Ref
No description

_notifyHeadersOfCharset($charset)   X-Ref
No description

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




Generated: Thu Apr 28 18:38:52 2016 Cross-referenced by PHPXref 0.7.1