doc/message_array.html

   1 <p>
   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).
   5 </p>
   6
   7 <pre>
   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)
  21                 ["MESSAGE-ID"]             (string)
  22
  23              ["ENTITIES"]                  (array)
  24                 [0]                        (array)
  25                    ["TYPE0"]               (string)
  26                    ["TYPE1"]               (string)
  27                    ["CHARSET"]             (string)
  28                    ["BOUNDARY"]            (string)
  29                    ["PRIORITY"]            (integer)
  30                    ["BODY"]                (array of strings)
  31
  32                 [1]                        (array)
  33                    ["TYPE0"]               (string)
  34                    ["TYPE1"]               (string)
  35                    ["CHARSET"]             (string)
  36                    ["BOUNDARY"]            (string)
  37                    ["PRIORITY"]            (integer)
  38                    ["BODY"]                (array of strings)
  39              .
  40              .
  41              .
  42
  43
  44 Example message:
  45 ----------------------------------------------------------------------
  46 $message     ["HEADER"]
  47                   ["TO"]                     "luke@usa.om.org,"
  48                                              "nathan@usa.om.org"
  49                   ["CC"]                     "matt@usa.om.org"
  50                   ["SUBJECT"]                "hey there.. just testing"
  51                   ["FROM"]                   "typist@usa.om.org"
  52                   ["REPLYTO"]                ""
  53                   ["MAILER"]                 "SquirrelMail v0.0.1"
  54                   ["TYPE0"]                  "multipart"
  55                   ["TYPE1"]                  "alternative"
  56                   ["BOUNDARY"]               "--blkjoaiu2093ojv0q9"
  57                   ["CHARSET"]                "us-ascii"
  58                   ["MIME"]                   true
  59                   ["ENCODING"]               "us-ascii"
  60
  61              ["ENTITIES"]
  62                   [0]
  63                      ["TYPE0"]               "text"
  64                      ["TYPE1"]               "plain"
  65                      ["CHARSET"]             "us-ascii"
  66                      ["BOUNDARY"]            ""
  67                      ["PRIORITY"]            10
  68                      ["BODY"]                "This is just a test to see"
  69                                              "how this will handle a message"
  70                                              "for this example"
  71
  72                  [1]
  73                      ["TYPE0"]               "text"
  74                      ["TYPE1"]               "html"
  75                      ["CHARSET"]             "us-ascii"
  76                      ["BOUNDARY"]            ""
  77                      ["PRIORITY"]            20
  78                      ["BODY"]                "&lt;B>This is just a test to see&lt;/B>&lt;BR>"
  79                                              "&lt;FONT FACE="Arial,Helvetica">how this will handle a message"
  80                                              "for this example&lt;/FONT>"
  81 </pre>