Classes List

Swift_Mime_Header

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
<?php

/* * This file is part of SwiftMailer. * (c) 2004-2009 Chris Corbyn * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


/** * A MIME Header. * * @author Chris Corbyn */
interface Swift_Mime_Header
{
    /** Text headers */
    const TYPE_TEXT = 2;

    /** headers (text + params) */
    const TYPE_PARAMETERIZED = 6;

    /** Mailbox and address headers */
    const TYPE_MAILBOX = 8;

    /** Date and time headers */
    const TYPE_DATE = 16;

    /** Identification headers */
    const TYPE_ID = 32;

    /** Address path headers */
    const TYPE_PATH = 64;

    /** * Get the type of Header that this instance represents. * * @see TYPE_TEXT, TYPE_PARAMETERIZED, TYPE_MAILBOX * @see TYPE_DATE, TYPE_ID, TYPE_PATH * * @return int */
    public function getFieldType();

    /** * Set the model for the field body. * * The actual types needed will vary depending upon the type of Header. * * @param mixed $model */
    public function setFieldBodyModel($model);

    /** * Set the charset used when rendering the Header. * * @param string $charset */
    public function setCharset($charset);

    /** * Get the model for the field body. * * The return type depends on the specifics of the Header. * * @return mixed */
    public function getFieldBodyModel();

    /** * Get the name of this header (e.g. Subject). * * The name is an identifier and as such will be immutable. * * @return string */
    public function getFieldName();

    /** * Get the field body, prepared for folding into a final header value. * * @return string */
    public function getFieldBody();

    /** * Get this Header rendered as a compliant string, including trailing CRLF. * * @return string */
    public function toString();
}