Sha256: 65bd707c391cccb9817ae1743c962179747754a9142ed57f0296249b8d40d96d
Contents?: true
Size: 1.42 KB
Versions: 14
Compression:
Stored size: 1.42 KB
Contents
# encoding: utf-8
# frozen_string_literal: true
require 'mail/fields/common_address_field'
module Mail
# = From Field
#
# The From field inherits from StructuredField and handles the From: header
# field in the email.
#
# Sending from to a mail message will instantiate a Mail::Field object that
# has a FromField as its field type. This includes all Mail::CommonAddress
# module instance metods.
#
# Only one From field can appear in a header, though it can have multiple
# addresses and groups of addresses.
#
# == Examples:
#
# mail = Mail.new
# mail.from = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
# mail.from #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
# mail[:from] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
# mail['from'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
# mail['From'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
#
# mail[:from].encoded #=> 'from: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
# mail[:from].decoded #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
# mail[:from].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
# mail[:from].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
class FromField < CommonAddressField #:nodoc:
NAME = 'From'
end
end
Version data entries
14 entries across 14 versions & 5 rubygems