First commit

LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -0,0 +1,92 @@
+#Readme
+
+This ansible role deploys msmtp for Ubuntu 12.04 (tested on vagrant)
+
+
+##Prerequisite
+* Having ansible installed on your workstation. 
+* Having an SMTP server 
+
+##How to install
+* Use github to clone/fork in your role directory
+* ansible galaxy ```ansible-galaxy install adham.helal.msmtp```
+
+##Variables 
+  Mostly you would need to configure the following variables 
+  - *msmtp_accounts:* You can define one or more smtp account 
+ 
+      ```
+      msmtp_accounts:
+      - account  : "gmail"
+        host     : "smtp.gmail.com"
+        port     : 587
+        auth     : "on"
+        user     : "example@gmail.example"
+        password : "some password"
+      - account  : "mysmtp"
+        host     : "smtp.example"
+        port     : 587
+        auth     : "on"
+        user     : "myuser"
+        password : "123456"
+      ```
+  - *msmtp_default_account:* Default smtp account to use 
+
+    ```msmtp_default_account: "gmail"```
+
+  - *msmtp_from:* From field
+
+    ```msmtp_from : "No Reply"```
+  
+  - Logging 
+     - Option A (syslog)
+     
+       ```
+        msmtp_log : "syslog"
+       ```
+
+     - Option B (file logging)
+     
+       ```
+        msmtp_log     : "file"
+        msmtp_logfile : /var/log/msmtp.log
+       ```
+
+     - Option C (No logging)
+
+       ```
+        msmtp_log     : "no"
+       ```
+  - Mail aliases 
+     - *msmtp_alias_default:* default email this required 
+
+       ```msmtp_alias_default : ops@example.com```
+
+     - *msmtp_alias_root:* root email this is optional
+
+       ```msmtp_alias_root : root@example.com```
+
+     - *msmtp_alias_cron:* cron email this optional
+
+       ```msmtp_alias_cron : cron@example.com``` 
+
+** All the default variables are located **defaults/main.yml**
+
+##Configure
+You can configure your variables in ansible with one of the following
+
+ * Create a variable in host/group variables directory. (recommended)
+ * Editing var/main.yml
+ * Run ansible-playbook with -e
+ * Edit the default/main.yml (not recommended)
+
+##Run
+**By default the mstmp will fail because the configuration uses a bogus smtp server you need to use a valid smtp server**
+    ```ansible-playbook -l hostname msmtp.yml```
+
+##Test
+  You should get a test mail if it works on the root mail
+
+##Possible issues
+ From field requires more work 
+[http://msmtp.sourceforge.net/doc/msmtp.html#Envelope_002dfrom-address](http://msmtp.sourceforge.net/doc/msmtp.html#Envelope_002dfrom-address) 

defaults/main.yml

@@ -0,0 +1,28 @@
+---
+msmtp_accounts:
+      #Account 1
+    - account  : "gmail"
+      host     : "smtp.gmail.com"
+      port     : 587
+      auth     : "on"
+      user     : "example@gmail.example"
+      password : "some password"
+      #Account 2
+    - account  : "mysmtp"
+      host     : "smtp.example"
+      port     : 587
+      auth     : "on"
+      user     : "myuser"
+      password : "123456"
+
+msmtp_default_account: "gmail"
+msmtp_from           : "My Org"
+
+## Logging (Select A) "syslog" or B) "file" logging or C) "no" log
+msmtp_log           : "syslog"
+#msmtp_logfile       : /var/log/msmtp.log
+
+## Aliases mail account ( only msmtp_alias_default is required the rest is optional )
+msmtp_alias_default : ops@example.
+msmtp_alias_root    : root@example.com
+msmtp_alias_cron    : cron@example.com

handlers/main.yml

@@ -0,0 +1,5 @@
+---
+# send test mail to admin
+- name: test mail
+  shell: echo "Test mail from new/updated MSTMP at" `hostname` | mail root -s "Test SMTP `hostname`"
+  tags: mail

meta/main.yml

@@ -0,0 +1,11 @@
+galaxy_info:
+  author: Adham Helal
+  description: "Deploy msmtp mail for Ubuntu 12.04"
+  min_ansible_version: 1.4
+  platforms:
+  - name: Ubuntu
+    versions:
+    - precise
+  categories:
+  - system
+  - networking

mstmp.yml

@@ -0,0 +1,6 @@
+---
+- hosts: all
+  sudo: True
+  roles:
+    - ansible-msmtp
+

tasks/main.yml

@@ -0,0 +1,3 @@
+---
+
+- include: msmtp.yml

tasks/msmtp.yml

@@ -0,0 +1,30 @@
+---
+
+# Author: Adham Helal
+#
+# Objective: Deploy msmtp 
+
+- name: Update apt cache
+  apt: update_cache=yes cache_valid_time=3600
+  tags: mail
+
+- name: Install  msmtp and mailx
+  apt:  pkg={{item}} state=present
+  with_items:
+    - msmtp
+    - msmtp-mta
+    - bsd-mailx
+  tags: mail    
+  notify: test mail
+
+- name: Copy mstprc conf file
+  template: src=msmtprc.j2 dest=/etc/msmtprc 
+            owner=root group=root mode=0644
+  tags: mail
+  notify: test mail
+
+- name: Copy aliases conf file
+  template: src=aliases.j2 dest=/etc/aliases 
+            owner=root group=root mode=0644
+  tags: mail
+  notify: test mail

templates/aliases.j2

@@ -0,0 +1,10 @@
+# {{ ansible_managed }}
+#### /etc/aliases
+#root mail
+root:  {{ msmtp_alias_root if msmtp_alias_root is defined else msmtp_alias_default }}
+
+#cron mail
+cron: {{ msmtp_alias_cron if msmtp_alias_cron is defined else msmtp_alias_default }}
+
+#default all other mails
+default: {{msmtp_alias_default}}

templates/msmtprc.j2

@@ -0,0 +1,36 @@
+# {{ ansible_managed }}
+# Default settings that all others account inherit
+defaults
+auth   on
+tls    on
+tls_trust_file /etc/ssl/certs/ca-certificates.crt
+
+# Logging 
+{% if msmtp_log is defined %}
+{% if msmtp_log == "syslog" %}
+syslog on
+{% elif msmtp_log == "file" and msmtp_logfile is defined %}
+logfile  {{msmtp_logfile}}
+{% endif %}
+{% endif %}
+
+
+from     {{msmtp_from}}
+keepbcc  on
+
+{% if msmtp_accounts is defined %}
+{% for msmtp_account in msmtp_accounts %}
+#
+account  {{msmtp_account.account}}
+host     {{msmtp_account.host}}
+port     {{msmtp_account.port}}
+auth     {{msmtp_account.auth}}
+user     {{msmtp_account.user}}
+password {{msmtp_account.password}}
+{% endfor %}
+{% endif %}
+
+# Default account to use
+account default : {{msmtp_default_account}}
+
+aliases /etc/aliases

vars/main.yml

@@ -0,0 +1,3 @@
+---
+# You can override default vars defined in defaults/main.yml here
+# But i would advice to use host or group vars instead