command_line_email 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.swp
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in command_line_email.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 James Lavin
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# CommandLineEmail
+
+Send email from the Linux or Mac command line. Attach specific file(s) or all files in a directory. Specify email body as CLI string or load from a file.
+
+## WARNING - NOT YET FULLY IMPLEMENTED
+
+This program still needs some work before I finish gemifying it. I have not yet created the bin/ directory file and currently run this by calling lib/command_line_email.rb directly.
+
+## Installation
+
+Install command_line_email as:
+
+    $ gem install command_line_email
+
+Or add this line to your application's Gemfile:
+
+    gem 'command_line_email'
+
+and then install with:
+
+    $ bundle
+
+## Usefulness
+
+This gem is useful for anyone who wishes to send email from a server using only the command line. It's also useful for anyone who wishes to send email from a computer on which they don't wish to install an email client. (I use multiple machines and keep all my email on one computer but wish to send emails from other computers.)
+
+## Usage
+
+Once set up (see "Configuration File" below), you can send an email using various options (see "Command Line Options" below). Here's one example:
+
+    ruby lib/command_line_email.rb -t "me" -t "other_me" -s "Test subject line" -b "My body text"
+
+### Configuration File
+
+The first time you run command_line_email, it will create a YAML file at ~/.command_line_email.yml. You edit this file to set your email configuration and, optionally, create mailing lists. A configuration file looks something like this:
+
+    ---
+    :connection:
+      :address: mail.domain.com
+      :port: 25
+      :domain: domain.com
+      :user_name: name@domain.com
+      :password: a2dfsae3355
+      :authentication: plain
+      :enable_starttls_auto: true
+
+    :mailing_lists:
+      :me: 'me@domain.com'
+      :parents: ['mom@domain.com','dad@domain.com']
+      :friends: ['joe@anotherdomain.com','sally@yetanotherdomain.com]
+
+    :defaults:
+      :from: 'sender@myemailaddress.com'
+      :to:   'my.wife@heremailaddress.com'
+      :cc:   'me@myotheremailaddress.com'
+      :subject: 'From Johnny Smith'
+
+### Command Line Options
+
+The following command line options are available:
+
+    -t (--to) takes an email address ("me@domain.com"), array of email addresses (['mom@domain.com','dad@domain.com']), or a string specified in mailing_lists (e.g., "me" or "parents" or "friends"), each of which points to an array of email addresses.
+
+    -f (--from) takes a string as the sender's email address
+
+    -s (--subject) takes a string as the email subject
+
+    -b (--body) takes a string as a text body. To provide more than one paragraph, provide a separate -b/--body for each paragraph in the order you wish the paragraphs to appear.
+
+    -c (--cc) takes the same values as -t/--to and sets the email's "carbon copy" recipients
+
+    -f (--file) takes a string representing the path to a file you wish to attach to the email. This flag can be used multiple times, each with a different file.
+
+    -d (--directory) takes a string with a directory path. If provided with the -f/--file option, it is presumed that all files are in the directory specified by the -d/--directory option. If no -f/--file option is present, ALL files within the -d/--directory directory will be attached.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/clemail

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'command_line_email'
+

data/command_line_email.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'command_line_email/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "command_line_email"
+  gem.version       = CommandLineEmail::VERSION
+  gem.authors       = ["James Lavin"]
+  gem.email         = ["command_line_email@futureresearch.com"]
+  gem.description   = %q{Send email from the Linux or Mac command line}
+  gem.summary       = %q{Send email from the Linux or Mac command line. Can attach specific files or all files in a directory. Can load email body from a file.}
+  gem.homepage      = "https://github.com/JamesLavin/command_line_email"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/command_line_email.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift("#{File.expand_path(File.dirname(__FILE__))}")
+$LOAD_PATH.unshift("#{File.expand_path(File.dirname(__FILE__))}/extruby/mail")
+$LOAD_PATH.unshift("#{File.expand_path(File.dirname(__FILE__))}/command_line_email")
+
+require "mail"
+require "mail/message"
+require "command_line_email/version"
+require "command_line_email/send_mail_setup"
+require "command_line_email/command_line_email"

data/lib/command_line_email/command_line_email.rb

@@ -0,0 +1,89 @@
+# encoding : UTF-8
+
+require 'mail'
+require 'yaml'
+require 'optparse'
+require 'send_mail_setup'
+
+user_config = CommandLineEmail::SendMailSetup.new
+
+Mail.defaults do
+  delivery_method :smtp, user_config.mail_options
+end
+
+mail_attrs = {to: []}
+
+option_parser = OptionParser.new do |opts|
+
+  opts.on("-t TO","--to TO") do |to|
+    mail_attrs[:to] = to_string_to_mailing_list(user_config, to, mail_attrs[:to])
+  end
+
+  opts.on("-f FROM","--from FROM") do |from|
+    mail_attrs[:from] = from
+  end
+
+  opts.on("-b BODY","--body BODY") do |body|
+    mail_attrs[:body] ||= ""
+    mail_attrs[:body] << body + "\n"
+  end
+
+  opts.on("-s SUBJECT","--subject SUBJECT") do |subject|
+    mail_attrs[:subject] = subject
+  end
+
+  opts.on("-c CC","--cc CC") do |cc|
+    if user_config.mailing_lists.has_key? cc.to_sym
+      mail_attrs[:cc] = user_config.mailing_lists[cc.to_sym]
+    else
+      mail_attrs[:cc] = cc
+    end
+  end
+
+  opts.on("-f FILE","--add-file FILE") do |file|
+    mail_attrs[:files] ||= []
+    mail_attrs[:files] << file
+  end
+
+  opts.on("-d DIRECTORY","--directory DIRECTORY") do |directory|
+    mail_attrs[:directory] = directory
+  end
+
+end
+
+def to_string_to_mailing_list(user_config, to, list=[])
+  # takes optional list in case you want to add to an existing list
+  if user_config.mailing_lists.has_key? to.to_sym
+    Array(user_config.mailing_lists[to.to_sym]).each { |address| list << address }
+  else
+    list << to
+  end
+  list
+end
+
+def grab_text_from_filename_if_file_exists(filename_or_text)
+  if File.exists?(filename_or_text)
+    File.open(filename_or_text,'r').read
+  else
+    filename_or_text
+  end
+end
+
+option_parser.parse!
+
+puts mail_attrs
+
+mail = Mail.new do
+  from    mail_attrs[:from]    || user_config.defaults[:from]
+  to      mail_attrs[:to]      || user_config.defaults[:to]
+  cc      mail_attrs[:cc]      || user_config.defaults[:cc]  || nil
+  subject mail_attrs[:subject] || user_config.defaults[:subject] || ''
+  body    mail_attrs[:body] ? grab_text_from_filename_if_file_exists(mail_attrs[:body]) : ''
+  if mail_attrs[:files]
+    attach_selected(mail_attrs[:files], mail_attrs[:directory] || '')
+  elsif mail_attrs[:directory]
+    attach_all_from_directory(mail_attrs[:directory])
+  end
+end
+
+mail.deliver!

data/lib/command_line_email/send_mail_setup.rb

@@ -0,0 +1,40 @@
+# encoding : UTF-8
+
+module CommandLineEmail
+
+  class SendMailSetup
+
+    attr_reader :mail_options, :mail_config_file
+
+    def initialize(config_file = nil)
+      @mail_config_file = config_file || File.expand_path('~/.command_line_email.yml')
+      set_mail_options
+    end
+
+    def mailing_lists
+      mail_config[:mailing_lists]
+    end
+
+    def defaults
+      mail_config[:defaults]
+    end
+
+    private
+
+    def mail_config
+      @mail_config ||= YAML::load(File.open(mail_config_file))
+    end
+
+    def set_mail_options
+      mail_options = {}
+
+      mail_config[:connection].keys.each do |key|
+        mail_options[key] = mail_config[:connection][key]
+      end
+
+      @mail_options = mail_options
+    end
+
+  end
+
+end

data/lib/command_line_email/version.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+
+module CommandLineEmail
+  VERSION = "0.0.1"
+end

data/lib/extruby/mail/message.rb

@@ -0,0 +1,19 @@
+module Mail
+
+  class Message
+
+    def attach_selected(filenames, dir = '')
+      filenames.each do |filename|
+        add_file dir + filename
+      end
+    end
+
+    def attach_all_from_directory(directory)
+      Dir.glob(directory + '/*').each do |filepath|
+        add_file filepath
+      end
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: command_line_email
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- James Lavin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-25 00:00:00.000000000 Z
+dependencies: []
+description: Send email from the Linux or Mac command line
+email:
+- command_line_email@futureresearch.com
+executables:
+- clemail
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/clemail
+- command_line_email.gemspec
+- lib/command_line_email.rb
+- lib/command_line_email/command_line_email.rb
+- lib/command_line_email/send_mail_setup.rb
+- lib/command_line_email/version.rb
+- lib/extruby/mail/message.rb
+homepage: https://github.com/JamesLavin/command_line_email
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Send email from the Linux or Mac command line. Can attach specific files
+  or all files in a directory. Can load email body from a file.
+test_files: []