class Mail::Address
Public Class Methods
Mail::Address handles all email addresses in Mail. It takes an email address string and parses it, breaking it down into its component parts and allowing you to get the address, comments, display name, name, local part, domain part and fully formatted address.
Mail::Address requires a correctly formatted email address per RFC2822 or RFC822. It handles all obsolete versions including obsolete domain routing on the local part.
a = Address.new('Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>') a.format #=> 'Mikel Lindsaar <mikel@test.lindsaar.net> (My email address)' a.address #=> 'mikel@test.lindsaar.net' a.display_name #=> 'Mikel Lindsaar' a.local #=> 'mikel' a.domain #=> 'test.lindsaar.net' a.comments #=> ['My email address'] a.to_s #=> 'Mikel Lindsaar <mikel@test.lindsaar.net> (My email address)'
# File lib/mail/elements/address.rb, line 22 def initialize(value = nil) @output_type = :decode if value.nil? @parsed = false @data = nil return else parse(value) end end
Public Instance Methods
Returns the address that is in the address itself. That is, the local@domain string, without any angle brackets or the like.
a = Address.new('Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>') a.address #=> 'mikel@test.lindsaar.net'
# File lib/mail/elements/address.rb, line 64 def address parse unless @parsed domain ? "#{local}@#{domain}" : local end
Provides a way to assign an address to an already made Mail::Address object.
a = Address.new a.address = 'Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>' a.address #=> 'mikel@test.lindsaar.net'
# File lib/mail/elements/address.rb, line 74 def address=(value) parse(value) end
Returns an array of comments that are in the email, or an empty array if there are no comments
a = Address.new('Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>') a.comments #=> ['My email address']
# File lib/mail/elements/address.rb, line 123 def comments parse unless @parsed if get_comments.empty? nil else get_comments.map { |c| c.squeeze(" ") } end end
# File lib/mail/elements/address.rb, line 164 def decoded @output_type = :decode format end
Returns the display name of the email address passed in.
a = Address.new('Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>') a.display_name #=> 'Mikel Lindsaar'
# File lib/mail/elements/address.rb, line 82 def display_name parse unless @parsed @display_name ||= get_display_name Encodings.decode_encode(@display_name.to_s, @output_type) if @display_name end
Provides a way to assign a display name to an already made Mail::Address object.
a = Address.new a.address = 'mikel@test.lindsaar.net' a.display_name = 'Mikel Lindsaar' a.format #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>'
# File lib/mail/elements/address.rb, line 94 def display_name=( str ) @display_name = str end
Returns the domain part (the right hand side of the @ sign in the email address) of the address
a = Address.new('Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>') a.domain #=> 'test.lindsaar.net'
# File lib/mail/elements/address.rb, line 113 def domain parse unless @parsed strip_all_comments(get_domain) if get_domain end
# File lib/mail/elements/address.rb, line 159 def encoded @output_type = :encode format end
Returns a correctly formatted address for the email going out. If given an incorrectly formatted address as input, Mail::Address will do its best to format it correctly. This includes quoting display names as needed and putting the address in angle brackets etc.
a = Address.new('Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>') a.format #=> 'Mikel Lindsaar <mikel@test.lindsaar.net> (My email address)'
# File lib/mail/elements/address.rb, line 46 def format parse unless @parsed if @data.nil? '' elsif display_name [quote_phrase(display_name), "<#{address}>", format_comments].compact.join(" ") elsif address [address, format_comments].compact.join(" ") else raw end end
Shows the Address object basic details, including the Address
a = Address.new('Mikel (My email) <mikel@test.lindsaar.net>') a.inspect #=> "#<Mail::Address:14184910 Address: |Mikel <mikel@test.lindsaar.net> (My email)| >"
# File lib/mail/elements/address.rb, line 154 def inspect parse unless @parsed "#<#{self.class}:#{self.object_id} Address: |#{to_s}| >" end
Returns the local part (the left hand side of the @ sign in the email address) of the address
a = Address.new('Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>') a.local #=> 'mikel'
# File lib/mail/elements/address.rb, line 103 def local parse unless @parsed "#{@data.obs_domain_list}#{get_local.strip}" if get_local end
Sometimes an address will not have a display name, but might have the name as a comment field after the address. This returns that name if it exists.
a = Address.new('mikel@test.lindsaar.net (Mikel Lindsaar)') a.name #=> 'Mikel Lindsaar'
# File lib/mail/elements/address.rb, line 137 def name parse unless @parsed get_name end
Returns the raw input of the passed in string, this is before it is passed by the parser.
# File lib/mail/elements/address.rb, line 35 def raw @data.raw end
Returns the format of the address, or returns nothing
a = Address.new('Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>') a.format #=> 'Mikel Lindsaar <mikel@test.lindsaar.net> (My email address)'
# File lib/mail/elements/address.rb, line 146 def to_s parse unless @parsed format end
Private Instance Methods
# File lib/mail/elements/address.rb, line 248 def format_comments if comments comment_text = comments.map {|c| escape_paren(c) }.join(' ').squeeze(" ") @format_comments ||= "(#{comment_text})" else nil end end
# File lib/mail/elements/address.rb, line 265 def get_comments @data && @data.comments end
# File lib/mail/elements/address.rb, line 211 def get_display_name if @data.display_name str = strip_all_comments(@data.display_name.to_s) elsif @data.comments if @data.domain str = strip_domain_comments(format_comments) else str = nil end else nil end if str.blank? nil else str end end
# File lib/mail/elements/address.rb, line 261 def get_domain @data && @data.domain end
# File lib/mail/elements/address.rb, line 257 def get_local @data && @data.local end
# File lib/mail/elements/address.rb, line 231 def get_name if display_name str = display_name else if comments comment_text = comments.join(' ').squeeze(" ") str = "(#{comment_text})" end end if str.blank? nil else unparen(str) end end
# File lib/mail/elements/address.rb, line 171 def parse(value = nil) @parsed = true case value when NilClass @data = nil nil when Mail::Parsers::AddressStruct @data = value when String @raw_text = value if value.blank? @data = nil else address_list = Mail::Parsers::AddressListsParser.new.parse(value) @data = address_list.addresses.first end end end
# File lib/mail/elements/address.rb, line 191 def strip_all_comments(string) unless comments.blank? comments.each do |comment| string = string.gsub("(#{comment})", '') end end string.strip end
# File lib/mail/elements/address.rb, line 200 def strip_domain_comments(value) unless comments.blank? comments.each do |comment| if @data.domain && @data.domain.include?("(#{comment})") value = value.gsub("(#{comment})", '') end end end value.to_s.strip end