PHP Interface Swift_Mime_HeaderSet, Halite

Author: Chris Corbyn
Inheritance: extends Swift_Mime_CharsetObserver
Afficher le fichier Open project: HaliteChallenge/Halite Interface Usage Examples

Méthodes publiques

Méthode Description
addDateHeader ( string $name, integer $timestamp = null ) Add a new Date header using $timestamp (UNIX time).
addIdHeader ( string $name, string | array $ids = null ) Add a new ID header for Message-ID or Content-ID.
addMailboxHeader ( string $name, array | string $addresses = null ) Add a new Mailbox Header with a list of $addresses.
addParameterizedHeader ( string $name, string $value = null, array $params = [] ) Add a new ParameterizedHeader with $name, $value and $params.
addPathHeader ( string $name, string $path = null ) Add a new Path header with an address (path) in it.
addTextHeader ( string $name, string $value = null ) Add a new basic text header with $name and $value.
defineOrdering ( array $sequence ) Define a list of Header names as an array in the correct order.
get ( string $name, integer $index ) : Swift_Mime_Header Get the header with the given $name.
getAll ( string $name = null ) : array Get all headers with the given $name.
has ( string $name, integer $index ) : boolean Returns true if at least one header with the given $name exists.
listAll ( ) : array Return the name of all Headers.
newInstance ( ) : Swift_Mime_HeaderSet Create a new instance of this HeaderSet.
remove ( string $name, integer $index ) Remove the header with the given $name if it's set.
removeAll ( string $name ) Remove all headers with the given $name.
set ( Swift_Mime_Header $header, integer $index ) Set a header in the HeaderSet.
setAlwaysDisplayed ( array $names ) Set a list of header names which must always be displayed when set.
toString ( ) : string Returns a string with a representation of all headers.

Method Details

addDateHeader() public méthode

Add a new Date header using $timestamp (UNIX time).
public addDateHeader ( string $name, integer $timestamp = null )
$name string
$timestamp integer

addIdHeader() public méthode

Add a new ID header for Message-ID or Content-ID.
public addIdHeader ( string $name, string | array $ids = null )
$name string
$ids string | array

addMailboxHeader() public méthode

Add a new Mailbox Header with a list of $addresses.
public addMailboxHeader ( string $name, array | string $addresses = null )
$name string
$addresses array | string

addParameterizedHeader() public méthode

Add a new ParameterizedHeader with $name, $value and $params.
public addParameterizedHeader ( string $name, string $value = null, array $params = [] )
$name string
$value string
$params array

addPathHeader() public méthode

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

addTextHeader() public méthode

Add a new basic text header with $name and $value.
public addTextHeader ( string $name, string $value = null )
$name string
$value string

defineOrdering() public méthode

These Headers will be output in the given order where present.
public defineOrdering ( array $sequence )
$sequence array

get() public méthode

If multiple headers match, the actual one may be specified by $index. Returns NULL if none present.
public get ( string $name, integer $index ) : Swift_Mime_Header
$name string
$index integer
Résultat Swift_Mime_Header

getAll() public méthode

Get all headers with the given $name.
public getAll ( string $name = null ) : array
$name string
Résultat array

has() public méthode

If multiple headers match, the actual one may be specified by $index.
public has ( string $name, integer $index ) : boolean
$name string
$index integer
Résultat boolean

listAll() public méthode

Return the name of all Headers.
public listAll ( ) : array
Résultat array

newInstance() public méthode

Create a new instance of this HeaderSet.
public newInstance ( ) : Swift_Mime_HeaderSet
Résultat Swift_Mime_HeaderSet

remove() public méthode

If multiple headers match, the actual one may be specified by $index.
public remove ( string $name, integer $index )
$name string
$index integer

removeAll() public méthode

Remove all headers with the given $name.
public removeAll ( string $name )
$name string

set() public méthode

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.
public set ( Swift_Mime_Header $header, integer $index )
$header Swift_Mime_Header
$index integer

setAlwaysDisplayed() public méthode

Usually headers without a field value won't be output unless set here.
public setAlwaysDisplayed ( array $names )
$names array

toString() public méthode

Returns a string with a representation of all headers.
public toString ( ) : string
Résultat string