Class Swift_Mime_Headers_IdentificationHeader

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

Swift_Mime_Headers_AbstractHeader implements Swift_Mime_Header

Extended by

Swift_Mime_Headers_IdentificationHeader

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

Methods summary

`public`	# `__construct( string $name, Swift_Mime_Grammar $grammar )` Creates a new IdentificationHeader with the given $name and $id. Creates a new IdentificationHeader with the given $name and $id. 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( mixed $model )` Set the model for the field body. This method takes a string ID, or an array of IDs Set the model for the field body. This method takes a string ID, or an array of IDs Parameters `$model` `mixed` $model Throws `Swift_RfcComplianceException`
`public array`	# `getFieldBodyModel( )` Get the model for the field body. This method returns an array of IDs Get the model for the field body. This method returns an array of IDs Returns `array`
`public`	# `setId( string\|array $id )` Set the ID used in the value of this header. Set the ID used in the value of this header. Parameters `$id` `string\|array` $id Throws `Swift_RfcComplianceException`
`public string`	# `getId( )` Get the ID used in the value of this Header. If multiple IDs are set only the first is returned. Get the ID used in the value of this Header. If multiple IDs are set only the first is returned. Returns `string`
`public`	# `setIds( array $ids )` Set a collection of IDs to use in the value of this Header. Set a collection of IDs to use in the value of this Header. Parameters `$ids` `string[]` $ids Throws `Swift_RfcComplianceException`
`public string[]`	# `getIds( )` Get the list of IDs used in this Header. Get the list of IDs used in this Header. 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` Throws `Swift_RfcComplianceException` See `Swift_Mime_Headers_AbstractHeader::toString()`
`private`	# `_assertValidId( string $id )` Throws an Exception if the id passed does not comply with RFC 2822. Throws an Exception if the id passed does not comply with RFC 2822. Parameters `$id` `string` $id Throws `Swift_RfcComplianceException`

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[]`	`$_ids`	# The IDs used in the value of this Header. This may hold multiple IDs or just a single ID. The IDs used in the value of this Header. This may hold multiple IDs or just a single ID.