Issue Summary

It is really nice to be able to develop locally inside a docker container! Please dockerize this repo!

• Please setup docker-compose to use a local volume for the library files
• Please add information to the README and USAGE files about how to startup the container

Due to the success we have seen from hacktoberfest, we are seeing more people create use cases. This is amazing!
We want to make sure that everyone can find them. Please help us to break up this file and make it easier to read and manage:

• Create a Use Cases Directory
• Put a README.md in this directory
• Make a file in the new directory for each individual Use Case from USE_CASES.md, copy the content to this file
• For each file you've created, link to it from the README you created
• Organize the links in the README by type
• Make sure the names of the files you created are related to the Use Case
  Thank you!

Grab the template from sendgrid-php and make sure it is in the correct location.

The file path should be similar:

/.github/ISSUE_TEMPLATE

Issue Summary

When all tests on the master branch pass in Travis CI, we would like to auto-deploy the release to the package manager.

Before writing any code, we suggest you review our CONTRIBUTING.md file and propose your solution for discussion here in the comments. Thank you!

Aceptance Criteria

• when Travis CI passes all tests on the master branch we auto-deploy to the package manager
• the version is determined by the CHANGELOG.md

It would be awesome to highlight some of the features of this library in a USE_CASES document.

Some examples that would be great:

• How to send substitutions
• How to send to multiple people in the To field
• How to send multiple emails to multiple distinct addresses
• How to schedule an email

The string from jsonString function needs to be word-wrapped to work in all situations (also with SMTP, not only with HTTP).

The standards document for the format of e-mail messages, RFC 2822 (the successor to RFC 822, the classic document that established the standards that have been followed ever since), says this about the length of lines in an e-mail message: Line length SHOULD be less than 78 characters and MUST be 998 or less, including CRLF.

Example when using Postfix relay server, longer lines (than 998) are broken by inserting "CR + LF + SPACE", to minimize the damage to MIME formatted mail. Many times this breaks the smtpapi-header json and email SendGrid returns "Invalid SMTPAPI Header" -email notification. Error messages are hard to track down since the error can come up pretty much anywhere in the smtpapi-header.

Might be good idea to implement the word-wrapping near 1000 chars since the smtpapi-header can be really big sometimes if you use lots of substitution tags like I do. Also the word-wrapping needs to happen after tags like "]," to keep the json valid.

How add it unsubscribe url in email body
`$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.sendgrid.com/v3/campaigns",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{"title":"March Newsletter","subject":"New Products for Spring!","sender_id":875149,"list_ids":[4375245],"segment_ids":[123124],"categories":["spring line"],"custom_unsubscribe_url":"http:://TestUrl/unsubscribe","html_content":"<title></title>

Check out follow this link to be removedunsubscribe instantly

Please help me

Issue Summary

For every release, we currently hand craft a CHANGELOG.md update, now we would like to automate this process. Please see the existing CHANGELOG.md for formatting structure.

Acceptance Criteria

• A script, which when run, creates a CHANGELOG.md update based on any merged PRs since the last release.

When debugging, it can be useful to examine the request body before sending to the SendGrid API.

Prove an example of how to examine the request body in TROUBLESHOOTING.md. For an example, see here.

Please add similar badges to this repo as were added in our sendgrid-php repo. Make sure to modify them for the smtpapi-php repo.

Issue Summary

License badge is missing in README.md file

Steps to Reproduce

1. Check badges section of README.md file.

As noted in #38 we're missing a USAGE file.

Please add a basic USAGE file to this repo that explains the basics of how to get started with SMTPAPI using this PHP library.

You can see an extensive example of this in the sendgrid-php library.

As noted in #38, we're missing a Table of contents in the README file!

Please add in-page anchors to the headers, then add those links to a ToC at the top of the README. Please, see how these were updated to use "-" instead of "_" in #38.

Is it possible to add the MIT-License file? Same as the other smtpapi- libraris? Thanks!

Issue Summary

We would like to have a template for describing what has changed in the pull request being submitted.

Github docs on this

You can use this file as an example

I am not able to use a transactional template and attachments through the SMTP API and SwiftMailer.

If I add an attachment, I receive only the attachment; if I remove it, I receive the template properly.

Please find attached the modified SendGrid example file.

swift_mailer.txt

Issue Summary

For every release, we hand craft the release notes on GitHub, now we would like to automate this process. Please see the existing release notes for an example. The contents of the release notes are generated from the CHANGELOG.md file. Here is the documentation for updating the release notes via the GitHub API.

Acceptance Criteria

• A script, which when run, creates a release note update based on the last deployed release

Issue Summary

Basically I would like to set a unsubscribe link under custom text while sending email via API.
Text would be "follow this link to be removed" (on this I want to set unsubscribe link).

I have enabled Subscription Tracking function from panel which displays unsubscribe link but I want to have my own link which I can place where I want.

I tried following combinations to set link

1. <% follow this link to be removed %>
2. < a href="[Unsubscribe]">follow this link to be removed < / a > (ignore white space around tag)
3. < a href="[unsubscribe]">follow this link to be removed< / a > (ignore white space around tag)
4. <%asm_preferences_url%>

Code

$sendgrid = new SendGrid('API-KEY');

$email = new SendGrid\Email();
$email->setSmtpapiTos($strArray)
->setFrom($eml['from_email'])
->setFromName($eml['from_name'])
->setSubject($sub)
->setHtml($nl_html)
->setSubstitutions(array('[%email%]' => $strArray));

$result = $sendgrid->send($email);

I have chat with support team but they do not have necessary resources to provide this level of analysis.
What am I missing here, or do I have to set any additional setting from my panel?

Technical

• sendgrid-php Version: master
• PHP Version: 5.x

• Add a "Code Reviews" section on CONTRIBUTING.md
• Put the following under the header:

If you can, please look at open PRs and review them. Give feedback and help us merge these PRs much faster! If you don't know how, Github has some great information on how to review a Pull Request.

• Link the header in the Contributing.md Table of Contents
• Add a link to the README.md file: Review Pull Requests under "Contributing Section"

In the documentation it says that lines should be wrapped:

Headers must be wrapped to keep the line length under 72. By RFC 821 no line can be longer than 1,000, so if you are going to generate this string yourself it is a good idea to make sure that you wrap it.

Is this missing here, or should it be done elsewhere?

Issue Summary

In the CONTRIBUTING.md file there is a section on Style Guidelines & Naming Conventions. Please review and implement a check in Travis CI. If there are any style errors, either fix or create a rule to exclude the error.

Before writing any code, we suggest you review our CONTRIBUTING.md file and propose your solution for discussion here in the comments. Thank you!

Aceptance Criteria

• TravisCI checks that the code conforms to our Style Guidelines & Naming Conventions as defined in our CONTRIBUTING.md file
• tests pass locally, in Travis CI and using Docker

PHP Fatal error: Uncaught Error: Call to undefined method Swift_Message::setTos()

$message->setTos(array('[email protected]'));

should probably be

$message->setTo(array('[email protected]'));

Issue Summary

Add these entries to the .travis.yml file so codecov reports show up!
https://github.com/codecov/example-php/blob/master/.travis.yml

Issue Summary

Our open sourced documentation has a great first time contributor page that we wish to duplicate here.

Acceptance Criteria

• We have a file in the root directory called first-timers.md or similar that helps a first time contributor make their first PR (please use our CONTRIBUTOR.md file for inspiration as well as this page)
• We provide a link to tasks with the labels "difficulty: easy" and "status: help wanted" (example query) to all the repos listed here, please scroll to the bottom.

Issue Summary

We would like to get our English polished up throughout the repo.

Aceptance Criteria

• Every .md file in this repo has been run through the Grammer.ly service and updated accordingly

Issue Summary

The role of Developer Experience Engineer just became available and we want to announce it in the README. Here is the copy:

If you're a software engineer who is passionate about #DeveloperExperience and/or #OpenSource, this is an incredible opportunity to join our #DX team as a Developer Experience Engineer and work with @thinkingserious and @aroach! Tell your friends :)

Acceptance Criteria

• The above announcement is added to the Announcements section of this README

This repo should have the following list of files included:

• ./Docker or docker/Docker
• ./docker-compose.yml or ./docker/docker-compose.yml
• ./.env_sample
• ./.gitignore
• ./.travis.yml
• ./.codeclimate.yml
• ./CHANGELOG.md
• ./CODE_OF_CONDUCT.md
• ./CONTRIBUTING.md
• ./.github/ISSUE_TEMPLATE
• ./LICENSE.md
• ./.github/PULL_REQUEST_TEMPLATE
• ./README.md
• ./TROUBLESHOOTING.md
• ./USAGE.md
• ./USE_CASES.md

This PR is only asking for tests of the existence of these files, if the files do not exist when you run the tests - do not worry about the tests not passing. We will identify this and create a new PR for the issue.
Thank you!

Issue Summary

We want to update our git workflow to function more like Gitflow. We need to update the CONTRIBUTING.md file and PULL_REQUEST_TEMPLATE to direct contributors to fork/branch off the development branch and to merge their PRs with the development branch. Once this issue is complete, we will be creating the development branch and making that branch the default. This is part of a larger strategy to execute releases for this SDK on a predictable cadence.

Acceptance Criteria

• Update CONTRIBUTING.md documentation, explaining the process of forking and branching off the development branch and submitting PRs agains the development branch.
• Update PULL_REQUEST_TEMPLATE with the same addition to the CONTRIBUTING.md documentation.

This license file might have the wrong end year (2017). If this is the case, please make a PR that updates the year. If the year is correct, please close this issue!

Similar to what was done on the SendGrid node README:

• put the logo at the top of the list
• Add License like so
• make sure the other badges are available like so:

![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)

For the following, make sure the correct repo is linked!
For email notifications, you can change the "nodejs" to the language of this repo (e.g. java, python, ruby, php, csharp, go, etc)

[![BuildStatus](https://travis-ci.org/sendgrid/sendgrid-nodejs.svg?branch=master)](https://travis-ci.org/sendgrid/sendgrid-nodejs)
[![Email Notifications Badge](https://dx.sendgrid.com/badge/nodejs)](https://dx.sendgrid.com/newsletter/nodejs)
[![npm](https://img.shields.io/npm/l/express.svg)]()
[![Twitter Follow](https://img.shields.io/twitter/follow/sendgrid.svg?style=social&label=Follow)](https://twitter.com/sendgrid)
[![GitHub contributors](https://img.shields.io/github/contributors/sendgrid/sendgrid-nodejs.svg)](https://github.com/sendgrid/sendgrid-nodejs/graphs/contributors)

Thank you and happy #Hacktoberfest!!

Hi!

I'm trying to update to version 0.6 but I can't because in my project I'm currently using Swift Mailer version 6 and this package needs Swift Mailer ^5.4.

Maybe needs to be a dev dependency instead a production one, considering that it's only being used on the examples scripts:

"require-dev": {
        "phpunit/phpunit": "3.7.*",
        "swiftmailer/swiftmailer": "^5.4"
}

Or maybe a suggest:

"suggest": {
        "swiftmailer/swiftmailer": "^5.4 - Needed to run the example scripts"
}

BTW, you might need to update the README.md to reflect the new version on "Install with Composer" section.

Cheers!

Add a file to the root of this repo called CODE_OF_CONDUCT.md, with the content from the same file in our docs repo.

Usage files are really nice when they exist in a repo, because it makes it really obvious where to look for information about how to use this tool. It can be frustrating when you expect this file to be there and it's not.
Please add a USAGE.md file, you can see an example of this
here

Please make sure you modify the file for this repo (hint: Most of this information should be in the README file)

sendgrid/vendor/sendgrid/smtpapi/lib/Smtpapi/Header.php

If there is a comma in the value of $name, addTo() will not escape or quote it, leading to a faulty To: header.

I recommend changing line 16 to:

$this->to[] = ($name ? '"' . preg_replace('{"}', '"', $name) . '" ' : $email);

Moved from sendgrid/sendgrid-php#101.

Need to investigate if still an issue.

We received an awesome PR for #hacktoberfest on our ruby library
We would love to see the same thing on the README in this repo as well.
Please replace the "-" with "_" in README, CONTRIBUTING, USE_CASES, USAGE files.

Thanks and happy Hacktoberfest!!

It is possible to configure how CodeClimate looks at a repository.
These Docs explain how this is done. Please create an appropriate .codeclimate.yml for this repo. It should test the main language of the repo and run tests.

SendGrid DX team current status:

• Wow
• OMG
• THANK YOU

Hacktoberfest 2017 has completely blown us away. We have had over 900 pull requests from over 300 contributors all in the last 30 days. That is more PRs than we normally get in 2 years!
We are actively working to review, comment, and/or merge as many PRs as we possibly can as quickly as we can.

We are currently working on “intaking” all the PRs that have come in, oldest first (we have about 400 remaining to go through). We are making sure that each PR we review is one we have a chance of merging - there have been a couple spammy items that came through. Due to the massive influx of requests so far, @thinkingserious and @mbernier have been working nights and weekends all month just to keep up! We’re not even mad, this is amazing!

Hey, that’s great for you - but what about my shirt!

If you have signed the CLA before 11/1, but haven’t had a PR merged yet, do not despair! We know we are behind on even just commenting on every PR to show you that we received it (something we typically do). If you submitted a mergeable (non-spam, actually adds value to the project) PR during October 2017, we will grant access to this page to redeem your shirt, sticker, and hacker pin. Next year, we will be sure to communicate this information sooner. We are sorry for any confusion we have caused. We appreciate those of you who have reached out to find out what’s going on!

What can I do to help move things along?

Have you signed the CLA yet?
We can only merge items from contributors who signed the CLA

Can you help another contributor?
If you can identify potential problems, add suggestions, or even leave a comment with your review of another PR (Looks good to me! Or I approve this change), that would help us review those PRs much faster, making it easier to get to your PR.

Do you even write tests, friend?
If you see a place where we could have a test to validate a piece of functionality, add it in. We know We know! It’s just another PR we have to review and merge. You’re right, it is! However, the more tests we have, the earlier our CI tool can catch issues, saving us a review as well as back and forth time.

@bertuss, @ladhadha, @mptap, @pushkyn, @ssiddhantsharma, @thepriefy, @uppe-r, @yudhik11

Issue Summary

I wanted to work on a fix for an issue reported here, but I am unable to run the existing tests locally or in CI, due to a test for files which do not exist in the repo. There is a test which checks for two Dockerfiles, which are not part of the repo, and the instructions to build and test locally don't include any info on creating these files.

Steps to Reproduce

1. Clone the repo
2. composer install
3. run the tests as instructed in the docs

Technical details:

• smtpapi-php Version: master (latest commit: [729d8e8])
• PHP Version: 5.6 and 7.0

Our preference is that users have an environment file when using the SendGrid API, because it is less likely that someone would commit their credentials to github.

Please make a couple changes:

• make a .env_sample file that contains: export SENDGRID_API_KEY=''
• make (or add) a .gitignore file and include .env
• add instructions to the README file about how to copy .env_sample to .env and add the API Key

The end year in the license file should be "this year" and this should be checked on every run of the tests. If the end year is no correct, fail the test.
example:

Copyright (c) 2012-2016 SendGrid, Inc.
It is 2017, so this should be:
Copyright (c) 2012-2017 SendGrid, Inc.
and the test should fail.
--done

Hello guys, how do i set my smtpapi-php to use one of my transactional templates?