1XDG-EMAIL(1)                   xdg-email Manual                   XDG-EMAIL(1)
2
3
4

NAME

6       xdg-email - command line tool for sending mail using the user's
7       preferred e-mail composer
8

SYNOPSIS

10       xdg-email [--utf8] [--cc address] [--bcc address] [--subject text]
11                 [--body text] [--attach file] [mailto-uri | address(es)]
12
13       xdg-email {--help | --manual | --version}
14

DESCRIPTION

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
23       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
28       xdg-email is for use inside a desktop session only. It is not
29       recommended to use xdg-email as root.
30
31       See http://portland.freedesktop.org/wiki/EmailConfig for information on
32       how the user can change the e-mail composer that is used.
33

OPTIONS

35       --utf8
36           Indicates that all command line options that follow are in utf8.
37           Without this option, command line options are expected to be
38           encoded according to locale. If the locale already specifies utf8
39           this option has no effect. This option does not affect mailto URIs
40           that are passed on the command line.
41
42       --cc address
43           Specify a recipient to be copied on the e-mail.
44
45       --bcc address
46           Specify a recipient to be blindly copied on the e-mail.
47
48       --subject text
49           Specify a subject for the e-mail.
50
51       --body text
52           Specify a body for the e-mail. Since the user will be able to make
53           changes before actually sending the e-mail, this can be used to
54           provide the user with a template for the e-mail.  text may contain
55           linebreaks.
56
57       --attach file
58           Specify an attachment for the e-mail.  file must point to an
59           existing file.
60
61           Some e-mail applications require the file to remain present after
62           xdg-email returns.
63
64       --help
65           Show command synopsis.
66
67       --manual
68           Show this manual page.
69
70       --version
71           Show the xdg-utils version information.
72

ENVIRONMENT VARIABLES

74       xdg-email honours the following environment variables:
75
76       XDG_UTILS_DEBUG_LEVEL
77           Setting this environment variable to a non-zero numerical value
78           makes xdg-email do more verbose reporting on stderr. Setting a
79           higher value increases the verbosity.
80

EXIT CODES

82       An exit code of 0 indicates success while a non-zero exit code
83       indicates failure. The following failure codes can be returned:
84
85       1
86           Error in command line syntax.
87
88       2
89           One of the files passed on the command line did not exist.
90
91       3
92           A required tool could not be found.
93
94       4
95           The action failed.
96
97       5
98           No permission to read one of the files passed on the command line.
99

CONFIGURATION

101       Visit http://portland.freedesktop.org/wiki/EmailConfig for information
102       how to configure xdg-email to use the email client of your choice.
103

EXAMPLES

105           xdg-email 'Jeremy White <jwhite@example.com>'
106
107           xdg-email --attach /tmp/logo.png \
108                     --subject 'Logo contest' \
109                     --body 'Attached you find the logo for the contest.' \
110                     'jwhite@example.com'
111
112           xdg-email --subject 'Your password is about to expire' \
113                     'jwhite@example.com' 'bastian@example.com' 'whipple@example.com'
114
115

AUTHORS

117       Kevin Krammer
118           Author.
119
120       Jeremy White
121           Author.
122

124       Copyright © 2006
125
126
127
128xdg-utils 1.0                     11/05/2016                      XDG-EMAIL(1)
Impressum