Added feature #15998: Create a new API to send mails based on SwiftMailer to replace...
[Packages/TYPO3.CMS.git] / typo3 / contrib / swiftmailer / classes / Swift / Mime / HeaderFactory.php
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 //@require 'Swift/Mime/CharsetObserver.php';
12
13 /**
14 * Creates MIME headers.
15 * @package Swift
16 * @subpackage Mime
17 * @author Chris Corbyn
18 */
19 interface Swift_Mime_HeaderFactory extends Swift_Mime_CharsetObserver
20 {
21
22 /**
23 * Create a new Mailbox Header with a list of $addresses.
24 * @param string $name
25 * @param array|string $addresses
26 * @return Swift_Mime_Header
27 */
28 public function createMailboxHeader($name, $addresses = null);
29
30 /**
31 * Create a new Date header using $timestamp (UNIX time).
32 * @param string $name
33 * @param int $timestamp
34 * @return Swift_Mime_Header
35 */
36 public function createDateHeader($name, $timestamp = null);
37
38 /**
39 * Create a new basic text header with $name and $value.
40 * @param string $name
41 * @param string $value
42 * @return Swift_Mime_Header
43 */
44 public function createTextHeader($name, $value = null);
45
46 /**
47 * Create a new ParameterizedHeader with $name, $value and $params.
48 * @param string $name
49 * @param string $value
50 * @param array $params
51 * @return Swift_Mime_ParameterizedHeader
52 */
53 public function createParameterizedHeader($name, $value = null,
54 $params = array());
55
56 /**
57 * Create a new ID header for Message-ID or Content-ID.
58 * @param string $name
59 * @param string|array $ids
60 * @return Swift_Mime_Header
61 */
62 public function createIdHeader($name, $ids = null);
63
64 /**
65 * Create a new Path header with an address (path) in it.
66 * @param string $name
67 * @param string $path
68 * @return Swift_Mime_Header
69 */
70 public function createPathHeader($name, $path = null);
71
72 }