TYPO3  7.6
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Swift_Mime_Headers_PathHeader Class Reference
Inheritance diagram for Swift_Mime_Headers_PathHeader:
Swift_Mime_Headers_AbstractHeader Swift_Mime_Header

Public Member Functions

 __construct ($name, Swift_Mime_Grammar $grammar)
 
 getFieldType ()
 
 setFieldBodyModel ($model)
 
 getFieldBodyModel ()
 
 setAddress ($address)
 
 getAddress ()
 
 getFieldBody ()
 
- Public Member Functions inherited from Swift_Mime_Headers_AbstractHeader
 __construct (Swift_Mime_Grammar $grammar)
 
 setCharset ($charset)
 
 getCharset ()
 
 setLanguage ($lang)
 
 getLanguage ()
 
 setEncoder (Swift_Mime_HeaderEncoder $encoder)
 
 getEncoder ()
 
 setGrammar (Swift_Mime_Grammar $grammar)
 
 getGrammar ()
 
 getFieldName ()
 
 setMaxLineLength ($lineLength)
 
 getMaxLineLength ()
 
 toString ()
 
 __toString ()
 

Private Member Functions

 _assertValidAddress ($address)
 

Private Attributes

 $_address
 

Additional Inherited Members

- Public Attributes inherited from Swift_Mime_Header
const TYPE_TEXT = 2
 
const TYPE_PARAMETERIZED = 6
 
const TYPE_MAILBOX = 8
 
const TYPE_DATE = 16
 
const TYPE_ID = 32
 
const TYPE_PATH = 64
 
- Protected Member Functions inherited from Swift_Mime_Headers_AbstractHeader
 setFieldName ($name)
 
 createPhrase (Swift_Mime_Header $header, $string, $charset, Swift_Mime_HeaderEncoder $encoder=null, $shorten=false)
 
 encodeWords (Swift_Mime_Header $header, $input, $usedLength=-1)
 
 tokenNeedsEncoding ($token)
 
 getEncodableWordTokens ($string)
 
 getTokenAsEncodedWord ($token, $firstLineOffset=0)
 
 generateTokenLines ($token)
 
 setCachedValue ($value)
 
 getCachedValue ()
 
 clearCachedValueIf ($condition)
 
 toTokens ($string=null)
 

Detailed Description

A Path Header in Swift Mailer, such a Return-Path.

Author
Chris Corbyn

Definition at line 16 of file PathHeader.php.

Constructor & Destructor Documentation

__construct (   $name,
Swift_Mime_Grammar  $grammar 
)

Creates a new PathHeader with the given $name.

Parameters
string$name
Swift_Mime_Grammar$grammar

Definition at line 31 of file PathHeader.php.

References Swift_Mime_Headers_AbstractHeader\setFieldName().

Member Function Documentation

_assertValidAddress (   $address)
private

Throws an Exception if the address passed does not comply with RFC 2822.

Parameters
string$address
Exceptions
Swift_RfcComplianceExceptionIf address is invalid

Definition at line 134 of file PathHeader.php.

References Swift_Mime_Headers_AbstractHeader\getGrammar().

Referenced by setAddress().

getAddress ( )

Get the address which is used in this Header (if any).

Null is returned if no address is set.

Returns
string

Definition at line 101 of file PathHeader.php.

References $_address.

Referenced by getFieldBodyModel().

getFieldBody ( )

Get the string value of the body in this Header.

This is not necessarily RFC 2822 compliant since folding white space will not be added at this stage (see toString() for that).

See Also
toString()
Returns
string

Implements Swift_Mime_Header.

Definition at line 116 of file PathHeader.php.

References Swift_Mime_Headers_AbstractHeader\getCachedValue(), and Swift_Mime_Headers_AbstractHeader\setCachedValue().

getFieldBodyModel ( )

Get the model for the field body. This method returns a string email address.

Returns
mixed

Implements Swift_Mime_Header.

Definition at line 69 of file PathHeader.php.

References getAddress().

getFieldType ( )

Get the type of Header that this instance represents.

See Also
TYPE_TEXT, TYPE_PARAMETERIZED, TYPE_MAILBOX
TYPE_DATE, TYPE_ID, TYPE_PATH
Returns
int

Implements Swift_Mime_Header.

Definition at line 45 of file PathHeader.php.

setAddress (   $address)

Set the Address which should appear in this Header.

Parameters
string$address
Exceptions
Swift_RfcComplianceException

Definition at line 81 of file PathHeader.php.

References _assertValidAddress(), elseif, and Swift_Mime_Headers_AbstractHeader\setCachedValue().

Referenced by setFieldBodyModel().

setFieldBodyModel (   $model)

Set the model for the field body. This method takes a string for an address.

Parameters
string$model
Exceptions
Swift_RfcComplianceException

Implements Swift_Mime_Header.

Definition at line 58 of file PathHeader.php.

References setAddress().

Member Data Documentation

$_address
private

Definition at line 23 of file PathHeader.php.

Referenced by getAddress().