• Stars
    star
    1,117
  • Rank 41,588 (Top 0.9 %)
  • Language
    Swift
  • License
    MIT License
  • Created almost 8 years ago
  • Updated over 7 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Send email to any SMTP server like a boss, in Swift and cross-platform

codebeat badge


Hedwig is a Swift package which supplies a set of high level APIs to allow you sending email to an SMTP server easily. If you are planning to send emails from your next amazing Swift server app, Hedwig might be a good choice.

Features

  • Connect to all SMTP servers, through whether plain, SSL or TLS (STARTTLS) port.
  • Authentication with PLAIN, CRAM-MD5, LOGIN or XOAUTH2.
  • Send email with HTML body and attachments.
  • Customize validation method and mail header, to track your mail campaign.
  • Queued mail sending, without blocking your app. You can even send mails concurrently.
  • Works with Swift Package Manager, in the latest Swift syntax and cross-platform.
  • Fully tested and documented.

Installation

Add the url of this repo to your Package.swift:

import PackageDescription

let package = Package(
    name: "YourAwesomeSoftware",
    dependencies: [
        .Package(url: "https://github.com/onevcat/Hedwig.git", 
                 majorVersion: 1)
    ]
)

Then run swift build whenever you get prepared. (Also remember to grab a cup of coffee ๐Ÿ˜„)

You can find more information on how to use Swift Package Manager in Apple's official page.

Usage

Sending text only email

let hedwig = Hedwig(hostName: "smtp.example.com", user: "[email protected]", password: "password")
let mail = Mail(
        text: "Across the great wall we can reach every corner in the world.", 
        from: "[email protected]", 
        to: "[email protected]", 
        subject: "Hello World"
)
    
hedwig.send(mail) { error in
    if error != nil { /* Error happened */ }
}

Sending HTML email

let hedwig = Hedwig(hostName: "smtp.example.com", user: "[email protected]", password: "password")
let attachment = Attachment(htmlContent: "<html><body><h1>Title</h1><p>Content</p></body></html>")
let mail = Mail(
        text: "Fallback text", 
        from: "[email protected]", 
        to: "[email protected]", 
        subject: "Title", 
        attachments: [attachment]
)
hedwig.send(mail) { error in
    if error != nil { /* Error happened */ }
}

CC and BCC

let hedwig = Hedwig(hostName: "smtp.example.com", user: "[email protected]", password: "password")
let mail = Mail(
        text: "Across the great wall we can reach every corner in the world.", 
        from: "[email protected]", 
        to: "[email protected]",
        cc: "Wei Wang <[email protected]>, [email protected]", // Addresses will be parsed for you
        bcc: "My Group: [email protected], [email protected];",    // Even with group syntax
        subject: "Hello World"
)
hedwig.send(mail) { error in
    if error != nil { /* Error happened */ }
}

Using different SMTP settings (security layer, auth method and etc.)

let hedwig = Hedwig(
        hostName: "smtp.example.com", 
        user: "[email protected]", 
        password: "password",
        port: 1234,     // Determined from secure layer by default
        secure: .plain, // .plain (Port 25) | .ssl (Port 465) | .tls (Port 587) (default)
        validation: .default, // You can set your own certificate/cipher/protocols
        domainName: "onevcat.com", // Used when saying hello to STMP Server
        authMethods: [.plain, .login] // Default: [.plain, .cramMD5, .login, .xOauth2]        
)

Send mails with inline image and other attachment

let imagePath = "/tmp/image.png"
// You can create an attachment from a local file path.
let imageAttachment = Attachment(
        filePath: imagePath, 
        inline: true, 
        // Add "Content-ID" if you need to embed this image to another attachment.
        additionalHeaders: ["Content-ID": "hedwig-image"] 
)
let html = Attachment(
        htmlContent: "<html><body>A photo <img src=\"cid:hedwig-image\"/></body></html>", 
        // If imageAttachment only used embeded in HTML, I recommend to set it as related.
        related: [imageAttachment]
)

// You can also create attachment from raw data.
let data = "{\"key\": \"hello world\"}".data(using: .utf8)!
let json = Attachment(
        data: data, 
        mime: "application/json", 
        name: "file.json", 
        inline: false // Send as standalone attachment.
)

let mail = Mail(
        text: "Fallback text", 
        from: "[email protected]", 
        to: "[email protected]", 
        subject: "Check the photo and json file!",
        attachments: [html, json]
hedwig.send(mail) { error in
    if error != nil { /* Error happened */ }
}

Send multiple mails

let mail1: Mail = //...
let mail2: Mail = //...

hedwig.send([mail1, mail2], 
        progress: { (mail, error) in
            if error != nil { 
                print("\(mail) failed. Error: \(error)") 
            }
        },
        completion: { (sent, failed) in
            for mail in sent {
                print("Sent mail: \(mail.messageId)")
            }
            
            for (mail, error) in failed {
                print("Mail \(mail.messageId) errored: \(error)")
            }
        }
)

Help and Questions

Visit the documentation page for full API reference.

You could also run the tests (swift test) to see more examples to know how to use Hedwig.

If you have found the framework to be useful, please consider a donation. Your kind contribution will help me afford more time on the project.

Click here to lend your support to: Hedwig and make a donation at pledgie.com !

Or you are a Bitcoin fan and want to treat me a cup of coffe, here is my wallet address:

1MqwfsxBJ5pJX4Qd2sRVhK3dKTQrWYooG5

FAQ

I cannot send mails with Gmail SMTP.

Gmail uses an application specific password. You need to create one and use the specified password when auth. See this.

I need to add/set some additonal header in the mail.

Both Mail and Attachment accept customizing header fields. Pass your headers as additionalHeaders when creating the mail or attachment and Hedwig will handle it.

Can I use it in iOS?

At this time Swift Package Manager has no support for iOS, watchOS, or tvOS platforms. So the answer is no. But this framework is not using anything only in iOS (like UIKit), so as soon as Swift Package Manager supports iOS, you can use it there too.

Tell me about the name and logo of Hedwig

Yes, Hedwig (bird) was Harry Potter's pet Snowy Owl. The logo of Hedwig (this framework) is created by myself and it pays reverence to the novels and movies.

Other questions

Submit an issue if you find something wrong. Pull requests are warmly welcome, but I suggest to discuss first.

You can also follow and contact me on Twitter or Sina Weibo.

Enjoy sending your emails

License

Hedwig is released under the MIT license. See LICENSE for details.

More Repositories

1

Kingfisher

A lightweight, pure-Swift library for downloading and caching images from the web.
Swift
23,065
star
2

VVDocumenter-Xcode

Xcode plug-in which helps you write documentation comment easier, for both Objective-C and Swift.
Objective-C
8,329
star
3

FengNiao

A command line tool for cleaning unused resources in Xcode.
Swift
3,382
star
4

APNGKit

High performance and delightful way to play with APNG format in iOS.
Swift
2,206
star
5

Rainbow

Delightful console output for Swift developers.
Swift
1,839
star
6

VVBlurPresentation

A simple way to present a view controller with keeping the blurred previous one.
Objective-C
894
star
7

RandomColorSwift

An attractive color generator for Swift. Ported from randomColor.js.
Swift
628
star
8

XUPorter

Add files and frameworks to your Xcode project after it is generated by Unity 3D.
C#
587
star
9

VVSpringCollectionViewFlowLayout

A spring-like collection view layout. The same effect like iOS7's Message.app
Objective-C
576
star
10

vno-jekyll

Another ported theme for Jekyll
SCSS
544
star
11

vno

Vno, just another ghost theme
CSS
518
star
12

Easy-Cal-Swift

Overload +-*/ operator for Swift, make it easier to use (and not so strict)
Swift
273
star
13

OneV-s-Den

Blog
SCSS
212
star
14

VVImageTint

UIImage category for image tint. For my blog post http://onevcat.com/2013/04/using-blending-in-ios/
Objective-C
193
star
15

UniWebView-Docs

Documentation of UniWebView Project
JavaScript
192
star
16

VCTransitionDemo

A simple demo indicates how to make a custom view controller transition in iOS 7
Objective-C
189
star
17

UserNotificationDemo

Demo project to show how to use UserNotifications framework in iOS 10
Swift
152
star
18

iOSWeekly

iOS Weekly issue for InfoQ CN
133
star
19

ToDoDemo

State-based View Controller demo
Swift
125
star
20

ObservationBP

Proof of concept for back-porting Observation framework to earlier iOS versions
Swift
113
star
21

DebuggableContext

Provides an easy to use action sheet for debugging purpose when shaking your iOS device.
Swift
97
star
22

resume

JavaScript
87
star
23

ComponentNetworking

Swift
83
star
24

swift-ui-book-issue

76
star
25

AddressParser

Email address parser.
Swift
70
star
26

Delegate

A meta library to provide a better `Delegate` pattern.
Swift
67
star
27

SpriteKitSimpleGame

A demo for starting using SpriteKit. Port famous Cocos2DSimpleGame to SpriteKit.
Objective-C
60
star
28

WatchWeather

Swift
47
star
29

MimeType

Get MIME type string from the extension of a file name
Swift
42
star
30

TimerExtensionDemo

A demo to show how to write a today extension.
Swift
41
star
31

ClockFaceView

A demo project for my blog post
Swift
31
star
32

UITestDemo

UITestDemo
Swift
21
star
33

VVStack

Just a TDD demo with XCTest and Kiwi
Objective-C
20
star
34

Noti

Swift
19
star
35

JekyllScroll

JekyllScroll is a theme for Jekyll.
CSS
19
star
36

DispatchMemoryLeakDemo

A demo that reproduce memory leak in iOS 9.2
Swift
19
star
37

VVBorderTimer

An easy border timer with configurable time, corner radius, line width and colors.
Objective-C
17
star
38

Notes

My Notes: http://notes.onevcat.com
17
star
39

lgtm-images

LGTM images collection
Swift
16
star
40

UniWebView-Deprecated

A universal webview plugin for Unity3D. Work with iOS, Android and Mac, using javascript to interact with Unity3D.
Objective-C
14
star
41

UnpauseMe

Script for Unity3D, unpause Unity3D animations or particles when set Time.timeScale = 0.
C#
14
star
42

PhotoData_Kiwi

Use Kiwi to replace objc.io's first issue. Just a demo for Kiwi and my post.
Objective-C
13
star
43

Swift-CI

Swift CI script. Stolen from vapor.
Shell
13
star
44

CounterDemo

A demo app for studying of TCA
Swift
12
star
45

check-lfs

A command-line tool to check binary file committed to a repo.
Swift
11
star
46

Kingfisher-Crash

Crash sample of Kingfisher SwiftUI with SPM on Xcode 11.2 beta
Swift
10
star
47

TexasPoker

A client of Texas Poker
Objective-C
9
star
48

NeuralNetworkLearning

Swift
9
star
49

XcodeScheme

9
star
50

YYTextSample

Sample project for a layout issue in iOS 10
Swift
9
star
51

pokemaster-images

Images for PokeMaster
8
star
52

KeyboardScrollingIssue

Swift
7
star
53

apple-versions

Astro
7
star
54

VVPluginDemo

A demo for how to make a simple Xcode 4 plug-in.
Objective-C
7
star
55

LineSDK-Integration

Integration Test Cases for LINE SDK Swift
Ruby
7
star
56

onevcat

6
star
57

VVPerlBBS

BBS with Perl. Powered by OneV's Den.
Perl
5
star
58

submail-provider

Submail email provider for Vapor
Swift
4
star
59

MwfTableViewController

Extension to UITableViewController in attempt to provide additional features that are reusable in most scenarios.
Objective-C
4
star
60

Flower-Data-Set

Python
4
star
61

GitHubActionPlayground

4
star
62

elm-2048

Practice my elm understanding
Elm
3
star
63

ChatBot

JavaScript
3
star
64

Math.swift

Math
Swift
3
star
65

onevcat.github.com

It's a user page
3
star
66

beginning-elm

JavaScript
3
star
67

LandscapeViewControllerDemo

Just a demo
Objective-C
3
star
68

LearningPerl

It's a repo for Perl learning to get prepared for future working in Kayac.
Objective-C
3
star
69

advent2021

For fun
Swift
2
star
70

qixia.wang

2
star
71

GoogleInteractiveMediaAds-Carthage

2
star
72

LazyContainerBug

State of cells in "lazy" container is lost, if the cell is embedded in a stack
Swift
2
star
73

objc-image-packer

Book build image for ObjCCN
HCL
2
star
74

cool-lang

COOL Lang
Java
2
star
75

JBAlertView

JBAlertView is the new AlertView for showing different alerts type (default, connection, error, ...)
Objective-C
2
star
76

github-battle

Typescript version of GitHub Battle
TypeScript
2
star
77

KF-issue-1931

Swift
1
star
78

VVAlertBanner

A alert banner view which could queue the alert and shou them each by each.
Objective-C
1
star
79

Kingfisher-TestImages

Test images for Swift image downloading framework - Kingfisher.
1
star
80

SPMConfigDemo

Swift
1
star
81

Kingfisher-Review-Sample

Swift
1
star