Class: Mail::ReturnPathField

Inherits:
StructuredField show all
Includes:
CommonAddress
Defined in:
lib/mail/fields/return_path_field.rb

Constant Summary collapse

FIELD_NAME = 
'return-path'
CAPITALIZED_FIELD = 
'Return-Path'

Constants included from Utilities

Utilities::CRLF, Utilities::LF, Utilities::TO_CRLF_REGEX

Constants included from Constants

Constants::ASTERISK, Constants::ATOM_UNSAFE, Constants::B_VALUES, Constants::CAPITAL_M, Constants::COLON, Constants::CONTROL_CHAR, Constants::CR, Constants::CRLF, Constants::CR_ENCODED, Constants::EMPTY, Constants::ENCODED_VALUE, Constants::EQUAL_LF, Constants::FIELD_BODY, Constants::FIELD_LINE, Constants::FIELD_PREFIX, Constants::FIELD_SPLIT, Constants::FULL_ENCODED_VALUE, Constants::FWS, Constants::HEADER_LINE, Constants::HEADER_SPLIT, Constants::HYPHEN, Constants::LF, Constants::LF_ENCODED, Constants::NULL_SENDER, Constants::PHRASE_UNSAFE, Constants::QP_SAFE, Constants::QP_UNSAFE, Constants::Q_VALUES, Constants::SPACE, Constants::TEXT, Constants::TOKEN_UNSAFE, Constants::UNDERSCORE, Constants::WSP

Instance Method Summary collapse

Methods included from CommonAddress

#<<, #addresses, #addrs, #charset, #decoded_group_addresses, #display_names, #each, #encode_if_needed, #encoded_group_addresses, #formatted, #group_addresses, #group_names, #groups, #parse, #value=

Methods inherited from StructuredField

#charset, #charset=, #errors

Methods included from Utilities

#atom_safe?, binary_unsafe_to_crlf, binary_unsafe_to_lf, blank?, #bracket, #capitalize_field, #constantize, #dasherize, #dquote, #escape_paren, #map_lines, #map_with_index, #match_to_s, #paren, #quote_atom, #quote_phrase, #quote_token, safe_for_line_ending_conversion?, to_crlf, to_lf, #token_safe?, #unbracket, #underscoreize, unescape, #unparen, unquote, #uri_escape, #uri_parser, #uri_unescape

Methods included from CommonField

#field_length, #name, #name=, #responsible_for?, #to_s, #value, #value=

Constructor Details

#initialize(value = nil, charset = 'utf-8') ⇒ ReturnPathField

Returns a new instance of ReturnPathField.



41
42
43
44
45
46
 
# File 'lib/mail/fields/return_path_field.rb', line 41

def initialize(value = nil, charset = 'utf-8')
  value = nil if value == '<>'
  self.charset = charset
  super(CAPITALIZED_FIELD, value, charset)
  self
end

Instance Method Details

#address ⇒ Object 



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

def address
  addresses.first
end

#decoded ⇒ Object 



52
53
54
 
# File 'lib/mail/fields/return_path_field.rb', line 52

def decoded
  do_decode
end

#default ⇒ Object 



60
61
62
 
# File 'lib/mail/fields/return_path_field.rb', line 60

def default
  address
end

#encoded ⇒ Object 



48
49
50
 
# File 'lib/mail/fields/return_path_field.rb', line 48

def encoded
  "#{CAPITALIZED_FIELD}: <#{address}>\r\n"
end