README.md

ThirdPartyMailer

Interact with third-party iOS mail clients, using custom URL schemes.

Supported mail clients

Client	URL Scheme	App Store
Sparrow	sparrow	discontinued
Gmail	googlegmail	link
Dispatch	x-dispatch	link
Spark	readdle-spark	link
Airmail	airmail	link
Microsoft Outlook	ms-outlook	link
Yahoo Mail	ymail	link
Fastmail	fastmail	link

Unfortunately, not all mail clients offer URL schemes to be supported by ThirdPartyMailer. If you’re aware of another candidate, please let us know.

How to install

Swift Package Manager

In Xcode, click on the “File” menu, “Swift Packages”, “Add Package Dependency…”, then enter the URL for this repo: https://github.com/vtourraine/ThirdPartyMailer.git.

CocoaPods

With CocoaPods, simply add ThirdPartyMailer to your Podfile:

pod 'ThirdPartyMailer'

Or, you can manually import the files from the Sources folder.

How to use

Getting the list of supported clients

let clients = ThirdPartyMailClient.clients()

Testing the client availability (i.e. if the app is installed)

⚠️ In order to test the client availability, your app needs to declare the relevant URL scheme in its Info.plist file, by adding a LSApplicationQueriesSchemes array. You can find an example here, or check out the documentation.

let application = UIApplication.shared

if ThirdPartyMailer.application(application, isMailClientAvailable: client) {
    // ...
}

Opening the client (with optional message recipient, subject, and body)

let application = UIApplication.shared

ThirdPartyMailer.application(application, openMailClient: client, recipient: nil, subject: nil, body: nil)

Requirements

ThirdPartyMailer is written in Swift 5.0, requires iOS 8.0 and above, Xcode 10.2 and above.

Credits

ThirdPartyMailer was created by Vincent Tourraine.

License

ThirdPartyMailer is available under the MIT license. See the LICENSE file for more info.