https://github.com/vtfk/azf-mail-socketlabs
Azure function mail socketlabs
https://github.com/vtfk/azf-mail-socketlabs
Last synced: 2 months ago
JSON representation
Azure function mail socketlabs
- Host: GitHub
- URL: https://github.com/vtfk/azf-mail-socketlabs
- Owner: vtfk
- Created: 2020-09-18T13:57:57.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-02T12:28:53.000Z (about 1 year ago)
- Last Synced: 2025-01-23T12:32:06.908Z (4 months ago)
- Language: JavaScript
- Size: 354 KB
- Stars: 0
- Watchers: 4
- Forks: 2
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Azure function mail socketlabs
## Setup
### Development setup
Create/Update **local.settings.json** with this:
```json
{
"IsEncrypted": false,
"Values": {
"FUNCTIONS_WORKER_RUNTIME": "node",
"AzureWebJobsStorage": "UseDevelopmentStorage=true",
"AzureWebJobsServiceBus": "",
"SOCKETLABS_SERVER_ID": your-socketlabs-server-id,
"SOCKETLABS_API_KEY": "your-socketlabs-api-key",
"E18_URL": "https://e18url.net", // optional
"E18_KEY": "secret token", // optional
"E18_SYSTEM": "dsf", // optional
"E18_EMPTY_JOB": true // optional
},
"ConnectionStrings": {}
}
```
### E18
To support [E18](https://github.com/vtfk/e18-node#usage), add `E18_URL`, `E18_KEY` and `E18_SYSTEM`
### Setup in Azure
1. Publish Azure function
1. In Configuration in your Azure function, add these Application settings
1. SOCKETLABS_SERVER_ID
1. SOCKETLABS_API_KEY
## **POST** `/mail`
### without templating
```json
{
"to": [
"[email protected]",
"[email protected]"
],
"cc": [
"[email protected]"
],
"bcc": [
"[email protected]"
],
"from": "Ola Nordmann ",
"subject": "Test",
"text": "Heihei",
"html": "Heihei"
}
```
### with templating
```json
{
"to": [
"[email protected]",
"[email protected]"
],
"cc": [
"[email protected]"
],
"bcc": [
"[email protected]"
],
"from": "Ola Nordmann ",
"subject": "Test",
"template": {
"templateName": "example",
"templateData": {
"body": "Something.", // can also be an array of strings
"signature": {
"name": "Ola Nordmann",
"title": "Boss",
"department": "Computer geek",
"company": "Example company",
"phone": "81549300",
"mobile": "01189998819919117253"
}
}
}
}
```
### bulk send
When you don't want the receivers to see the other receivers
**REMARK: When using bulk - you will receive status 200, and list of suceeded and failed mails. You must retry failed yourself, if you want to**
Add `"type": 'bulk'` to the payload to enable bulk send
*Works for both templating and not templating*
```json
{
"to": [
"[email protected]",
"[email protected]"
],
"cc": [
"[email protected]"
],
"bcc": [
"[email protected]"
],
"type": "bulk", // Like this
"from": "Ola Nordmann ",
"subject": "Test",
"text": "Heihei",
"html": "Heihei"
}
```
### with attachments
```json
{
...,
"attachments": [
{
"content": "document in base64",
"filename": "name of file",
"type": "application/json"
}
]
}
```
## **GET** `/template/{template}`
Get template handlebars
### Get all templates
**/template/all**
### Get specific template
**/template/example**