PRmail/postman-java
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update 'README.md'

Browse Source
This commit is contained in:
nikkel 2020-03-20 03:15:53 +07:00
parent 0f208c369c
commit aea23f5ee2
1 changed files with 37 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -1,3 +1,39 @@
# postman-java # postman-java
Java Client API for the Postman email platform (https://postman.prmail.vn)
Currently the client supports two basic operations - Send and SendRaw -
the other API functions for accessing messages will be added at a later date.
## Usage
```java
PostmanService postmanService = new PostmanService("<<POSTAL_SERVER_URL>>", "API_KEY");
PostmanMessage message = new PostmanMessageBuilder()
.from("no-reply@my-domain.com")
.to("email@company.com")
.cc("email@company.com")
.bcc("email@company.com")
.withSubject("Testing with attachments")
.withPlainBody("Please view this email in a modern email client!")
.withHtmlBody("<html><h1>html body</h1><h2>Please check your attachments!</h2></html>")
.withTag("tag")
.addAttachment(new Attachment("test-csv.csv", "application/octet-stream", attachmentByte))
.build();
postman.sendMessage(message);
```
## Embedded images
If you want to use embedded image simply add it with
`.addEmbeddedImage(new EmbeddedImage("cidReference", "image/png", googleLogo))`
And reference if in the html body of your email with
`<img src="cid:google" width="140">`
You can put Base64 encoded documents for attachments and embedded image or the byte[] of your document
in the methods `addAttachment` and `addEmbeddedImage`
Java Client API for the Postal email platform