Module: Mail::CommonAddress

Overview

:nodoc:

Instance Method Summary collapse

Instance Method Details

#<<(val) ⇒ Object



84
85
86
87
88
89
90
91
92
93
# File 'lib/mail/fields/common/common_address.rb', line 84

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

#addressesObject

Returns the address string of all the addresses in the address list



32
33
34
35
# File 'lib/mail/fields/common/common_address.rb', line 32

def addresses
  list = address_list.addresses.map { |a| a.address }
  Mail::AddressContainer.new(self, list)
end

#addrsObject

Returns the actual address objects in the address list



50
51
52
53
# File 'lib/mail/fields/common/common_address.rb', line 50

def addrs
  list = address_list.addresses
  Mail::AddressContainer.new(self, list)
end

#charsetObject



16
17
18
# File 'lib/mail/fields/common/common_address.rb', line 16

def charset
  @charset
end

#decoded_group_addressesObject

Returns a list of decoded group addresses



66
67
68
# File 'lib/mail/fields/common/common_address.rb', line 66

def decoded_group_addresses
  groups.map { |k,v| v.map { |a| a.decoded } }.flatten
end

#defaultObject



80
81
82
# File 'lib/mail/fields/common/common_address.rb', line 80

def default
  addresses
end

#display_namesObject

Returns the display name of all the addresses in the address list



44
45
46
47
# File 'lib/mail/fields/common/common_address.rb', line 44

def display_names
  list = address_list.addresses.map { |a| a.display_name }
  Mail::AddressContainer.new(self, list)
end

#eachObject

Allows you to iterate through each address object in the address_list



25
26
27
28
29
# File 'lib/mail/fields/common/common_address.rb', line 25

def each
  address_list.addresses.each do |address|
    yield(address)
  end
end

#encode_if_needed(val) ⇒ Object



20
21
22
# File 'lib/mail/fields/common/common_address.rb', line 20

def encode_if_needed(val)
  Encodings.address_encode(val, charset)
end

#encoded_group_addressesObject

Returns a list of encoded group addresses



71
72
73
# File 'lib/mail/fields/common/common_address.rb', line 71

def encoded_group_addresses
  groups.map { |k,v| v.map { |a| a.encoded } }.flatten
end

#formattedObject

Returns the formatted string of all the addresses in the address list



38
39
40
41
# File 'lib/mail/fields/common/common_address.rb', line 38

def formatted
  list = address_list.addresses.map { |a| a.format }
  Mail::AddressContainer.new(self, list)
end

#group_addressesObject

Returns the addresses that are part of groups



61
62
63
# File 'lib/mail/fields/common/common_address.rb', line 61

def group_addresses
  decoded_group_addresses
end

#group_namesObject

Returns the name of all the groups in a string



76
77
78
# File 'lib/mail/fields/common/common_address.rb', line 76

def group_names # :nodoc:
  address_list.group_names
end

#groupsObject

Returns a hash of group name => address strings for the address list



56
57
58
# File 'lib/mail/fields/common/common_address.rb', line 56

def groups
  address_list.addresses_grouped_by_group
end

#parse(val = value) ⇒ Object



8
9
10
11
12
13
14
# File 'lib/mail/fields/common/common_address.rb', line 8

def parse(val = value)
  unless Utilities.blank?(val)
    @address_list = AddressList.new(encode_if_needed(val))
  else
    nil
  end
end

#value=(val) ⇒ Object



95
96
97
98
# File 'lib/mail/fields/common/common_address.rb', line 95

def value=(val)
  super
  parse(self.value)
end