class Net::IMAP

Returns the debug mode.

# File net-imap-0.3.4.1/lib/net/imap.rb, line 740
def self.debug
  return @@debug
end

Sets the debug mode.

# File net-imap-0.3.4.1/lib/net/imap.rb, line 745
def self.debug=(val)
  return @@debug = val
end

Decodes string as an IMAP formatted “date”.

Double quotes are optional. Day of month may be padded with zero or space. See STRFDATE.

# File net-imap-0.3.4.1/lib/net/imap/data_encoding.rb, line 89
def self.decode_date(string)
  string = string.delete_prefix('"').delete_suffix('"')
  Date.strptime(string, STRFDATE)
end

Decodes string as an IMAP4 formatted “date-time”.

Note that double quotes are not optional. See STRFTIME.

# File net-imap-0.3.4.1/lib/net/imap/data_encoding.rb, line 106
def self.decode_datetime(string)
  DateTime.strptime(string, STRFTIME)
end

Decodes string as an IMAP4 formatted “date-time”.

Same as decode_datetime, but returning a Time instead.

# File net-imap-0.3.4.1/lib/net/imap/data_encoding.rb, line 115
def self.decode_time(string)
  decode_datetime(string).to_time
end

Decode a string from modified UTF-7 format to UTF-8.

UTF-7 is a 7-bit encoding of Unicode [UTF7]. IMAP uses a slightly modified version of this to encode mailbox names containing non-ASCII characters; see [IMAP] section 5.1.3.

Net::IMAP does not automatically encode and decode mailbox names to and from UTF-7.

# File net-imap-0.3.4.1/lib/net/imap/data_encoding.rb, line 56
def self.decode_utf7(s)
  return s.gsub(/&([^-]+)?-/n) {
    if $1
      ($1.tr(",", "/") + "===").unpack1("m").encode(Encoding::UTF_8, Encoding::UTF_16BE)
    else
      "&"
    end
  }
end

The default port for IMAP connections, port 143

# File net-imap-0.3.4.1/lib/net/imap.rb, line 750
def self.default_port
  return PORT
end

The default port for IMAPS connections, port 993

# File net-imap-0.3.4.1/lib/net/imap.rb, line 755
def self.default_tls_port
  return SSL_PORT
end

Formats time as an IMAP4 date.

# File net-imap-0.3.4.1/lib/net/imap/data_encoding.rb, line 79
def self.encode_date(date)
  date.to_date.strftime STRFDATE
end

Formats time as an IMAP4 date-time.

# File net-imap-0.3.4.1/lib/net/imap/data_encoding.rb, line 97
def self.encode_datetime(time)
  time.to_datetime.strftime STRFTIME
end

Encode a string from UTF-8 format to modified UTF-7.

# File net-imap-0.3.4.1/lib/net/imap/data_encoding.rb, line 67
def self.encode_utf7(s)
  return s.gsub(/(&)|[^\x20-\x7e]+/) {
    if $1
      "&-"
    else
      base64 = [$&.encode(Encoding::UTF_16BE)].pack("m0")
      "&" + base64.delete("=").tr("/", ",") + "-"
    end
  }.force_encoding("ASCII-8BIT")
end

DEPRECATED

The original version returned incorrectly formatted strings. Strings returned by encode_datetime or format_time use the correct IMAP4rev1 syntax for “date-time”.

This invalid format has been temporarily retained for backward compatibility. A future release will change this method to return the correct format.

# File net-imap-0.3.4.1/lib/net/imap/data_encoding.rb, line 137
def self.format_datetime(time)
  warn("#{self}.format_datetime incorrectly formats IMAP date-time. " \
       "Convert to #{self}.encode_datetime or #{self}.format_time instead.",
       uplevel: 1, category: :deprecated)
  time.strftime("%d-%b-%Y %H:%M %z")
end

Creates a new Net::IMAP object and connects it to the specified host.

options is an option hash, each key of which is a symbol.

The available options are:

port

Port number (default value is 143 for imap, or 993 for imaps)

ssl

If options[:ssl] is true, then an attempt will be made to use SSL (now TLS) to connect to the server. If options[:ssl] is a hash, it’s passed to OpenSSL::SSL::SSLContext#set_params as parameters.

open_timeout

Seconds to wait until a connection is opened

idle_response_timeout

Seconds to wait until an IDLE response is received

The most common errors are:

Errno::ECONNREFUSED

Connection refused by host or an intervening firewall.

Errno::ETIMEDOUT

Connection timed out (possibly due to packets being dropped by an intervening firewall).

Errno::ENETUNREACH

There is no route to that network.

SocketError

Hostname not known or other socket error.

Net::IMAP::ByeResponseError

The connected to the host was successful, but it immediately said goodbye.

# File net-imap-0.3.4.1/lib/net/imap.rb, line 2009
def initialize(host, port_or_options = {},
               usessl = false, certs = nil, verify = true)
  super()
  @host = host
  begin
    options = port_or_options.to_hash
  rescue NoMethodError
    # for backward compatibility
    options = {}
    options[:port] = port_or_options
    if usessl
      options[:ssl] = create_ssl_params(certs, verify)
    end
  end
  @port = options[:port] || (options[:ssl] ? SSL_PORT : PORT)
  @tag_prefix = "RUBY"
  @tagno = 0
  @open_timeout = options[:open_timeout] || 30
  @idle_response_timeout = options[:idle_response_timeout] || 5
  @parser = ResponseParser.new
  @sock = tcp_socket(@host, @port)
  begin
    if options[:ssl]
      start_tls_session(options[:ssl])
      @usessl = true
    else
      @usessl = false
    end
    @responses = Hash.new([].freeze)
    @tagged_responses = {}
    @response_handlers = []
    @tagged_response_arrival = new_cond
    @continued_command_tag = nil
    @continuation_request_arrival = new_cond
    @continuation_request_exception = nil
    @idle_done_cond = nil
    @logout_command_tag = nil
    @debug_output_bol = true
    @exception = nil

    @greeting = get_response
    if @greeting.nil?
      raise Error, "connection closed"
    end
    if @greeting.name == "BYE"
      raise ByeResponseError, @greeting
    end

    @client_thread = Thread.current
    @receiver_thread = Thread.start {
      begin
        receive_responses
      rescue Exception
      end
    }
    @receiver_thread_terminating = false
  rescue Exception
    @sock.close
    raise
  end
end

Adds a response handler. For example, to detect when the server sends a new EXISTS response (which normally indicates new messages being added to the mailbox), add the following handler after selecting the mailbox:

imap.add_response_handler { |resp|
  if resp.kind_of?(Net::IMAP::UntaggedResponse) and resp.name == "EXISTS"
    puts "Mailbox now has #{resp.data} messages"
  end
}

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1963
def add_response_handler(handler = nil, &block)
  raise ArgumentError, "two Procs are passed" if handler && block
  @response_handlers.push(block || handler)
end

Sends an APPEND command [IMAP4rev1 §6.3.11] to append the message to the end of the mailbox. The optional flags argument is an array of flags initially passed to the new message. The optional date_time argument specifies the creation time to assign to the new message; it defaults to the current time.

For example:

imap.append("inbox", <<EOF.gsub(/\n/, "\r\n"), [:Seen], Time.now)
Subject: hello
From: shugo@ruby-lang.org
To: shugo@ruby-lang.org

hello world
EOF

A Net::IMAP::NoResponseError is raised if the mailbox does not exist (it is not created automatically), or if the flags, date_time, or message arguments contain errors.

Capabilities¶ ↑

If UIDPLUS [RFC4315] is supported and the destination supports persistent UIDs, the server’s response should include an APPENDUID response code with UIDPlusData. This will report the UIDVALIDITY of the destination mailbox and the assigned UID of the appended message.

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1487
def append(mailbox, message, flags = nil, date_time = nil)
  args = []
  if flags
    args.push(flags)
  end
  args.push(date_time) if date_time
  args.push(Literal.new(message))
  send_command("APPEND", mailbox, *args)
end

Sends an AUTHENTICATE command [IMAP4rev1 §6.2.2] to authenticate the client. If successful, the connection enters the “authenticated” state.

mechanism is the name of the SASL authentication mechanism to be used. All other arguments are forwarded to the authenticator for the requested mechanism. The listed call signatures are suggestions. The documentation for each individual mechanism must be consulted for its specific parameters.

An exception Net::IMAP::NoResponseError is raised if authentication fails.

Related: login, starttls

Supported SASL Mechanisms¶ ↑

PLAIN

See PlainAuthenticator. Login using clear-text username and password.

XOAUTH2

See XOauth2Authenticator. Login using a username and OAuth2 access token. Non-standard and obsoleted by OAUTHBEARER, but widely supported.

Deprecated: Obsolete mechanisms are available for backwards compatibility.

For DIGEST-MD5 see DigestMD5Authenticator.

For LOGIN, see LoginAuthenticator.

For CRAM-MD5, see CramMD5Authenticator.

Using a deprecated mechanism will print a warning.

See Net::IMAP::Authenticators for information on plugging in authenticators for other mechanisms. See the SASL mechanism registry for information on these and other SASL mechanisms.

Capabilities¶ ↑

Clients MUST NOT attempt to authenticate with a mechanism unless "AUTH=#{mechanism}" for that mechanism is a server capability.

Server capabilities may change after starttls, login, and authenticate. Cached capabilities must be invalidated after this method completes. The TaggedResponse to authenticate may include updated capabilities in its ResponseCode.

Example¶ ↑

If the authenticators ignore unhandled keyword arguments, the same config can be used for multiple mechanisms:

password  = nil # saved locally, so we don't ask more than once
accesstok = nil # saved locally...
creds = {
  authcid:      username,
  password:     proc { password  ||= ui.prompt_for_password },
  oauth2_token: proc { accesstok ||= kms.fresh_access_token },
}
capa = imap.capability
if    capa.include? "AUTH=OAUTHBEARER"
  imap.authenticate "OAUTHBEARER",   **creds # authcid, oauth2_token
elsif capa.include? "AUTH=XOAUTH2"
  imap.authenticate "XOAUTH2",       **creds # authcid, oauth2_token
elsif capa.include? "AUTH=SCRAM-SHA-256"
  imap.authenticate "SCRAM-SHA-256", **creds # authcid, password
elsif capa.include? "AUTH=PLAIN"
  imap.authenticate "PLAIN",         **creds # authcid, password
elsif capa.include? "AUTH=DIGEST-MD5"
  imap.authenticate "DIGEST-MD5",    **creds # authcid, password
elsif capa.include? "LOGINDISABLED"
  raise "the server has disabled login"
else
  imap.login username, password
end

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1040
def authenticate(mechanism, *args, **props, &cb)
  authenticator = self.class.authenticator(mechanism, *args, **props, &cb)
  send_command("AUTHENTICATE", mechanism) do |resp|
    if resp.instance_of?(ContinuationRequest)
      data = authenticator.process(resp.data.text.unpack("m")[0])
      s = [data].pack("m0")
      send_string_data(s)
      put_string(CRLF)
    end
  end
end

Sends a CAPABILITY command [IMAP4rev1 §6.1.1] and returns an array of capabilities that the server supports. Each capability is a string.

See the IANA IMAP4 capabilities registry for a list of all standard capabilities, and their reference RFCs.

Note that Net::IMAP does not currently modify its behaviour according to the capabilities of the server; it is up to the user of the class to ensure that a certain capability is supported by a server before using it.

Capability requirements—other than IMAP4rev1—are listed in the documentation for each command method.

Basic IMAP4rev1 capabilities¶ ↑

All IMAP4rev1 servers must include IMAP4rev1 in their capabilities list. All IMAP4rev1 servers must implement the STARTTLS, AUTH=PLAIN, and LOGINDISABLED capabilities, and clients must respect their presence or absence. See the capabilites requirements on starttls, login, and authenticate.

Using IMAP4rev1 extensions¶ ↑

IMAP4rev1 servers must not activate incompatible behavior until an explicit client action invokes a capability, e.g. sending a command or command argument specific to that capability. Extensions with backward compatible behavior, such as response codes or mailbox attributes, may be sent at any time.

Invoking capabilities which are unknown to Net::IMAP may cause unexpected behavior and errors, for example ResponseParseError is raised when unknown response syntax is received. Invoking commands or command parameters that are unsupported by the server may raise NoResponseError, BadResponseError, or cause other unexpected behavior.

Caching CAPABILITY responses¶ ↑

Servers may send their capability list, unsolicited, using the CAPABILITY response code or an untagged CAPABILITY response. These responses can be retrieved and cached using responses or add_response_handler.

But cached capabilities must be discarded after starttls, login, or authenticate. The OK TaggedResponse to login and authenticate may include CAPABILITY response code data, but the TaggedResponse for starttls is sent clear-text and cannot be trusted.

# File net-imap-0.3.4.1/lib/net/imap.rb, line 849
def capability
  synchronize do
    send_command("CAPABILITY")
    return @responses.delete("CAPABILITY")[-1]
  end
end

Sends a CHECK command [IMAP4rev1 §6.4.1] to request a checkpoint of the currently selected mailbox. This performs implementation-specific housekeeping; for instance, reconciling the mailbox’s in-memory and on-disk state.

Related: idle, noop

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1503
def check
  send_command("CHECK")
end

Sends a CLOSE command [IMAP4rev1 §6.4.2] to close the currently selected mailbox. The CLOSE command permanently removes from the mailbox all messages that have the \Deleted flag set.

Related: unselect

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1513
def close
  send_command("CLOSE")
end

Sends a COPY command [IMAP4rev1 §6.4.7] to copy the specified message(s) to the end of the specified destination mailbox. The set parameter is a number, an array of numbers, or a Range object. The number is a message sequence number.

Related: uid_copy

Capabilities¶ ↑

If UIDPLUS [RFC4315] is supported, the server’s response should include a COPYUID response code with UIDPlusData. This will report the UIDVALIDITY of the destination mailbox, the UID set of the source messages, and the assigned UID set of the moved messages.

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1749
def copy(set, mailbox)
  copy_internal("COPY", set, mailbox)
end

Sends a CREATE command [IMAP4rev1 §6.3.3] to create a new mailbox.

A Net::IMAP::NoResponseError is raised if a mailbox with that name cannot be created.

Related: rename, delete

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1129
def create(mailbox)
  send_command("CREATE", mailbox)
end

Sends a DELETE command [IMAP4rev1 §6.3.4] to remove the mailbox.

A Net::IMAP::NoResponseError is raised if a mailbox with that name cannot be deleted, either because it does not exist or because the client does not have permission to delete it.

Related: create, rename

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1141
def delete(mailbox)
  send_command("DELETE", mailbox)
end

Disconnects from the server.

Related: logout

# File net-imap-0.3.4.1/lib/net/imap.rb, line 768
def disconnect
  return if disconnected?
  begin
    begin
      # try to call SSL::SSLSocket#io.
      @sock.io.shutdown
    rescue NoMethodError
      # @sock is not an SSL::SSLSocket.
      @sock.shutdown
    end
  rescue Errno::ENOTCONN
    # ignore `Errno::ENOTCONN: Socket is not connected' on some platforms.
  rescue Exception => e
    @receiver_thread.raise(e)
  end
  @receiver_thread.join
  synchronize do
    @sock.close
  end
  raise e if e
end

Returns true if disconnected from the server.

Related: logout, disconnect

# File net-imap-0.3.4.1/lib/net/imap.rb, line 793
def disconnected?
  return @sock.closed?
end

Sends a EXAMINE command [IMAP4rev1 §6.3.2] to select a mailbox so that messages in the mailbox can be accessed. Behaves the same as select, except that the selected mailbox is identified as read-only.

A Net::IMAP::NoResponseError is raised if the mailbox does not exist or is for some reason non-examinable.

Related: select

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1115
def examine(mailbox)
  synchronize do
    @responses.clear
    send_command("EXAMINE", mailbox)
  end
end

Sends an EXPUNGE command [IMAP4rev1 §6.4.3] Sends a EXPUNGE command to permanently remove from the currently selected mailbox all messages that have the Deleted flag set.

Related: uid_expunge

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1538
def expunge
  synchronize do
    send_command("EXPUNGE")
    return @responses.delete("EXPUNGE")
  end
end

Sends a FETCH command [IMAP4rev1 §6.4.5] to retrieve data associated with a message in the mailbox.

The set parameter is a number or a range between two numbers, or an array of those. The number is a message sequence number, where -1 represents a ‘*’ for use in range notation like 100..-1 being interpreted as ‘100:*’. Beware that the exclude_end? property of a Range object is ignored, and the contents of a range are independent of the order of the range endpoints as per the protocol specification, so 1…5, 5..1 and 5…1 are all equivalent to 1..5.

attr is a list of attributes to fetch; see the documentation for FetchData for a list of valid attributes.

The return value is an array of FetchData or nil (instead of an empty array) if there is no matching message.

Related: uid_search, FetchData

For example:¶ ↑

p imap.fetch(6..8, "UID")
#=> [#<Net::IMAP::FetchData seqno=6, attr={"UID"=>98}>, \\
     #<Net::IMAP::FetchData seqno=7, attr={"UID"=>99}>, \\
     #<Net::IMAP::FetchData seqno=8, attr={"UID"=>100}>]
p imap.fetch(6, "BODY[HEADER.FIELDS (SUBJECT)]")
#=> [#<Net::IMAP::FetchData seqno=6, attr={"BODY[HEADER.FIELDS (SUBJECT)]"=>"Subject: test\r\n\r\n"}>]
data = imap.uid_fetch(98, ["RFC822.SIZE", "INTERNALDATE"])[0]
p data.seqno
#=> 6
p data.attr["RFC822.SIZE"]
#=> 611
p data.attr["INTERNALDATE"]
#=> "12-Oct-2000 22:40:59 +0900"
p data.attr["UID"]
#=> 98

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1681
def fetch(set, attr, mod = nil)
  return fetch_internal("FETCH", set, attr, mod)
end

Sends a GETACL command [RFC4314 §3.3] along with a specified mailbox. If this mailbox exists, an array containing objects of MailboxACLItem will be returned.

Related: setacl, MailboxACLItem

Capabilities¶ ↑

The server’s capabilities must include ACL [RFC4314].

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1410
def getacl(mailbox)
  synchronize do
    send_command("GETACL", mailbox)
    return @responses.delete("ACL")[-1]
  end
end

Sends a GETQUOTA command [RFC2087 §4.2] along with specified mailbox. If this mailbox exists, then an array containing a MailboxQuota object is returned. This command is generally only available to server admin.

Related: getquotaroot, setquota, MailboxQuota

Capabilities¶ ↑

The server’s capabilities must include QUOTA [RFC2087].

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1354
def getquota(mailbox)
  synchronize do
    send_command("GETQUOTA", mailbox)
    return @responses.delete("QUOTA")
  end
end

Sends a GETQUOTAROOT command [RFC2087 §4.3] along with the specified mailbox. This command is generally available to both admin and user. If this mailbox exists, it returns an array containing objects of type MailboxQuotaRoot and MailboxQuota.

Related: getquota, setquota, MailboxQuotaRoot, MailboxQuota

Capabilities¶ ↑

The server’s capabilities must include QUOTA [RFC2087].

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1333
def getquotaroot(mailbox)
  synchronize do
    send_command("GETQUOTAROOT", mailbox)
    result = []
    result.concat(@responses.delete("QUOTAROOT"))
    result.concat(@responses.delete("QUOTA"))
    return result
  end
end

Sends an ID command [RFC2971 §3.1] and returns a hash of the server’s response, or nil if the server does not identify itself.

Note that the user should first check if the server supports the ID capability. For example:

capabilities = imap.capability
if capabilities.include?("ID")
  id = imap.id(
    name: "my IMAP client (ruby)",
    version: MyIMAP::VERSION,
    "support-url": "mailto:bugs@example.com",
    os: RbConfig::CONFIG["host_os"],
  )
end

See [ID] for field definitions.

Capabilities¶ ↑

The server’s capabilities must include ID

RFC2971

# File net-imap-0.3.4.1/lib/net/imap.rb, line 879
def id(client_id=nil)
  synchronize do
    send_command("ID", ClientID.new(client_id))
    @responses.delete("ID")&.last
  end
end

Sends an IDLE command [RFC2177 §3] [IMAP4rev2 §6.3.13] that waits for notifications of new or expunged messages. Yields responses from the server during the IDLE.

Use idle_done to leave IDLE.

If timeout is given, this method returns after timeout seconds passed. timeout can be used for keep-alive. For example, the following code checks the connection for each 60 seconds.

loop do
  imap.idle(60) do |res|
    ...
  end
end

Related: idle_done, noop, check

Capabilities¶ ↑

The server’s capabilities must include IDLE [RFC2177].

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1910
def idle(timeout = nil, &response_handler)
  raise LocalJumpError, "no block given" unless response_handler

  response = nil

  synchronize do
    tag = Thread.current[:net_imap_tag] = generate_tag
    put_string("#{tag} IDLE#{CRLF}")

    begin
      add_response_handler(&response_handler)
      @idle_done_cond = new_cond
      @idle_done_cond.wait(timeout)
      @idle_done_cond = nil
      if @receiver_thread_terminating
        raise @exception || Net::IMAP::Error.new("connection closed")
      end
    ensure
      unless @receiver_thread_terminating
        remove_response_handler(response_handler)
        put_string("DONE#{CRLF}")
        response = get_tagged_response(tag, "IDLE", @idle_response_timeout)
      end
    end
  end

  return response
end

Leaves IDLE.

Related: idle

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1942
def idle_done
  synchronize do
    if @idle_done_cond.nil?
      raise Net::IMAP::Error, "not during IDLE"
    end
    @idle_done_cond.signal
  end
end

Sends a LIST command [IMAP4rev1 §6.3.8] and returns a subset of names from the complete set of all names available to the client. refname provides a context (for instance, a base directory in a directory-based mailbox hierarchy). mailbox specifies a mailbox or (via wildcards) mailboxes under that context. Two wildcards may be used in mailbox: ‘*’, which matches all characters including the hierarchy delimiter (for instance, ‘/’ on a UNIX-hosted directory-based mailbox hierarchy); and ‘%’, which matches all characters except the hierarchy delimiter.

If refname is empty, mailbox is used directly to determine which mailboxes to match. If mailbox is empty, the root name of refname and the hierarchy delimiter are returned.

The return value is an array of MailboxList.

Related: lsub, MailboxList

For example:¶ ↑

imap.create("foo/bar")
imap.create("foo/baz")
p imap.list("", "foo/%")
#=> [#<Net::IMAP::MailboxList attr=[:Noselect], delim="/", name="foo/">, \\
     #<Net::IMAP::MailboxList attr=[:Noinferiors, :Marked], delim="/", name="foo/bar">, \\
     #<Net::IMAP::MailboxList attr=[:Noinferiors], delim="/", name="foo/baz">]

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1213
def list(refname, mailbox)
  synchronize do
    send_command("LIST", refname, mailbox)
    return @responses.delete("LIST")
  end
end

Sends a LOGIN command [IMAP4rev1 §6.2.3] to identify the client and carries the plaintext password authenticating this user. If successful, the connection enters the “authenticated” state.

Using authenticate is generally preferred over login. The LOGIN command is not the same as authenticate with the “LOGIN” mechanism.

A Net::IMAP::NoResponseError is raised if authentication fails.

Related: authenticate, starttls

Capabilities¶ ↑

Clients MUST NOT call login if LOGINDISABLED is listed with the capabilities.

Server capabilities may change after starttls, login, and authenticate. Cached capabilities must be invalidated after this method completes. The TaggedResponse to login may include updated capabilities in its ResponseCode.

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1073
def login(user, password)
  send_command("LOGIN", user, password)
end

Sends a LOGOUT command [IMAP4rev1 §6.1.3] to inform the command to inform the server that the client is done with the connection.

Related: disconnect

# File net-imap-0.3.4.1/lib/net/imap.rb, line 907
def logout
  send_command("LOGOUT")
end

Sends a LSUB command [IMAP4rev1 §6.3.9] and returns a subset of names from the set of names that the user has declared as being “active” or “subscribed.” refname and mailbox are interpreted as for list.

The return value is an array of MailboxList objects.

Related: subscribe, unsubscribe, list, MailboxList

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1425
def lsub(refname, mailbox)
  synchronize do
    send_command("LSUB", refname, mailbox)
    return @responses.delete("LSUB")
  end
end

Sends a MOVE command [RFC6851 §3.1] [IMAP4rev2 §6.4.8] to move the specified message(s) to the end of the specified destination mailbox. The set parameter is a number, an array of numbers, or a Range object. The number is a message sequence number.

Related: uid_move

Capabilities¶ ↑

The server’s capabilities must include MOVE [RFC6851].

If UIDPLUS [RFC4315] is supported, the server’s response should include a COPYUID response code with UIDPlusData. This will report the UIDVALIDITY of the destination mailbox, the UID set of the source messages, and the assigned UID set of the moved messages.

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1785
def move(set, mailbox)
  copy_internal("MOVE", set, mailbox)
end

Sends a NAMESPACE command [RFC2342 §5] and returns the namespaces that are available. The NAMESPACE command allows a client to discover the prefixes of namespaces used by a server for personal mailboxes, other users’ mailboxes, and shared mailboxes.

The return value is a Namespaces object which has personal, other, and shared fields, each an array of Namespace objects. These arrays will be empty when the server responds with nil.

Many IMAP servers are configured with the default personal namespaces as ("" "/"): no prefix and the “/” hierarchy delimiter. In that common case, the naive client may not have any trouble naming mailboxes. But many servers are configured with the default personal namespace as e.g. ("INBOX." "."), placing all personal folders under INBOX, with “.” as the hierarchy delimiter. If the client does not check for this, but naively assumes it can use the same folder names for all servers, then folder creation (and listing, moving, etc) can lead to errors.

From RFC2342:

Although typically a server will support only a single Personal
Namespace, and a single Other User's Namespace, circumstances exist
where there MAY be multiples of these, and a client MUST be prepared
for them.  If a client is configured such that it is required to create
a certain mailbox, there can be circumstances where it is unclear which
Personal Namespaces it should create the mailbox in.  In these
situations a client SHOULD let the user select which namespaces to
create the mailbox in.

Related: list, Namespaces, Namespace

For example:¶ ↑

capabilities = imap.capability
if capabilities.include?("NAMESPACE")
  namespaces = imap.namespace
  if namespace = namespaces.personal.first
    prefix = namespace.prefix  # e.g. "" or "INBOX."
    delim  = namespace.delim   # e.g. "/" or "."
    # personal folders should use the prefix and delimiter
    imap.create(prefix + "foo")
    imap.create(prefix + "bar")
    imap.create(prefix + %w[path to my folder].join(delim))
  end
end

Capabilities¶ ↑

The server’s capabilities must include NAMESPACE [RFC2342].

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1271
def namespace
  synchronize do
    send_command("NAMESPACE")
    return @responses.delete("NAMESPACE")[-1]
  end
end

Sends a NOOP command [IMAP4rev1 §6.1.2] to the server.

This allows the server to send unsolicited untagged EXPUNGE responses, but does not execute any client request. IMAP servers are permitted to send unsolicited untagged responses at any time, except for ‘EXPUNGE`.

• EXPUNGE can only be sent while a command is in progress.

• EXPUNGE must not be sent during fetch, store, or search.

• EXPUNGE may be sent during uid_fetch, uid_store, or uid_search.

Related: idle, check

# File net-imap-0.3.4.1/lib/net/imap.rb, line 898
def noop
  send_command("NOOP")
end

Removes the response handler.

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1969
def remove_response_handler(handler)
  @response_handlers.delete(handler)
end

Sends a RENAME command [IMAP4rev1 §6.3.5] to change the name of the mailbox to newname.

A Net::IMAP::NoResponseError is raised if a mailbox with the name mailbox cannot be renamed to newname for whatever reason; for instance, because mailbox does not exist, or because there is already a mailbox with the name newname.

Related: create, delete

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1154
def rename(mailbox, newname)
  send_command("RENAME", mailbox, newname)
end

Sends a SEARCH command [IMAP4rev1 §6.4.4] to search the mailbox for messages that match the given searching criteria, and returns message sequence numbers. keys can either be a string holding the entire search string, or a single-dimension array of search keywords and arguments.

Related: uid_search

Search criteria¶ ↑

For a full list of search criteria, see [IMAP4rev1 §6.4.4], or [IMAP4rev2 §6.4.4], in addition to documentation for any [CAPABILITIES] reported by capability which may define additional search filters, e.g: CONDSTORE, WITHIN, FILTERS, SEARCH=FUZZY, OBJECTID, or SAVEDATE. The following are some common search criteria:

<message set>

a set of message sequence numbers. “,” indicates an interval, “:” indicates a range. For instance, “2,10:12,15” means “2,10,11,12,15”.

BEFORE <date>

messages with an internal date strictly before <date>. The date argument has a format similar to 8-Aug-2002, and can be formatted using Net::IMAP.format_date.

BODY <string>

messages that contain <string> within their body.

CC <string>

messages containing <string> in their CC field.

FROM <string>

messages that contain <string> in their FROM field.

NEW

messages with the Recent, but not the Seen, flag set.

NOT <search-key>

negate the following search key.

OR <search-key> <search-key>

“or” two search keys together.

ON <date>

messages with an internal date exactly equal to <date>, which has a format similar to 8-Aug-2002.

SINCE <date>

messages with an internal date on or after <date>.

SUBJECT <string>

messages with <string> in their subject.

TO <string>

messages with <string> in their TO field.

For example:¶ ↑

p imap.search(["SUBJECT", "hello", "NOT", "NEW"])
#=> [1, 6, 7, 8]

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1631
def search(keys, charset = nil)
  return search_internal("SEARCH", keys, charset)
end

Sends a SELECT command [IMAP4rev1 §6.3.1] to select a mailbox so that messages in the mailbox can be accessed.

After you have selected a mailbox, you may retrieve the number of items in that mailbox from imap.responses["EXISTS"][-1], and the number of recent messages from imap.responses["RECENT"][-1]. Note that these values can change if new messages arrive during a session or when existing messages are expunged; see add_response_handler for a way to detect these events.

A Net::IMAP::NoResponseError is raised if the mailbox does not exist or is for some reason non-selectable.

Related: examine

Capabilities¶ ↑

If [UIDPLUS] is supported, the server may return an untagged “NO” response with a “UIDNOTSTICKY” response code indicating that the mailstore does not support persistent UIDs:

@responses["NO"].last.code.name == "UIDNOTSTICKY"

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1099
def select(mailbox)
  synchronize do
    @responses.clear
    send_command("SELECT", mailbox)
  end
end

Sends a SETACL command [RFC4314 §3.1] along with mailbox, user and the rights that user is to have on that mailbox. If rights is nil, then that user will be stripped of any rights to that mailbox.

Related: getacl

Capabilities¶ ↑

The server’s capabilities must include ACL [RFC4314].

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1392
def setacl(mailbox, user, rights)
  if rights.nil?
    send_command("SETACL", mailbox, user, "")
  else
    send_command("SETACL", mailbox, user, rights)
  end
end

Sends a SETQUOTA command [RFC2087 §4.1] along with the specified mailbox and quota. If quota is nil, then quota will be unset for that mailbox. Typically one needs to be logged in as a server admin for this to work.

Related: getquota, getquotaroot

Capabilities¶ ↑

The server’s capabilities must include QUOTA [RFC2087].

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1372
def setquota(mailbox, quota)
  if quota.nil?
    data = '()'
  else
    data = '(STORAGE ' + quota.to_s + ')'
  end
  send_command("SETQUOTA", mailbox, RawData.new(data))
end

Sends a SORT command [RFC5256 §3] to search a mailbox for messages that match search_keys and return an array of message sequence numbers, sorted by sort_keys. search_keys are interpreted the same as for search.

Related: uid_sort, search, uid_search, thread, uid_thread

For example:¶ ↑

p imap.sort(["FROM"], ["ALL"], "US-ASCII")
#=> [1, 2, 3, 5, 6, 7, 8, 4, 9]
p imap.sort(["DATE"], ["SUBJECT", "hello"], "US-ASCII")
#=> [6, 7, 8, 1]

Capabilities¶ ↑

The server’s capabilities must include SORT [RFC5256].

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1829
def sort(sort_keys, search_keys, charset)
  return sort_internal("SORT", sort_keys, search_keys, charset)
end

Sends a STARTTLS command [IMAP4rev1 §6.2.1] to start a TLS session.

Any options are forwarded to OpenSSL::SSL::SSLContext#set_params.

This method returns after TLS negotiation and hostname verification are both successful. Any error indicates that the connection has not been secured.

Note:

Any response_handlers added before STARTTLS should be aware that the TaggedResponse to STARTTLS is sent clear-text, before TLS negotiation. TLS negotiation starts immediately after that response.

Related: Net::IMAP.new, login, authenticate

Capability¶ ↑

The server’s capabilities must include STARTTLS.

Server capabilities may change after starttls, login, and authenticate. Cached capabilities must be invalidated after this method completes.

The TaggedResponse to starttls is sent clear-text, so the server must not send capabilities in the starttls response and clients must not use them if they are sent. Servers will generally send an unsolicited untagged response immeditely after starttls completes.

# File net-imap-0.3.4.1/lib/net/imap.rb, line 940
def starttls(options = {}, verify = true)
  send_command("STARTTLS") do |resp|
    if resp.kind_of?(TaggedResponse) && resp.name == "OK"
      begin
        # for backward compatibility
        certs = options.to_str
        options = create_ssl_params(certs, verify)
      rescue NoMethodError
      end
      start_tls_session(options)
    end
  end
end

Sends a STATUS commands [IMAP4rev1 §6.3.10] and returns the status of the indicated mailbox. attr is a list of one or more attributes whose statuses are to be requested. Supported attributes include:

MESSAGES:: the number of messages in the mailbox.
RECENT:: the number of recent messages in the mailbox.
UNSEEN:: the number of unseen messages in the mailbox.

The return value is a hash of attributes. For example:

p imap.status("inbox", ["MESSAGES", "RECENT"])
#=> {"RECENT"=>0, "MESSAGES"=>44}

A Net::IMAP::NoResponseError is raised if status values for mailbox cannot be returned; for instance, because it does not exist.

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1449
def status(mailbox, attr)
  synchronize do
    send_command("STATUS", mailbox, attr)
    return @responses.delete("STATUS")[-1].attr
  end
end

Sends a STORE command [IMAP4rev1 §6.4.6] to alter data associated with messages in the mailbox, in particular their flags. The set parameter is a number, an array of numbers, or a Range object. Each number is a message sequence number. attr is the name of a data item to store: ‘FLAGS’ will replace the message’s flag list with the provided one, ‘+FLAGS’ will add the provided flags, and ‘-FLAGS’ will remove them. flags is a list of flags.

The return value is an array of FetchData

Related: uid_store

For example:¶ ↑

p imap.store(6..8, "+FLAGS", [:Deleted])
#=> [#<Net::IMAP::FetchData seqno=6, attr={"FLAGS"=>[:Seen, :Deleted]}>, \\
     #<Net::IMAP::FetchData seqno=7, attr={"FLAGS"=>[:Seen, :Deleted]}>, \\
     #<Net::IMAP::FetchData seqno=8, attr={"FLAGS"=>[:Seen, :Deleted]}>]

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1719
def store(set, attr, flags)
  return store_internal("STORE", set, attr, flags)
end

Sends a SUBSCRIBE command [IMAP4rev1 §6.3.6] to add the specified mailbox name to the server’s set of “active” or “subscribed” mailboxes as returned by lsub.

A Net::IMAP::NoResponseError is raised if mailbox cannot be subscribed to; for instance, because it does not exist.

Related: unsubscribe, lsub, list

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1166
def subscribe(mailbox)
  send_command("SUBSCRIBE", mailbox)
end

Sends a THREAD command [RFC5256 §3] to search a mailbox and return message sequence numbers in threaded format, as a ThreadMember tree. search_keys are interpreted the same as for search.

The supported algorithms are:

ORDEREDSUBJECT

split into single-level threads according to subject, ordered by date.

REFERENCES

split into threads by parent/child relationships determined by which message is a reply to which.

Unlike search, charset is a required argument. US-ASCII and UTF-8 are sample values.

Related: uid_thread, search, uid_search, sort, uid_sort

Capabilities¶ ↑

The server’s capabilities must include THREAD [RFC5256].

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1869
def thread(algorithm, search_keys, charset)
  return thread_internal("THREAD", algorithm, search_keys, charset)
end

Sends a UID COPY command [IMAP4rev1 §6.4.8] to copy the specified message(s) to the end of the specified destination mailbox.

Similar to copy, but set contains unique identifiers.

Capabilities¶ ↑

UIDPLUS affects uid_copy the same way it affects copy.

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1762
def uid_copy(set, mailbox)
  copy_internal("UID COPY", set, mailbox)
end

Sends a UID EXPUNGE command [RFC4315 §2.1] [IMAP4rev2 §6.4.9] to permanently remove all messages that have both the \Deleted flag set and a UID that is included in uid_set.

By using uid_expunge instead of expunge when resynchronizing with the server, the client can ensure that it does not inadvertantly remove any messages that have been marked as \Deleted by other clients between the time that the client was last connected and the time the client resynchronizes.

Note:

Although the command takes a set of UIDs for its argument, the server still returns regular EXPUNGE responses, which contain a sequence number. These will be deleted from responses and this method returns them as an array of sequence number integers.

Related: expunge

Capabilities¶ ↑

The server’s capabilities must include UIDPLUS [RFC4315].

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1570
def uid_expunge(uid_set)
  synchronize do
    send_command("UID EXPUNGE", MessageSet.new(uid_set))
    return @responses.delete("EXPUNGE")
  end
end

Sends a UID FETCH command [IMAP4rev1 §6.4.8] to retrieve data associated with a message in the mailbox.

Similar to fetch, but the set parameter contains unique identifiers instead of message sequence numbers.

Note: Servers MUST implicitly include the UID message data item as part of any FETCH response caused by a UID command, regardless of whether a UID was specified as a message data item to the FETCH.

Related: fetch, FetchData

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1697
def uid_fetch(set, attr, mod = nil)
  return fetch_internal("UID FETCH", set, attr, mod)
end

Sends a UID MOVE command [RFC6851 §3.2] [IMAP4rev2 §6.4.9] to move the specified message(s) to the end of the specified destination mailbox.

Similar to move, but set contains unique identifiers.

Related: move

Capabilities¶ ↑

Same as move: The server’s capabilities must include MOVE [RFC6851]. UIDPLUS also affects uid_move the same way it affects move.

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1803
def uid_move(set, mailbox)
  copy_internal("UID MOVE", set, mailbox)
end

Sends a UID SEARCH command [IMAP4rev1 §6.4.8] to search the mailbox for messages that match the given searching criteria, and returns unique identifiers (UIDs).

See search for documentation of search criteria.

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1640
def uid_search(keys, charset = nil)
  return search_internal("UID SEARCH", keys, charset)
end

Sends a UID SORT command [RFC5256 §3] to search a mailbox for messages that match search_keys and return an array of unique identifiers, sorted by sort_keys. search_keys are interpreted the same as for search.

Related: sort, search, uid_search, thread, uid_thread

Capabilities¶ ↑

The server’s capabilities must include SORT [RFC5256].

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1844
def uid_sort(sort_keys, search_keys, charset)
  return sort_internal("UID SORT", sort_keys, search_keys, charset)
end

Sends a UID STORE command [IMAP4rev1 §6.4.8] to alter data associated with messages in the mailbox, in particular their flags.

Similar to store, but set contains unique identifiers instead of message sequence numbers.

Related: store

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1731
def uid_store(set, attr, flags)
  return store_internal("UID STORE", set, attr, flags)
end

Sends a UID THREAD command [RFC5256 §3] Similar to thread, but returns unique identifiers instead of message sequence numbers.

Related: thread, search, uid_search, sort, uid_sort

Capabilities¶ ↑

The server’s capabilities must include THREAD [RFC5256].

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1883
def uid_thread(algorithm, search_keys, charset)
  return thread_internal("UID THREAD", algorithm, search_keys, charset)
end

Sends an UNSELECT command [RFC3691 §2] [IMAP4rev2 §6.4.2] to free the session resources for a mailbox and return to the “authenticated” state. This is the same as close, except that \Deleted messages are not removed from the mailbox.

Related: close

Capabilities¶ ↑

The server’s capabilities must include UNSELECT [RFC3691].

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1529
def unselect
  send_command("UNSELECT")
end

Sends an UNSUBSCRIBE command [IMAP4rev1 §6.3.7] to remove the specified mailbox name from the server’s set of “active” or “subscribed” mailboxes.

A Net::IMAP::NoResponseError is raised if mailbox cannot be unsubscribed from; for instance, because the client is not currently subscribed to it.

Related: subscribe, lsub, list

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1179
def unsubscribe(mailbox)
  send_command("UNSUBSCRIBE", mailbox)
end

Sends a XLIST command, and returns a subset of names from the complete set of all names available to the client. refname provides a context (for instance, a base directory in a directory-based mailbox hierarchy). mailbox specifies a mailbox or (via wildcards) mailboxes under that context. Two wildcards may be used in mailbox: ‘*’, which matches all characters including the hierarchy delimiter (for instance, ‘/’ on a UNIX-hosted directory-based mailbox hierarchy); and ‘%’, which matches all characters except the hierarchy delimiter.

If refname is empty, mailbox is used directly to determine which mailboxes to match. If mailbox is empty, the root name of refname and the hierarchy delimiter are returned.

The XLIST command is like the LIST command except that the flags returned refer to the function of the folder/mailbox, e.g. :Sent

The return value is an array of MailboxList objects. For example:

imap.create("foo/bar")
imap.create("foo/baz")
p imap.xlist("", "foo/%")
#=> [#<Net::IMAP::MailboxList attr=[:Noselect], delim="/", name="foo/">, \\
     #<Net::IMAP::MailboxList attr=[:Noinferiors, :Marked], delim="/", name="foo/bar">, \\
     #<Net::IMAP::MailboxList attr=[:Noinferiors], delim="/", name="foo/baz">]

Related: list, MailboxList

Capabilities¶ ↑

The server’s capabilities must include XLIST, a deprecated Gmail extension (replaced by SPECIAL-USE).

# File net-imap-0.3.4.1/lib/net/imap.rb, line 1315
def xlist(refname, mailbox)
  synchronize do
    send_command("XLIST", refname, mailbox)
    return @responses.delete("XLIST")
  end
end