added "reply-to" capabilities
[squirrelmail.git] / doc / message_array.doc
1 Here is a map of the message array that contains all the information about
2 a message.  A single part message is handled the same as a multipart message,
3 except in the "ENTITIES" part, there would only be one entry (0).
4
5 $message     ["HEADER"]                    (array)
6                 ["TO"]                     (array)
7                 ["CC"]                     (array)
8                 ["SUBJECT"]                (string)
9                 ["FROM"]                   (string)
10                 ["REPLYTO"]                (string)
11                 ["MAILER"]                 (string)
12                 ["TYPE0"]                  (string)
13                 ["TYPE1"]                  (string)
14                 ["BOUNDARY"]               (string)
15                 ["CHARSET"]                (string)
16                 ["MIME"]                   (boolean)
17                 ["ENCODING"]               (string)
18
19              ["ENTITIES"]                  (array)
20                 [0]                        (array)
21                    ["TYPE0"]               (string)
22                    ["TYPE1"]               (string)
23                    ["CHARSET"]             (string)
24                    ["BOUNDARY"]            (string)
25                    ["PRIORITY"]            (integer)
26                    ["BODY"]                (array of strings)
27
28                 [1]                        (array)
29                    ["TYPE0"]               (string)
30                    ["TYPE1"]               (string)
31                    ["CHARSET"]             (string)
32                    ["BOUNDARY"]            (string)
33                    ["PRIORITY"]            (integer)
34                    ["BODY"]                (array of strings)
35              .
36              .
37              .
38
39
40 Example message:
41 ----------------------------------------------------------------------
42 $message     ["HEADER"]
43                   ["TO"]                     "luke@usa.om.org,"
44                                              "nathan@usa.om.org"
45                   ["CC"]                     "matt@usa.om.org"
46                   ["SUBJECT"]                "hey there.. just testing"
47                   ["FROM"]                   "typist@usa.om.org"
48                   ["REPLYTO"]                ""
49                   ["MAILER"]                 "SquirrelMail v0.0.1"
50                   ["TYPE0"]                  "multipart"
51                   ["TYPE1"]                  "alternative"
52                   ["BOUNDARY"]               "--blkjoaiu2093ojv0q9"
53                   ["CHARSET"]                "us-ascii"
54                   ["MIME"]                   true
55                   ["ENCODING"]               "us-ascii"
56
57              ["ENTITIES"]
58                   [0]
59                      ["TYPE0"]               "text"
60                      ["TYPE1"]               "plain"
61                      ["CHARSET"]             "us-ascii"
62                      ["BOUNDARY"]            ""
63                      ["PRIORITY"]            10
64                      ["BODY"]                "This is just a test to see"
65                                              "how this will handle a message"
66                                              "for this example"
67
68                  [1]
69                      ["TYPE0"]               "text"
70                      ["TYPE1"]               "html"
71                      ["CHARSET"]             "us-ascii"
72                      ["BOUNDARY"]            ""
73                      ["PRIORITY"]            20
74                      ["BODY"]                "<B>This is just a test to see</B><BR>"
75                                              "<FONT FACE="Arial,Helvetica">how this will handle a message"
76                                              "for this example</FONT>"