Class: IMAP (Net)

Overview
Module Structure
Class Hierarchy
Constants
IMAP::SEEN
IMAP::ANSWERED
IMAP::FLAGGED
IMAP::DELETED
IMAP::DRAFT
IMAP::RECENT
IMAP::NOINFERIORS
IMAP::NOSELECT
IMAP::MARKED
IMAP::UNMARKED
IMAP::CRLF
IMAP::PORT
IMAP::DATE_MONTH
IMAP::ContinuationRequest
IMAP::UntaggedResponse
IMAP::TaggedResponse
IMAP::ResponseText
IMAP::ResponseCode
IMAP::MailboxList
IMAP::MailboxQuota
IMAP::MailboxQuotaRoot
IMAP::MailboxACLItem
IMAP::StatusData
IMAP::FetchData
IMAP::Envelope
IMAP::Address
IMAP::ContentDisposition
IMAP::ThreadMember
Class Methods
IMAP.debug
IMAP.debug= / 1
IMAP.add_authenticator / 2
IMAP.decode_utf7 / 1
IMAP.encode_utf7 / 1
IMAP.u16tou8 / 1
IMAP.u8tou16 / 1
Instance Attributes
IMAP#greeting [R]
IMAP#responses [R]
IMAP#response_handlers [R]
IMAP#client_thread [RW]
Instance Methods
IMAP#disconnect
IMAP#disconnected?
IMAP#capability
IMAP#noop
IMAP#logout
IMAP#authenticate / 2
IMAP#login / 2
IMAP#select / 1
IMAP#examine / 1
IMAP#create / 1
IMAP#delete / 1
IMAP#rename / 2
IMAP#subscribe / 1
IMAP#unsubscribe / 1
IMAP#list / 2
IMAP#getquotaroot / 1
IMAP#getquota / 1
IMAP#setquota / 2
IMAP#setacl / 3
IMAP#getacl / 1
IMAP#lsub / 2
IMAP#status / 2
IMAP#append / 4
IMAP#check
IMAP#close
IMAP#expunge
IMAP#search / 2
IMAP#uid_search / 2
IMAP#fetch / 2
IMAP#uid_fetch / 2
IMAP#store / 3
IMAP#uid_store / 3
IMAP#copy / 2
IMAP#uid_copy / 2
IMAP#sort / 3
IMAP#uid_sort / 3
IMAP#add_response_handler / 1
IMAP#remove_response_handler / 1
IMAP#thread / 3
IMAP#uid_thread / 3
IMAP#initialize / 5
IMAP#receive_responses
IMAP#get_tagged_response / 1
IMAP#pick_up_tagged_response / 1
IMAP#get_response
IMAP#record_response / 2
IMAP#send_command / 3
IMAP#generate_tag
IMAP#put_string / 1
IMAP#send_data / 1
IMAP#send_string_data / 1
IMAP#send_quoted_string / 1
IMAP#send_literal / 1
IMAP#send_number_data / 1
IMAP#send_list_data / 1
IMAP#send_time_data / 1
IMAP#send_symbol_data / 1
IMAP#search_internal / 3
IMAP#fetch_internal / 3
IMAP#store_internal / 4
IMAP#copy_internal / 3
IMAP#sort_internal / 4
IMAP#thread_internal / 4
IMAP#normalize_searching_criteria / 1
is a submodule of
module: Net   
is modularized into
class: RawData   
class: Atom   
class: QuotedString   
class: Literal   
class: MessageSet   
class: BodyTypeBasic   
class: BodyTypeText   
class: BodyTypeMessage   
class: BodyTypeMultipart   
class: ResponseParser   
includes
  SSL ( Unknown-Module )
  MonitorMixin   
  OpenSSL   
inherits from
  Object ( Builtin-Module )
has properties
attribute: greeting [R]   
attribute: responses [R]   
attribute: response_handlers [R]   
attribute: client_thread [RW]   
constant: SEEN   
constant: ANSWERED   
constant: FLAGGED   
constant: DELETED   
constant: DRAFT   
constant: RECENT   
constant: NOINFERIORS   
constant: NOSELECT   
constant: MARKED   
constant: UNMARKED   
class method: debug   
class method: debug= / 1   
class method: add_authenticator / 2   
method: disconnect   
method: disconnected?   
method: capability   
method: noop   
method: logout   
method: authenticate / 2   
method: login / 2   
method: select / 1   
method: examine / 1   
method: create / 1   
method: delete / 1   
method: rename / 2   
method: subscribe / 1   
method: unsubscribe / 1   
method: list / 2   
method: getquotaroot / 1   
method: getquota / 1   
method: setquota / 2   
method: setacl / 3   
method: getacl / 1   
method: lsub / 2   
method: status / 2   
method: append / 4   
method: check   
method: close   
method: expunge   
method: search / 2   
method: uid_search / 2   
method: fetch / 2   
method: uid_fetch / 2   
method: store / 3   
method: uid_store / 3   
method: copy / 2   
method: uid_copy / 2   
method: sort / 3   
method: uid_sort / 3   
method: add_response_handler / 1   
method: remove_response_handler / 1   
method: thread / 3   
method: uid_thread / 3   
class method: decode_utf7 / 1   
class method: encode_utf7 / 1   
constant: CRLF   
constant: PORT   
method: initialize / 5   
method: receive_responses   
method: get_tagged_response / 1   
method: pick_up_tagged_response / 1   
method: get_response   
method: record_response / 2   
method: send_command / 3   
method: generate_tag   
method: put_string / 1   
method: send_data / 1   
method: send_string_data / 1   
method: send_quoted_string / 1   
method: send_literal / 1   
method: send_number_data / 1   
method: send_list_data / 1   
constant: DATE_MONTH   
method: send_time_data / 1   
method: send_symbol_data / 1   
method: search_internal / 3   
method: fetch_internal / 3   
method: store_internal / 4   
method: copy_internal / 3   
method: sort_internal / 4   
method: thread_internal / 4   
method: normalize_searching_criteria / 1   
class method: u16tou8 / 1   
class method: u8tou16 / 1   
constant: ContinuationRequest   
constant: UntaggedResponse   
constant: TaggedResponse   
constant: ResponseText   
constant: ResponseCode   
constant: MailboxList   
constant: MailboxQuota   
constant: MailboxQuotaRoot   
constant: MailboxACLItem   
constant: StatusData   
constant: FetchData   
constant: Envelope   
constant: Address   
constant: ContentDisposition   
constant: ThreadMember   
is defined at
#200 in net/imap.rb  

Overview

Module Structure

  module: <Toplevel Module>
  module: <Built-in Module>
  module: <Unknown Module>
module: SSL     
  module: MonitorMixin
  module: OpenSSL
  module: Net
✗ class: IMAP
class: RawData     
class: Atom     
class: QuotedString     
class: Literal     
class: MessageSet     
class: BodyTypeBasic     
class: BodyTypeText     
class: BodyTypeMessage     
class: BodyTypeMultipart     
class: ResponseParser     

Class Hierarchy

Object ( Builtin-Module )
Struct ( Builtin-Module )
  BodyTypeBasic ( Net::IMAP )   
  BodyTypeText ( Net::IMAP )   
  BodyTypeMessage ( Net::IMAP )   
  BodyTypeMultipart ( Net::IMAP )   
IMAP ( Net )
includes
  SSL ( Unknown-Module )
  MonitorMixin   
  OpenSSL   
has properties
attribute: greeting [R]   
attribute: responses [R]   
attribute: response_handlers [R]   
attribute: client_thread [RW]   
constant: SEEN   
constant: ANSWERED   
constant: FLAGGED   
constant: DELETED   
constant: DRAFT   
constant: RECENT   
constant: NOINFERIORS   
constant: NOSELECT   
constant: MARKED   
constant: UNMARKED   
class method: debug   
class method: debug= / 1   
class method: add_authenticator / 2   
method: disconnect   
method: disconnected?   
method: capability   
method: noop   
method: logout   
method: authenticate / 2   
method: login / 2   
method: select / 1   
method: examine / 1   
method: create / 1   
method: delete / 1   
method: rename / 2   
method: subscribe / 1   
method: unsubscribe / 1   
method: list / 2   
method: getquotaroot / 1   
method: getquota / 1   
method: setquota / 2   
method: setacl / 3   
method: getacl / 1   
method: lsub / 2   
method: status / 2   
method: append / 4   
method: check   
method: close   
method: expunge   
method: search / 2   
method: uid_search / 2   
method: fetch / 2   
method: uid_fetch / 2   
method: store / 3   
method: uid_store / 3   
method: copy / 2   
method: uid_copy / 2   
method: sort / 3   
method: uid_sort / 3   
method: add_response_handler / 1   
method: remove_response_handler / 1   
method: thread / 3   
method: uid_thread / 3   
class method: decode_utf7 / 1   
class method: encode_utf7 / 1   
constant: CRLF   
constant: PORT   
method: initialize / 5   
method: receive_responses   
method: get_tagged_response / 1   
method: pick_up_tagged_response / 1   
method: get_response   
method: record_response / 2   
method: send_command / 3   
method: generate_tag   
method: put_string / 1   
method: send_data / 1   
method: send_string_data / 1   
method: send_quoted_string / 1   
method: send_literal / 1   
method: send_number_data / 1   
method: send_list_data / 1   
constant: DATE_MONTH   
method: send_time_data / 1   
method: send_symbol_data / 1   
method: search_internal / 3   
method: fetch_internal / 3   
method: store_internal / 4   
method: copy_internal / 3   
method: sort_internal / 4   
method: thread_internal / 4   
method: normalize_searching_criteria / 1   
class method: u16tou8 / 1   
class method: u8tou16 / 1   
constant: ContinuationRequest   
constant: UntaggedResponse   
constant: TaggedResponse   
constant: ResponseText   
constant: ResponseCode   
constant: MailboxList   
constant: MailboxQuota   
constant: MailboxQuotaRoot   
constant: MailboxACLItem   
constant: StatusData   
constant: FetchData   
constant: Envelope   
constant: Address   
constant: ContentDisposition   
constant: ThreadMember   
RawData ( Net::IMAP )
Atom ( Net::IMAP )
QuotedString ( Net::IMAP )
Literal ( Net::IMAP )
MessageSet ( Net::IMAP )
ResponseParser ( Net::IMAP )

Constants

IMAP::SEEN

#226 in net/imap.rb

SEEN = :Seen   

IMAP::ANSWERED

#229 in net/imap.rb

ANSWERED = :Answered   

IMAP::FLAGGED

#233 in net/imap.rb

FLAGGED = :Flagged   

IMAP::DELETED

#237 in net/imap.rb

DELETED = :Deleted   

IMAP::DRAFT

#240 in net/imap.rb

DRAFT = :Draft   

IMAP::RECENT

#245 in net/imap.rb

RECENT = :Recent   

IMAP::NOINFERIORS

#249 in net/imap.rb

NOINFERIORS = :Noinferiors   

IMAP::NOSELECT

#252 in net/imap.rb

NOSELECT = :Noselect   

IMAP::MARKED

#257 in net/imap.rb

MARKED = :Marked   

IMAP::UNMARKED

#260 in net/imap.rb

UNMARKED = :Unmarked   

IMAP::CRLF

#856 in net/imap.rb

CRLF = "\r\n" # :nodoc:   

IMAP::PORT

#857 in net/imap.rb

PORT = 143 # :nodoc:   

IMAP::DATE_MONTH

#1158 in net/imap.rb

DATE_MONTH = %w(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec)   

IMAP::ContinuationRequest

#1480 in net/imap.rb

ContinuationRequest = Struct.new(:data, :raw_data)   

IMAP::UntaggedResponse

#1499 in net/imap.rb

UntaggedResponse = Struct.new(:name, :data, :raw_data)   

IMAP::TaggedResponse

#1523 in net/imap.rb

TaggedResponse = Struct.new(:tag, :name, :data, :raw_data)   

IMAP::ResponseText

#1537 in net/imap.rb

ResponseText = Struct.new(:code, :text)   

IMAP::ResponseCode

#1555 in net/imap.rb

ResponseCode = Struct.new(:name, :data)   

IMAP::MailboxList

#1572 in net/imap.rb

MailboxList = Struct.new(:attr, :delim, :name)   

IMAP::MailboxQuota

#1593 in net/imap.rb

MailboxQuota = Struct.new(:mailbox, :usage, :quota)   

IMAP::MailboxQuotaRoot

#1607 in net/imap.rb

MailboxQuotaRoot = Struct.new(:mailbox, :quotaroots)   

IMAP::MailboxACLItem

#1625 in net/imap.rb

MailboxACLItem = Struct.new(:user, :rights)   

IMAP::StatusData

#1636 in net/imap.rb

StatusData = Struct.new(:mailbox, :attr)   

IMAP::FetchData

#1677 in net/imap.rb

FetchData = Struct.new(:seqno, :attr)   

IMAP::Envelope

#1703 in net/imap.rb

Envelope = Struct.new(:date, :subject, :from, :sender, :reply_to,   

IMAP::Address

#1722 in net/imap.rb

Address = Struct.new(:name, :route, :mailbox, :host)   

IMAP::ContentDisposition

#1734 in net/imap.rb

ContentDisposition = Struct.new(:dsp_type, :param)   

IMAP::ThreadMember

#1746 in net/imap.rb

ThreadMember = Struct.new(:seqno, :children)   

Class Methods

IMAP.debug

#263 in net/imap.rb

debug

IMAP.debug= / 1

#268 in net/imap.rb

debug= ( val )

IMAP.add_authenticator / 2

#281 in net/imap.rb

add_authenticator ( auth_type ,
  authenticator )

IMAP.decode_utf7 / 1

#827 in net/imap.rb

decode_utf7 ( s )

IMAP.encode_utf7 / 1

#843 in net/imap.rb

encode_utf7 ( s )

IMAP.u16tou8 / 1

#1255 in net/imap.rb

u16tou8 ( s )

IMAP.u8tou16 / 1

#1307 in net/imap.rb

u8tou16 ( s )

Instance Attributes

IMAP#greeting [R]

#208 in net/imap.rb

IMAP#responses [R]

#217 in net/imap.rb

IMAP#response_handlers [R]

#220 in net/imap.rb

IMAP#client_thread [RW]

#223 in net/imap.rb

Instance Methods

IMAP#disconnect

#286 in net/imap.rb

disconnect

IMAP#disconnected?

#299 in net/imap.rb

disconnected?

IMAP#capability

#313 in net/imap.rb

capability

IMAP#noop

#321 in net/imap.rb

noop

IMAP#logout

#327 in net/imap.rb

logout

IMAP#authenticate / 2

#356 in net/imap.rb

authenticate ( auth_type ,
  *args )

IMAP#login / 2

#379 in net/imap.rb

login ( user ,
  password )

IMAP#select / 1

#395 in net/imap.rb

select ( mailbox )

IMAP#examine / 1

#408 in net/imap.rb

examine ( mailbox )

IMAP#create / 1

#419 in net/imap.rb

create ( mailbox )

IMAP#delete / 1

#428 in net/imap.rb

delete ( mailbox )

IMAP#rename / 2

#439 in net/imap.rb

rename ( mailbox ,
  newname )

IMAP#subscribe / 1

#449 in net/imap.rb

subscribe ( mailbox )

IMAP#unsubscribe / 1

#459 in net/imap.rb

unsubscribe ( mailbox )

IMAP#list / 2

#485 in net/imap.rb

list ( refname ,
  mailbox )

IMAP#getquotaroot / 1

#496 in net/imap.rb

getquotaroot ( mailbox )

IMAP#getquota / 1

#510 in net/imap.rb

getquota ( mailbox )

IMAP#setquota / 2

#522 in net/imap.rb

setquota ( mailbox ,
  quota )

IMAP#setacl / 3

#535 in net/imap.rb

setacl ( mailbox ,
  user ,
  rights )

IMAP#getacl / 1

#546 in net/imap.rb

getacl ( mailbox )

IMAP#lsub / 2

#558 in net/imap.rb

lsub ( refname ,
  mailbox )

IMAP#status / 2

#581 in net/imap.rb

status ( mailbox ,
  attr )

IMAP#append / 4

#606 in net/imap.rb

append ( mailbox ,
  message ,
  flags = nil ,
  date_time = nil )

IMAP#check

#620 in net/imap.rb

check

IMAP#close

#627 in net/imap.rb

close

IMAP#expunge

#633 in net/imap.rb

expunge

IMAP#search / 2

#680 in net/imap.rb

search ( keys ,
  charset = nil )

IMAP#uid_search / 2

#685 in net/imap.rb

uid_search ( keys ,
  charset = nil )

IMAP#fetch / 2

#712 in net/imap.rb

fetch ( set ,
  attr )

IMAP#uid_fetch / 2

#717 in net/imap.rb

uid_fetch ( set ,
  attr )

IMAP#store / 3

#735 in net/imap.rb

store ( set ,
  attr ,
  flags )

IMAP#uid_store / 3

#740 in net/imap.rb

uid_store ( set ,
  attr ,
  flags )

IMAP#copy / 2

#748 in net/imap.rb

copy ( set ,
  mailbox )

IMAP#uid_copy / 2

#753 in net/imap.rb

uid_copy ( set ,
  mailbox )

IMAP#sort / 3

#766 in net/imap.rb

sort ( sort_keys ,
  search_keys ,
  charset )

IMAP#uid_sort / 3

#771 in net/imap.rb

uid_sort ( sort_keys ,
  search_keys ,
  charset )

IMAP#add_response_handler / 1

#787 in net/imap.rb

add_response_handler ( handler = Proc.new )

IMAP#remove_response_handler / 1

#792 in net/imap.rb

remove_response_handler ( handler )

IMAP#thread / 3

#809 in net/imap.rb

thread ( algorithm ,
  search_keys ,
  charset )

IMAP#uid_thread / 3

#815 in net/imap.rb

uid_thread ( algorithm ,
  search_keys ,
  charset )

IMAP#initialize / 5

#881 in net/imap.rb

initialize ( host ,
  port = PORT ,
  usessl = false ,
  certs = nil ,
  verify = false )

IMAP#receive_responses

#931 in net/imap.rb

receive_responses

IMAP#get_tagged_response / 1

#992 in net/imap.rb

get_tagged_response ( tag )

IMAP#pick_up_tagged_response / 1

#1000 in net/imap.rb

pick_up_tagged_response ( tag )

IMAP#get_response

#1012 in net/imap.rb

get_response

IMAP#record_response / 2

#1032 in net/imap.rb

record_response ( name ,
  data )

IMAP#send_command / 3

#1039 in net/imap.rb

send_command ( cmd ,
  *args ,
  &block )

IMAP#generate_tag

#1064 in net/imap.rb

generate_tag

IMAP#put_string / 1

#1069 in net/imap.rb

put_string ( str )

IMAP#send_data / 1

#1084 in net/imap.rb

send_data ( data )

IMAP#send_string_data / 1

#1103 in net/imap.rb

send_string_data ( str )

IMAP#send_quoted_string / 1

#1118 in net/imap.rb

send_quoted_string ( str )

IMAP#send_literal / 1

#1122 in net/imap.rb

send_literal ( str )

IMAP#send_number_data / 1

#1137 in net/imap.rb

send_number_data ( num )

IMAP#send_list_data / 1

#1144 in net/imap.rb

send_list_data ( list )

IMAP#send_time_data / 1

#1160 in net/imap.rb

send_time_data ( time )

IMAP#send_symbol_data / 1

#1168 in net/imap.rb

send_symbol_data ( symbol )

IMAP#search_internal / 3

#1172 in net/imap.rb

search_internal ( cmd ,
  keys ,
  charset )

IMAP#fetch_internal / 3

#1188 in net/imap.rb

fetch_internal ( cmd ,
  set ,
  attr )

IMAP#store_internal / 4

#1205 in net/imap.rb

store_internal ( cmd ,
  set ,
  attr ,
  flags )

IMAP#copy_internal / 3

#1216 in net/imap.rb

copy_internal ( cmd ,
  set ,
  mailbox )

IMAP#sort_internal / 4

#1220 in net/imap.rb

sort_internal ( cmd ,
  sort_keys ,
  search_keys ,
  charset )

IMAP#thread_internal / 4

#1233 in net/imap.rb

thread_internal ( cmd ,
  algorithm ,
  search_keys ,
  charset )

IMAP#normalize_searching_criteria / 1

#1244 in net/imap.rb

normalize_searching_criteria ( keys )