aboutsummaryrefslogtreecommitdiffstats
path: root/pullimap.md
diff options
context:
space:
mode:
authorGuilhem Moulin <guilhem@fripost.org>2016-03-11 19:32:05 +0100
committerGuilhem Moulin <guilhem@fripost.org>2016-03-11 19:32:05 +0100
commit7f15c76976dc76b580a2e182ad1538cd6359f926 (patch)
tree17d079e54bf9002a978c687c9efe08d57f57bd91 /pullimap.md
parenta7e0aa0bae9b4da9fe441eb91604df9306dfde79 (diff)
interimap: convert manpage to markdown.
Diffstat (limited to 'pullimap.md')
-rw-r--r--pullimap.md30
1 files changed, 14 insertions, 16 deletions
diff --git a/pullimap.md b/pullimap.md
index c14c605..5251706 100644
--- a/pullimap.md
+++ b/pullimap.md
@@ -5,8 +5,7 @@
Name
====
-PullIMAP - Pull mails from an IMAP mailbox and deliver them to a SMTP
-session
+PullIMAP - Pull mails from an IMAP mailbox and deliver them to a SMTP session
Synopsis
========
@@ -25,15 +24,15 @@ A *statefile* is used to keep track of the mailbox's `UIDVALIDITY` and
`UIDNEXT` values. While `pullimap` is running, the *statefile* is also
used to keep track of UIDs being delivered, which avoids duplicate
deliveries in case the process is interrupted.
-See the [**Control flow**](#control-flow) section below for details.
+See the **[control flow]** section below for details.
Options
=======
`--config=`*FILE*
-: Specify an alternate configuration file. Relative paths start from
- *$XDG_CONFIG_HOME*, or *~/.config* if the `XDG_CONFIG_HOME`
+: Specify an alternate [configuration file]. Relative paths start
+ from *$XDG_CONFIG_HOME*, or *~/.config* if the `XDG_CONFIG_HOME`
environment variable is unset.
`--idle`[`=`*seconds*]
@@ -71,7 +70,6 @@ Options
: Show the version number and exit.
-
Configuration file
==================
@@ -211,8 +209,8 @@ Valid options are:
*SSL_fingerprint*
: Fingerprint of the server certificate (or its public key) in the
- form `ALGO$DIGEST_HEX`, where `ALGO` is the used algorithm (default
- `sha256`).
+ form `[ALGO$]DIGEST_HEX`, where `ALGO` is the used algorithm
+ (by default `sha256`).
Attempting to connect to a server with a non-matching certificate
fingerprint causes `pullimap` to abort the connection during the
SSL/TLS handshake.
@@ -258,9 +256,9 @@ The [IMAP4rev1 specification][RFC 3501] does not guaranty that untagged
command. Thus it would be unsafe for `pullimap` to update the `UIDNEXT`
value in its *statefile* while the `UID FETCH` command is progress.
Instead, for each untagged `FETCH` response received while the `UID
-FETCH` command is in progress, `pullimap` delivers the message `BODY` to
-the SMTP or LMTP server (specified with *deliver-method*) then appends
-the message UID to the *statefile*.
+FETCH` command is in progress, `pullimap` delivers the message `RFC822`
+body to the SMTP or LMTP server (specified with *deliver-method*) then
+appends the message UID to the *statefile*.
When the `UID FETCH` command eventually terminates, `pullimap` updates
the `UIDNEXT` value in the *statefile* and truncate the file down to 8
bytes. Keeping track of message UIDs as they are received avoids
@@ -270,8 +268,8 @@ FETCH` command is in progress.
In more details, `pullimap` works as follows:
1. Issue an `UID FETCH` command to retrieve message `ENVELOPE` and
- `BODY` (and `UID`) with UID bigger or equal than the `UIDNEXT` value
- found in the *statefile*.
+ `RFC822` (and `UID`) with UID bigger or equal than the `UIDNEXT`
+ value found in the *statefile*.
While the `UID FETCH` command is in progress, perform the following
for each untagged `FETCH` response sent by the server:
@@ -282,8 +280,8 @@ In more details, `pullimap` works as follows:
the `UID FETCH` IMAP command is in progress);
i. perform a mail transaction (using [SMTP pipelining][RFC 2920] if
- possible) to deliver the retrieved message BODY to the SMTP or
- LMTP session; and
+ possible) to deliver the retrieved message `RFC822` body to the
+ SMTP or LMTP session; and
i. append the message UID to the *statefile*.
@@ -301,7 +299,7 @@ In more details, `pullimap` works as follows:
`UIDVALIDITY` and `UIDNEXT` values).
6. If `--idle` was set, issue an `IDLE` command; stop idling and go
- back to step 1. when a new message is received (or when the `IDLE`
+ back to step 1 when a new message is received (or when the `IDLE`
timeout expires).
Standards