mu/man/mu-extract.1

99 lines
2.4 KiB
Groff
Raw Normal View History

.TH MU EXTRACT 1 "May 2011" "User Manuals"
2010-08-24 20:09:43 +02:00
.SH NAME
2011-05-25 21:04:13 +02:00
mu extract\- display and save message parts (attachments), and open them with
other tools.
2010-08-24 20:09:43 +02:00
.SH SYNOPSIS
.B mu extract [options] <file>
.B mu extract [options] <file> <pattern>
2010-08-24 20:09:43 +02:00
.SH DESCRIPTION
2010-09-01 22:35:03 +02:00
\fBmu extact\fR is the \fBmu\fR sub-command for extracting MIME-parts (e.g.,
2011-01-31 08:15:55 +01:00
attachments) from mail messages. It works on message files, and does not
2011-05-25 21:04:13 +02:00
require the message to be indexed in the database.
2010-09-01 22:35:03 +02:00
2011-05-25 21:04:13 +02:00
For attachments, the file name used when saving it, is the name of the
attachment in the message. If there is no such name, or when saving
non-attachment MIME-parts, a name is derived from the message-id of the
message.
2011-04-05 06:34:22 +02:00
2011-05-24 21:42:20 +02:00
If you specify a pattern (a case-insensitive regular expression) as the second
argument, all attachments with filenames matching that pattern will be
2011-05-24 21:42:20 +02:00
extracted. The regular expressions are Perl-compatible (as per the
PCRE-library).
2011-04-05 06:34:22 +02:00
Without any options, \fBmu extract\fR simply outputs the list of MIME-parts in
the message.
2010-08-24 20:09:43 +02:00
.SH OPTIONS
.TP
2010-09-01 22:35:03 +02:00
\fB\-a\fR, \fB\-\-save\-attachments\fR
save all MIME-parts that look like attachments.
2010-10-23 11:04:14 +02:00
.TP
\fB\-\-save\-all\fR
2010-09-01 22:35:03 +02:00
save all non-multipart MIME-parts.
2010-10-23 11:04:14 +02:00
.TP
\fB\-\-parts\fR=<parts>
only consider the following numbered parts
(comma-separated list).The numbers for the parts can be seen from running
\fBmu extract\fR without any options but only the message file.
.TP
2010-09-01 22:35:03 +02:00
\fB\-\-target\-dir\fR=<dir>
2010-10-23 11:04:14 +02:00
save the parts in the target directory rather than
the current working directory.
2010-09-01 22:35:03 +02:00
2010-10-23 11:04:14 +02:00
.TP
2010-09-01 22:35:03 +02:00
\fB\-\-overwrite\fR
overwrite existing files with the same name; by default overwriting is not
allowed.
.TP
2011-04-05 06:34:22 +02:00
\fB\-\-play\fR Try to 'play' (open) the attachment with the default
application for the particular file type. Depends on the \fBxdg-open\fR
utility.
2010-08-24 20:09:43 +02:00
.SH EXAMPLES
To display information about all the MIME-parts in a message file:
.nf
$ mu extract msgfile
.fi
To extract MIME-part 3 and 4 from this message, overwriting existing files
with the same name:
.nf
$ mu extract --parts=3,4 --overwrite msgfile
.fi
To extract all files ending in '.jpg' (case-insensitive):
.nf
$ mu extract msgfile '.*\.jpg'
.fi
2011-05-25 21:04:13 +02:00
To extract an mp3-file, and play it in the the default mp3-playing application
(requires \fIxdg-open\fR):
.nf
$ mu extract --play msgfile 'whoopsididitagain.mp3'
.fi
2010-08-24 20:09:43 +02:00
.SH BUGS
2010-10-23 11:04:14 +02:00
2011-04-05 06:34:22 +02:00
Please report bugs if you find them:
2010-08-24 20:09:43 +02:00
.BR http://code.google.com/p/mu0/issues/list
.SH AUTHOR
Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
.BR mu(1) xdg-open(1)