{ "content": [ { "type": "text", "text": "# xdg-email (man)\n\n## NAME\n\nxdg-email - command line tool for sending mail using the user's preferred e-mail composer\n\n## SYNOPSIS\n\nxdg-email [--utf8] [--cc address] [--bcc address] [--subject text] [--body text]\n[--attach file] [mailto-uri | address(es)]\nxdg-email {--help | --manual | --version}\n\n## DESCRIPTION\n\nxdg-email opens the user's preferred e-mail composer in order to send a mail to address(es)\nor mailto-uri. RFC2368 defines mailto: URIs. xdg-email limits support to, cc, subject and\nbody fields in mailto-uri, all other fields are silently ignored. address(es) must follow\nthe syntax of RFC822. Multiple addresses may be provided as separate arguments.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (4 subsections)\n- **ENVIRONMENT VARIABLES**\n- **EXIT CODES**\n- **SEE ALSO**\n- **EXAMPLES**\n- **AUTHORS** (2 subsections)\n- **COPYRIGHT**\n- **NOTES**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "xdg-email", "section": "", "mode": "man", "summary": "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]\n[--attach file] [mailto-uri | address(es)]\nxdg-email {--help | --manual | --version}", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [ { "flag": "", "long": "--utf8", "arg": null, "description": "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." }, { "flag": "", "long": "--help", "arg": null, "description": "Show command synopsis." }, { "flag": "", "long": "--manual", "arg": null, "description": "Show this manual page." }, { "flag": "", "long": "--version", "arg": null, "description": "Show the xdg-utils version information." } ], "examples": [ "xdg-email 'Jeremy White '", "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'" ], "see_also": [ { "name": "xdg-open", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/xdg-open/1/json" }, { "name": "xdg-mime", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/xdg-mime/1/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 5, "subsections": [] }, { "name": "DESCRIPTION", "lines": 12, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "--utf8", "lines": 24, "long": "--utf8" }, { "name": "--help", "lines": 2, "long": "--help" }, { "name": "--manual", "lines": 2, "long": "--manual" }, { "name": "--version", "lines": 2, "long": "--version" } ] }, { "name": "ENVIRONMENT VARIABLES", "lines": 6, "subsections": [] }, { "name": "EXIT CODES", "lines": 18, "subsections": [] }, { "name": "SEE ALSO", "lines": 3, "subsections": [] }, { "name": "EXAMPLES", "lines": 11, "subsections": [] }, { "name": "AUTHORS", "lines": 1, "subsections": [ { "name": "Kevin Krammer", "lines": 2 }, { "name": "Jeremy White", "lines": 2 } ] }, { "name": "COPYRIGHT", "lines": 2, "subsections": [] }, { "name": "NOTES", "lines": 9, "subsections": [] } ], "sections": { "NAME": { "content": "xdg-email - command line tool for sending mail using the user's preferred e-mail composer\n", "subsections": [] }, "SYNOPSIS": { "content": "xdg-email [--utf8] [--cc address] [--bcc address] [--subject text] [--body text]\n[--attach file] [mailto-uri | address(es)]\n\nxdg-email {--help | --manual | --version}\n", "subsections": [] }, "DESCRIPTION": { "content": "xdg-email opens the user's preferred e-mail composer in order to send a mail to address(es)\nor mailto-uri. RFC2368 defines mailto: URIs. xdg-email limits support to, cc, subject and\nbody fields in mailto-uri, all other fields are silently ignored. address(es) must follow\nthe syntax of RFC822. Multiple addresses may be provided as separate arguments.\n\nAll information provided on the command line is used to prefill corresponding fields in the\nuser's e-mail composer. The user will have the opportunity to change any of this information\nbefore actually sending the e-mail.\n\nxdg-email is for use inside a desktop session only. It is not recommended to use xdg-email as\nroot.\n", "subsections": [] }, "OPTIONS": { "content": "", "subsections": [ { "name": "--utf8", "content": "Indicates that all command line options that follow are in utf8. Without this option,\ncommand line options are expected to be encoded according to locale. If the locale\nalready specifies utf8 this option has no effect. This option does not affect mailto URIs\nthat are passed on the command line.\n\n--cc address\nSpecify a recipient to be copied on the e-mail.\n\n--bcc address\nSpecify a recipient to be blindly copied on the e-mail.\n\n--subject text\nSpecify a subject for the e-mail.\n\n--body text\nSpecify a body for the e-mail. Since the user will be able to make changes before\nactually sending the e-mail, this can be used to provide the user with a template for the\ne-mail. text may contain linebreaks.\n\n--attach file\nSpecify an attachment for the e-mail. file must point to an existing file.\n\nSome e-mail applications require the file to remain present after xdg-email returns.\n", "long": "--utf8" }, { "name": "--help", "content": "Show command synopsis.\n", "long": "--help" }, { "name": "--manual", "content": "Show this manual page.\n", "long": "--manual" }, { "name": "--version", "content": "Show the xdg-utils version information.\n", "long": "--version" } ] }, "ENVIRONMENT VARIABLES": { "content": "xdg-email honours the following environment variables:\n\nXDGUTILSDEBUGLEVEL\nSetting this environment variable to a non-zero numerical value makes xdg-email do more\nverbose reporting on stderr. Setting a higher value increases the verbosity.\n", "subsections": [] }, "EXIT CODES": { "content": "An exit code of 0 indicates success while a non-zero exit code indicates failure. The\nfollowing failure codes can be returned:\n\n1\nError in command line syntax.\n\n2\nOne of the files passed on the command line did not exist.\n\n3\nA required tool could not be found.\n\n4\nThe action failed.\n\n5\nNo permission to read one of the files passed on the command line.\n", "subsections": [] }, "SEE ALSO": { "content": "xdg-open(1), xdg-mime(1), MIME applications associations specification[1], RFC 6068 - The\n'mailto' URI Scheme[2]\n", "subsections": [] }, "EXAMPLES": { "content": "xdg-email 'Jeremy White '\n\nxdg-email --attach /tmp/logo.png \\\n--subject 'Logo contest' \\\n--body 'Attached you find the logo for the contest.' \\\n'jwhite@example.com'\n\nxdg-email --subject 'Your password is about to expire' \\\n'jwhite@example.com' 'bastian@example.com' 'whipple@example.com'\n\n", "subsections": [] }, "AUTHORS": { "content": "", "subsections": [ { "name": "Kevin Krammer", "content": "Author.\n" }, { "name": "Jeremy White", "content": "Author.\n" } ] }, "COPYRIGHT": { "content": "Copyright © 2006\n", "subsections": [] }, "NOTES": { "content": "1. MIME applications associations specification\nhttp://www.freedesktop.org/wiki/Specifications/mime-apps-spec/\n\n2. RFC 6068 - The 'mailto' URI Scheme\nhttps://tools.ietf.org/html/rfc6068\n\n\n\nxdg-utils 1.0 08/22/2022 XDG-EMAIL(1)", "subsections": [] } } } }