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

OPTIONS

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

ENVIRONMENT VARIABLES

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

EXIT CODES

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

SEE ALSO

98       xdg-open(1), xdg-mime(1), MIME applications associations
99       specification[1], RFC 6068 - The 'mailto' URI Scheme[2]
100

EXAMPLES

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

AUTHORS

114       Kevin Krammer
115           Author.
116
117       Jeremy White
118           Author.
119

121       Copyright © 2006
122

NOTES

124        1. MIME applications associations specification
125           http://www.freedesktop.org/wiki/Specifications/mime-apps-spec/
126
127        2. RFC 6068 - The 'mailto' URI Scheme
128           https://tools.ietf.org/html/rfc6068
129
130
131
132xdg-utils 1.0                     07/25/2023                      XDG-EMAIL(1)
Impressum