Skip to content

Commit 18036e1

Browse files
committed
Changed project name, path: PursuanceProject/pursuemail -> elimisteve/effectivemail
1 parent d7aa026 commit 18036e1

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# PursueMail
1+
# EffectiveMail
22

33
## Dev
44

@@ -10,16 +10,16 @@ Use https://mailcatcher.me/ for local SMTP testing.
1010
Download and configure with:
1111

1212
```
13-
go get github.com/PursuanceProject/pursuemail
14-
cd $(go env GOPATH)/src/github.com/PursuanceProject/pursuemail
13+
go get github.com/elimisteve/effectivemail
14+
cd $(go env GOPATH)/src/github.com/elimisteve/effectivemail
1515
cp .env-sample .env
1616
# !!! Customize .env !!!
1717
```
1818

1919
Postgres setup:
2020

2121
```
22-
go get github.com/PursuanceProject/pursuemail
22+
go get github.com/elimisteve/effectivemail
2323
cd db
2424
sudo -u postgres bash init_sql.sh
2525
cd ..
@@ -29,8 +29,8 @@ Build and run:
2929

3030
```
3131
go build
32-
source .env # Sets 'PGPASSWORD' environment variable so pursuemail can use it
33-
./pursuemail
32+
source .env # Sets 'PGPASSWORD' environment variable so effectivemail can use it
33+
./effectivemail
3434
```
3535

3636

@@ -39,7 +39,7 @@ source .env # Sets 'PGPASSWORD' environment variable so pursuemail can use it
3939
### Map Email Address to (Random) UUID
4040

4141
```
42-
curl -i localhost:9080/api/v1/email -d '{"email": "spam@pursuanceproject.org"}'
42+
curl -i localhost:9080/api/v1/email -d '{"email": "spam@effective.af"}'
4343
```
4444

4545

@@ -49,27 +49,27 @@ In the below examples, the emails sent to users will be encrypted if
4949
and only if their PGP keys are found in `~/.gnupg/pubring.gpg`,
5050
otherwise they will be sent unencrypted.
5151

52-
If you want to tell PursueMail to only send an email if it is sent in
52+
If you want to tell EffectiveMail to only send an email if it is sent in
5353
encrypted form, add `"secure_only": true` to the top level of the JSON
5454
POST body when doing any of the following API calls.
5555

5656

5757
#### Send Email to One User by (UU)ID
5858

5959
```
60-
curl -i localhost:9080/api/v1/email/ec348de2-2430-46d6-9ed7-f65b12a4a75a/send -d '{"email_data": {"from": "team@pursuanceproject.org", "subject": "4 tasks due today!", "body": "4 tasks due today: ..."}}'
60+
curl -i localhost:9080/api/v1/email/ec348de2-2430-46d6-9ed7-f65b12a4a75a/send -d '{"email_data": {"from": "steve@effective.af", "subject": "4 tasks due today!", "body": "4 tasks due today: ..."}}'
6161
```
6262

6363
#### Send Bulk Email (to Multiple Users) by their Email Addresses
6464

6565
```
66-
curl -i localhost:9080/api/v1/email/bulksend -d '{"emails": ["activist1@riseup.net", "activist2@riseup.net"], "email_data": {"from": "team@pursuanceproject.org", "subject": "2 tasks due today!", "body": "2 tasks due today in pursuance #827: ..."}}'
66+
curl -i localhost:9080/api/v1/email/bulksend -d '{"emails": ["activist1@riseup.net", "activist2@riseup.net"], "email_data": {"from": "steve@effective.af", "subject": "2 tasks due today!", "body": "2 tasks due today in pursuance #827: ..."}}'
6767
```
6868

6969
#### Send Bulk Email (to Multiple Users) by their (UU)IDs
7070

7171
```
72-
curl -i localhost:9080/api/v1/email/bulksend -d '{"ids": ["ec348de2-2430-46d6-9ed7-f65b12a4a75a", "451724a2-ddb8-4fd9-8336-819316c6019a"], "email_data": {"from": "team@pursuanceproject.org", "subject": "3 tasks due today!", "body": "3 tasks due today in pursuance #827: ..."}}'
72+
curl -i localhost:9080/api/v1/email/bulksend -d '{"ids": ["ec348de2-2430-46d6-9ed7-f65b12a4a75a", "451724a2-ddb8-4fd9-8336-819316c6019a"], "email_data": {"from": "steve@effective.af", "subject": "3 tasks due today!", "body": "3 tasks due today in pursuance #827: ..."}}'
7373
```
7474

7575
#### Send _Definitely-encrypted_ Email

0 commit comments

Comments
 (0)