Class Swift_Mime_Headers_IdentificationHeader

InheritanceSwift_Mime_Headers_IdentificationHeader » Swift_Mime_Headers_AbstractHeader
ImplementsSwift_Mime_Header

An ID MIME Header for something like Message-ID or Content-ID.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Creates a new IdentificationHeader with the given $name and $id. Swift_Mime_Headers_IdentificationHeader
__toString() Returns a string representation of this object. Swift_Mime_Headers_AbstractHeader
getCharset() Get the character set used in this Header. Swift_Mime_Headers_AbstractHeader
getEncoder() Get the encoder used for encoding this Header. Swift_Mime_Headers_AbstractHeader
getFieldBody() Get the string value of the body in this Header. Swift_Mime_Headers_IdentificationHeader
getFieldBodyModel() Get the model for the field body. Swift_Mime_Headers_IdentificationHeader
getFieldName() Get the name of this header (e.g. charset). Swift_Mime_Headers_AbstractHeader
getFieldType() Get the type of Header that this instance represents. Swift_Mime_Headers_IdentificationHeader
getGrammar() Get the grammar used for this Header. Swift_Mime_Headers_AbstractHeader
getId() Get the ID used in the value of this Header. Swift_Mime_Headers_IdentificationHeader
getIds() Get the list of IDs used in this Header. Swift_Mime_Headers_IdentificationHeader
getLanguage() Get the language used in this Header. Swift_Mime_Headers_AbstractHeader
getMaxLineLength() Get the maximum permitted length of lines in this Header. Swift_Mime_Headers_AbstractHeader
setCharset() Set the character set used in this Header. Swift_Mime_Headers_AbstractHeader
setEncoder() Set the encoder used for encoding the header. Swift_Mime_Headers_AbstractHeader
setFieldBodyModel() Set the model for the field body. Swift_Mime_Headers_IdentificationHeader
setGrammar() Set the grammar used for the header. Swift_Mime_Headers_AbstractHeader
setId() Set the ID used in the value of this header. Swift_Mime_Headers_IdentificationHeader
setIds() Set a collection of IDs to use in the value of this Header. Swift_Mime_Headers_IdentificationHeader
setLanguage() Set the language used in this Header. Swift_Mime_Headers_AbstractHeader
setMaxLineLength() Set the maximum length of lines in the header (excluding EOL). Swift_Mime_Headers_AbstractHeader
toString() Get this Header rendered as a RFC 2822 compliant string. Swift_Mime_Headers_AbstractHeader

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
clearCachedValueIf() Clear the cached value if $condition is met. Swift_Mime_Headers_AbstractHeader
createPhrase() Produces a compliant, formatted RFC 2822 'phrase' based on the string given. Swift_Mime_Headers_AbstractHeader
encodeWords() Encode needed word tokens within a string of input. Swift_Mime_Headers_AbstractHeader
generateTokenLines() Generates tokens from the given string which include CRLF as individual tokens. Swift_Mime_Headers_AbstractHeader
getCachedValue() Get the value in the cache. Swift_Mime_Headers_AbstractHeader
getEncodableWordTokens() Splits a string into tokens in blocks of words which can be encoded quickly. Swift_Mime_Headers_AbstractHeader
getTokenAsEncodedWord() Get a token as an encoded word for safe insertion into headers. Swift_Mime_Headers_AbstractHeader
setCachedValue() Set a value into the cache. Swift_Mime_Headers_AbstractHeader
setFieldName() Set the name of this Header field. Swift_Mime_Headers_AbstractHeader
toTokens() Generate a list of all tokens in the final header. Swift_Mime_Headers_AbstractHeader
tokenNeedsEncoding() Test if a token needs to be encoded or not. Swift_Mime_Headers_AbstractHeader

Method Details

__construct() public method

Creates a new IdentificationHeader with the given $name and $id.

public void __construct ( $name, Swift_Mime_Grammar $grammar )
$name string
$grammar Swift_Mime_Grammar
getFieldBody() public method

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 {@see toString()} for that).

See also toString().

public string getFieldBody ( )
throws Swift_RfcComplianceException
getFieldBodyModel() public method

Get the model for the field body.

This method returns an array of IDs

public array getFieldBodyModel ( )
getFieldType() public method

Get the type of Header that this instance represents.

See also:

  • [[TYPE_TEXT,]] TYPE_PARAMETERIZED, TYPE_MAILBOX.
  • [[TYPE_DATE,]] TYPE_ID, TYPE_PATH.
public int getFieldType ( )
getId() public method

Get the ID used in the value of this Header.

If multiple IDs are set only the first is returned.

public string getId ( )
getIds() public method

Get the list of IDs used in this Header.

public string[] getIds ( )
setFieldBodyModel() public method

Set the model for the field body.

This method takes a string ID, or an array of IDs.

public void setFieldBodyModel ( $model )
$model mixed
throws Swift_RfcComplianceException
setId() public method

Set the ID used in the value of this header.

public void setId ( $id )
$id string|array
throws Swift_RfcComplianceException
setIds() public method

Set a collection of IDs to use in the value of this Header.

public void setIds ( array $ids )
$ids string[]
throws Swift_RfcComplianceException