Interface Swift_Mime_Header

A MIME Header.

Direct known implementers

Swift_Mime_Headers_AbstractHeader, Swift_Mime_ParameterizedHeader

Indirect known implementers

Swift_Mime_Headers_DateHeader, Swift_Mime_Headers_IdentificationHeader, Swift_Mime_Headers_MailboxHeader, Swift_Mime_Headers_ParameterizedHeader, Swift_Mime_Headers_PathHeader, Swift_Mime_Headers_UnstructuredHeader

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

Methods summary

`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. The actual types needed will vary depending upon the type of Header. Set the model for the field body. The actual types needed will vary depending upon the type of Header. Parameters `$model` `mixed` $model
`public`	# `setCharset( string $charset )` Set the charset used when rendering the Header. Set the charset used when rendering the Header. Parameters `$charset` `string` $charset
`public mixed`	# `getFieldBodyModel( )` Get the model for the field body. The return type depends on the specifics of the Header. Get the model for the field body. The return type depends on the specifics of the Header. Returns `mixed`
`public string`	# `getFieldName( )` Get the name of this header (e.g. Subject). The name is an identifier and as such will be immutable. Get the name of this header (e.g. Subject). The name is an identifier and as such will be immutable. Returns `string`
`public string`	# `getFieldBody( )` Get the field body, prepared for folding into a final header value. Get the field body, prepared for folding into a final header value. Returns `string`
`public string`	# `toString( )` Get this Header rendered as a compliant string. Get this Header rendered as a compliant string. Returns `string`

Magic methods summary

Constants summary

`integer`	`TYPE_TEXT`	`2`	# Text headers Text headers
`integer`	`TYPE_PARAMETERIZED`	`6`	# Parameterized headers (text + params) Parameterized headers (text + params)
`integer`	`TYPE_MAILBOX`	`8`	# Mailbox and address headers Mailbox and address headers
`integer`	`TYPE_DATE`	`16`	# Date and time headers Date and time headers
`integer`	`TYPE_ID`	`32`	# Identification headers Identification headers
`integer`	`TYPE_PATH`	`64`	# Address path headers Address path headers