1XDG-EMAIL(1) XDG-EMAIL(1)
2
6 xdg-email - command line tool for sending mail using the user's
7 preferred e-mail composer
8
10 xdg-email [--utf8] [--cc address] [--bcc address] [--subject text]
11 [--body text] [--attach file] [mailto-uri address(es)]
12 xdg-email {--help --manual --version}
14
16 xdg-email opens the user's preferred e-mail composer in order to send a
17 mail to address(es) or mailto-uri. RFC2368 defines mailto: URIs.
18 xdg-email limits support to, cc, subject and body fields in mailto-uri,
19 all other fields are silently ignored. address(es) must follow the
20 syntax of RFC822. Multiple addresses may be provided as separate
21 arguments.
22 All information provided on the command line is used to prefill
24 corresponding fields in the user's e-mail composer. The user will have
25 the opportunity to change any of this information before actually
26 sending the e-mail.
27 xdg-email is for use inside a desktop session only. It is not
29 recommended to use xdg-email as root.
30 See http://portland.freedesktop.org/EmailConfig for information on how
32 the user can change the e-mail composer that is used.
33
35 --utf8 Indicates that all command line options that follow are in utf8.
36 Without this option, command line options are expected to be
37 encoded according to locale. If the locale already specifies
38 utf8 this option has no effect. This option does not affect
39 mailto URIs that are passed on the command line.
40 --cc address
42 Specify a recipient to be copied on the e-mail.
43 --bcc address
45 Specify a recipient to be blindly copied on the e-mail.
46 --subject text
48 Specify a subject for the e-mail.
49 --body text
51 Specify a body for the e-mail. Since the user will be able to
52 make changes before actually sending the e-mail, this can be
53 used to provide the user with a template for the e-mail. text
54 may contain linebreaks.
55 --attach file
57 Specify an attachment for the e-mail. file must point to an
58 existing file.
59 Some e-mail applications require the file to remain present
61 after xdg-email returns.
62 --help Show command synopsis.
64 --manual
66 Show this manualpage.
67 --version
69 Show the xdg-utils version information.
70
72 xdg-email honours the following environment variables:
73 XDG_UTILS_DEBUG_LEVEL
75 Setting this environment variable to a non-zero numerical value
76 makes xdg-email do more verbose reporting on stderr. Setting a
77 higher value increases the verbosity.
78
80 An exit code of 0 indicates success while a non-zero exit code
81 indicates failure. The following failure codes can be returned:
82 1 Error in command line syntax.
84 2 One of the files passed on the command line did not exist.
86 3 A required tool could not be found.
88 4 The action failed.
90 5 No permission to read one of the files passed on the command
92 line.
93
95 Visit http://portland.freedesktop.org/EmailConfig for information how
96 to configure xdg-email to use the email client of your choice.
97
99 xdg-email 'Jeremy White <jwhite@example.com>'
100 xdg-email --attach /tmp/logo.png \
103 --subject 'Logo contest' \
104 --body 'Attached you find the logo for the contest.' \
105 'jwhite@example.com'
106 xdg-email --subject 'Your password is about to expire' \
109 'jwhite@example.com' 'bastian@example.com' 'whipple@example.com'
110
113 Kevin Krammer, Jeremy White.
114 <kevin.krammer@gmx.at>
115 <jwhite@codeweavers.com>
116xdg-utils 1.0 06/24/2007 XDG-EMAIL(1)