Geeklog
[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]

Class: Swift_Mime_HeaderSet

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/Mime/HeaderSet.php

Interface Overview

Swift_Mime_CharsetObserver
   |
   --Swift_Mime_HeaderSet

A collection of MIME headers.


Author(s):

  • Chris Corbyn

Methods


Inherited Methods

Class: Swift_Mime_CharsetObserver

Swift_Mime_CharsetObserver::charsetChanged()
Notify this observer that the entity's charset has changed.

Class Details

[line 16]
A collection of MIME headers.



Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


method addDateHeader [line 32]

void addDateHeader( string $name, [int $timestamp = null])

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



Tags:

access:  public


Parameters:

string   $name  
int   $timestamp  

[ Top ]

method addIdHeader [line 57]

void addIdHeader( string $name, [string|array $ids = null])

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



Tags:

access:  public


Parameters:

string   $name  
string|array   $ids  

[ Top ]

method addMailboxHeader [line 24]

void addMailboxHeader( string $name, [array|string $addresses = null])

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



Tags:

access:  public


Parameters:

string   $name  
array|string   $addresses  

[ Top ]

method addParameterizedHeader [line 49]

void addParameterizedHeader( string $name, [string $value = null], [array $params = array()])

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



Tags:

access:  public


Parameters:

string   $name  
string   $value  
array   $params  

[ Top ]

method addPathHeader [line 65]

void addPathHeader( string $name, [string $path = null])

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



Tags:

access:  public


Parameters:

string   $name  
string   $path  

[ Top ]

method addTextHeader [line 40]

void addTextHeader( string $name, [string $value = null])

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



Tags:

access:  public


Parameters:

string   $name  
string   $value  

[ Top ]

method defineOrdering [line 152]

void defineOrdering( $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.




Tags:

access:  public


Parameters:

array   $sequence  

[ Top ]

method get [line 103]

Swift_Mime_Header get( string $name, [int $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.




Tags:

access:  public


Parameters:

string   $name  
int   $index  

[ Top ]

method getAll [line 112]

array getAll( [string $name = null])

Get all headers with the given $name.



Tags:

access:  public


Parameters:

string   $name  

[ Top ]

method has [line 77]

bool has( string $name, [int $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.




Tags:

access:  public


Parameters:

string   $name  
int   $index  

[ Top ]

method listAll [line 119]

array listAll( )

Return the name of all Headers.



Tags:

access:  public


[ Top ]

method newInstance [line 143]

Swift_Mime_HeaderSet newInstance( )

Create a new instance of this HeaderSet.



Tags:

access:  public


[ Top ]

method remove [line 129]

void remove( string $name, [int $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.




Tags:

access:  public


Parameters:

string   $name  
int   $index  

[ Top ]

method removeAll [line 136]

void removeAll( string $name)

Remove all headers with the given $name.



Tags:

access:  public


Parameters:

string   $name  

[ Top ]

method set [line 91]

void set( Swift_Mime_Header $header, [int $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.




Tags:

access:  public


Parameters:

Swift_Mime_Header   $header  
int   $index  

[ Top ]

method setAlwaysDisplayed [line 161]

void setAlwaysDisplayed( $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.




Tags:

access:  public


Parameters:

array   $names  

[ Top ]

method toString [line 168]

string toString( )

Returns a string with a representation of all headers.



Tags:

access:  public


[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:49:34 +0000 by phpDocumentor 1.4.3