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
|
# encoding: utf-8
# frozen_string_literal: true
#
# = Blind Carbon Copy Field
#
# The Bcc field inherits from StructuredField and handles the Bcc: header
# field in the email.
#
# Sending bcc to a mail message will instantiate a Mail::Field object that
# has a BccField as its field type. This includes all Mail::CommonAddress
# module instance metods.
#
# Only one Bcc field can appear in a header, though it can have multiple
# addresses and groups of addresses.
#
# == Examples:
#
# mail = Mail.new
# mail.bcc = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
# mail.bcc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
# mail[:bcc] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::BccField:0x180e1c4
# mail['bcc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::BccField:0x180e1c4
# mail['Bcc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::BccField:0x180e1c4
#
# mail[:bcc].encoded #=> '' # Bcc field does not get output into an email
# mail[:bcc].decoded #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
# mail[:bcc].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
# mail[:bcc].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
#
require 'mail/fields/common/common_address'
module Mail
class BccField < StructuredField
include Mail::CommonAddress
FIELD_NAME = 'bcc'
CAPITALIZED_FIELD = 'Bcc'
def initialize(value = '', charset = 'utf-8')
@charset = charset
super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
self
end
def include_in_headers=(include_in_headers)
@include_in_headers = include_in_headers
end
def include_in_headers
defined?(@include_in_headers) ? @include_in_headers : self.include_in_headers = false
end
# Bcc field should not be :encoded by default
def encoded
if include_in_headers
do_encode(CAPITALIZED_FIELD)
else
''
end
end
def decoded
do_decode
end
end
end
|