File: common_address_field.rb

package info (click to toggle)
ruby-mail 2.8.1%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 5,704 kB
  • sloc: ruby: 73,709; makefile: 3
file content (170 lines) | stat: -rw-r--r-- 4,827 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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
# encoding: utf-8
# frozen_string_literal: true
require 'mail/fields/named_structured_field'

module Mail
  class AddressContainer < Array #:nodoc:
    def initialize(field, list = nil)
      @field = field
      super list if list
    end

    def <<(address)
      @field << address
    end
  end

  class CommonAddressField < NamedStructuredField #:nodoc:
    def self.singular?
      true
    end

    def initialize(value = nil, charset = nil)
      super encode_if_needed(value, charset), charset
    end

    def element # :nodoc:
      @element ||= AddressList.new(value)
    end

    # Allows you to iterate through each address object in the address_list
    def each
      element.addresses.each do |address|
        yield(address)
      end
    end

    def default
      addresses
    end

    def address
      addresses.first
    end

    # Returns the address string of all the addresses in the address list
    def addresses
      list = element.addresses.map { |a| a.address }
      Mail::AddressContainer.new(self, list)
    end

    # Returns the formatted string of all the addresses in the address list
    def formatted
      list = element.addresses.map { |a| a.format }
      Mail::AddressContainer.new(self, list)
    end

    # Returns the display name of all the addresses in the address list
    def display_names
      list = element.addresses.map { |a| a.display_name }
      Mail::AddressContainer.new(self, list)
    end

    # Returns the actual address objects in the address list
    def addrs
      list = element.addresses
      Mail::AddressContainer.new(self, list)
    end

    # Returns a hash of group name => address strings for the address list
    def groups
      element.addresses_grouped_by_group
    end

    # Returns the addresses that are part of groups
    def group_addresses
      decoded_group_addresses
    end

    # Returns a list of decoded group addresses
    def decoded_group_addresses
      groups.map { |k,v| v.map { |a| a.decoded } }.flatten
    end

    # Returns a list of encoded group addresses
    def encoded_group_addresses
      groups.map { |k,v| v.map { |a| a.encoded } }.flatten
    end

    # Returns the name of all the groups in a string
    def group_names # :nodoc:
      element.group_names
    end

    def <<(val)
      case
      when val.nil?
        raise ArgumentError, "Need to pass an address to <<"
      when Utilities.blank?(val)
        self
      else
        self.value = [self.value, encode_if_needed(val)].reject { |a| Utilities.blank?(a) }.join(", ")
      end
    end

    def encode_if_needed(val, val_charset = charset) #:nodoc:
      case val
      when nil
        val

      # Need to join arrays of addresses into a single value
      when Array
        val.compact.map { |a| encode_if_needed a, val_charset }.join(', ')

      # Pass through UTF-8; encode non-UTF-8.
      else
        utf8_if_needed(val, val_charset) || Encodings.encode_non_usascii(val, val_charset)
      end
    end

    private
      if 'string'.respond_to?(:encoding)
        # Pass through UTF-8 addresses
        def utf8_if_needed(val, val_charset)
          if val_charset =~ /\AUTF-?8\z/i
            val
          elsif val.encoding == Encoding::UTF_8
            val
          elsif (utf8 = val.dup.force_encoding(Encoding::UTF_8)).valid_encoding?
            utf8
          end
        end
      else
        def utf8_if_needed(val, val_charset)
          if val_charset =~ /\AUTF-?8\z/i
            val
          end
        end
      end

      def do_encode
        return '' if Utilities.blank?(value)
        address_array = element.addresses.reject { |a| encoded_group_addresses.include?(a.encoded) }.compact.map { |a| a.encoded }
        address_text  = address_array.join(", \r\n\s")
        group_array = groups.map { |k,v| "#{k}: #{v.map { |a| a.encoded }.join(", \r\n\s")};" }
        group_text  = group_array.join(" \r\n\s")
        return_array = [address_text, group_text].reject { |a| Utilities.blank?(a) }
        "#{name}: #{return_array.join(", \r\n\s")}\r\n"
      end

      def do_decode
        return nil if Utilities.blank?(value)
        address_array = element.addresses.reject { |a| decoded_group_addresses.include?(a.decoded) }.map { |a| a.decoded }
        address_text  = address_array.join(", ")
        group_array = groups.map { |k,v| "#{k}: #{v.map { |a| a.decoded }.join(", ")};" }
        group_text  = group_array.join(" ")
        return_array = [address_text, group_text].reject { |a| Utilities.blank?(a) }
        return_array.join(", ")
      end

      def get_group_addresses(group_list)
        if group_list.respond_to?(:addresses)
          group_list.addresses.map do |address|
            Mail::Address.new(address)
          end
        else
          []
        end
      end
  end
end