GitHub - LiveUI/MailCore: Emailing wrapper for Vapor 3 apps
source link: https://github.com/LiveUI/MailCore
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
README.md
Mailing wrapper for multiple mailing services like Mailgun, SendGrid or SMTP
Features
- Mailgun
- SendGrid
- SMTP
- Attachments
- Multiple emails sent at the same time
- Multiple recipint, CC & BCC fields
Install
Just add following line package to your Package.swift
file.
.package(url: "https://github.com/LiveUI/MailCore.git", .branch("master"))
Usage
Usage is really simple mkey!
1/3) Configure
First create your client configuration:
Mailgun
let config = Mailer.Config.mailgun(key: "{mailgunApi}", domain: "{mailgunDomain}", region: "{mailgunRegion}")
SendGrid
let config = Mailer.Config.sendGrid(key: "{sendGridApiKey}")
SMTP
Use the SMTP
struct as a handle to your SMTP server:
let smtp = SMTP(hostname: "smtp.gmail.com", // SMTP server address email: "[email protected]", // username to login password: "password") // password to login let config = Mailer.Config.smtp(smtp)
SMTP using TLS
All parameters of SMTP
struct:
let smtp = SMTP(hostname: String, email: String, password: String, port: Int32 = 465, useTLS: Bool = true, tlsConfiguration: TLSConfiguration? = nil, authMethods: [AuthMethod] = [], accessToken: String? = nil, domainName: String = "localhost", timeout: UInt = 10) let config = Mailer.Config.smtp(smtp)
2/3) Register service
Register and configure the service in your apps configure
method.
Mailer(config: config, registerOn: &services)
Mailer.Config
is an enum
and you can choose from any integrated services to be used
3/3) Send an email
let mail = Mailer.Message(from: "[email protected]", to: "[email protected]", subject: "Oil spill", text: "Oooops I did it again", html: "<p>Oooops I did it again</p>") return try req.mail.send(mail).flatMap(to: Response.self) { mailResult in print(mailResult) // ... Return your response for example }
Testing
Mailcore provides a MailCoreTestTools
framework which you can import into your tests to get MailerMock
.
To register, and potentially override any existing "real" Mailer service, just initialize MailerMock
with your services.
// Register MailerMock(services: &services) // Retrieve in your tests let mailer = try! req.make(MailerService.self) as! MailerMock
MailerMock
will store the last used result as well as the received message and request. Structure of the moct can be seen below:
public class MailerMock: MailerService { public var result: Mailer.Result = .success public var receivedMessage: Mailer.Message? public var receivedRequest: Request? // MARK: Initialization @discardableResult public init(services: inout Services) { services.remove(type: Mailer.self) services.register(self, as: MailerService.self) } // MARK: Public interface public func send(_ message: Mailer.Message, on req: Request) throws -> Future<Mailer.Result> { receivedMessage = message receivedRequest = req return req.eventLoop.newSucceededFuture(result: result) } public func clear() { result = .success receivedMessage = nil receivedRequest = nil } }
Support
Join our Slack, channel #help-boost to ... well, get help :)
Enterprise AppStore
Core package for Einstore, a completely open source enterprise AppStore written in Swift!
- Website: http://www.einstore.io
- Github: https://github.com/Einstore/Einstore
Other core packages
- EinstoreCore - AppStore core module
- ApiCore - Base user & team management including forgotten passwords, etc ...
Implemented thirdparty providers
- Mailgun - https://github.com/twof/VaporMailgunService
- SendGrig - https://github.com/vapor-community/sendgrid-provider
- SMTP - https://github.com/IBM-Swift/Swift-SMTP
Code contributions
We love PR’s, we can’t get enough of them ... so if you have an interesting improvement, bug-fix or a new feature please don’t hesitate to get in touch. If you are not sure about something before you start the development you can always contact our dev and product team through our Slack.
Author
Ondrej Rafaj (@rafiki270 on Github, Twitter, LiveUI Slack and Vapor Slack)
License
MIT license, please see LICENSE file for more details.
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK