XOOPS RMCommon Utilities  2.1.8.91RC
 All Classes Namespaces Files Functions Variables
Swift_Mime_HeaderSet Interface Reference
Inheritance diagram for Swift_Mime_HeaderSet:
Inheritance graph

Public Member Functions

 addDateHeader ($name, $timestamp=null)
 
 addIdHeader ($name, $ids=null)
 
 addMailboxHeader ($name, $addresses=null)
 
 addParameterizedHeader ($name, $value=null, $params=array())
 
 addPathHeader ($name, $path=null)
 
 addTextHeader ($name, $value=null)
 
 defineOrdering (array $sequence)
 
 get ($name, $index=0)
 
 getAll ($name=null)
 
 has ($name, $index=0)
 
 newInstance ()
 
 remove ($name, $index=0)
 
 removeAll ($name)
 
 set (Swift_Mime_Header $header, $index=0)
 
 setAlwaysDisplayed (array $names)
 
 toString ()
 
- Public Member Functions inherited from Swift_Mime_CharsetObserver
 charsetChanged ($charset)
 

Detailed Description

Definition at line 21 of file HeaderSet.php.

Member Function Documentation

Swift_Mime_HeaderSet::addDateHeader (   $name,
  $timestamp = null 
)

Add a new Date header using $timestamp (UNIX time).

Parameters
string$name
int$timestamp

Implemented in Swift_Mime_SimpleHeaderSet.

Swift_Mime_HeaderSet::addIdHeader (   $name,
  $ids = null 
)

Add a new ID header for Message-ID or Content-ID.

Parameters
string$name
string | array$ids

Implemented in Swift_Mime_SimpleHeaderSet.

Swift_Mime_HeaderSet::addMailboxHeader (   $name,
  $addresses = null 
)

Add a new Mailbox Header with a list of $addresses.

Parameters
string$name
array | string$addresses

Implemented in Swift_Mime_SimpleHeaderSet.

Swift_Mime_HeaderSet::addParameterizedHeader (   $name,
  $value = null,
  $params = array() 
)

Add a new ParameterizedHeader with $name, $value and $params.

Parameters
string$name
string$value
array$params

Implemented in Swift_Mime_SimpleHeaderSet.

Swift_Mime_HeaderSet::addPathHeader (   $name,
  $path = null 
)

Add a new Path header with an address (path) in it.

Parameters
string$name
string$path

Implemented in Swift_Mime_SimpleHeaderSet.

Swift_Mime_HeaderSet::addTextHeader (   $name,
  $value = null 
)

Add a new basic text header with $name and $value.

Parameters
string$name
string$value

Implemented in Swift_Mime_SimpleHeaderSet.

Swift_Mime_HeaderSet::defineOrdering ( array  $sequence)

Define a list of Header names as an array in the correct order.

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

Parameters
array$sequence

Implemented in Swift_Mime_SimpleHeaderSet.

Swift_Mime_HeaderSet::get (   $name,
  $index = 0 
)

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

Parameters
string$name
int$index
Returns
Swift_Mime_Header

Implemented in Swift_Mime_SimpleHeaderSet.

Swift_Mime_HeaderSet::getAll (   $name = null)

Get all headers with the given $name.

Parameters
string$name
Returns
array

Implemented in Swift_Mime_SimpleHeaderSet.

Swift_Mime_HeaderSet::has (   $name,
  $index = 0 
)

Returns true if at least one header with the given $name exists.

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

Parameters
string$name
int$index
Returns
boolean

Implemented in Swift_Mime_SimpleHeaderSet.

Swift_Mime_HeaderSet::newInstance ( )

Create a new instance of this HeaderSet.

Returns
Swift_Mime_HeaderSet

Implemented in Swift_Mime_SimpleHeaderSet.

Swift_Mime_HeaderSet::remove (   $name,
  $index = 0 
)

Remove the header with the given $name if it's set.

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

Parameters
string$name
int$index

Implemented in Swift_Mime_SimpleHeaderSet.

Swift_Mime_HeaderSet::removeAll (   $name)

Remove all headers with the given $name.

Parameters
string$name

Implemented in Swift_Mime_SimpleHeaderSet.

Swift_Mime_HeaderSet::set ( Swift_Mime_Header  $header,
  $index = 0 
)

Set a header in the HeaderSet.

The header may be a previously fetched header via 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.

Parameters
Swift_Mime_Header$header
int$index

Implemented in Swift_Mime_SimpleHeaderSet.

Swift_Mime_HeaderSet::setAlwaysDisplayed ( array  $names)

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.

Parameters
array$names

Implemented in Swift_Mime_SimpleHeaderSet.

Swift_Mime_HeaderSet::toString ( )

Returns a string with a representation of all headers.

Returns
string

Implemented in Swift_Mime_SimpleHeaderSet.


The documentation for this interface was generated from the following file: