Mercurial > repos > brinkmanlab > sendmail

annotate sendmail.xml @ 0:126f37fe9f20 draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
author brinkmanlab
date Fri, 24 Jan 2020 17:47:27 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
1 <tool id="sendmail" name="Send Email" version="1.0" profile="16.04">
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
2 <description>Send mail using templates and include information about datasets</description>
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
3 <command><![CDATA[
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
4 #from galaxy.util import send_mail
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
5 $send_mail($__app__.config.email_from, $to, $subject, "", $__app__.config, open($body).read())
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
6 ]]></command>
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
7 <configfiles>
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
8 <configfile name="body"><![CDATA[
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
9 #set $template_path = '/'.join([$__tool_data_path__, "sendmail", $template])
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
10 #import os
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
11 #if '..' not in $template and $os.path.isfile($template_path)
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
12 #include $template_path
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
13 #else
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
14 <html>
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
15 <body>
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
16 $data.name is now complete.
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
17 #if $hasattr(__app__.config, "public_url")
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
18 You can view it <a href="${__app__.config.public_url}/datasets/${data.dataset.id}/display">here</a>.
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
19 #end if
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
20 </body>
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
21 </html>
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
22 #end if
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
23 ]]></configfile>
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
24 </configfiles>
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
25 <inputs>
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
26 <param name="data" type="data" format="data" multiple="true" label="Data" />
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
27 <param name="to" type="text" label="To" />
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
28 <param name="subject" type="text" value="Job complete" label="Subject" />
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
29 <repeat name="extras" title="Extras">
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
30 <param name="extra" type="text" label="Extra data to make available in the template body" />
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
31 </repeat>
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
32 <param name="template" type="text" value="template.html" label="Template" help="Relative path of template to use in tool-data/sendmail/" />
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
33 </inputs>
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
34 <help><![CDATA[
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
35 Send mail using templates and include information about datasets.
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
36
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
37 Templates are parsed using Galaxies Cheeta Template Engine. The variables available are everything that is available to a tool including:
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
38 - $data Dataset instance passed to the tool input
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
39 - $to Reciepent address specified in the tool parameters
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
40 - $subject Subject specified in the tool parameters
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
41 - $extras[].extra List of extras specified in the tool parameters
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
42 - $template Relative path to the current template
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
43
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
44 See this tools xml for an example template.
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
45 ]]></help>
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
46 <citations>
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
47 <citation type="doi">10.5281/zenodo.3364789</citation>
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
48 </citations>
126f37fe9f20 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/sendmail commit 33b02e08cbc8f76fb4b8537f8c968393f85a1b5e"
brinkmanlab
parents:
diff changeset
49 </tool>