123456789_123456789_123456789_123456789_123456789_

Class: Net::IMAP::BodyTypeBasic

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Struct
Instance Chain:
self, Struct
Inherits: Struct
  • Object
Defined in: lib/net/imap.rb

Overview

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 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

  • #content_id rw

    BodyTypeBasic represents basic body structures of messages.

  • #description rw

    BodyTypeBasic represents basic body structures of messages.

  • #disposition rw

    BodyTypeBasic represents basic body structures of messages.

  • #encoding rw

    BodyTypeBasic represents basic body structures of messages.

  • #extension rw

    BodyTypeBasic represents basic body structures of messages.

  • #language rw

    BodyTypeBasic represents basic body structures of messages.

  • #md5 rw

    BodyTypeBasic represents basic body structures of messages.

  • #media_type rw

    BodyTypeBasic represents basic body structures of messages.

  • #param rw

    BodyTypeBasic represents basic body structures of messages.

  • #size rw

    BodyTypeBasic represents basic body structures of messages.

  • #subtype rw

    BodyTypeBasic represents basic body structures of messages.

  • #multipart? ⇒ Boolean readonly

Instance Method Summary

Instance Attribute Details

#content_id (rw)

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 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.

[ GitHub ]

  
# File 'lib/net/imap.rb', line 1966

class BodyTypeBasic < Struct.new(:media_type, :subtype,
:param, :content_id,
:description, :encoding, :size,
:md5, :disposition, :language,
:extension)

#description (rw)

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 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.

[ GitHub ]

  
# File 'lib/net/imap.rb', line 1966

class BodyTypeBasic < Struct.new(:media_type, :subtype,
:param, :content_id,
:description, :encoding, :size,
:md5, :disposition, :language,
:extension)

#disposition (rw)

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 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.

[ GitHub ]

  
# File 'lib/net/imap.rb', line 1966

class BodyTypeBasic < Struct.new(:media_type, :subtype,
:param, :content_id,
:description, :encoding, :size,
:md5, :disposition, :language,
:extension)

#encoding (rw)

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 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.

[ GitHub ]

  
# File 'lib/net/imap.rb', line 1966

class BodyTypeBasic < Struct.new(:media_type, :subtype,
:param, :content_id,
:description, :encoding, :size,
:md5, :disposition, :language,
:extension)

#extension (rw)

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 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.

[ GitHub ]

  
# File 'lib/net/imap.rb', line 1966

class BodyTypeBasic < Struct.new(:media_type, :subtype,
:param, :content_id,
:description, :encoding, :size,
:md5, :disposition, :language,
:extension)

#language (rw)

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 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.

[ GitHub ]

  
# File 'lib/net/imap.rb', line 1966

class BodyTypeBasic < Struct.new(:media_type, :subtype,
:param, :content_id,
:description, :encoding, :size,
:md5, :disposition, :language,
:extension)

#md5 (rw)

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 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.

[ GitHub ]

  
# File 'lib/net/imap.rb', line 1966

class BodyTypeBasic < Struct.new(:media_type, :subtype,
:param, :content_id,
:description, :encoding, :size,
:md5, :disposition, :language,
:extension)

#media_type (rw)

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 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.

[ GitHub ]

  
# File 'lib/net/imap.rb', line 1966

class BodyTypeBasic < Struct.new(:media_type, :subtype,
:param, :content_id,
:description, :encoding, :size,
:md5, :disposition, :language,
:extension)

#multipart?Boolean (readonly)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 1971

def multipart?
  return false
end

#param (rw)

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 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.

[ GitHub ]

  
# File 'lib/net/imap.rb', line 1966

class BodyTypeBasic < Struct.new(:media_type, :subtype,
:param, :content_id,
:description, :encoding, :size,
:md5, :disposition, :language,
:extension)

#size (rw)

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 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.

[ GitHub ]

  
# File 'lib/net/imap.rb', line 1966

class BodyTypeBasic < Struct.new(:media_type, :subtype,
:param, :content_id,
:description, :encoding, :size,
:md5, :disposition, :language,
:extension)

#subtype (rw)

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 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.

[ GitHub ]

  
# File 'lib/net/imap.rb', line 1966

class BodyTypeBasic < Struct.new(:media_type, :subtype,
:param, :content_id,
:description, :encoding, :size,
:md5, :disposition, :language,
:extension)

Instance Method Details

#media_subtype

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

[ GitHub ]

  
# File 'lib/net/imap.rb', line 1978

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