Mailutils imap

From Mailutils

You do not have permission to edit this page, for the following reasons:

• The action you have requested is limited to users in the group: emailconfirmed.
• You must confirm your e-mail address before editing pages. Please set and validate your e-mail address through your user preferences.

You can view and copy the source of this page:

The <tt>[[mu|mailutils]] imap</tt> command invokes an interactive IMAP4 client shell. It reads commands from the standard input, executes them and displays the results on the standard output. The shell is similar to the [[mailutils pop]] shell, which see. == IMAP protocol commands == Most commands in this group correspond (with minor differences) to IMAP commands described in [http://www.faqs.org/rfcs/rfc3501.html RFC 3501]. ;connect [-tls] ''hostname'' [''port''] :Open connection to ''hostname''. If the <tt>-tls</tt> option is given, TLS encryption (also known as IMAPS protocol) will be used. If port argument is not supplied, the command uses port 143 for a plain IMAP connection or 993 for IMAPS (if <tt>-tls</tt> is given). ;capability [-reread] [''name''...] :List server capabilities. Any number of ''name'' arguments is accepted. If given, the shell will display only the named capabilities, otherwise it displays the entire list. By default <tt>capability</tt> reuses the response of its previous invocation (if there was any), instead of resending the <tt>CAPABILITY</tt> command to the server. To force it do so, use the <tt>-reread</tt> option. ;starttls :Start TLS negotiation. This command is valid only after unencrypted connection has been successfully initiated using <tt>connect</tt> without <tt>-tls</tt> argument. ;login ''user'' [''pass''] :Login to the server as ''user'' with password ''pass''. If the ''pass'' argument is omitted, the shell will ask you to enter it. While entering, both echoing and history recording will be disabled. Use this to avoid compromising your password. ;logout :Quit imap session ;id [-test ''kw''] [''arg'' [''arg''...]] :Send IMAP ID command. See [http://www.faqs.org/rfcs/rfc2971.html RFC 2971], for a discussion of arguments. By default, this command outputs entire ID list. If, however, the <tt>-test ''kw''</tt> option is given, it will check whether the keyword ''kw'' is defined and display its value if so. ;check :Request a server checkpoint. ;select [''mbox''] :Select a mailbox. Without argument, selects <tt>"INBOX"</tt>. ;examine [''mbox''] :Examine a mailbox, i.e. select it in read-only mode. If ''mbox'' is not given, <tt>"INBOX"</tt> is assumed. ;status ''mbox'' ''kw'' [''kw''...] :Get mailbox status. Valid keywords (''kw'') are: <tt>MESSAGES</tt>, <tt>RECENT</tt>, <tt>UIDNEXT</tt>, <tt>UIDVALIDITY</tt>, and <tt>UNSEEN</tt>. Keywords are case-insensitive. ;fetch ''msgset'' ''items'' :Fetch message data. See [http://tools.ietf.org/html/rfc3501#section-6.4.5 RFC 3501, section 6.4.5], for a discussion of its arguments. ;store ''msgset'' ''items'' :Alter mailbox data. See [http://tools.ietf.org/html/rfc3501#section-6.4.6 RFC 3501, section 6.4.6], for a discussion of its arguments. ;close :Close the mailbox (with expunge). ;unselect :Close the mailbox (without expunge). ;delete ''mbox'' :Delete the mailbox. ;rename ''old-name'' ''new-name'' :Rename existing mailbox ''old-name'' to ''new-name'' ;expunge :Permanently remove messages marked for deletion. ;create ''mbox'' :Create new mailbox. ;append [-time ''datetime''] [-flag ''flag''] ''mailbox'' ''file'' :Read an RFC-822 message from ''file'' and append it to the ''mailbox''. Use the <tt>-time</tt> option to supply envelope date for the message. Use <tt>-flag</tt> option to supply message flags. For example: append -time "25-Aug-2002 18:00:00 +0200" -flag \Seen INBOX input.msg ;list ''ref'' ''mbox'' :List matching mailboxes. See [http://tools.ietf.org/html/rfc3501#section-6.3.8 RFC 3501, section 6.3.8], for a discussion of its arguments. ;lsub ''ref'' ''mbox'' :List subscribed mailboxes ([http://tools.ietf.org/html/rfc3501#section-6.3.9 RFC 3501, section 6.3.9]). ;subscribe ''mbox'' :Subscribe to a mailbox. ;unsubscribe ''mbox'' :Remove mailbox ''mbox'' from the subscription list. ;quit :Same as <tt>logout</tt>. ;noop :Send a ''no operation''. ;disconnect :Close existing connection. == Internal commands == The <tt>imap</tt> shell implements the same set of internal commands as <tt>pop</tt> shell (see the [[#pop-internal|description above]]). There is only one imap-specific internal command: ;uid [on|off] :Control UID mode. When the UID mode is <tt>on</tt>, the commands <tt>fetch</tt> and <tt>store</tt> (and, in future, <tt>search</tt> and <tt>copy</tt>) operate on and return message UIDs instead of their sequence numbers. :To examine the current state of the UID mode, issue the <tt>uid</tt> command without arguments. == See also == * [[mailutils (utility)]] [[Category:utilities]]

Return to Mailutils imap.