Skip to content

SDKs

Each SDK signs in with your recovery phrase or an API key, creates addresses that receive mail, opens what arrives, sends with attachments, and listens for events. The keys are derived from the phrase on your machine; the phrase is never sent.

LanguagePackageInstall
TypeScriptmailcycle-sdk on npmnpm install mailcycle-sdkAvailable
Pythonmailcycle on PyPIpip install mailcycleAvailable
Gomailcycle.email/gogo get mailcycle.email/goAvailable
Rustmailcycle on crates.iocargo add mailcycleAvailable
Swiftmailcycle.email/swift/mailcycle.git.package(url: "https://mailcycle.email/swift/mailcycle.git", from: "0.1.0")Available
PHPmailcycle/mailcycle on Mailcycle’s Composer repositorycomposer require mailcycle/mailcycleAvailable
Javaemail.mailcycle:mailcycle on Maven Centralimplementation("email.mailcycle:mailcycle:0.3.0")Available
.NETMailcycle on NuGetdotnet add package MailcycleAvailable
Rubymailcycle on RubyGemsgem install mailcycleAvailable

The Swift line goes in the dependencies of your Package.swift. For PHP, add the repository first with composer config repositories.mailcycle composer https://mailcycle.email/php. The Java line is for Gradle; with Maven, the guide has the <dependency> block.

All of them implement the same encryption format and are checked against the same test vectors, so mail sealed by one opens in any other and in the apps.

The encryption format is published, so you can write a client now rather than wait. Plain HTTP calls also work without any SDK for everything except opening mail and creating addresses that receive it: see Authentication and Email addresses.

© Northlab Studios Ltd, trading as Mailcycle. Registered in England and Wales, company no. 17462734. Registered office: 167-169 Great Portland Street, London W1W 5PF.