updated code documentation link in README
removal of superfluous 'license-file' in Cargo.toml'
preparation for publishing and v0.1.0
Mailcap files are a format documented in RFC
1524, "A User Agent Configuration
Mechanism For Multimedia Mail Format Information." They allow the handling of
MIME types by software aware of those types. For example, a mailcap line of
text/html; qutebrowser '%s'; test=test -n "$DISPLAY"
would instruct the
software to open any HTML file with qutebrowser if you are running a graphical
session, with the file replacing the '%s'
.
mailcap
is a parsing library that looks at either a present $MAILCAPS
env
variable or cycles through the four paths where a mailcap file would be found in
ascending order of importance: /usr/local/etc/mailcap
, /usr/etc/mailcap
,
/etc/mailcap
, and $HOME/.mailcap
. It builds the mailcap from all available
files, with duplicate entries being squashed with newer lines, allowing
$HOME/.mailcap
to be the final decider.
The entries that make up the mailcap include only those that are relevant i.e.
those that have passed the test
field (if present). With the above text/html
example, that test would fail if run through SSH, and unless another existing
text/html
entry (or text/*
) exists that doesn't require a display server, no
entry would exist for that mime type.
Add the following to your Cargo.toml
:
[dependencies]
mailcap = "0.1.0"
use mailcap::Mailcap;
fn main() {
let cap = Mailcap::new().unwrap();
if let Some(i) = cap.get("text/html") {
let command = i.viewer("/var/www/index.html");
assert_eq!(command, "qutebrowser '/var/www/index.html'");
}
}
Wildcard fallbacks are also supported.
use mailcap::Mailcap;
fn main() {
let cap = Mailcap::new().unwrap();
if let Some(i) = cap.get("video/avi") {
// if no video/avi MIME entry available
let mime_type = i.mime();
assert_eq!(mime_type, "video/*");
}
}
Code documentation is available here.
To-be-included features can be seen through the current open issues.
Refer to the announcement mailing list for project updates and the devel mailing list for contributions and collaboration.
Issues should be directed to the project issue tracker.
This project is licensed under the GPLv3.