Skip to content

Commit 76db355

Browse files
committed
📚 Document Address "group syntax"
1 parent b5f38c9 commit 76db355

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

lib/net/imap/response_data.rb

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -786,6 +786,14 @@ class Envelope < Struct.new(:date, :subject, :from, :sender, :reply_to,
786786
# parsed into its component parts by the server. Address objects are
787787
# returned within Envelope fields.
788788
#
789+
# === Group syntax
790+
#
791+
# When the #host field is +nil+, this is a special form of address structure
792+
# that indicates the [RFC5322[https://tools.ietf.org/html/rfc5322]] group
793+
# syntax. If the #mailbox name field is also +nil+, this is an end-of-group
794+
# marker (semicolon in RFC-822 syntax). If the #mailbox name field is
795+
# non-+NIL+, this is the start of a group marker, and the mailbox #name
796+
# field holds the group name phrase.
789797
class Address < Struct.new(:name, :route, :mailbox, :host)
790798
##
791799
# method: name

0 commit comments

Comments
 (0)