https://github.com/icerockdev/email-service
Email sending service for kotlin - part of BOKO libs
https://github.com/icerockdev/email-service
backend email kotlin kotlin-jvm
Last synced: 4 days ago
JSON representation
Email sending service for kotlin - part of BOKO libs
- Host: GitHub
- URL: https://github.com/icerockdev/email-service
- Owner: icerockdev
- License: apache-2.0
- Created: 2020-02-11T04:07:39.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2026-03-19T04:41:24.000Z (18 days ago)
- Last Synced: 2026-03-19T21:16:04.381Z (17 days ago)
- Topics: backend, email, kotlin, kotlin-jvm
- Language: Kotlin
- Homepage:
- Size: 206 KB
- Stars: 10
- Watchers: 5
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Email service
## Installation
````kotlin
// Append repository
repositories {
mavenCentral()
}
// Append dependency
implementation("com.icerockdev.service:email-service:1.0.0")
````
## Library usage
### Configuration
````kotlin
val emailScope = CoroutineScope(Dispatchers.IO + SupervisorJob())
MailerService(
emailScope,
SMTPConfig(
host = "smtp.gmail.com",
port = 587,
smtpSecure = SMTPSecure.TLS,
smtpAuth = true,
username = "",
password = ""
)
)
````
### Send email
````kotlin
mailerService.compose().apply {
fromEmail = "from@icerockdev.com"
fromName = "From Person"
subject = "TEST EMAIL"
to = mutableMapOf("to@icerockdev.com" to "Test Person")
html = "
Test test test
"
attachments = listOf(
Mail.Attachment(
file = File("test.pdf"),
name = "test.pdf"
)
)
inlineAttachments = listOf(
file = File("test.png"),
cidName = "testpng",
name = "test.png"
)
}.sendAsync()
````
## Contributing
All development (both new features and bug fixes) is performed in the `develop` branch. This way `master` always contains the sources of the most recently released version. Please send PRs with bug fixes to the `develop` branch. Documentation fixes in the markdown files are an exception to this rule. They are updated directly in `master`.
The `develop` branch is pushed to `master` on release.
For more details on contributing please see the [contributing guide](CONTRIBUTING.md).
## License
Copyright 2020 IceRock MAG Inc.
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.