Skip to content

Add README clarifications #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
demoore merged 1 commit into from
Apr 4, 2022
Merged

Add README clarifications #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,11 +98,11 @@ import java.util.Map;

import com.sendwithus.SendWithUs;

final String SENDWITHUS_API_KEY = "API-KEY-HERE";
final String EMAIL_ID_WELCOME_EMAIL = "EMAIL-ID-HERE";
final String TEMPLATE_ID = "TEMPLATE-ID-HERE";
final String DRIP_CAMPAIGN_ID = "DRIP-CAMPAIGN-ID-HERE";
final String SNIPPET_ID = "SNIPPET-ID-HERE";
// IDs and API keys are found in the Sendwithus dashboard
final String SENDWITHUS_API_KEY = "API-KEY-HERE"; // starts with "live_..." or "test_..."
final String TEMPLATE_ID = "TEMPLATE-ID-HERE"; // starts with "tem_..."
final String DRIP_CAMPAIGN_ID = "DRIP-CAMPAIGN-ID-HERE"; // starts with "dc_..."
final String SNIPPET_ID = "SNIPPET-ID-HERE"; // starts with "snp_..."

SendWithUs sendwithusAPI = new SendWithUs(SENDWITHUS_API_KEY);

Expand All @@ -128,9 +128,21 @@ emailDataMap.put("link", "http://sendwithus.com/some_link");
// Attachments is optional
String[] attachments = {"test.png"}

// CC is optional (BCC follows a similar pattern)
String[] ccEmails = {"[email protected]", "[email protected]"};
HashMap<String, Object>[] ccRecipientsMap = (HashMap<String, Object>[]) new HashMap[ccEmails.length];

int i = 0;
for (String email : ccEmails){
HashMap<String, Object> hashMap = new HashMap<String, Object>();
hashMap.put("address", email);
ccRecipientsMap[i] = hashMap;
i++;
}

// Sending the email using the legacy send() java API
SendReceipt sendReceipt = sendwithusAPI.send(
EMAIL_ID_WELCOME_EMAIL,
TEMPLATE_ID,
recipientMap,
senderMap,
emailDataMap,
Expand All @@ -142,8 +154,9 @@ SendReceipt sendReceipt = sendwithusAPI.send(

// Example sending the same email using the new SendWithUsSendRequest class
SendWithUsSendRequest request = new SendWithUsSendRequest()
.setEmailId(EMAIL_ID_WELCOME_EMAIL)
.setEmailId(TEMPLATE_ID)
.setRecipient(recipientMap)
.setCcRecipients(ccRecipientsMap)
.setSender(senderMap)
.setEmailData(emailDataMap)
.setAttachmentPaths(attachments)
Expand Down