Ruby Net::IMAP Functions
EditRocket provides the following information on Net::IMAP functions in the Ruby source code builder.
add_authenticator(auth_type, authenticator) - Adds an authenticator for Net::IMAP#authenticate. auth_type is the type of authentication this authenticator supports (for instance, "LOGIN"). The authenticator is an object which defines a process() method to handle authentication with the server. See Net::IMAP::LoginAuthenticator and Net::IMAP::CramMD5Authenticator for examples.
add_response_handler(handler = Proc.new) - Adds a response handler. For example, to detect when the server sends us a new EXISTS response (which normally indicates new messages being added to the mail box), you could add the following handler after selecting the mailbox.
append(mailbox, message, flags = nil, date_time = nil) - "Sends a APPEND command to append the message to the end of the mailbox. The optional flags argument is an array of flags to initially passing 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:"
authenticate(auth_type, *args) - "Sends an AUTHENTICATE command to authenticate the client. The auth_type parameter is a string that represents the authentication mechanism to be used. Currently Net::IMAP supports authentication mechanisms:"
capability() - Sends a CAPABILITY command, and returns an array of capabilities that the server supports. Each capability is a string. See [IMAP] for a list of possible capabilities.
check() - Sends a CHECK command 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.
close() - Sends a CLOSE command to close the currently selected mailbox. The CLOSE command permanently removes from the mailbox all messages that have the \Deleted flag set.
copy(set, mailbox) - Sends a COPY command to copy the specified message(s) to the end of the specified destination mailbox. The set parameter is a number or an array of numbers or a Range object. The number is a message sequence number.
create(mailbox) - Sends a CREATE command to create a new mailbox.
debug=(val) - Sets the debug mode.
debug() - Returns the debug mode.
decode_utf7(s) - Decode a string from modified UTF-7 format to UTF-8.
delete(mailbox) - Sends a DELETE command to remove the mailbox.
disconnect() - Disconnects from the server.
disconnected?() - Returns true if disconnected from the server.
encode_utf7(s) - Encode a string from UTF-8 format to modified UTF-7.
examine(mailbox) - "Sends a EXAMINE command 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."
expunge() - Sends a EXPUNGE command to permanently remove from the currently selected mailbox all messages that have the \Deleted flag set.
fetch(set, attr) - "Sends a FETCH command to retrieve data associated with a message in the mailbox. The set parameter is a number or an array of numbers or a Range object. The number is a message sequence number. attr is a list of attributes to fetch; see the documentation for Net::IMAP::FetchData for a list of valid attributes. The return value is an array of Net::IMAP::FetchData. For example:"
getacl(mailbox) - Send the GETACL command along with specified mailbox. If this mailbox exists, an array containing objects of Net::IMAP::MailboxACLItem will be returned.
getquota(mailbox) - Sends the GETQUOTA command along with specified mailbox. If this mailbox exists, then an array containing a Net::IMAP::MailboxQuota object is returned. This command generally is only available to server admin.
getquotaroot(mailbox) - Sends the GETQUOTAROOT command along with specified mailbox. This command is generally available to both admin and user. If mailbox exists, returns an array containing objects of Net::IMAP::MailboxQuotaRoot and Net::IMAP::MailboxQuota.
list(refname, mailbox) - "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 directory-based mailbox hierarchy); and '%', which matches all characters except the hierarchy delimiter."
login(user, password) - "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."
logout() - Sends a LOGOUT command to inform the server that the client is done with the connection.
lsub(refname, mailbox) - "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+."
new(host, port = PORT, usessl = false, certs = nil, verify = false) - Creates a new Net::IMAP object and connects it to the specified port (143 by default) on the named host. If usessl is true, then an attempt will be made to use SSL (now TLS) to connect to the server. For this to work OpenSSL [OSSL] and the Ruby OpenSSL [RSSL] extensions need to be installed. The certs parameter indicates the path or file containing the CA cert of the server, and the verify parameter is for the OpenSSL verification callback.
noop() - Sends a NOOP command to the server. It does nothing.
remove_response_handler(handler) - Removes the response handler.
rename(mailbox, newname) - Sends a RENAME command to change the name of the mailbox to newname.
search(keys, charset = nil) - 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.
select(mailbox) - Sends a SELECT command to select a mailbox so that messages in the mailbox can be accessed.
setacl(mailbox, user, rights) - Sends the SETACL command 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. The IMAP ACL commands are described in [RFC-2086].
setquota(mailbox, quota) - Sends a SETQUOTA command 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 server admin for this to work. The IMAP quota commands are described in [RFC-2087].
sort(sort_keys, search_keys, charset) - "Sends a SORT command to sort messages in the mailbox. Returns an array of message sequence numbers. For example:"
status(mailbox, attr) - "Sends a STATUS command, and returns the status of the indicated mailbox. attr is a list of one or more attributes that we are request the status of. Supported attributes include:"
store(set, attr, flags) - "Sends a STORE command to alter data associated with messages in the mailbox, in particular their flags. The set parameter is a number or 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' means to replace the message's flag list with the provided one; '+FLAGS' means to add the provided flags; and '-FLAGS' means to remove them. flags is a list of flags."
subscribe(mailbox) - "Sends a SUBSCRIBE command to add the specified mailbox name to the server's set of "active" or "subscribed" mailboxes as returned by #lsub()."
thread(algorithm, search_keys, charset) - "As for #search(), but returns message sequence numbers in threaded format, as a Net::IMAP::ThreadMember tree. The supported algorithms are:"
uid_copy(set, mailbox) - "As for #copy(), but set contains unique identifiers."
uid_fetch(set, attr) - "As for #fetch(), but set contains unique identifiers."
uid_search(keys, charset = nil) - "As for #search(), but returns unique identifiers."
uid_sort(sort_keys, search_keys, charset) - "As for #sort(), but returns an array of unique identifiers."
uid_store(set, attr, flags) - "As for #store(), but set contains unique identifiers."
uid_thread(algorithm, search_keys, charset) - "As for #thread(), but returns unique identifiers instead of message sequence numbers."
unsubscribe(mailbox) - Sends a UNSUBSCRIBE command to remove the specified mailbox name from the server's set of "active" or "subscribed" mailboxes.