Table of Contents - net-imap: Ruby Standard Library Documentation
Classes and Modules
- Net
-
Net::IMAP
- IMAP Overview
- Sequence numbers and UIDs
- Server capabilities and protocol extensions
- Examples of Usage
- List sender and subject of all recent messages in the default mailbox
- Move all messages from April 2003 from “Mail/sent-mail” to “Mail/sent-apr03”
- Thread Safety
- Errors
- What’s here?
- Connection control methods
- Core IMAP commands
- IMAP commands for any state
- IMAP commands for the “Not Authenticated” state
- IMAP commands for the “Authenticated” state
- IMAP commands for the “Selected” state
- IMAP commands for the “Logout” state
- Supported IMAP extensions
- RFC9051:
IMAP4rev2
- RFC2087:
QUOTA
- RFC2177:
IDLE
- RFC2342:
NAMESPACE
- RFC2971:
ID
- RFC3691:
UNSELECT
- RFC4314:
ACL
- RFC4315:
UIDPLUS
- RFC5256:
SORT
- RFC5256:
THREAD
XLIST
(non-standard, deprecated)- RFC6851:
MOVE
- Handling server responses
- References
- Message envelope and body structure
- Supported IMAP Extensions
- IANA registries
- Net::IMAP::Address
- Net::IMAP::Authenticators
- Net::IMAP::BadResponseError
- Net::IMAP::BodyStructure
- Net::IMAP::BodyTypeAttachment
- Net::IMAP::BodyTypeBasic
- Net::IMAP::BodyTypeExtension
- Net::IMAP::BodyTypeMessage
- Net::IMAP::BodyTypeMultipart
- Net::IMAP::BodyTypeText
- Net::IMAP::ByeResponseError
- Net::IMAP::ContentDisposition
- Net::IMAP::ContinuationRequest
- Net::IMAP::CramMD5Authenticator
- Net::IMAP::DataFormatError
- Net::IMAP::DigestMD5Authenticator
- Net::IMAP::Envelope
- Net::IMAP::Error
- Net::IMAP::FetchData
- Net::IMAP::IgnoredResponse
- Net::IMAP::LoginAuthenticator
- Net::IMAP::MailboxACLItem
- Net::IMAP::MailboxList
- Net::IMAP::MailboxQuota
- Net::IMAP::MailboxQuotaRoot
- Net::IMAP::Namespace
- Net::IMAP::Namespaces
- Net::IMAP::NoResponseError
- Net::IMAP::NumValidator
- Net::IMAP::PlainAuthenticator
- Net::IMAP::ResponseCode
- Net::IMAP::ResponseError
- Net::IMAP::ResponseParseError
- Net::IMAP::ResponseParser
- Net::IMAP::ResponseText
- Net::IMAP::SASL
- Net::IMAP::SASL::BidiStringError
- Net::IMAP::SASL::ProhibitedCodepoint
- Net::IMAP::SASL::SASLprep
- Net::IMAP::SASL::StringPrep
- Net::IMAP::SASL::StringPrepError
- Net::IMAP::StatusData
- Net::IMAP::StringFormatter
- Net::IMAP::TaggedResponse
- Net::IMAP::ThreadMember
- Net::IMAP::UIDPlusData
- Net::IMAP::UnknownResponseError
- Net::IMAP::UntaggedResponse
- Net::IMAP::XOauth2Authenticator
- StringPrepTablesGenerator
Methods
- ::[] — Net::IMAP::SASL::StringPrep
- ::debug — Net::IMAP
- ::debug= — Net::IMAP
- ::decode_date — Net::IMAP
- ::decode_datetime — Net::IMAP
- ::decode_time — Net::IMAP
- ::decode_utf7 — Net::IMAP
- ::default_imap_port — Net::IMAP
- ::default_imaps_port — Net::IMAP
- ::default_port — Net::IMAP
- ::default_ssl_port — Net::IMAP
- ::default_tls_port — Net::IMAP
- ::encode_date — Net::IMAP
- ::encode_datetime — Net::IMAP
- ::encode_time — Net::IMAP
- ::encode_utf7 — Net::IMAP
- ::format_date — Net::IMAP
- ::format_datetime — Net::IMAP
- ::format_time — Net::IMAP
- ::new — Net::IMAP
- ::new — Net::IMAP::CramMD5Authenticator
- ::new — Net::IMAP::DigestMD5Authenticator
- ::new — Net::IMAP::LoginAuthenticator
- ::new — Net::IMAP::XOauth2Authenticator
- ::new — Net::IMAP::ResponseError
- ::new — Net::IMAP::ResponseParser
- ::new — Net::IMAP::SASL::StringPrepError
- ::new — Net::IMAP::SASL::ProhibitedCodepoint
- ::new — StringPrepTablesGenerator
- ::parse_date — Net::IMAP
- ::parse_datetime — Net::IMAP
- ::parse_time — Net::IMAP
- #add_authenticator — Net::IMAP::Authenticators
- #add_response_handler — Net::IMAP
- #append — Net::IMAP
- #arrays — StringPrepTablesGenerator
- #asgn_regex — StringPrepTablesGenerator
- #asgn_regexps — StringPrepTablesGenerator
- #asgn_regexps! — StringPrepTablesGenerator
- #asgn_table — StringPrepTablesGenerator
- #assigned_uids — Net::IMAP::UIDPlusData
- #attr — Net::IMAP::MailboxList
- #attr — Net::IMAP::StatusData
- #attr — Net::IMAP::FetchData
- #authenticate — Net::IMAP
- #authenticator — Net::IMAP::Authenticators
- #authenticators — Net::IMAP::Authenticators
- #bcc — Net::IMAP::Envelope
- #bidi_L — StringPrepTablesGenerator
- #bidi_R_AL — StringPrepTablesGenerator
- #bidi_consts — StringPrepTablesGenerator
- #bidi_fails_req2 — StringPrepTablesGenerator
- #bidi_fails_req3 — StringPrepTablesGenerator
- #bidi_failure_regexp — StringPrepTablesGenerator
- #bidi_not_R_AL — StringPrepTablesGenerator
- #body — Net::IMAP::BodyTypeMessage
- #build_oauth2_string — Net::IMAP::XOauth2Authenticator
- #capability — Net::IMAP
- #cc — Net::IMAP::Envelope
- #check — Net::IMAP
- #check_bidi! — Net::IMAP::SASL::StringPrep
- #check_prohibited! — Net::IMAP::SASL::StringPrep
- #children — Net::IMAP::ThreadMember
- #clean_deps — StringPrepTablesGenerator
- #close — Net::IMAP
- #code — Net::IMAP::ResponseText
- #content_id — Net::IMAP::BodyTypeBasic
- #copy — Net::IMAP
- #copy_internal — Net::IMAP
- #create — Net::IMAP
- #create_ssl_params — Net::IMAP
- #data — Net::IMAP::ContinuationRequest
- #data — Net::IMAP::UntaggedResponse
- #data — Net::IMAP::TaggedResponse
- #data — Net::IMAP::ResponseCode
- #date — Net::IMAP::Envelope
- #delete — Net::IMAP
- #delim — Net::IMAP::MailboxList
- #delim — Net::IMAP::Namespace
- #description — Net::IMAP::BodyTypeBasic
- #disconnect — Net::IMAP
- #disconnected? — Net::IMAP
- #disposition — Net::IMAP::BodyTypeBasic
- #disposition — Net::IMAP::BodyTypeMultipart
- #dsp_type — Net::IMAP::ContentDisposition
- #dsp_type — Net::IMAP::BodyTypeAttachment
- #encoding — Net::IMAP::BodyTypeBasic
- #ensure_mod_sequence_value — Net::IMAP::NumValidator
- #ensure_number — Net::IMAP::NumValidator
- #ensure_nz_number — Net::IMAP::NumValidator
- #envelope — Net::IMAP::BodyTypeMessage
- #examine — Net::IMAP
- #expunge — Net::IMAP
- #extension — Net::IMAP::BodyTypeBasic
- #extension — Net::IMAP::BodyTypeMultipart
- #extensions — Net::IMAP::Namespace
- #fetch — Net::IMAP
- #fetch_internal — Net::IMAP
- #from — Net::IMAP::Envelope
- #generate_json_data_file — StringPrepTablesGenerator
- #generate_tag — Net::IMAP
- #get_response — Net::IMAP
- #get_tagged_response — Net::IMAP
- #getacl — Net::IMAP
- #getquota — Net::IMAP
- #getquotaroot — Net::IMAP
- #hmac_md5 — Net::IMAP::CramMD5Authenticator
- #host — Net::IMAP::Address
- #id — Net::IMAP
- #idle — Net::IMAP
- #idle_done — Net::IMAP
- #in_reply_to — Net::IMAP::Envelope
- #json_deps — StringPrepTablesGenerator
- #language — Net::IMAP::BodyTypeBasic
- #language — Net::IMAP::BodyTypeMultipart
- #lines — Net::IMAP::BodyTypeText
- #list — Net::IMAP
- #load_tables_and_titles_from_json! — StringPrepTablesGenerator
- #login — Net::IMAP
- #logout — Net::IMAP
- #lsub — Net::IMAP
- #mailbox — Net::IMAP::MailboxQuota
- #mailbox — Net::IMAP::MailboxQuotaRoot
- #mailbox — Net::IMAP::MailboxACLItem
- #mailbox — Net::IMAP::StatusData
- #mailbox — Net::IMAP::Address
- #md5 — Net::IMAP::BodyTypeBasic
- #media_subtype — Net::IMAP::BodyTypeBasic
- #media_subtype — Net::IMAP::BodyTypeText
- #media_subtype — Net::IMAP::BodyTypeMessage
- #media_subtype — Net::IMAP::BodyTypeMultipart
- #media_type — Net::IMAP::BodyTypeBasic
- #media_type — Net::IMAP::BodyTypeAttachment
- #media_type — Net::IMAP::BodyTypeMultipart
- #merged_tables_regex — StringPrepTablesGenerator
- #message_id — Net::IMAP::Envelope
- #move — Net::IMAP
- #multipart? — Net::IMAP::BodyTypeBasic
- #multipart? — Net::IMAP::BodyTypeText
- #multipart? — Net::IMAP::BodyTypeMessage
- #multipart? — Net::IMAP::BodyTypeAttachment
- #multipart? — Net::IMAP::BodyTypeMultipart
- #multipart? — Net::IMAP::BodyTypeExtension
- #name — Net::IMAP::UntaggedResponse
- #name — Net::IMAP::TaggedResponse
- #name — Net::IMAP::ResponseCode
- #name — Net::IMAP::MailboxList
- #name — Net::IMAP::Address
- #namespace — Net::IMAP
- #nc — Net::IMAP::DigestMD5Authenticator
- #noop — Net::IMAP
- #normalize_searching_criteria — Net::IMAP
- #nstring — Net::IMAP::StringFormatter
- #other — Net::IMAP::Namespaces
- #param — Net::IMAP::ContentDisposition
- #param — Net::IMAP::BodyTypeBasic
- #param — Net::IMAP::BodyTypeAttachment
- #param — Net::IMAP::BodyTypeMultipart
- #parse — Net::IMAP::ResponseParser
- #parse_rfc_text — StringPrepTablesGenerator
- #parts — Net::IMAP::BodyTypeMultipart
- #personal — Net::IMAP::Namespaces
- #prefix — Net::IMAP::Namespace
- #process — Net::IMAP::CramMD5Authenticator
- #process — Net::IMAP::DigestMD5Authenticator
- #process — Net::IMAP::LoginAuthenticator
- #process — Net::IMAP::PlainAuthenticator
- #process — Net::IMAP::XOauth2Authenticator
- #put_string — Net::IMAP
- #qdval — Net::IMAP::DigestMD5Authenticator
- #quota — Net::IMAP::MailboxQuota
- #ranges — StringPrepTablesGenerator
- #raw_data — Net::IMAP::ContinuationRequest
- #raw_data — Net::IMAP::UntaggedResponse
- #raw_data — Net::IMAP::IgnoredResponse
- #raw_data — Net::IMAP::TaggedResponse
- #rb_deps — StringPrepTablesGenerator
- #receive_responses — Net::IMAP
- #record_response — Net::IMAP
- #regex_str — StringPrepTablesGenerator
- #regexp_const_desc — StringPrepTablesGenerator
- #regexp_const_name — StringPrepTablesGenerator
- #regexp_for — StringPrepTablesGenerator
- #regexps — StringPrepTablesGenerator
- #remove_response_handler — Net::IMAP
- #rename — Net::IMAP
- #reply_to — Net::IMAP::Envelope
- #rights — Net::IMAP::MailboxACLItem
- #route — Net::IMAP::Address
- #saslprep — Net::IMAP::SASL
- #saslprep — Net::IMAP::SASL::SASLprep
- #saslprep_rb — StringPrepTablesGenerator
- #search — Net::IMAP
- #search_internal — Net::IMAP
- #select — Net::IMAP
- #send_command — Net::IMAP
- #send_data — Net::IMAP
- #send_date_data — Net::IMAP
- #send_list_data — Net::IMAP
- #send_literal — Net::IMAP
- #send_number_data — Net::IMAP
- #send_quoted_string — Net::IMAP
- #send_string_data — Net::IMAP
- #send_symbol_data — Net::IMAP
- #send_time_data — Net::IMAP
- #sender — Net::IMAP::Envelope
- #seqno — Net::IMAP::FetchData
- #seqno — Net::IMAP::ThreadMember
- #setacl — Net::IMAP
- #setquota — Net::IMAP
- #sets — StringPrepTablesGenerator
- #shared — Net::IMAP::Namespaces
- #size — Net::IMAP::BodyTypeBasic
- #sort — Net::IMAP
- #sort_internal — Net::IMAP
- #source_uids — Net::IMAP::UIDPlusData
- #start_tls_session — Net::IMAP
- #starttls — Net::IMAP
- #status — Net::IMAP
- #store — Net::IMAP
- #store_internal — Net::IMAP
- #string — Net::IMAP::StringFormatter
- #stringprep_rb — StringPrepTablesGenerator
- #subject — Net::IMAP::Envelope
- #subscribe — Net::IMAP
- #subtype — Net::IMAP::BodyTypeBasic
- #subtype — Net::IMAP::BodyTypeAttachment
- #subtype — Net::IMAP::BodyTypeMultipart
- #table_regexps_rb — StringPrepTablesGenerator
- #table_titles_rb — StringPrepTablesGenerator
- #tables — StringPrepTablesGenerator
- #tag — Net::IMAP::TaggedResponse
- #tcp_socket — Net::IMAP
- #text — Net::IMAP::ResponseText
- #thread — Net::IMAP
- #thread_internal — Net::IMAP
- #titles — StringPrepTablesGenerator
- #to — Net::IMAP::Envelope
- #to_ranges — StringPrepTablesGenerator
- #to_regexp — StringPrepTablesGenerator
- #uid_copy — Net::IMAP
- #uid_expunge — Net::IMAP
- #uid_fetch — Net::IMAP
- #uid_mapping — Net::IMAP::UIDPlusData
- #uid_move — Net::IMAP
- #uid_search — Net::IMAP
- #uid_sort — Net::IMAP
- #uid_store — Net::IMAP
- #uid_thread — Net::IMAP
- #uidvalidity — Net::IMAP::UIDPlusData
- #unselect — Net::IMAP
- #unsubscribe — Net::IMAP
- #usage — Net::IMAP::MailboxQuota
- #user — Net::IMAP::MailboxACLItem
- #valid_mod_sequence_value? — Net::IMAP::NumValidator
- #valid_nstring? — Net::IMAP::StringFormatter
- #valid_number? — Net::IMAP::NumValidator
- #valid_nz_number? — Net::IMAP::NumValidator
- #valid_string? — Net::IMAP::StringFormatter
- #validate_data — Net::IMAP
- #xlist — Net::IMAP