| OLD | NEW |
|---|
| (Empty) | |
| 1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859
-1"><title>xdg-email</title><meta name="generator" content="DocBook XSL Styleshe
ets V1.69.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#84
0084" alink="#0000FF"><div class="refentry" lang="en"><a name="xdg-email"></a><d
iv class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-email 
212; command line tool for sending mail using the user's preferred e-mail compos
er</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis
"><p><code class="command">xdg-email</code> [<code class="option">--utf8</code>
] [<code class="option">--cc</code> <em class="replaceable"><code>address</code>
</em>] [<code class="option">--bcc</code> <em class="replaceable"><code>address<
/code></em>] [<code class="option">--subject</code> <em class="replaceable"><cod
e>text</code></em>] [<code class="option">--body</code> <em class="replaceable">
<code>text</code></em>] [<code class="option">--attach</code> <em class="replace
able"><code>file</code></em>] [ <em class="replaceable"><code>mailto-uri</code><
/em> | <em class="replaceable"><code>address(es)</code></em> ]</p></div><div
class="cmdsynopsis"><p><code class="command">xdg-email</code> { <code class="op
tion">--help</code> | <code class="option">--manual</code> | <code class="
option">--version</code> }</p></div></div><div class="refsect1" lang="en"><a nam
e="description"></a><h2>Description</h2><p> |
| 2 xdg-email opens the user's preferred e-mail composer in order to send |
| 3 a mail to <em class="replaceable"><code>address(es)</code></em> or |
| 4 <em class="replaceable"><code>mailto-uri</code></em>. RFC2368 defines mail
to: |
| 5 URIs. xdg-email limits support to, cc, subject and body fields in |
| 6 <em class="replaceable"><code>mailto-uri</code></em>, all other fields are
silently |
| 7 ignored. <em class="replaceable"><code>address(es)</code></em> must follow
the |
| 8 syntax of RFC822. Multiple addresses may be provided as |
| 9 separate arguments. |
| 10 </p><p> |
| 11 All information provided on the command line is used to |
| 12 prefill corresponding fields in the user's e-mail composer. The user |
| 13 will have the opportunity to change any of this information before |
| 14 actually sending the e-mail. |
| 15 </p><p> |
| 16 xdg-email is for use inside a desktop session only. |
| 17 It is not recommended to use xdg-email as root. |
| 18 </p><p> |
| 19 See http://portland.freedesktop.org/EmailConfig for information on |
| 20 how the user can change the e-mail composer that is used. |
| 21 </p></div><div class="refsect1" lang="en"><a name="options"></a><h2>Options<
/h2><div class="variablelist"><dl><dt><span class="term"><code class="option">--
utf8</code></span></dt><dd> |
| 22 Indicates that all command line options that follow are in utf8. |
| 23 Without this option, command line options are expected to be |
| 24 encoded according to locale. |
| 25 If the locale already specifies utf8 this option has no effect. |
| 26 This option does not affect mailto URIs that are passed on the |
| 27 command line. |
| 28 </dd><dt><span class="term"><code class="option">--cc</code> <em class
="replaceable"><code>address</code></em></span></dt><dd> |
| 29 Specify a recipient to be copied on the e-mail. |
| 30 </dd><dt><span class="term"><code class="option">--bcc</code> <em clas
s="replaceable"><code>address</code></em></span></dt><dd> |
| 31 Specify a recipient to be blindly copied on the e-mail. |
| 32 </dd><dt><span class="term"><code class="option">--subject</code> <em
class="replaceable"><code>text</code></em></span></dt><dd> |
| 33 Specify a subject for the e-mail. |
| 34 </dd><dt><span class="term"><code class="option">--body</code> <em cla
ss="replaceable"><code>text</code></em></span></dt><dd> |
| 35 Specify a body for the e-mail. Since the user will be able to |
| 36 make changes before actually sending the e-mail, this can be |
| 37 used to provide the user with a template for the e-mail. |
| 38 <em class="replaceable"><code>text</code></em> may contain linebreak
s. |
| 39 </dd><dt><span class="term"><code class="option">--attach</code> <em c
lass="replaceable"><code>file</code></em></span></dt><dd><p> |
| 40 Specify an attachment for the e-mail. <em class="replaceable"><code>
file</code></em> |
| 41 must point to an existing file. |
| 42 </p><p> |
| 43 Some e-mail applications require the file to remain present |
| 44 after xdg-email returns. |
| 45 </p></dd><dt><span class="term"><code class="option">--help</code></sp
an></dt><dd> |
| 46 Show command synopsis. |
| 47 </dd><dt><span class="term"><code class="option">--manual</code></span
></dt><dd> |
| 48 Show this manualpage. |
| 49 </dd><dt><span class="term"><code class="option">--version</code></spa
n></dt><dd> |
| 50 Show the xdg-utils version information. |
| 51 </dd></dl></div></div><div class="refsect1" lang="en"><a name="env_var
s"></a><h2>Environment Variables</h2><p> |
| 52 xdg-email honours the following environment variables: |
| 53 </p><div class="variablelist"><dl><dt><span class="term">XDG_UTILS_DEBUG_LEV
EL</span></dt><dd> |
| 54 Setting this environment variable to a non-zero numerical value |
| 55 makes xdg-email do more verbose reporting on stderr. |
| 56 Setting a higher value increases the verbosity. |
| 57 </dd></dl></div></div><div class="refsect1" lang="en"><a name="exitcod
es"></a><h2>Exit Codes</h2><p> |
| 58 An exit code of 0 indicates success while a non-zero exit code |
| 59 indicates failure. The following failure codes can be returned: |
| 60 </p><div class="variablelist"><dl><dt><span class="term"><code class="option
">1</code></span></dt><dd> |
| 61 Error in command line syntax. |
| 62 </dd><dt><span class="term"><code class="option">2</code></span></dt><
dd> |
| 63 One of the files passed on the command line did not exist. |
| 64 </dd><dt><span class="term"><code class="option">3</code></span></dt><
dd> |
| 65 A required tool could not be found. |
| 66 </dd><dt><span class="term"><code class="option">4</code></span></dt><
dd> |
| 67 The action failed. |
| 68 </dd><dt><span class="term"><code class="option">5</code></span></dt><
dd> |
| 69 No permission to read one of the files passed on the command |
| 70 line. |
| 71 </dd></dl></div></div><div class="refsect1" lang="en"><a name="configu
ration"></a><h2>Configuration</h2><p>Visit http://portland.freedesktop.org/Email
Config for information |
| 72 how to configure xdg-email to use the email client of your choice. |
| 73 </p></div><div class="refsect1" lang="en"><a name="examples"></a><h2>Example
s</h2><p> |
| 74 </p><pre class="programlisting"> |
| 75 xdg-email 'Jeremy White <jwhite@example.com>' |
| 76 </pre><p> |
| 77 </p><p> |
| 78 </p><pre class="programlisting"> |
| 79 xdg-email --attach /tmp/logo.png \ |
| 80 --subject 'Logo contest' \ |
| 81 --body 'Attached you find the logo for the contest.' \ |
| 82 'jwhite@example.com' |
| 83 </pre><p> |
| 84 </p><p> |
| 85 </p><pre class="programlisting"> |
| 86 xdg-email --subject 'Your password is about to expire' \ |
| 87 'jwhite@example.com' 'bastian@example.com' 'whipple@example.com' |
| 88 </pre><p> |
| 89 </p></div></div></body></html> |
| OLD | NEW |
|---|
Chromium Code Reviews
