detroit-email 0.1.0 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- data/.ruby +13 -10
- data/COPYING.rdoc +1 -1
- data/{GPL3.txt → LICENSE.txt} +0 -0
- data/README.rdoc +27 -14
- data/lib/detroit-email.rb +36 -9
- data/man/detroit-email.5 +118 -0
- data/man/detroit-email.5.html +165 -0
- data/man/detroit-email.5.ronn +90 -0
- metadata +13 -9
data/.ruby
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
---
|
|
2
|
+
source:
|
|
3
|
+
- meta
|
|
2
4
|
authors:
|
|
3
5
|
- name: T.Sawyer
|
|
4
6
|
email: transfire@gmail.com
|
|
@@ -6,28 +8,29 @@ copyrights:
|
|
|
6
8
|
- holder: Thomas Sawyer
|
|
7
9
|
year: '2011'
|
|
8
10
|
license: GPL3
|
|
9
|
-
replacements: []
|
|
10
|
-
conflicts: []
|
|
11
11
|
requirements:
|
|
12
12
|
- name: detroit
|
|
13
|
+
version: 0.3.0+
|
|
13
14
|
dependencies: []
|
|
15
|
+
alternatives: []
|
|
16
|
+
conflicts: []
|
|
14
17
|
repositories: []
|
|
15
18
|
resources:
|
|
16
19
|
home: http://detroit.github.com/
|
|
17
20
|
code: http://github.com/detroit/detroit-email
|
|
18
21
|
mail: http://groups.google.com/group/rubyworks-mailinglist
|
|
22
|
+
extra: {}
|
|
19
23
|
load_path:
|
|
20
24
|
- lib
|
|
21
|
-
extra: {}
|
|
22
25
|
revision: 0
|
|
23
|
-
|
|
24
|
-
source:
|
|
25
|
-
- Profile
|
|
26
|
-
alternatives: []
|
|
27
|
-
title: Detroit Email
|
|
28
|
-
version: 0.1.0
|
|
26
|
+
created: '2011-10-16'
|
|
29
27
|
summary: Email plugin for Detroit
|
|
28
|
+
title: Detroit Email
|
|
29
|
+
version: 0.2.0
|
|
30
|
+
name: detroit-email
|
|
31
|
+
suite: detroit
|
|
30
32
|
description: Email plugin for Detroit build system. This plugin is designed to send
|
|
31
33
|
out a well formated release announcement during the promote phase. Though, it can
|
|
32
34
|
be configured to send out any message desired.
|
|
33
|
-
|
|
35
|
+
organization: rubyworks
|
|
36
|
+
date: '2012-04-01'
|
data/COPYING.rdoc
CHANGED
data/{GPL3.txt → LICENSE.txt}
RENAMED
|
File without changes
|
data/README.rdoc
CHANGED
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
= Detroit Email Tool
|
|
2
2
|
|
|
3
|
+
{Website}[http://rubyworks.github.com/detroit-email] /
|
|
4
|
+
{Report Issue}[http://github.com/rubyworks/detroit-email/issues] /
|
|
5
|
+
{Repository}[http://github.com/rubyworks/deroit-email]
|
|
3
6
|
|
|
4
|
-
|
|
7
|
+
|
|
8
|
+
== Description
|
|
5
9
|
|
|
6
10
|
The Email tool is used to send out project announcements to a set of
|
|
7
11
|
email addresses.
|
|
@@ -16,26 +20,35 @@ and or by using a message file.
|
|
|
16
20
|
Email account settings default to environment variables so they need
|
|
17
21
|
not be set independently for every project.
|
|
18
22
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
23
|
+
@server ENV['EMAIL_SERVER']
|
|
24
|
+
@from ENV['EMAIL_FROM']
|
|
25
|
+
@account ENV['EMAIL_ACCOUNT'] || ENV['EMAIL_FROM']
|
|
26
|
+
@password ENV['EMAIL_PASSWORD']
|
|
27
|
+
@port ENV['EMAIL_PORT']
|
|
28
|
+
@domain ENV['EMAIL_DOMAIN']
|
|
29
|
+
@login ENV['EMAIL_LOGIN']
|
|
30
|
+
@secure ENV['EMAIL_SECURE']
|
|
27
31
|
|
|
28
32
|
|
|
29
|
-
==
|
|
33
|
+
== Installation
|
|
30
34
|
|
|
31
35
|
$ gem install detroit-email
|
|
32
36
|
|
|
33
37
|
|
|
34
|
-
==
|
|
38
|
+
== Copyrights
|
|
39
|
+
|
|
40
|
+
Copyright (c) 2011 Rubyworks
|
|
35
41
|
|
|
36
|
-
|
|
42
|
+
This program is free software: you can redistribute it and/or modify
|
|
43
|
+
it under the terms of the GNU General Public License as published by
|
|
44
|
+
the Free Software Foundation, either version 3 of the License, or
|
|
45
|
+
(at your option) any later version.
|
|
37
46
|
|
|
38
|
-
|
|
47
|
+
This program is distributed in the hope that it will be useful,
|
|
48
|
+
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
49
|
+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
50
|
+
GNU General Public License for more details.
|
|
39
51
|
|
|
40
|
-
|
|
52
|
+
You should have received a copy of the GNU General Public License
|
|
53
|
+
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
41
54
|
|
data/lib/detroit-email.rb
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
require 'detroit/tool'
|
|
2
|
-
|
|
3
1
|
module Detroit
|
|
4
2
|
|
|
3
|
+
require 'detroit/tool'
|
|
4
|
+
|
|
5
5
|
# New Email instance.
|
|
6
6
|
def Email(options={})
|
|
7
7
|
Email.new(options)
|
|
@@ -76,16 +76,27 @@ module Detroit
|
|
|
76
76
|
end
|
|
77
77
|
|
|
78
78
|
|
|
79
|
-
# A S S E M B L Y
|
|
79
|
+
# A S S E M B L Y
|
|
80
80
|
|
|
81
|
-
#
|
|
82
|
-
def
|
|
83
|
-
|
|
81
|
+
#
|
|
82
|
+
def assemble?(station, options={})
|
|
83
|
+
destination = options[:destination]
|
|
84
|
+
case station
|
|
85
|
+
when :prepare then (destination == :promote)
|
|
86
|
+
when :promote then true
|
|
87
|
+
else false
|
|
88
|
+
end
|
|
84
89
|
end
|
|
85
90
|
|
|
86
|
-
# Attach announce
|
|
87
|
-
def
|
|
88
|
-
|
|
91
|
+
# Attach #approve to prepare and #announce to promote assembly stations.
|
|
92
|
+
def assemble(station, options={})
|
|
93
|
+
destination = options[:destination]
|
|
94
|
+
case station
|
|
95
|
+
when :prepare
|
|
96
|
+
approve if destination == :promote
|
|
97
|
+
when :promote
|
|
98
|
+
announce
|
|
99
|
+
end
|
|
89
100
|
end
|
|
90
101
|
|
|
91
102
|
|
|
@@ -238,3 +249,19 @@ module Detroit
|
|
|
238
249
|
end
|
|
239
250
|
|
|
240
251
|
end
|
|
252
|
+
|
|
253
|
+
# Copyright (c) 2011 Rubyworks
|
|
254
|
+
#
|
|
255
|
+
# This program is free software: you can redistribute it and/or modify
|
|
256
|
+
# it under the terms of the GNU General Public License as published by
|
|
257
|
+
# the Free Software Foundation, either version 3 of the License, or
|
|
258
|
+
# (at your option) any later version.
|
|
259
|
+
#
|
|
260
|
+
# This program is distributed in the hope that it will be useful,
|
|
261
|
+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
262
|
+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
263
|
+
# GNU General Public License for more details.
|
|
264
|
+
#
|
|
265
|
+
# You should have received a copy of the GNU General Public License
|
|
266
|
+
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
267
|
+
|
data/man/detroit-email.5
ADDED
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
.\" generated with Ronn/v0.7.3
|
|
2
|
+
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
3
|
+
.
|
|
4
|
+
.TH "DETROIT\-EMAIL" "5" "October 2011" "" ""
|
|
5
|
+
.
|
|
6
|
+
.SH "NAME"
|
|
7
|
+
\fBdetroit\-email\fR \- send out customizable email announcement
|
|
8
|
+
.
|
|
9
|
+
.SH "DESCRIPTION"
|
|
10
|
+
The Email plug\-in for Detroit can send out release announcements, or other messages during the standard \fBpromote\fR stop\.
|
|
11
|
+
.
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.
|
|
14
|
+
.IP "\(bu" 4
|
|
15
|
+
\fBfile\fR \- If the body of the message is in a file use this option to set the path to that file relative to the project\'s root directory\.
|
|
16
|
+
.
|
|
17
|
+
.IP "\(bu" 4
|
|
18
|
+
\fBsubject\fR \- The subject of the message\. Defaults to a typical release announcement subject of "ANN: {title} {version}"\.
|
|
19
|
+
.
|
|
20
|
+
.IP "\(bu" 4
|
|
21
|
+
\fBmailto\fR/\fBto\fR \- List of email addresses to whom to email\.
|
|
22
|
+
.
|
|
23
|
+
.IP "\(bu" 4
|
|
24
|
+
\fBfrom\fR \- Email address from whom\.
|
|
25
|
+
.
|
|
26
|
+
.IP "\(bu" 4
|
|
27
|
+
\fBserver\fR \- Email host url\.
|
|
28
|
+
.
|
|
29
|
+
.IP "\(bu" 4
|
|
30
|
+
\fBport\fR \- Emails server port\. The default is usually correct\.
|
|
31
|
+
.
|
|
32
|
+
.IP "\(bu" 4
|
|
33
|
+
\fBaccount\fR \- Email account name (defaults to \fBfrom\fR)\.
|
|
34
|
+
.
|
|
35
|
+
.IP "\(bu" 4
|
|
36
|
+
\fBdomain\fR \- User domain (not sure why SMTP requires this)\.
|
|
37
|
+
.
|
|
38
|
+
.IP "\(bu" 4
|
|
39
|
+
\fBlogin\fR \- Login type\. Can be either \fBplain\fR or \fBlogin\fR\.
|
|
40
|
+
.
|
|
41
|
+
.IP "\(bu" 4
|
|
42
|
+
\fBsecure\fR \- Use TLS/SSL, true or false?
|
|
43
|
+
.
|
|
44
|
+
.IP "\(bu" 4
|
|
45
|
+
\fBparts\fR \- List of components of the announcement\. This will be used to construct the message as long as \fBfile\fR or \fBmessage\fR are not used\. Recognizes values are \fBreadme\fR, \fBmessage\fR, \fBdescription\fR, \fBresources\fR, \fBnotes\fR and \fBchanges\fR\.
|
|
46
|
+
.
|
|
47
|
+
.IP "\(bu" 4
|
|
48
|
+
\fBnoenv\fR \- Do not use environment variables for email defaults\.
|
|
49
|
+
.
|
|
50
|
+
.IP "" 0
|
|
51
|
+
.
|
|
52
|
+
.SH "DEFAULTS"
|
|
53
|
+
Most of the options default to environment variables (unless \fBnoenv\fR is used)\.
|
|
54
|
+
.
|
|
55
|
+
.IP "\(bu" 4
|
|
56
|
+
\fBEMAIL_SERVER\fR
|
|
57
|
+
.
|
|
58
|
+
.IP "\(bu" 4
|
|
59
|
+
\fBEMAIL_FROM\fR
|
|
60
|
+
.
|
|
61
|
+
.IP "\(bu" 4
|
|
62
|
+
\fBEMAIL_ACCOUNT\fR
|
|
63
|
+
.
|
|
64
|
+
.IP "\(bu" 4
|
|
65
|
+
\fBEMAIL_PORT\fR
|
|
66
|
+
.
|
|
67
|
+
.IP "\(bu" 4
|
|
68
|
+
\fBEMAIL_DOMAIN\fR
|
|
69
|
+
.
|
|
70
|
+
.IP "\(bu" 4
|
|
71
|
+
\fBEMAIL_LOGIN\fR
|
|
72
|
+
.
|
|
73
|
+
.IP "\(bu" 4
|
|
74
|
+
\fBEMAIL_SECURE\fR
|
|
75
|
+
.
|
|
76
|
+
.IP "\(bu" 4
|
|
77
|
+
\fBEMAIL_PASSWORD\fR
|
|
78
|
+
.
|
|
79
|
+
.IP "" 0
|
|
80
|
+
.
|
|
81
|
+
.P
|
|
82
|
+
Note that if EMAIL_PASSWORD is not set in the environment, then the user will be prompted for it on the command line when it is required\.
|
|
83
|
+
.
|
|
84
|
+
.SH "EXAMPLES"
|
|
85
|
+
Usually the use case is send out a release announcement, and in that case the default configuration suffices\. So, the typical example is as simple as:
|
|
86
|
+
.
|
|
87
|
+
.IP "" 4
|
|
88
|
+
.
|
|
89
|
+
.nf
|
|
90
|
+
|
|
91
|
+
announce:
|
|
92
|
+
service: email
|
|
93
|
+
mailto:
|
|
94
|
+
\- ruby\-talk@ruby\-lang\.org
|
|
95
|
+
.
|
|
96
|
+
.fi
|
|
97
|
+
.
|
|
98
|
+
.IP "" 0
|
|
99
|
+
.
|
|
100
|
+
.SH "RESOURCES"
|
|
101
|
+
For more information:
|
|
102
|
+
.
|
|
103
|
+
.IP "\(bu" 4
|
|
104
|
+
API Documentation \fIhttp://rubydoc\.info/gems/detroit\-email\fR
|
|
105
|
+
.
|
|
106
|
+
.IP "\(bu" 4
|
|
107
|
+
Development Site \fIhttp://github\.com/detroit/detroit\-email\fR
|
|
108
|
+
.
|
|
109
|
+
.IP "" 0
|
|
110
|
+
.
|
|
111
|
+
.SH "COPYRIGHT"
|
|
112
|
+
Copyright (c) 2010 Thomas Sawyer, Rubyworks
|
|
113
|
+
.
|
|
114
|
+
.P
|
|
115
|
+
Detroit EMail is distributable in accordance with the GPLv3 license\.
|
|
116
|
+
.
|
|
117
|
+
.SH "SEE ALSO"
|
|
118
|
+
dnote(1)
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta http-equiv='content-type' value='text/html;charset=utf8'>
|
|
5
|
+
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
|
|
6
|
+
<title>detroit-email(5) - send out customizable email announcement</title>
|
|
7
|
+
<style type='text/css' media='all'>
|
|
8
|
+
/* style: man */
|
|
9
|
+
body#manpage {margin:0}
|
|
10
|
+
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
|
|
11
|
+
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
|
|
12
|
+
.mp h2 {margin:10px 0 0 0}
|
|
13
|
+
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
|
|
14
|
+
.mp h3 {margin:0 0 0 4ex}
|
|
15
|
+
.mp dt {margin:0;clear:left}
|
|
16
|
+
.mp dt.flush {float:left;width:8ex}
|
|
17
|
+
.mp dd {margin:0 0 0 9ex}
|
|
18
|
+
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
|
|
19
|
+
.mp pre {margin-bottom:20px}
|
|
20
|
+
.mp pre+h2,.mp pre+h3 {margin-top:22px}
|
|
21
|
+
.mp h2+pre,.mp h3+pre {margin-top:5px}
|
|
22
|
+
.mp img {display:block;margin:auto}
|
|
23
|
+
.mp h1.man-title {display:none}
|
|
24
|
+
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
|
|
25
|
+
.mp h2 {font-size:16px;line-height:1.25}
|
|
26
|
+
.mp h1 {font-size:20px;line-height:2}
|
|
27
|
+
.mp {text-align:justify;background:#fff}
|
|
28
|
+
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
|
|
29
|
+
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
|
|
30
|
+
.mp u {text-decoration:underline}
|
|
31
|
+
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
|
|
32
|
+
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
|
|
33
|
+
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
|
|
34
|
+
.mp b.man-ref {font-weight:normal;color:#434241}
|
|
35
|
+
.mp pre {padding:0 4ex}
|
|
36
|
+
.mp pre code {font-weight:normal;color:#434241}
|
|
37
|
+
.mp h2+pre,h3+pre {padding-left:0}
|
|
38
|
+
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
|
|
39
|
+
ol.man-decor {width:100%}
|
|
40
|
+
ol.man-decor li.tl {text-align:left}
|
|
41
|
+
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
|
|
42
|
+
ol.man-decor li.tr {text-align:right;float:right}
|
|
43
|
+
</style>
|
|
44
|
+
</head>
|
|
45
|
+
<!--
|
|
46
|
+
The following styles are deprecated and will be removed at some point:
|
|
47
|
+
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
|
|
48
|
+
|
|
49
|
+
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
|
|
50
|
+
.man-navigation should be used instead.
|
|
51
|
+
-->
|
|
52
|
+
<body id='manpage'>
|
|
53
|
+
<div class='mp' id='man'>
|
|
54
|
+
|
|
55
|
+
<div class='man-navigation' style='display:none'>
|
|
56
|
+
<a href="#NAME">NAME</a>
|
|
57
|
+
<a href="#DESCRIPTION">DESCRIPTION</a>
|
|
58
|
+
<a href="#OPTIONS">OPTIONS</a>
|
|
59
|
+
<a href="#DEFAULTS">DEFAULTS</a>
|
|
60
|
+
<a href="#EXAMPLES">EXAMPLES</a>
|
|
61
|
+
<a href="#RESOURCES">RESOURCES</a>
|
|
62
|
+
<a href="#COPYRIGHT">COPYRIGHT</a>
|
|
63
|
+
<a href="#SEE-ALSO">SEE ALSO</a>
|
|
64
|
+
</div>
|
|
65
|
+
|
|
66
|
+
<ol class='man-decor man-head man head'>
|
|
67
|
+
<li class='tl'>detroit-email(5)</li>
|
|
68
|
+
<li class='tc'></li>
|
|
69
|
+
<li class='tr'>detroit-email(5)</li>
|
|
70
|
+
</ol>
|
|
71
|
+
|
|
72
|
+
<h2 id="NAME">NAME</h2>
|
|
73
|
+
<p class="man-name">
|
|
74
|
+
<code>detroit-email</code> - <span class="man-whatis">send out customizable email announcement</span>
|
|
75
|
+
</p>
|
|
76
|
+
|
|
77
|
+
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
|
78
|
+
|
|
79
|
+
<p>The Email plug-in for Detroit can send out release announcements, or other
|
|
80
|
+
messages during the standard <code>promote</code> stop.</p>
|
|
81
|
+
|
|
82
|
+
<h2 id="OPTIONS">OPTIONS</h2>
|
|
83
|
+
|
|
84
|
+
<ul>
|
|
85
|
+
<li><p><code>file</code> - If the body of the message is in a file use this option
|
|
86
|
+
to set the path to that file relative to the project's root
|
|
87
|
+
directory.</p></li>
|
|
88
|
+
<li><p><code>subject</code> - The subject of the message. Defaults to a typical
|
|
89
|
+
release announcement subject of "ANN: {title} {version}".</p></li>
|
|
90
|
+
<li><p><code>mailto</code>/<code>to</code> - List of email addresses to whom to email.</p></li>
|
|
91
|
+
<li><p><code>from</code> - Email address from whom.</p></li>
|
|
92
|
+
<li><p><code>server</code> - Email host url.</p></li>
|
|
93
|
+
<li><p><code>port</code> - Emails server port. The default is usually correct.</p></li>
|
|
94
|
+
<li><p><code>account</code> - Email account name (defaults to <code>from</code>).</p></li>
|
|
95
|
+
<li><p><code>domain</code> - User domain (not sure why SMTP requires this).</p></li>
|
|
96
|
+
<li><p><code>login</code> - Login type. Can be either <code>plain</code> or <code>login</code>.</p></li>
|
|
97
|
+
<li><p><code>secure</code> - Use TLS/SSL, true or false?</p></li>
|
|
98
|
+
<li><p><code>parts</code> - List of components of the announcement. This will be
|
|
99
|
+
used to construct the message as long as <code>file</code> or <code>message</code> are
|
|
100
|
+
not used. Recognizes values are <code>readme</code>, <code>message</code>, <code>description</code>,
|
|
101
|
+
<code>resources</code>, <code>notes</code> and <code>changes</code>.</p></li>
|
|
102
|
+
<li><p><code>noenv</code> - Do not use environment variables for email defaults.</p></li>
|
|
103
|
+
</ul>
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
<h2 id="DEFAULTS">DEFAULTS</h2>
|
|
107
|
+
|
|
108
|
+
<p>Most of the options default to environment variables (unless <code>noenv</code> is used).</p>
|
|
109
|
+
|
|
110
|
+
<ul>
|
|
111
|
+
<li><code>EMAIL_SERVER</code></li>
|
|
112
|
+
<li><code>EMAIL_FROM</code></li>
|
|
113
|
+
<li><code>EMAIL_ACCOUNT</code></li>
|
|
114
|
+
<li><code>EMAIL_PORT</code></li>
|
|
115
|
+
<li><code>EMAIL_DOMAIN</code></li>
|
|
116
|
+
<li><code>EMAIL_LOGIN</code></li>
|
|
117
|
+
<li><code>EMAIL_SECURE</code></li>
|
|
118
|
+
<li><code>EMAIL_PASSWORD</code></li>
|
|
119
|
+
</ul>
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
<p>Note that if EMAIL_PASSWORD is not set in the environment, then the user
|
|
123
|
+
will be prompted for it on the command line when it is required.</p>
|
|
124
|
+
|
|
125
|
+
<h2 id="EXAMPLES">EXAMPLES</h2>
|
|
126
|
+
|
|
127
|
+
<p>Usually the use case is send out a release announcement, and in that case the
|
|
128
|
+
default configuration suffices. So, the typical example is as simple as:</p>
|
|
129
|
+
|
|
130
|
+
<pre><code>announce:
|
|
131
|
+
service: email
|
|
132
|
+
mailto:
|
|
133
|
+
- ruby-talk@ruby-lang.org
|
|
134
|
+
</code></pre>
|
|
135
|
+
|
|
136
|
+
<h2 id="RESOURCES">RESOURCES</h2>
|
|
137
|
+
|
|
138
|
+
<p>For more information:</p>
|
|
139
|
+
|
|
140
|
+
<ul>
|
|
141
|
+
<li><p><a href="http://rubydoc.info/gems/detroit-email">API Documentation</a></p></li>
|
|
142
|
+
<li><p><a href="http://github.com/detroit/detroit-email">Development Site</a></p></li>
|
|
143
|
+
</ul>
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
<h2 id="COPYRIGHT">COPYRIGHT</h2>
|
|
147
|
+
|
|
148
|
+
<p>Copyright (c) 2010 Thomas Sawyer, Rubyworks</p>
|
|
149
|
+
|
|
150
|
+
<p>Detroit EMail is distributable in accordance with the GPLv3 license.</p>
|
|
151
|
+
|
|
152
|
+
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
|
153
|
+
|
|
154
|
+
<p><span class="man-ref">dnote<span class="s">(1)</span></span></p>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
<ol class='man-decor man-foot man foot'>
|
|
158
|
+
<li class='tl'></li>
|
|
159
|
+
<li class='tc'>October 2011</li>
|
|
160
|
+
<li class='tr'>detroit-email(5)</li>
|
|
161
|
+
</ol>
|
|
162
|
+
|
|
163
|
+
</div>
|
|
164
|
+
</body>
|
|
165
|
+
</html>
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
detroit-email(5) - send out customizable email announcement
|
|
2
|
+
===========================================================
|
|
3
|
+
|
|
4
|
+
## DESCRIPTION
|
|
5
|
+
|
|
6
|
+
The Email plug-in for Detroit can send out release announcements, or other
|
|
7
|
+
messages during the standard `promote` stop.
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
## OPTIONS
|
|
11
|
+
|
|
12
|
+
* `file` - If the body of the message is in a file use this option
|
|
13
|
+
to set the path to that file relative to the project's root
|
|
14
|
+
directory.
|
|
15
|
+
|
|
16
|
+
* `subject` - The subject of the message. Defaults to a typical
|
|
17
|
+
release announcement subject of "ANN: {title} {version}".
|
|
18
|
+
|
|
19
|
+
* `mailto`/`to` - List of email addresses to whom to email.
|
|
20
|
+
|
|
21
|
+
* `from` - Email address from whom.
|
|
22
|
+
|
|
23
|
+
* `server` - Email host url.
|
|
24
|
+
|
|
25
|
+
* `port` - Emails server port. The default is usually correct.
|
|
26
|
+
|
|
27
|
+
* `account` - Email account name (defaults to `from`).
|
|
28
|
+
|
|
29
|
+
* `domain` - User domain (not sure why SMTP requires this).
|
|
30
|
+
|
|
31
|
+
* `login` - Login type. Can be either `plain` or `login`.
|
|
32
|
+
|
|
33
|
+
* `secure` - Use TLS/SSL, true or false?
|
|
34
|
+
|
|
35
|
+
* `parts` - List of components of the announcement. This will be
|
|
36
|
+
used to construct the message as long as `file` or `message` are
|
|
37
|
+
not used. Recognizes values are `readme`, `message`, `description`,
|
|
38
|
+
`resources`, `notes` and `changes`.
|
|
39
|
+
|
|
40
|
+
* `noenv` - Do not use environment variables for email defaults.
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
## DEFAULTS
|
|
44
|
+
|
|
45
|
+
Most of the options default to environment variables (unless `noenv` is used).
|
|
46
|
+
|
|
47
|
+
* `EMAIL_SERVER`
|
|
48
|
+
* `EMAIL_FROM`
|
|
49
|
+
* `EMAIL_ACCOUNT`
|
|
50
|
+
* `EMAIL_PORT`
|
|
51
|
+
* `EMAIL_DOMAIN`
|
|
52
|
+
* `EMAIL_LOGIN`
|
|
53
|
+
* `EMAIL_SECURE`
|
|
54
|
+
* `EMAIL_PASSWORD`
|
|
55
|
+
|
|
56
|
+
Note that if EMAIL_PASSWORD is not set in the environment, then the user
|
|
57
|
+
will be prompted for it on the command line when it is required.
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
## EXAMPLES
|
|
61
|
+
|
|
62
|
+
Usually the use case is send out a release announcement, and in that case the
|
|
63
|
+
default configuration suffices. So, the typical example is as simple as:
|
|
64
|
+
|
|
65
|
+
announce:
|
|
66
|
+
service: email
|
|
67
|
+
mailto:
|
|
68
|
+
- ruby-talk@ruby-lang.org
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
## RESOURCES
|
|
72
|
+
|
|
73
|
+
For more information:
|
|
74
|
+
|
|
75
|
+
* [API Documentation](http://rubydoc.info/gems/detroit-email)
|
|
76
|
+
|
|
77
|
+
* [Development Site](http://github.com/detroit/detroit-email)
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
## COPYRIGHT
|
|
81
|
+
|
|
82
|
+
Copyright (c) 2010 Thomas Sawyer, Rubyworks
|
|
83
|
+
|
|
84
|
+
Detroit EMail is distributable in accordance with the GPLv3 license.
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
## SEE ALSO
|
|
88
|
+
|
|
89
|
+
detroit(1)
|
|
90
|
+
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: detroit-email
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.2.0
|
|
5
5
|
prerelease:
|
|
6
6
|
platform: ruby
|
|
7
7
|
authors:
|
|
@@ -9,19 +9,19 @@ authors:
|
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: bin
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date:
|
|
12
|
+
date: 2012-04-02 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: detroit
|
|
16
|
-
requirement: &
|
|
16
|
+
requirement: &8890620 !ruby/object:Gem::Requirement
|
|
17
17
|
none: false
|
|
18
18
|
requirements:
|
|
19
19
|
- - ! '>='
|
|
20
20
|
- !ruby/object:Gem::Version
|
|
21
|
-
version:
|
|
21
|
+
version: 0.3.0
|
|
22
22
|
type: :runtime
|
|
23
23
|
prerelease: false
|
|
24
|
-
version_requirements: *
|
|
24
|
+
version_requirements: *8890620
|
|
25
25
|
description: Email plugin for Detroit build system. This plugin is designed to send
|
|
26
26
|
out a well formated release announcement during the promote phase. Though, it can
|
|
27
27
|
be configured to send out any message desired.
|
|
@@ -30,17 +30,21 @@ email:
|
|
|
30
30
|
executables: []
|
|
31
31
|
extensions: []
|
|
32
32
|
extra_rdoc_files:
|
|
33
|
-
-
|
|
33
|
+
- LICENSE.txt
|
|
34
34
|
- README.rdoc
|
|
35
35
|
- COPYING.rdoc
|
|
36
36
|
files:
|
|
37
37
|
- .ruby
|
|
38
38
|
- lib/detroit-email.rb
|
|
39
|
+
- man/detroit-email.5
|
|
40
|
+
- man/detroit-email.5.html
|
|
41
|
+
- man/detroit-email.5.ronn
|
|
42
|
+
- LICENSE.txt
|
|
39
43
|
- README.rdoc
|
|
40
|
-
- GPL3.txt
|
|
41
44
|
- COPYING.rdoc
|
|
42
45
|
homepage: http://detroit.github.com/
|
|
43
|
-
licenses:
|
|
46
|
+
licenses:
|
|
47
|
+
- GPL3
|
|
44
48
|
post_install_message:
|
|
45
49
|
rdoc_options: []
|
|
46
50
|
require_paths:
|
|
@@ -59,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
59
63
|
version: '0'
|
|
60
64
|
requirements: []
|
|
61
65
|
rubyforge_project:
|
|
62
|
-
rubygems_version: 1.8.
|
|
66
|
+
rubygems_version: 1.8.11
|
|
63
67
|
signing_key:
|
|
64
68
|
specification_version: 3
|
|
65
69
|
summary: Email plugin for Detroit
|