Class Swift_Mime_Headers_PathHeader

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

Swift_Mime_Headers_AbstractHeader implements Swift_Mime_Header

Extended by

Swift_Mime_Headers_PathHeader

Package: Swift\Mime
Author: Chris Corbyn
Located at vendors/swiftmailer/lib/classes/Swift/Mime/Headers/PathHeader.php

Methods summary

`public`	# `__construct( string $name, Swift_Mime_Grammar $grammar )` Creates a new PathHeader with the given $name. Creates a new PathHeader with the given $name. Parameters `$name` `string` $name `$grammar` `Swift_Mime_Grammar` $grammar Overrides `Swift_Mime_Headers_AbstractHeader::__construct`
`public integer`	# `getFieldType( )` Get the type of Header that this instance represents. Get the type of Header that this instance represents. Returns `integer` See `Swift_Mime_Header::TYPE_TEXT`, `Swift_Mime_Header::TYPE_PARAMETERIZED`, `Swift_Mime_Header::TYPE_MAILBOX` `Swift_Mime_Header::TYPE_DATE`, `Swift_Mime_Header::TYPE_ID`, `Swift_Mime_Header::TYPE_PATH`
`public`	# `setFieldBodyModel( string $model )` Set the model for the field body. This method takes a string for an address. Set the model for the field body. This method takes a string for an address. Parameters `$model` `string` $model Throws `Swift_RfcComplianceException`
`public mixed`	# `getFieldBodyModel( )` Get the model for the field body. This method returns a string email address. Get the model for the field body. This method returns a string email address. Returns `mixed`
`public`	# `setAddress( string $address )` Set the Address which should appear in this Header. Set the Address which should appear in this Header. Parameters `$address` `string` $address Throws `Swift_RfcComplianceException`
`public string`	# `getAddress( )` Get the address which is used in this Header (if any). Null is returned if no address is set. Get the address which is used in this Header (if any). Null is returned if no address is set. Returns `string`
`public string`	# `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 `Swift_Mime_Headers_AbstractHeader::toString()` for that). 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 `Swift_Mime_Headers_AbstractHeader::toString()` for that). Returns `string` See `Swift_Mime_Headers_AbstractHeader::toString()`
`private`	# `_assertValidAddress( string $address )` Throws an Exception if the address passed does not comply with RFC 2822. Throws an Exception if the address passed does not comply with RFC 2822. Parameters `$address` `string` $address Throws `Swift_RfcComplianceException` If invalid.

Methods inherited from Swift_Mime_Headers_AbstractHeader

__toString(), clearCachedValueIf(), createPhrase(), encodeWords(), generateTokenLines(), getCachedValue(), getCharset(), getEncodableWordTokens(), getEncoder(), getFieldName(), getGrammar(), getLanguage(), getMaxLineLength(), getTokenAsEncodedWord(), setCachedValue(), setCharset(), setEncoder(), setFieldName(), setGrammar(), setLanguage(), setMaxLineLength(), toString(), toTokens(), tokenNeedsEncoding()

Magic methods summary

Constants summary

Constants inherited from Swift_Mime_Header

TYPE_DATE, TYPE_ID, TYPE_MAILBOX, TYPE_PARAMETERIZED, TYPE_PATH, TYPE_TEXT

Properties summary

`private string`	`$_address`	# The address in this Header (if specified). The address in this Header (if specified).