File: comments_field.rb

package info (click to toggle)
ruby-mail 2.6.4%2Bdfsg1-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 4,256 kB
  • ctags: 1,327
  • sloc: ruby: 44,678; makefile: 3
file content (42 lines) | stat: -rw-r--r-- 1,318 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# encoding: utf-8
# frozen_string_literal: true
# 
# = Comments Field
# 
# The Comments field inherits from UnstructuredField and handles the Comments:
# header field in the email.
# 
# Sending comments to a mail message will instantiate a Mail::Field object that
# has a CommentsField as its field type.
#  
# An email header can have as many comments fields as it wants.  There is no upper
# limit, the comments field is also optional (that is, no comment is needed)
# 
# == Examples:
# 
#  mail = Mail.new
#  mail.comments = 'This is a comment'
#  mail.comments    #=> 'This is a comment'
#  mail[:comments]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CommentsField:0x180e1c4
#  mail['comments'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CommentsField:0x180e1c4
#  mail['comments'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CommentsField:0x180e1c4
# 
#  mail.comments = "This is another comment"
#  mail[:comments].map { |c| c.to_s } 
#  #=> ['This is a comment', "This is another comment"]
#
module Mail
  class CommentsField < UnstructuredField
    
    FIELD_NAME = 'comments'
    CAPITALIZED_FIELD = 'Comments'
    
    def initialize(value = nil, charset = 'utf-8')
      @charset = charset
      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value))
      self.parse
      self
    end
    
  end
end