Class: Net::IMAP::BodyTypeBasic

Inherits:
Struct
  • Object
show all
Defined in:
lib/net/imap.rb

Overview

Net::IMAP::BodyTypeBasic represents basic body structures of messages.

Fields:

media_type

Returns the content media type name as defined in [MIME-IMB].

subtype

Returns the content subtype name as defined in [MIME-IMB].

param

Returns a hash that represents parameters as defined in [MIME-IMB].

content_id

Returns a string giving the content id as defined in [MIME-IMB].

description

Returns a string giving the content description as defined in [MIME-IMB].

encoding

Returns a string giving the content transfer encoding as defined in [MIME-IMB].

size

Returns a number giving the size of the body in octets.

md5

Returns a string giving the body MD5 value as defined in [MD5].

disposition

Returns a Net::IMAP::ContentDisposition object giving the content disposition.

language

Returns a string or an array of strings giving the body language value as defined in [LANGUAGE-TAGS].

extension

Returns extension data.

multipart?

Returns false.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#content_id ⇒ Object

Returns the value of attribute content_id

Returns:

  • (Object) —

    the current value of content_id



1752
1753
1754
 
# File 'lib/net/imap.rb', line 1752

def content_id
  @content_id
end

#description ⇒ Object

Returns the value of attribute description

Returns:

  • (Object) —

    the current value of description



1752
1753
1754
 
# File 'lib/net/imap.rb', line 1752

def description
  @description
end

#disposition ⇒ Object

Returns the value of attribute disposition

Returns:

  • (Object) —

    the current value of disposition



1752
1753
1754
 
# File 'lib/net/imap.rb', line 1752

def disposition
  @disposition
end

#encoding ⇒ Object

Returns the value of attribute encoding

Returns:

  • (Object) —

    the current value of encoding



1752
1753
1754
 
# File 'lib/net/imap.rb', line 1752

def encoding
  @encoding
end

#extension ⇒ Object

Returns the value of attribute extension

Returns:

  • (Object) —

    the current value of extension



1752
1753
1754
 
# File 'lib/net/imap.rb', line 1752

def extension
  @extension
end

#language ⇒ Object

Returns the value of attribute language

Returns:

  • (Object) —

    the current value of language



1752
1753
1754
 
# File 'lib/net/imap.rb', line 1752

def language
  @language
end

#md5 ⇒ Object

Returns the value of attribute md5

Returns:

  • (Object) —

    the current value of md5



1752
1753
1754
 
# File 'lib/net/imap.rb', line 1752

def md5
  @md5
end

#media_type ⇒ Object

Returns the value of attribute media_type

Returns:

  • (Object) —

    the current value of media_type



1752
1753
1754
 
# File 'lib/net/imap.rb', line 1752

def media_type
  @media_type
end

#param ⇒ Object

Returns the value of attribute param

Returns:

  • (Object) —

    the current value of param



1752
1753
1754
 
# File 'lib/net/imap.rb', line 1752

def param
  @param
end

#size ⇒ Object

Returns the value of attribute size

Returns:

  • (Object) —

    the current value of size



1752
1753
1754
 
# File 'lib/net/imap.rb', line 1752

def size
  @size
end

#subtype ⇒ Object

Returns the value of attribute subtype

Returns:

  • (Object) —

    the current value of subtype



1752
1753
1754
 
# File 'lib/net/imap.rb', line 1752

def subtype
  @subtype
end

Instance Method Details

#media_subtype ⇒ Object

Obsolete: use subtype instead. Calling this will generate a warning message to stderr, then return the value of subtype.



1764
1765
1766
1767
1768
 
# File 'lib/net/imap.rb', line 1764

def media_subtype
  $stderr.printf("warning: media_subtype is obsolete.\n")
  $stderr.printf("         use subtype instead.\n")
  return subtype
end

#multipart? ⇒ Boolean

Returns:

  • (Boolean) 


1757
1758
1759
 
# File 'lib/net/imap.rb', line 1757

def multipart?
  return false
end