# phpman > man > xdg-email(1)

[XDG-EMAIL(1)](https://www.chedong.com/phpMan.php/man/XDG-EMAIL/1/markdown)                              xdg-email Manual                              [XDG-EMAIL(1)](https://www.chedong.com/phpMan.php/man/XDG-EMAIL/1/markdown)



## NAME
       xdg-email - command line tool for sending mail using the user's preferred e-mail composer

## SYNOPSIS
       **xdg-email** [**--utf8**] [**--cc** _address_] [**--bcc** _address_] [**--subject** _text_] [**--body** _text_]
                 [**--attach** _file_] [_mailto-uri_ | _address(es)_]

       **xdg-email** {**--help** | **--manual** | **--version**}

## DESCRIPTION
       xdg-email opens the user's preferred e-mail composer in order to send a mail to _address(es)_
       or _mailto-uri_. RFC2368 defines mailto: URIs. xdg-email limits support to, cc, subject and
       body fields in _mailto-uri_, all other fields are silently ignored.  _address(es)_ must follow
       the syntax of RFC822. Multiple addresses may be provided as separate arguments.

       All information provided on the command line is used to prefill corresponding fields in the
       user's e-mail composer. The user will have the opportunity to change any of this information
       before actually sending the e-mail.

       xdg-email is for use inside a desktop session only. It is not recommended to use xdg-email as
       root.

## OPTIONS
### --utf8
           Indicates that all command line options that follow are in utf8. Without this option,
           command line options are expected to be encoded according to locale. If the locale
           already specifies utf8 this option has no effect. This option does not affect mailto URIs
           that are passed on the command line.

       **--cc** _address_
           Specify a recipient to be copied on the e-mail.

       **--bcc** _address_
           Specify a recipient to be blindly copied on the e-mail.

       **--subject** _text_
           Specify a subject for the e-mail.

       **--body** _text_
           Specify a body for the e-mail. Since the user will be able to make changes before
           actually sending the e-mail, this can be used to provide the user with a template for the
           e-mail.  _text_ may contain linebreaks.

       **--attach** _file_
           Specify an attachment for the e-mail.  _file_ must point to an existing file.

           Some e-mail applications require the file to remain present after xdg-email returns.

### --help
           Show command synopsis.

### --manual
           Show this manual page.

### --version
           Show the xdg-utils version information.

## ENVIRONMENT VARIABLES
       xdg-email honours the following environment variables:

       XDG_UTILS_DEBUG_LEVEL
           Setting this environment variable to a non-zero numerical value makes xdg-email do more
           verbose reporting on stderr. Setting a higher value increases the verbosity.

## EXIT CODES
       An exit code of 0 indicates success while a non-zero exit code indicates failure. The
       following failure codes can be returned:

       **1**
           Error in command line syntax.

       **2**
           One of the files passed on the command line did not exist.

       **3**
           A required tool could not be found.

       **4**
           The action failed.

       **5**
           No permission to read one of the files passed on the command line.

## SEE ALSO
       [**xdg-open**(1)](https://www.chedong.com/phpMan.php/man/xdg-open/1/markdown), [**xdg-mime**(1)](https://www.chedong.com/phpMan.php/man/xdg-mime/1/markdown), **MIME** **applications** **associations** **specification**[1], **RFC** **6068** **-** **The**
       **'mailto'** **URI** **Scheme**[2]

## EXAMPLES
           xdg-email 'Jeremy White <<jwhite@example.com>>'

           xdg-email --attach /tmp/logo.png \
                     --subject 'Logo contest' \
                     --body 'Attached you find the logo for the contest.' \
                     '<jwhite@example.com>'

           xdg-email --subject 'Your password is about to expire' \
                     '<jwhite@example.com>' '<bastian@example.com>' '<whipple@example.com>'


## AUTHORS
### Kevin Krammer
           Author.

### Jeremy White
           Author.

## COPYRIGHT
       Copyright © 2006

## NOTES
        1. MIME applications associations specification
           <http://www.freedesktop.org/wiki/Specifications/mime-apps-spec/>

        2. RFC 6068 - The 'mailto' URI Scheme
           <https://tools.ietf.org/html/rfc6068>



xdg-utils 1.0                                08/22/2022                                 [XDG-EMAIL(1)](https://www.chedong.com/phpMan.php/man/XDG-EMAIL/1/markdown)