Skip to content
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

fix: Inspected code of Stats, example helpers #975

Merged
merged 7 commits into from
Jun 9, 2020
Merged

fix: Inspected code of Stats, example helpers #975

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d82606b
Merge pull request #1 from sendgrid/master
kampalex May 19, 2020
b2520ac
Merge pull request #2 from sendgrid/master
kampalex May 26, 2020
a2e30cb
Merge pull request #3 from sendgrid/master
kampalex Jun 2, 2020
0abb577
Merge pull request #4 from sendgrid/master
kampalex Jun 3, 2020
7cbf642
Merge pull request #5 from sendgrid/master
kampalex Jun 8, 2020
f849c81
Example helpers code inspection
kampalex Jun 9, 2020
e3ccebd
Removed spaces (accidentally added)
kampalex Jun 9, 2020
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
316 changes: 164 additions & 152 deletions examples/helpers/mail/example.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
<?php
namespace SendGrid;

// If you are using Composer
require __DIR__ . '/../../../vendor/autoload.php';
require __DIR__ . '<PATH_TO>/vendor/autoload.php';
// comment out the above line if not using Composer
// require("./sendgrid-php.php");
// If not using Composer, uncomment the above line
Expand Down Expand Up @@ -44,7 +43,7 @@ function helloEmail()
$mail = new Mail($from, $to, $subject, $content);

$personalization = new Personalization();
$personalization->addTo(new To(null, "[email protected]"));
$personalization->addTo(new To("[email protected]"));
$mail->addPersonalization($personalization);

//echo json_encode($mail, JSON_PRETTY_PRINT), "\n";
Expand All @@ -58,150 +57,156 @@ function helloEmail()

function kitchenSink()
{
$from = new From("[email protected]", "Twilio SendGrid");
$subject = "Hello World from the Twilio SendGrid PHP Library";
$to = new To("[email protected]", "Example User");
$content = new Content("text/plain", "some text here");

$mail = new Mail($from, $to, $subject, $content);

$personalization0 = new Personalization();
$personalization0->addTo(new To("[email protected]", "Example User"));
$personalization0->addCc(new Cc("[email protected]", "Example User"));
$personalization0->addCc(new Cc("[email protected]", "Example User"));
$personalization0->addBcc(new Bcc("[email protected]", "Example User"));
$personalization0->addBcc(new Bcc("[email protected]", "Example User"));
$personalization0->setSubject(new Subject("Hello World from the Twilio SendGrid PHP Library"));
$personalization0->addHeader(new Header("X-Test", "test"));
$personalization0->addHeader(new Header("X-Mock", "true"));
$personalization0->addSubstitution("%name%", "Example User");
$personalization0->addSubstitution("%city%", "Denver");
$personalization0->addSubstitution("%sec1%", "%section1%");
$personalization0->addCustomArg(new CustomArg("user_id", "343"));
$personalization0->addCustomArg(new CustomArg("type", "marketing"));
$personalization0->setSendAt(new SendAt(1443636843));
$mail->addPersonalization($personalization0);

$personalization1 = new Personalization();
$personalization1->addTo(new To("[email protected]", "Example User"));
$personalization1->addTo(new To("[email protected]", "Example User"));
$personalization1->addCc(new Cc("[email protected]", "Example User"));
$personalization1->addCc(new Cc("[email protected]", "Example User"));
$personalization1->addBcc(new Bcc("[email protected]", "Example User"));
$personalization1->addBcc(new Bcc("[email protected]", "Example User"));
$personalization1->setSubject(new Subject("Hello World from the Twilio SendGrid PHP Library"));
$personalization1->addHeader(new Header("X-Test", "test"));
$personalization1->addHeader(new Header("X-Mock", "true"));
$personalization1->addSubstitution("%name%", "Example User");
$personalization1->addSubstitution("%city%", "Denver");
$personalization1->addSubstitution("%sec2%", "%section2%");
$personalization1->addCustomArg(new CustomArg("user_id", "343"));
$personalization1->addCustomArg(new CustomArg("type", "marketing"));
$personalization1->setSendAt(new SendAt(1443636843));
$mail->addPersonalization($personalization1);

//Examples of adding personalization by specifying personalization indexes
$mail->addCc("[email protected]", "Example User", null, 0);
$mail->addBcc("[email protected]", "Example User", null, 1);

$content = new Content("text/html", "<html><body>some text here</body></html>");
$mail->addContent($content);

$attachment = new Attachment();
$attachment->setContent("TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gQ3JhcyBwdW12");
$attachment->setType("application/pdf");
$attachment->setFilename("balance_001.pdf");
$attachment->setDisposition("attachment");
$attachment->setContentId("Balance Sheet");
$mail->addAttachment($attachment);

$attachment2 = new Attachment();
$attachment2->setContent("BwdW");
$attachment2->setType("image/png");
$attachment2->setFilename("banner.png");
$attachment2->setDisposition("inline");
$attachment2->setContentId("Banner");
$mail->addAttachment($attachment2);

$mail->setTemplateId("439b6d66-4408-4ead-83de-5c83c2ee313a");

# This must be a valid [batch ID](https://sendgrid.com/docs/API_Reference/SMTP_API/scheduling_parameters.html) to work
# $mail->setBatchID("sendgrid_batch_id");

$mail->addSection("%section1%", "Substitution Text for Section 1");
$mail->addSection("%section2%", "Substitution Text for Section 2");

$mail->addHeader("X-Test1", "1");
$mail->addHeader("X-Test2", "2");

$mail->addCategory("May");
$mail->addCategory("2016");

$mail->addCustomArg("campaign", "welcome");
$mail->addCustomArg("weekday", "morning");

$mail->setSendAt(1443636842);

$asm = new ASM();
$asm->setGroupId(99);
$asm->setGroupsToDisplay([4,5,6,7,8]);
$mail->setASM($asm);

$mail->setIpPoolName("23");

$mail_settings = new MailSettings();
$bcc_settings = new BccSettings();
$bcc_settings->setEnable(true);
$bcc_settings->setEmail("[email protected]");
$mail_settings->setBccSettings($bcc_settings);
$sandbox_mode = new SandBoxMode();
$sandbox_mode->setEnable(true);
$mail_settings->setSandboxMode($sandbox_mode);
$bypass_list_management = new BypassListManagement();
$bypass_list_management->setEnable(true);
$mail_settings->setBypassListManagement($bypass_list_management);
$footer = new Footer();
$footer->setEnable(true);
$footer->setText("Footer Text");
$footer->setHtml("<html><body>Footer Text</body></html>");
$mail_settings->setFooter($footer);
$spam_check = new SpamCheck();
$spam_check->setEnable(true);
$spam_check->setThreshold(1);
$spam_check->setPostToUrl("https://spamcatcher.sendgrid.com");
$mail_settings->setSpamCheck($spam_check);
$mail->setMailSettings($mail_settings);

$tracking_settings = new TrackingSettings();
$click_tracking = new ClickTracking();
$click_tracking->setEnable(true);
$click_tracking->setEnableText(true);
$tracking_settings->setClickTracking($click_tracking);
$open_tracking = new OpenTracking();
$open_tracking->setEnable(true);
$open_tracking->setSubstitutionTag("Optional tag to replace with the open image in the body of the message");
$tracking_settings->setOpenTracking($open_tracking);
$subscription_tracking = new SubscriptionTracking();
$subscription_tracking->setEnable(true);
$subscription_tracking->setText("text to insert into the text/plain portion of the message");
$subscription_tracking->setHtml("<html><body>html to insert into the text/html portion of the message</body></html>");
$subscription_tracking->setSubstitutionTag("Optional tag to replace with the open image in the body of the message");
$tracking_settings->setSubscriptionTracking($subscription_tracking);
$ganalytics = new Ganalytics();
$ganalytics->setEnable(true);
$ganalytics->setCampaignSource("some source");
$ganalytics->setCampaignTerm("some term");
$ganalytics->setCampaignContent("some content");
$ganalytics->setCampaignName("some name");
$ganalytics->setCampaignMedium("some medium");
$tracking_settings->setGanalytics($ganalytics);
$mail->setTrackingSettings($tracking_settings);

$reply_to = new ReplyTo("[email protected]", "Optional Name");
$mail->setReplyTo($reply_to);

//echo json_encode($mail, JSON_PRETTY_PRINT), "\n";
return $mail;
try {
$from = new From("[email protected]", "Twilio SendGrid");
$subject = "Hello World from the Twilio SendGrid PHP Library";
$to = new To("[email protected]", "Example User");
$content = new Content("text/plain", "some text here");

$mail = new Mail($from, $to, $subject, $content);

$personalization0 = new Personalization();
$personalization0->addTo(new To("[email protected]", "Example User"));
$personalization0->addCc(new Cc("[email protected]", "Example User"));
$personalization0->addCc(new Cc("[email protected]", "Example User"));
$personalization0->addBcc(new Bcc("[email protected]", "Example User"));
$personalization0->addBcc(new Bcc("[email protected]", "Example User"));
$personalization0->setSubject(new Subject("Hello World from the Twilio SendGrid PHP Library"));
$personalization0->addHeader(new Header("X-Test", "test"));
$personalization0->addHeader(new Header("X-Mock", "true"));
$personalization0->addSubstitution("%name%", "Example User");
$personalization0->addSubstitution("%city%", "Denver");
$personalization0->addSubstitution("%sec1%", "%section1%");
$personalization0->addCustomArg(new CustomArg("user_id", "343"));
$personalization0->addCustomArg(new CustomArg("type", "marketing"));
$personalization0->setSendAt(new SendAt(1443636843));
$mail->addPersonalization($personalization0);

$personalization1 = new Personalization();
$personalization1->addTo(new To("[email protected]", "Example User"));
$personalization1->addTo(new To("[email protected]", "Example User"));
$personalization1->addCc(new Cc("[email protected]", "Example User"));
$personalization1->addCc(new Cc("[email protected]", "Example User"));
$personalization1->addBcc(new Bcc("[email protected]", "Example User"));
$personalization1->addBcc(new Bcc("[email protected]", "Example User"));
$personalization1->setSubject(new Subject("Hello World from the Twilio SendGrid PHP Library"));
$personalization1->addHeader(new Header("X-Test", "test"));
$personalization1->addHeader(new Header("X-Mock", "true"));
$personalization1->addSubstitution("%name%", "Example User");
$personalization1->addSubstitution("%city%", "Denver");
$personalization1->addSubstitution("%sec2%", "%section2%");
$personalization1->addCustomArg(new CustomArg("user_id", "343"));
$personalization1->addCustomArg(new CustomArg("type", "marketing"));
$personalization1->setSendAt(new SendAt(1443636843));
$mail->addPersonalization($personalization1);

// Examples of adding personalization by specifying personalization indexes
$mail->addCc("[email protected]", "Example User", null, 0);
$mail->addBcc("[email protected]", "Example User", null, 1);

$content = new Content("text/html", "<html><body>some text here</body></html>");
$mail->addContent($content);

$attachment = new Attachment();
$attachment->setContent("TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gQ3JhcyBwdW12");
$attachment->setType("application/pdf");
$attachment->setFilename("balance_001.pdf");
$attachment->setDisposition("attachment");
$attachment->setContentId("Balance Sheet");
$mail->addAttachment($attachment);

$attachment2 = new Attachment();
$attachment2->setContent("BwdW");
$attachment2->setType("image/png");
$attachment2->setFilename("banner.png");
$attachment2->setDisposition("inline");
$attachment2->setContentId("Banner");
$mail->addAttachment($attachment2);

$mail->setTemplateId("439b6d66-4408-4ead-83de-5c83c2ee313a");

# This must be a valid [batch ID](https://sendgrid.com/docs/API_Reference/SMTP_API/scheduling_parameters.html) to work
# $mail->setBatchID("sendgrid_batch_id");

$mail->addSection("%section1%", "Substitution Text for Section 1");
$mail->addSection("%section2%", "Substitution Text for Section 2");

$mail->addHeader("X-Test1", "1");
$mail->addHeader("X-Test2", "2");

$mail->addCategory("May");
$mail->addCategory("2016");

$mail->addCustomArg("campaign", "welcome");
$mail->addCustomArg("weekday", "morning");

$mail->setSendAt(1443636842);

$asm = new ASM();
$asm->setGroupId(99);
$asm->setGroupsToDisplay([4,5,6,7,8]);
$mail->setASM($asm);

$mail->setIpPoolName("23");

$mail_settings = new MailSettings();
$bcc_settings = new BccSettings();
$bcc_settings->setEnable(true);
$bcc_settings->setEmail("[email protected]");
$mail_settings->setBccSettings($bcc_settings);
$sandbox_mode = new SandBoxMode();
$sandbox_mode->setEnable(true);
$mail_settings->setSandboxMode($sandbox_mode);
$bypass_list_management = new BypassListManagement();
$bypass_list_management->setEnable(true);
$mail_settings->setBypassListManagement($bypass_list_management);
$footer = new Footer();
$footer->setEnable(true);
$footer->setText("Footer Text");
$footer->setHtml("<html><body>Footer Text</body></html>");
$mail_settings->setFooter($footer);
$spam_check = new SpamCheck();
$spam_check->setEnable(true);
$spam_check->setThreshold(1);
$spam_check->setPostToUrl("https://spamcatcher.sendgrid.com");
$mail_settings->setSpamCheck($spam_check);
$mail->setMailSettings($mail_settings);

$tracking_settings = new TrackingSettings();
$click_tracking = new ClickTracking();
$click_tracking->setEnable(true);
$click_tracking->setEnableText(true);
$tracking_settings->setClickTracking($click_tracking);
$open_tracking = new OpenTracking();
$open_tracking->setEnable(true);
$open_tracking->setSubstitutionTag("Optional tag to replace with the open image in the body of the message");
$tracking_settings->setOpenTracking($open_tracking);
$subscription_tracking = new SubscriptionTracking();
$subscription_tracking->setEnable(true);
$subscription_tracking->setText("text to insert into the text/plain portion of the message");
$subscription_tracking->setHtml("<html><body>html to insert into the text/html portion of the message</body></html>");
$subscription_tracking->setSubstitutionTag("Optional tag to replace with the open image in the body of the message");
$tracking_settings->setSubscriptionTracking($subscription_tracking);
$ganalytics = new Ganalytics();
$ganalytics->setEnable(true);
$ganalytics->setCampaignSource("some source");
$ganalytics->setCampaignTerm("some term");
$ganalytics->setCampaignContent("some content");
$ganalytics->setCampaignName("some name");
$ganalytics->setCampaignMedium("some medium");
$tracking_settings->setGanalytics($ganalytics);
$mail->setTrackingSettings($tracking_settings);

$reply_to = new ReplyTo("[email protected]", "Optional Name");
$mail->setReplyTo($reply_to);

//echo json_encode($mail, JSON_PRETTY_PRINT), "\n";
return $mail;
} catch (\Exception $e) {
echo 'Caught exception: ', $e->getMessage(), "\n";
}

return null;
}

function sendHelloEmail()
Expand All @@ -211,12 +216,17 @@ function sendHelloEmail()

$request_body = helloEmail();

if (!($request_body instanceof Mail)) {
echo 'Invalid request_body to send HelloEmail', "\n";
return;
}

try {
$response = $sg->client->mail()->send()->post($request_body);
print $response->statusCode() . "\n";
print_r($response->headers());
print $response->body() . "\n";
} catch (Exception $e) {
} catch (\Exception $e) {
echo 'Caught exception: ', $e->getMessage(), "\n";
}
}
Expand All @@ -228,18 +238,20 @@ function sendKitchenSink()

$request_body = kitchenSink();

if (!($request_body instanceof Mail)) {
echo 'Invalid request_body to send KitchenSink', "\n";
return;
}

try {
$response = $sg->client->mail()->send()->post($request_body);
print $response->statusCode() . "\n";
print_r($response->headers());
print $response->body() . "\n";
} catch (Exception $e) {
} catch (\Exception $e) {
echo 'Caught exception: ', $e->getMessage(), "\n";
}
}

sendHelloEmail(); // this will actually send an email
sendKitchenSink(); // this will only send an email if you set SandBox Mode to false
?>


9 changes: 6 additions & 3 deletions examples/helpers/stats/example.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
<?php

// If you are using Composer
require __DIR__ . '/../../../vendor/autoload.php';
require __DIR__ . '<PATH_TO>/vendor/autoload.php';
// comment out the above line if not using Composer
// require("./sendgrid-php.php");
// If not using Composer, uncomment the above line

$apiKey = getenv('SENDGRID_API_KEY');
$sg = new \SendGrid($apiKey);

$stats = new \SendGrid\Stats('2017-10-18');
// Provide date in YYYY-MM-DD format
$stats = new \SendGrid\Stats\Stats('2017-10-18');

//$response = $sg->client->categories()->post(['category' => 'cat2']);
//$response = $sg->client->categories()->get(null, $query_params);

$globalResponse = $sg->client->stats()->get(null, $stats->getGlobal());

$categoryResponse = $sg->client->categories()->stats()->get(null, $stats->getCategory(['category1', 'category2']));
Expand Down
Loading