HonzaR/android-sparkpost-with-attachments

Android Library for SparkPost (Email Delivery Service & Transactional Email)

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.HonzaR:android-sparkpost-with-attachments:v0.2.2'
	}

	dependencies {
		implementation("com.github.HonzaR:android-sparkpost-with-attachments:v0.2.2")
	}

	<dependency>
	    <groupId>com.github.HonzaR</groupId>
	    <artifactId>android-sparkpost-with-attachments</artifactId>
	    <version>v0.2.2</version>
	</dependency>


                            
    libraryDependencies += "com.github.HonzaR" % "android-sparkpost-with-attachments" % "v0.2.2"


                            
    :dependencies [[com.github.HonzaR/android-sparkpost-with-attachments "v0.2.2"]]

Readme

android-sparkpost-with-attachments

Android Library for SparkPost -> Email Delivery Service & Transactional Email

This is improvement of NoelChew's android-sparkpost library. We add possibility to send files with SparkPost service in Base64 encoding.

How to Use

ArrayList<SparkPostFile> files = new ArrayList<>();
File[] fs = getAllFilesFromDirectory(new File(getExternalFilesDir(null)));
files.add(new SparkPostFile("image/jpeg", "attachment", getBase64FromFile(front[0])));
String html = "<html><body>Here is your inline image!<br> <img src=\\\"cid:attachment\\\"></body></html>";
SparkPostEmailUtil.sendEmail(context,
                    sparkPostApiKey,
                    subject,
                    message,
                    new SparkPostSender(senderEmail, senderName),
                    new SparkPostRecipient(recipientEmail),
                    html,
                    files,
                    new EmailListener() {
                        @Override
                        public void onSuccess() {
                            // do something here
                        }

                        @Override
                        public void onError(String errorMessage) {
                            // do something here
                        }
                    });

Account Setup

You will need to [create a SparkPost API key]. [create a SparkPost API key]: https://support.sparkpost.com/customer/portal/articles/1933377-create-api-keys

To start sending emails with your own domain, you will need to [create a sending domain]. [create a sending domain]: https://support.sparkpost.com/customer/portal/articles/1933318-creating-sending-domains

Next, you will need to [verify the sending domain]. [verify the sending domain]: https://support.sparkpost.com/customer/portal/articles/1933360-verify-sending-domains

With a verified sending domain, you can [send up to 100,000 emails a month]. [send up to 100,000 emails a month]: https://www.sparkpost.com/pricing

Else, you can [send up to 50 emails using anyname@sparkpostbox.com] [send up to 50 emails using anyname@sparkpostbox.com]: https://developers.sparkpost.com/api/index#header-rate-limiting

Integration

This library is hosted by jitpack.io.

Root level gradle:

allprojects {
 repositories {
    jcenter()
    maven { url "https://jitpack.io" }
 }
}

Application level gradle:

dependencies {
    compile 'com.github.HonzaR:android-sparkpost-with-attachments:x.y.z'
}

Note: do not add the jitpack.io repository under buildscript

Proguard

-keep class com.honzar.sparkpostutil.library.** {*;}

Disclaimer

I am not in any way affiliated with SparkPost. I created this library because I failed to exclude their [java library] from my proguard configuration. Do shed some light if you have done it successfully. [java library]: https://github.com/SparkPost/java-sparkpost