address.go 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257
  1. package rfc5321
  2. import (
  3. "errors"
  4. "net"
  5. )
  6. // Parse productions according to ABNF in RFC5322
  7. type RFC5322 struct {
  8. AddressList
  9. Parser
  10. addr SingleAddress
  11. }
  12. type AddressList struct {
  13. List []SingleAddress
  14. Group string
  15. }
  16. type SingleAddress struct {
  17. DisplayName string
  18. DisplayNameQuoted bool
  19. LocalPart string
  20. LocalPartQuoted bool
  21. Domain string
  22. IP net.IP
  23. NullPath bool
  24. }
  25. var (
  26. errNotAtom = errors.New("not atom")
  27. errExpectingAngleAddress = errors.New("not angle address")
  28. errNotAWord = errors.New("not a word")
  29. errExpectingColon = errors.New("expecting : ")
  30. errExpectingSemicolon = errors.New("expecting ; ")
  31. errExpectingAngleClose = errors.New("expecting >")
  32. errExpectingAngleOpen = errors.New("< expected")
  33. errQuotedUnclosed = errors.New("quoted string not closed")
  34. )
  35. // Address parses the "address" production specified in RFC5322
  36. // address = mailbox / group
  37. func (s *RFC5322) Address(input []byte) (AddressList, error) {
  38. s.set(input)
  39. s.next()
  40. s.List = nil
  41. s.addr = SingleAddress{}
  42. if err := s.mailbox(); err != nil {
  43. if s.ch == ':' {
  44. if groupErr := s.group(); groupErr != nil {
  45. return s.AddressList, groupErr
  46. } else {
  47. err = nil
  48. }
  49. }
  50. return s.AddressList, err
  51. }
  52. return s.AddressList, nil
  53. }
  54. // group = display-name ":" [group-List] ";" [CFWS]
  55. func (s *RFC5322) group() error {
  56. if s.addr.DisplayName == "" {
  57. if err := s.displayName(); err != nil {
  58. return err
  59. }
  60. } else {
  61. s.Group = s.addr.DisplayName
  62. s.addr.DisplayName = ""
  63. }
  64. if s.ch != ':' {
  65. return errExpectingColon
  66. }
  67. s.next()
  68. _ = s.groupList()
  69. s.skipSpace()
  70. if s.ch != ';' {
  71. return errExpectingSemicolon
  72. }
  73. return nil
  74. }
  75. // mailbox = name-addr / addr-spec
  76. func (s *RFC5322) mailbox() error {
  77. pos := s.pos // save the position
  78. if err := s.nameAddr(); err != nil {
  79. if err == errExpectingAngleAddress && s.ch != ':' { // ':' means it's a group
  80. // we'll attempt to parse as an email address without angle brackets
  81. s.addr.DisplayName = ""
  82. s.addr.DisplayNameQuoted = false
  83. s.pos = pos - 1 //- 1 // rewind to the saved position
  84. if s.pos > -1 {
  85. s.ch = s.buf[s.pos]
  86. }
  87. if err = s.Parser.mailbox(); err != nil {
  88. return err
  89. }
  90. s.addAddress()
  91. } else {
  92. return err
  93. }
  94. }
  95. return nil
  96. }
  97. // addAddress ads the current address to the List
  98. func (s *RFC5322) addAddress() {
  99. s.addr.LocalPart = s.LocalPart
  100. s.addr.LocalPartQuoted = s.LocalPartQuotes
  101. s.addr.Domain = s.Domain
  102. s.addr.IP = s.IP
  103. s.List = append(s.List, s.addr)
  104. s.addr = SingleAddress{}
  105. }
  106. // nameAddr consumes the name-addr production.
  107. // name-addr = [display-name] angle-addr
  108. func (s *RFC5322) nameAddr() error {
  109. _ = s.displayName()
  110. if s.ch == '<' {
  111. if err := s.angleAddr(); err != nil {
  112. return err
  113. }
  114. s.next()
  115. if s.ch != '>' {
  116. return errExpectingAngleClose
  117. }
  118. s.addAddress()
  119. return nil
  120. } else {
  121. return errExpectingAngleAddress
  122. }
  123. }
  124. // angleAddr consumes the angle-addr production
  125. // angle-addr = [CFWS] "<" addr-spec ">" [CFWS] / obs-angle-addr
  126. func (s *RFC5322) angleAddr() error {
  127. s.skipSpace()
  128. if s.ch != '<' {
  129. return errExpectingAngleOpen
  130. }
  131. // addr-spec = local-part "@" domain
  132. if err := s.Parser.mailbox(); err != nil {
  133. return err
  134. }
  135. s.skipSpace()
  136. return nil
  137. }
  138. // displayName consumes the display-name production:
  139. // display-name = phrase
  140. // phrase = 1*word / obs-phrase
  141. func (s *RFC5322) displayName() error {
  142. defer func() {
  143. if s.accept.Len() > 0 {
  144. s.addr.DisplayName = s.accept.String()
  145. s.accept.Reset()
  146. }
  147. }()
  148. // phrase
  149. if err := s.word(); err != nil {
  150. return err
  151. }
  152. for {
  153. err := s.word()
  154. if err != nil {
  155. return nil
  156. }
  157. }
  158. }
  159. // quotedString consumes a quoted-string production
  160. func (s *RFC5322) quotedString() error {
  161. if s.ch == '"' {
  162. if err := s.Parser.QcontentSMTP(); err != nil {
  163. return err
  164. }
  165. if s.ch != '"' {
  166. return errQuotedUnclosed
  167. } else {
  168. // accept the "
  169. s.next()
  170. }
  171. }
  172. return nil
  173. }
  174. // word = atom / quoted-string
  175. func (s *RFC5322) word() error {
  176. if s.ch == '"' {
  177. s.addr.DisplayNameQuoted = true
  178. return s.quotedString()
  179. } else if s.isAtext(s.ch) || s.ch == ' ' || s.ch == '\t' {
  180. return s.atom()
  181. }
  182. return errNotAWord
  183. }
  184. // atom = [CFWS] 1*atext [CFWS]
  185. func (s *RFC5322) atom() error {
  186. s.skipSpace()
  187. if !s.isAtext(s.ch) {
  188. return errNotAtom
  189. }
  190. for {
  191. if s.isAtext(s.ch) {
  192. s.accept.WriteByte(s.ch)
  193. s.next()
  194. } else {
  195. skipped := s.skipSpace()
  196. if !s.isAtext(s.ch) {
  197. return nil
  198. }
  199. if skipped > 0 {
  200. s.accept.WriteByte(' ')
  201. }
  202. s.accept.WriteByte(s.ch)
  203. s.next()
  204. }
  205. }
  206. }
  207. // groupList consumes the "group-List" production:
  208. // group-List = mailbox-List / CFWS / obs-group-List
  209. func (s *RFC5322) groupList() error {
  210. // mailbox-list = (mailbox *("," mailbox))
  211. if err := s.mailbox(); err != nil {
  212. return err
  213. }
  214. s.next()
  215. for {
  216. s.skipSpace()
  217. if s.ch != ',' {
  218. return nil
  219. }
  220. s.next()
  221. s.skipSpace()
  222. if err := s.mailbox(); err != nil {
  223. return err
  224. }
  225. s.next()
  226. }
  227. }
  228. // skipSpace skips vertical space by calling next(), returning the count of spaces skipped
  229. func (s *RFC5322) skipSpace() int {
  230. var skipped int
  231. for {
  232. if s.ch != ' ' && s.ch != 9 {
  233. return skipped
  234. }
  235. s.next()
  236. skipped++
  237. }
  238. }