1: <?php
2:
3: /*
4: * This file is part of SwiftMailer.
5: * (c) 2004-2009 Chris Corbyn
6: *
7: * For the full copyright and license information, please view the LICENSE
8: * file that was distributed with this source code.
9: */
10:
11: /**
12: * Creates MIME headers.
13: * @package Swift
14: * @subpackage Mime
15: * @author Chris Corbyn
16: */
17: interface Swift_Mime_HeaderFactory extends Swift_Mime_CharsetObserver
18: {
19: /**
20: * Create a new Mailbox Header with a list of $addresses.
21: * @param string $name
22: * @param array|string $addresses
23: * @return Swift_Mime_Header
24: */
25: public function createMailboxHeader($name, $addresses = null);
26:
27: /**
28: * Create a new Date header using $timestamp (UNIX time).
29: * @param string $name
30: * @param int $timestamp
31: * @return Swift_Mime_Header
32: */
33: public function createDateHeader($name, $timestamp = null);
34:
35: /**
36: * Create a new basic text header with $name and $value.
37: * @param string $name
38: * @param string $value
39: * @return Swift_Mime_Header
40: */
41: public function createTextHeader($name, $value = null);
42:
43: /**
44: * Create a new ParameterizedHeader with $name, $value and $params.
45: * @param string $name
46: * @param string $value
47: * @param array $params
48: * @return Swift_Mime_ParameterizedHeader
49: */
50: public function createParameterizedHeader($name, $value = null, $params = array());
51:
52: /**
53: * Create a new ID header for Message-ID or Content-ID.
54: * @param string $name
55: * @param string|array $ids
56: * @return Swift_Mime_Header
57: */
58: public function createIdHeader($name, $ids = null);
59:
60: /**
61: * Create a new Path header with an address (path) in it.
62: * @param string $name
63: * @param string $path
64: * @return Swift_Mime_Header
65: */
66: public function createPathHeader($name, $path = null);
67: }
68: