[squirrelmail.git] / doc / message_array.html

<p>
Here is a map of the message array that contains all the information about
a message.  A single part message is handled the same as a multipart message,
except in the "ENTITIES" part, there would only be one entry (0).
</p>

<pre>
$message     ["HEADER"]                    (array)
                ["TO"]                     (array)
                ["CC"]                     (array)
                ["SUBJECT"]                (string)
                ["FROM"]                   (string)
                ["REPLYTO"]                (string)
                ["MAILER"]                 (string)
                ["TYPE0"]                  (string)
                ["TYPE1"]                  (string)
                ["BOUNDARY"]               (string)
                ["CHARSET"]                (string)
                ["MIME"]                   (boolean)
                ["ENCODING"]               (string)

             ["ENTITIES"]                  (array)
                [0]                        (array)
                   ["TYPE0"]               (string)
                   ["TYPE1"]               (string)
                   ["CHARSET"]             (string)
                   ["BOUNDARY"]            (string)
                   ["PRIORITY"]            (integer)
                   ["BODY"]                (array of strings)

                [1]                        (array)
                   ["TYPE0"]               (string)
                   ["TYPE1"]               (string)
                   ["CHARSET"]             (string)
                   ["BOUNDARY"]            (string)
                   ["PRIORITY"]            (integer)
                   ["BODY"]                (array of strings)
             .
             .
             .


Example message:
----------------------------------------------------------------------
$message     ["HEADER"]
                  ["TO"]                     "luke@usa.om.org,"
                                             "nathan@usa.om.org"
                  ["CC"]                     "matt@usa.om.org"
                  ["SUBJECT"]                "hey there.. just testing"
                  ["FROM"]                   "typist@usa.om.org"
                  ["REPLYTO"]                ""
                  ["MAILER"]                 "SquirrelMail v0.0.1"
                  ["TYPE0"]                  "multipart"
                  ["TYPE1"]                  "alternative"
                  ["BOUNDARY"]               "--blkjoaiu2093ojv0q9"
                  ["CHARSET"]                "us-ascii"
                  ["MIME"]                   true
                  ["ENCODING"]               "us-ascii"

             ["ENTITIES"]
                  [0]
                     ["TYPE0"]               "text"
                     ["TYPE1"]               "plain"
                     ["CHARSET"]             "us-ascii"
                     ["BOUNDARY"]            ""
                     ["PRIORITY"]            10
                     ["BODY"]                "This is just a test to see"
                                             "how this will handle a message"
                                             "for this example"

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