search

search(keys, charset = nil) Instance Public methods Sends a SEARCH command 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. The following are some common search criteria; see [IMAP] section 6.4.4 for a full list. <message set> a set of message sequence numbers. ',' indicates an interva

rename

rename(mailbox, newname) Instance Public methods Sends a RENAME command 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.

remove_response_handler

remove_response_handler(handler) Instance Public methods Removes the response handler.

noop

noop() Instance Public methods Sends a NOOP command to the server. It does nothing.

lsub

lsub(refname, mailbox) Instance Public methods Sends a LSUB command, 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 Net::IMAP::MailboxList.

logout

logout() Instance Public methods Sends a LOGOUT command to inform the server that the client is done with the connection.

login

login(user, password) Instance Public methods Sends a LOGIN command to identify the client and carries the plaintext password authenticating this user. Note that, unlike calling authenticate() with an auth_type of âLOGINâ, login() does not use the login authenticator. A Net::IMAP::NoResponseError is raised if authentication fails.

list

list(refname, mailbox) Instance Public methods Sends a LIST 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 directo

idle_done

idle_done() Instance Public methods Leaves IDLE.

idle

idle(&response_handler) Instance Public methods Sends an IDLE command that waits for notifications of new or expunged messages. Yields responses from the server during the IDLE. Use idle_done() to leave IDLE.