Skip to content

Commit

Permalink
Added instructions for adding new emails.
Browse files Browse the repository at this point in the history
  • Loading branch information
tedivm committed Mar 14, 2014
1 parent 10e153e commit c4c223b
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ everyone to submit feature requests or, even better, pull requests to help make
languages.


# Usage
## Usage

## SetupEnvironment.sh
### SetupEnvironment.sh

The SetupEnvironment.sh file acts as a wrapper around a number of different scripts. It identifies which of the
systems below it is being asked to control and then takes the appropriate steps to get the environment setup for
Expand All @@ -23,7 +23,7 @@ pretest action. This way you can simply call your test suite as normal and will
environment.


## Server Settings
### Server Settings

* Username: **testuser**
* Password: **applesauce**
Expand All @@ -35,7 +35,7 @@ environment.
* Travis IP Address: **127.0.0.1**


## PHP
### PHP

This package is available via Composer, which makes integrating it into Travis-CI trivial.

Expand All @@ -56,7 +56,7 @@ before_script:
```


## Vagrant Notes
### Vagrant Notes

You'll need to have [Vagrant](http://www.vagrantup.com) and [VirtualBox](https://www.virtualbox.org) installed for local
development. Once these packages are installed the only thing left to do is call SetupEnvironment.sh as outlined above.
Expand All @@ -72,8 +72,19 @@ before every run of your test suite. This keeps the machine running while you're
turnaround, but also makes sure it isn't left running when not being used.


## Travis CI Notes
### Travis CI Notes

Just like with Vagrant, you simply need to run the SetupEnvironment.sh script before running your tests. Getting the
package onto Travis CI can be done through a package manager directly, as with the composer example above, or through
through a wrapper script that pulls it directly from git.


## Adding Additional Emails

This package works by storing a copy of a working Dovecot mail directory and then copying that directory into the test environment. Adding a new email in means sending it to the running instance of Dovecot and then updating the resources directory to make sure those changes stick between uses. This can be done a number of ways.

The preferred way is to connect a mail client to the running instance of Dovecot, and then using that to transfer the email in. Most mail clients, such as Mail.app, allow drag and drop transfer of emails between accounts. This method is simpliest because it does not require setting up an SMTP server, as it simply reuses an existing "real" account to create the message and then transfers it in. This was the method used to creating the initial set of emails.

Another option is to enable postfix directly on the Vagrant instance and to use that to recieve messages. This gets a little more complicated because it does require getting a mail server setup and integrated with Dovecot.

A final method is to email testuser@tedivm.com with the desired message, and then to open an issue here to request it's inclusion. There is obviously a bit of turnaround here, so please attempt to add it in on your own and feel free to issue a pull request to get it included here.

0 comments on commit c4c223b

Please sign in to comment.