From: Rocco Rutte Date: Thu, 1 Nov 2007 11:44:18 +0000 (+0100) Subject: Manual: Document URL syntax in just one place, let others refer to it. X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=71fca072a2c09410f0bf8fa5e8fbee8edd04dede;p=neomutt Manual: Document URL syntax in just one place, let others refer to it. --- diff --git a/doc/manual.xml.head b/doc/manual.xml.head index 4fc8f6cf8..14bfcc4a8 100644 --- a/doc/manual.xml.head +++ b/doc/manual.xml.head @@ -5601,6 +5601,53 @@ OpenSSL, mutt -v would contain: + +URL syntax + + +Mutt optionally supports the IMAP, POP3 and SMTP protocols which require +to access servers using URLs. The canonical syntax for specifying URLs +in mutt is (an item enclosed in [] means it is optional and +may be omitted): + + + +proto[s]://[username[:password]@]server[:port]/[path] + + + +proto is the communication protocol: +imap for IMAP, pop for POP3 and +smtp for SMTP. If ``s'' for ``secure communication'' +is appended, mutt will attempt to establish an encrypted communication +using SSL or TLS. If no explicit port is given, mutt will use the +system's default for the given protocol. + + + +Since all protocols by mutt support authentication, the username may be +given directly in the URL instead of using the pop_user or +imap_user variables. A password can be given, too but +is not recommended if the URL is specified in a configuration file on +disk. + + + +The optional path is only relevant for IMAP. + + + +For IMAP for example, you can select an alternative port by specifying it with the +server: imap://imapserver:port/INBOX. You can also specify different +username for each folder: imap://username@imapserver[:port]/INBOX +or imap://username2@imapserver[:port]/path/to/folder. +Replacing imap:// by imaps:// +would make mutt attempt to conect using SSL or TLS on a different port +to encrypt the communication. + + + + @@ -5614,18 +5661,9 @@ browsing. -You can access the remote POP3 mailbox by selecting the folder -pop://popserver/. - - - -You can select an alternative port by specifying it with the server, ie: -pop://popserver:port/. - - - -You can also specify different username for each folder, ie: -pop://username@popserver[:port]/. +Remote POP3 servers can be accessed using URLs with the pop protocol +for unencrypted and pops for encrypted +communication, see for details. @@ -5636,15 +5674,6 @@ controlled by the variable, which defaults to every 60 seconds. - -If Mutt was compiled with SSL support (by running the configure -script with the --with-ssl flag), connections to POP3 servers -can be encrypted. This naturally requires that the server supports -SSL encrypted connections. To access a folder with POP3/SSL, you should -use pops: prefix, ie: -pops://[username@]popserver[:port]/. - - Another way to access your POP3 mail is the fetch-mail function (default: G). It allows to connect to $pop_host, fetch all your new mail and place it in the @@ -5672,40 +5701,15 @@ with folders located on a remote IMAP server. -You can access the remote inbox by selecting the folder -imap://imapserver/INBOX, where imapserver is the name of the -IMAP server and INBOX is the special name for your spool mailbox on -the IMAP server. If you want to access another mail folder at the IMAP -server, you should use imap://imapserver/path/to/folder where -path/to/folder is the path of the folder you want to access. - - - -You can select an alternative port by specifying it with the server, ie: -imap://imapserver:port/INBOX. - - - -You can also specify different username for each folder, ie: -imap://username@imapserver[:port]/INBOX. - - - -If Mutt was compiled with SSL support (by running the configure -script with the --with-ssl flag), connections to IMAP servers -can be encrypted. This naturally requires that the server supports -SSL encrypted connections. To access a folder with IMAP/SSL, you should -use imaps://[username@]imapserver[:port]/path/to/folder as your -folder path. - - - -Pine-compatible notation is also supported, ie +You can access the remote inbox by selecting the folder by its URL +(see for details) using the +imap or imaps protocol. +Alternatively, a pine-compatible notation is also supported, ie {[username@]imapserver[:port][/ssl]}path/to/folder -Note that not all servers use / as the hierarchy separator. Mutt should +Note that not all servers use ``/'' as the hierarchy separator. Mutt should correctly notice which separator is being used by the server and convert paths accordingly. @@ -5870,6 +5874,10 @@ will contact the given SMTP server to deliver messages; if it is unset, mutt will use the program specified by $sendmail. + +For details on the URL syntax, please see . + + The built-in SMTP support supports encryption (the smtps protocol using SSL or TLS) as well as SMTP authentication using SASL. The authentication mechanisms