Sendgrid-nodejs: わかりやすい例

こんにちは@julesbou 、

怒っている暴言は、特に解決策が添付されている場合は、私には問題ありません:)

お時間を割いていただき、誠にありがとうございます。

現在、次のイテレーションの改善を計画しているので、タイミングは良かったです。

他にご要望がございましたら、このスレッドでお知らせいただくか、追加の問題を開いてください。

ありがとう！

ヘルパークラスをどのように使用しますか？ 私がしたいのはfrom名を設定することだけですか？

@jsgandalf 、

最も簡単な方法は、 https ： https://github.com/sendgrid/sendgrid-nodejs/blob/master/examples/helpers/mail/exampleです。 js＃L4

次のように独自のjsonを作成することもできます： https ：

ありがとう！

非常に役立ちます！ これはreadmeにあるはずです!!

@ jsgandalf @ thinkingserious私もライブラリを使用するのは非常にイライラします。 テンプレートメールを送信しようとしています。 ここでの例はあまり役に立ちませんでした。 「to」と「from」のメールアドレスを設定する方法がわかりません。このコードはメールを送信しません。 私は過去3日間頭をかいてきました。 何か助けはありますか？

フィードバック@bcootnerをありがとう。 あなたのリクエストは、これをキューに修正するのに役立ちます。 これは私がやりたいと思っている問題です。

それまでの間、この例がお役に立てば幸いです。

var sg = require('sendgrid').SendGrid(process.env.SENDGRID_API_KEY)

function helloTemplate(){
  var helper = require('sendgrid').mail

  from_email = new helper.Email("[email protected]")
  to_email = new helper.Email("[email protected]")
  subject = "Hello World from the SendGrid Node.js Library"
  content = new helper.Content("text/plain", "some text here")
  mail = new helper.Mail(from_email, subject, to_email, content)
  // The constructor above already creates our personalization object
  // -name- and -card- are substitutions in my template
  substitution = new helper.Substitution("-name-", "Example User")
  mail.personalizations[0].addSubstitution(substitution)
  substitution = new helper.Substitution("-card-", "Denver")
  mail.personalizations[0].addSubstitution(substitution)
  mail.setTemplateId("YOUR_TEMPLATE_ID")
  return mail.toJSON()
}

function send(toSend){
  //console.log(JSON.stringify(toSend, null, 2))
  //console.log(JSON.stringify(toSend))

  var sg = require('sendgrid').SendGrid(process.env.SENDGRID_API_KEY)

  var requestBody = toSend
  var emptyRequest = require('sendgrid-rest').request
  var requestPost = JSON.parse(JSON.stringify(emptyRequest))
  requestPost.method = 'POST'
  requestPost.path = '/v3/mail/send'
  requestPost.body = requestBody
  sg.API(requestPost, function (response) {
    console.log(response.statusCode)
    console.log(response.body)
    console.log(response.headers)
  })
}

send(helloTemplate())

さらにサポートが必要な場合は、お問い合わせください。

@thinkingserious時間と思慮深い応答をありがとう。 私は次のコードを持っています：

    var  sg = require('sendgrid').SendGrid("SG.**** .. ***6o");

    function welcomeTemplate() {
         console.log("template")
         var helper = require('sendgrid').mail
         from_email = new helper.Email("[email protected]")
         to_email = new helper.Email("[email protected]")
         subject = "Hello World from the SendGrid Node.js Library"
         content = new helper.Content("text/plain", "some text here")
         mail = new helper.Mail(from_email, subject, to_email, content)
         substitution = new helper.Substitution("-Name-", "bcootner")
         mail.personalizations[0].addSubstitution(substitution)
         mail.setTemplateId("5a****-*******-******-9")    //The ID of my Transactional Template
         return mail.toJSON()
}

function sendMail(toSend) {
     console.log("Send")
     var sg = require('sendgrid').SendGrid("SG.***....****o")
     var requestBody = toSend
     var emptyRequest = require('sendgrid-rest').request
     var requestPost = JSON.parse(JSON.stringify(emptyRequest))
     requestPost.method = 'POST'
     requestPost.path = '/v3/mail/send'
     requestPost.body = requestBody
     sg.API(requestPost, function (response) {
            console.log(response.statusCode)
            console.log(response.body)
            console.log(response.headers)
       })
}

そして、このコードをsendMail(welcomeTemplate())呼び出しますが、それは機能しません。 「テンプレート」と「送信」はログに表示されますが、statusCode、本文、またはヘッダーは表示されず、電子メールは受信されず、ダッシュボードには何も表示されません。

requestPost.body = requestBody後、 console.log(JSON.stringify(requestBody))を実行して、何が得られるか教えてください。

@thinkingseriousデバッグを行った後、 var emptyRequest = require('sendgrid-rest').request行の後にログに何も出力されないようです。 最初に「テンプレート」がログに記録され、約5分後に「送信」が出力されます（送信関数でコメントした行のコメントを解除すると、正常に機能します）。 このrequireステートメントに欠けているものはありますか？ npm install sendgrid

これを試してください：

A.次のペイロードを使用してpost.jsonというファイルを作成します。

{"content":[{"type":"text","value":"Hello, World!"}],"from":{"email":"[email protected]"},"personalizations":[{"subject":"Hello, World!","to":[{"email":"[email protected]"}]}]}

B.サンプルメールを置き換える

C.次のコマンドを実行します。

curl -X "POST" "https://api.sendgrid.com/v3/mail/send" \
        -H "Authorization: Bearer $SENDGRID_API_KEY"  \
        -H "Content-Type: application/json" \
        -d @post.json

D. $ SENDGRID_API_KEYをAPIKEYに置き換えるか、APIKeyをSENDGRID_API_KEYという環境変数に追加します

@thinkingseriousそのテストメールを受け取りました。また、 Hello Testを正常に機能させることができました。これらのテンプレートは、機能したくないだけです。

編集：それで私はvar emptyRequest = require('sendgrid-rest').requestをvar emptyRequest = sg.emptyRequest()に置き換えました、そしてそれは電子メールを送ります、テンプレートデザインまたはどんな画像からのフォーマットもありません。

@bcootner 、

残念ながら、私はあなたのエラーを再現することができないので、私は問題があるかもしれないところを通り抜けるのを手伝おうとしています。 curl経由でメールを送信できるので、APIキーが適切であることを意味します。 おそらくテンプレートIDに問題がありますか？

mail.setTemplateId("5a****-*******-******-9")を削除すると、メールは送信されますか？

@thinkingseriousしたがって、 SendGridNode.jsライブラリからHelloWorld 」というテストが送信されます。

私の編集を見たかどうかはわかりませんが、 var emptyRequest = require('sendgrid-rest').requestをvar emptyRequest = sg.emptyRequest()置き換えると、テンプレートのテキストは送信されますが、書式設定はありません（フォントも画像もありません）。 コンソールから次のプリントアウトが表示されます。

2016-07-13T00:01:07.514157+00:00 app[web.1]:   date: 'Wed, 13 Jul 2016 00:01:07 GMT',
2016-07-13T00:01:07.514159+00:00 app[web.1]:   connection: 'close',
2016-07-13T00:01:07.514157+00:00 app[web.1]:   date: 'Wed, 13 Jul 2016 00:01:07 GMT',
2016-07-13T00:01:07.514158+00:00 app[web.1]:   'content-type': 'text/plain; charset=utf-8',
2016-07-13T00:01:07.502390+00:00 app[web.1]: 202
2016-07-13T00:01:07.502454+00:00 app[web.1]: 
2016-07-13T00:01:07.514155+00:00 app[web.1]: { server: 'nginx',
2016-07-13T00:01:07.514159+00:00 app[web.1]:   connection: 'close',
2016-07-13T00:01:07.514161+00:00 app[web.1]:   'x-frame-options': 'DENY' }

'text / plain'に問題があると思われることがありますが、よくわかりません。 再度、感謝します！

ねえ@bcootner 、私はちょうど同じ問題を経験し、数時間頭を

_Params_

• から（例：'[email protected] '）
• to（eg'[email protected] '）
• サブジェクト（例：「テストサブジェクト」）
• メッセージ（例：「テストメッセージ」）
• テンプレート（使用したいテンプレートID）
• templateVariables（オブジェクト、ここでkey-電子メール内の変数、value-それを置き換える値） { ":name": "someName", ":email": "someEmail" } 。 :emailと:nameは、メールテンプレートで変数を設定する方法であり、 -email-または任意の値にすることができます。
• 成功のコールバック
• エラーコールバック

    let sendTemplateMail =  (from, to, subject, message, template, templateVariables, successCallback, errorCallback) => {
        var sg = require('sendgrid').SendGrid(process.env.SENDGRID_API_KEY),
            helper = require('sendgrid').mail,
            content_text = new helper.Content("text/plain", message),
            content_html = new helper.Content("text/html", message),
            request = sg.emptyRequest(),
            email_to = new helper.Email(to),
            email_from = new helper.Email(from),
            mail = new helper.Mail(email_from, subject, email_to, content_text),
            personalization = new helper.Personalization();

        personalization.addTo(email_to);
        personalization.setSubject(subject);

        mail.setTemplateId(template);
        mail.addContent(content_html);

        for(var key in templateVariables) {
            if(templateVariables.hasOwnProperty(key)) {
                var substitution = new helper.Substitution(key, templateVariables[key]);
                personalization.addSubstitution(substitution);
            }
        }

        mail.addPersonalization(personalization);

        request.method = 'POST';
        request.path = '/v3/mail/send';
        request.body = mail.toJSON();

        sg.API(request, (json) => {
            if(json.statusCode >= 300) {
                errorCallback(json);
            } else {
                successCallback(json);
            }
        });
    }

ドキュメントには、基本的で単純な例を使用して、実際にリファクタリングが必要です。 私の関数があなたを助けることを願っています:)

@ByEmkeご支援ありがとう[email protected]までメールで

ドキュメントに関しては、メールヘルパー自体と同様にリファクタリングが進行中です。 私たちはあなたのフィードバックをすべて集めており、次の反復に興奮しています。

また、大きな混乱は、テンプレートを使用するときにコンテンツを設定する必要があることです。 幸いなことに、それはすぐに（数日）変わるでしょう。

@bcootnerあなたはそれを釘付けにしたと思います。 content_html = new helper.Content("text/html", message)が必要です。 幸い、この要件は数日でなくなります。現在、私たちのチームはこの動作を変更しているため、テンプレートを指定するときにコンテンツを設定する必要はありません。

@ByEmke @thinkingseこの問題についてご協力ございます。昨夜、次のコードで動作させることができました。

 var sg = require('sendgrid').SendGrid("SendGrid API Key" or <environment variable>)

function sendEmail(tempID){
    var helper = require('sendgrid').mail;
    from_email = new helper.Email("[email protected]")
    to_email = new helper.Email("[email protected]")
    subject = "Dummy Subject"
    content = new helper.Content("text/html", "dummy content")
    mail = new helper.Mail(from_email, subject, to_email, content)

    substitution = new helper.Substitution("-name-", "User's Name")
    mail.personalizations[0].addSubstitution(substitution)
    mail.setTemplateId(tempID)
    var requestBody = mail.toJSON()
    var requestPost = JSON.parse(JSON.stringify(sg.emptyRequest()))
    requestPost.method = 'POST'
    requestPost.path = '/v3/mail/send'
    requestPost.body = requestBody
    sg.API(requestPost, function (response) {
       console.log(response.statusCode)
       console.log(response.body)
       console.log(response.headers)
  })
}

再度、感謝します！

また、特にテンプレートやその他の機能を使用している場合は、ドキュメントをフォローするのが非常に難しいと感じています。

helper（）構文よりもrequest.body = {}構文の方が好きです。これにより、物事がより冗長になり、読みにくくなります（少なくとも私にとっては）。

私はかなりの時間をかけてドキュメントを調べ、変更をテストし、例を見て、ここに来て、テンプレートを使用するときにコンテンツを設定する必要があることを確認しましたが、ドキュメントには別の方法が記載されています。 ああ。 このようなものはあなたを怒らせることができます。 とにかく、実用的な例を提供してくれた@ByEmkeに称賛を

@peterkuiper （または私はアダムと言うべきです:)）

フィードバックをありがとうございます。ライブラリドキュメントを改善する方法に非常に興味があります。

明確にするために、あなたはこれらを参照していますか？ https://github.com/sendgrid/sendgrid-nodejs/blob/master/USAGE.md

コンテンツの問題（皆さんの話を聞きました:)）に関しては、これはほぼ修正されています。 テンプレートを使用するときにコンテンツを設定する必要がないリリースをAPIにデプロイします。 変更により、テンプレートのエクスペリエンスが大幅に向上することを願っています。

@thinkingserious Githubに直接アクセスする必要があるときに、sendgrid.com（https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/index.html）のドキュメントをチェックしていました。 私はこのリポジトリのREADMEをざっと読み、例を確認し、USAGE.md（私の悪い）を完全に見逃しました。 USAGE.mdファイルは、私の好みの形式であるため、sendgrid.comに配置する必要があります:)テンプレートを使用する際のいくつかのベストプラクティスについてはまだわかりませんが、自分で理解するか、ドキュメント。

私はそのファイルを閲覧していて、混乱していると思うもののランダムな例を見つけました。

var request = sg.emptyRequest()
request.queryParams["start_time"] = '1'
request.queryParams["limit"] = '1'
request.queryParams["end_time"] = '1'
request.queryParams["offset"] = '1'
request.method = 'GET'
request.path = '/v3/suppression/blocks'
sg.API(request, function (response) {
    console.log(response.statusCode)
    console.log(response.body)
    console.log(response.headers)
  })

start_time、limit、end_time、offsetとはどのようなタイプで、これらはどういう意味ですか？ より多くのqueryParamsがありますか？ そして、なぜそれはrequest.bodyではないのですか？

ユーザーガイドへのリンク（まったく役に立ちません）がありますが、 https： //sendgrid.com/docs/API_Reference/Web_API_v3/blocks.htmlをクリアするAPIドキュメントへのリンクがあるはず

したがって、必要な情報がどこにあるかを見つけようとして、前後に移動する必要があります。

素晴らしいフィードバック@peterkuiper！

私もあなたを盗み出したいです。 Tシャツのサイズと郵送先住所を[email protected]まで

USAGE.mdドキュメントを更新して、クエリと応答の本文の説明を含めます。

テンプレートに関しては、メールエンドポイントの場合と同様に、一般的なユースケースの例を備えたヘルパーを作成する計画があります。 また、テンプレートを使用するときにコンテンツを指定する必要がなくなる修正があります。 それは大きな混乱の原因です。

@thinkingseriousかっこいい、ありがとう:)メールを送信しました！

そこにいる間、ベストプラクティスにも言及している（そして私のチームに混乱を引き起こしている）何か他のものに気づきました。 私のチームメートの1人が、いくつかの機能（つまり、電子メールの検証）のテンプレートを作成し、verify-nl、verify-enなどを追加しました。したがって、すべてのテンプレートは基本的に同じで、テキスト（異なる言語）だけが異なります。 <％subject％> en <％body％>を見たことがあり、それへの参照が見つかりませんでした（TL; DRは私の部分からかもしれません）ので、APIを使用するときに発生する内部置換であると思います。

私は「通常の」慣行が何であるか興味があります：

• 異なる言語で各機能のテンプレートを作成し、いくつかのマイナーな置換（つまり名前）のみを行います

このアプローチを使用すると、テンプレートの一部を変更するときに多くの作業が発生する可能性があるようです。 「テンプレートテンプレート」（つまり、ヘッダー/フッター/その他の部分）を作成できるかどうかはわかりません。 また、異なる言語がたくさんある場合は、300個のテンプレートの制限に簡単に達することができます（これは私たちの場合は問題ではありません）。

• 機能ごとにテンプレートを作成し、<％body％>を使用してアプリケーションから本体を設定し、「マスター」テンプレートを1つだけ作成します（またはonサブタグを使用します）

質問が理にかなっていることを願っています:)

@peterkuiper 、

わかりませんが、フィーラーをいくつか出しました。 発見したことで返答します。 ありがとう！

@thinkingseriousバージョン2.0.0を使用することになりました。これは、その動作が非常に気に入っています。

var client = require("sendgrid")("key");

client.send({
  to: "[email protected]",
  from: "[email protected]",
  subject: "subject",
  text:  "hello"
  // Or using the html property:
  // html: "Hello <strong>World!</strong>!"
}, fn);

これがバージョン3.x.xどのように表示されるかを調べています。 現在の例は本当に紛らわしいと思います。

素晴らしいフィードバック@IonicaBizau！

私たちは間違いなく次の反復のためにあなたの考えを検討します。

@thinkingserious素晴らしい！ それでも、これが3.x.xどのように表示されるか知りたいです。

https://github.com/sendgrid/sendgrid-nodejs#quick -start

このクライアントはv2メールエンドポイントから切り離してv3エンドポイントへのアクセスを許可するために最初から再作成されたため、1対1のマッピングはありません。

とは言うものの、メールヘルパーの目的は、v2の場合と同じように簡単に通話できるようにすることです。 私たちはまだそこにいません。最初に戻って、さらに多くの反復を楽しみにしています。

@thinkingserious私はそれを見ましたが、私は次の点が好きではありません：

1. グローバル変数（ varまたはletまたは同様のキーワードなしで宣言されている）があるため、混乱します。 例： from_email = new helper.Email("[email protected]")代わりにvar from_email = ...
2. 電子メールリソースのためだけにnew helper.Emailを使用することは、非常に不親切です。 これは、おそらくモジュール内の低レベルの機能にラップすることができます。 Content 、 Mailなども同じです。
3. method 、 path 、 body手動で設定するのは、やはり非常に不便です。
4. コールバック関数は、（応答ではなく） err, data, ...形式である必要があります。

要するに、IMHO、_quick start_は、電子メールを送信するための低レベルの実装です。 これは、より深い機能には役立ちますが、_クイックスタート_には絶対に役立ちません。 😁

素晴らしいサービスとモジュールをありがとうございました。 ✨

@IonicaBizau 、

素晴らしいフィードバック、ありがとう！

メールヘルパーの次のイテレーションを構築するときに、私たちは間違いなくあなたの考えを参照します。

正解です。この最初のバージョンは、APIの薄いラッパーです。 計画は、あなたがしたことのように、コミュニティのフィードバックに基づいてその機能を徐々に改善することです！

コミュニティへのご支援と貢献のために、私たちはあなたにいくつかの盗品を送りたいと思います。 Tシャツのサイズと郵送先住所を記載したメールを

必要に応じて、フィードバックを追加してください。 再度、感謝します！

@IonicaBizau

次のようなこともできます。

var sg = require('sendgrid').SendGrid('API_KEY');
var request = sg.emptyRequest()

request.body = {
  "content": [
    {
      "type": "text/html",
      "value": "<html><p>Hello, world!</p></html>"
    }
  ],
  "from": {
    "email": "[email protected]",
    "name": "My Name"
  },
  "personalizations": [
    {
      "to": [
        {
          "email": "[email protected]",
          "name": "John Doe"
        }
      ]
    }
  ],
  "template_id": "TEMPLATE_ID",
};

request.method = 'POST'
request.path = '/v3/mail/send'
sg.API(request, function (response) {
  console.log(response.statusCode)
  console.log(response.body)
  console.log(response.headers)
});

私はヘルパー構文よりもこの構文の方が好きです。 例を見てください、彼らは私をかなり助けてくれました。

https://github.com/sendgrid/sendgrid-nodejs/blob/master/examples/mail/mail.js

HTH

@thinkingserious Wowowow！ 間違いなくします。 ありがとう-助けてくれてうれしい！ 😁

@peterkuiper私もそれを試しましたが、 text/htmlをhtmlに置き換えるのを間違えたと思います。そのため、コンテンツは添付ファイルとして表示されました。 次に、バージョンをダウングレードすることにしました。

しかし、繰り返しになりますが、これはまだ低レベルに見えます（ request.method = ... 、 content配列でMIMEタイプを送信、コールバックでresponse引数など）。

ありがとう@peterkuiper！

そのスタイルの例を先週READMEに追加しました:)

@IonicaBizau 、

はい、その低レベルのものはすぐに隠されます。

@thinkingseriousリクエストがまもなく非表示になると聞いてうれしいです👍

@IonicaBizauのすばらしい提案に続いて、

var sg = require('sendgrid').SendGrid('API_KEY');
sg.addTo(x);
sg.addBcc(email);
sg.addBcc(email);
sg.addHeader(header);

SDKを介してこのレベルの詳細を公開する必要はないようです。

また、これがすでに機能であるかどうかはわかりませんが、これらの呼び出しをチェーンできると便利です。

var sg = require('sendgrid').SendGrid('API_KEY');
sg.addTo(x)
  .addBcc(email)
  .addBcc(email)
  .addHeader(header)
  .send();

ありがとう、そして良い仕事を続けてください👍

@jamesdixon 、

追加のフィードバックをありがとう！

メールヘルパーを拡張して実装の非表示をさらに有効にするまでは、 @ adambuczynskiのすばらしいプルリクエストを確認してください： //github.com/sendgrid/sendgrid-nodejs/pull/261。 それはあなたの特定の考えに直接対処するものではありませんが、それは正しい方向への一歩です。

@thinkingserious低レベルのリクエストはまもなく非表示になるとsendgrid-restを使用できます。 このように、このライブラリが行う必要があるのは、電子メールの送信を許可することだけです。そのため、電子メール送信APIのみを公開します。

それは、関心の分離を行い、このパッケージの焦点を少し狭めて、

@adambuczynski 、

私たちの計画は、ヘルパーを介して抽象化レイヤーを実行することです。 メールが最初ですが、近い将来、サブユーザー管理とテンプレート用にメールを追加する予定です。 しかし、最初にメールヘルパーを磨き、それを標準にする必要があります。

正解です。このライブラリはsendgrid-restの非常に薄いレイヤーであり、例、USAGEファイル、単体テストを追加するだけです（これらはすべて、 Swagger定義を使用して自動化されています[これもオープンソースにしたいと考えています]）。 長期的には、すべてのエンドポイントにヘルパーコードを実装し、双方向のデータ検証を完了し、その機能のコアも自動化することを想定しています。 ワークフローとユースケースは手作りされます。

今後数週間/数か月にわたって、GitHubでロードマップを公開し、さらなるフィードバックを提供します。

また、8月末までに、このライブラリにIncoming ParseWebhookのサポートを追加する予定です。

この質問をしてくれてありがとう、そして私の返事があなたとコミュニティからのさらなるフィードバックを引き起こすことを願っています。 これをコミュニティ主導のライブラリにし、SendGridによってサポートおよび主導されるようにします。

@thinkingseriousのアップデートをありがとう。 今後、sendgridnodejsライブラリで役割を果たしたいと思います。

この段階でなぜ解析サポートを追加するのですか？ 来年1月にParseサービスが廃止されると思いました。

@thinkingseriousここで何かお手伝いできることがあれば、pingを

@adambuczynskiそれは素晴らしいニュースです！ また、プルリクエストはトップに近づいています。 来週初めにマージできるようになると思います。

Parseに関しては、まだ正式に廃止することを決定していません。 ライブラリにサポートを追加することは、それを継続するかどうかを決定するためのテストの一部です。

@IonicaBizau 、

ありがとうございました！ どうぞよろしくお願いいたします。

メールヘルパーを使用して複数の受信者を設定する方法はありますか？
helper.Mail(from_email, subject, to_email, content)がpersonalization.addToを使用して受信者を設定していることに気付きました。これは受信者の配列ではなく1人の受信者でのみ機能し（おそらく私は間違っています）、ヘルパーはsetTo提供しないと思います

私はとパーソナライゼーションを自分で設定している場合ていることがわかりlet personalization = new helper.Personalization();私は何ができるpersonalization.tos = [email, email]//email=new helper.Email(email_address, name) 、それは安全なのですか？ 将来のリリースで変更される可能性はありますか？

@ albert-the-creator私はそれを次のように使用します：

  //Helpers
  const Mail = sendgrid.mail.Mail;
  const Email = sendgrid.mail.Email;
  const Personalization = sendgrid.mail.Personalization;

  //Create new mail object
  let mail = new Mail();

  //Create recipients
  let recipients = new Personalization();
  recipients.addTo(new Email(data.to, data.toname));

  //Set recipients
  mail.addPersonalization(recipients);

たとえばループでrecipients.addTo行を繰り返すことで、複数の受信者を追加できると思います。

このアプローチは非常に冗長で、Eメールクラスとパーソナライゼーションクラスに分かれています。 メールアドレスを追加して送信したい場合がありますが、これを実現するには多くのコード行が必要なように感じます。

@ albert-the-creator、

そのコンストラクターは、人々が単一の電子メールをより簡単に送信できるようにするために作られました。基本的には「こんにちは電子メール」機能です。

複数のメールの場合は、おそらく次の例に従う必要があります（自分でパーソナライズを設定してこのパスを開始しているため）： https ：

パーソナライズについて読むことも役立つ場合があります： https ：

ヘルパーは間違いなく進化しますが、重大な変更はメジャーポイントリリースで示されます。 ただし、APIが大きく変わることはないと思います。

@adambuczynski 、

ピッチインしてくれてありがとう！ このような追加の一般的なユースケースや、テンプレートを含むメールの送信などを考慮して、ヘルパーを更新する必要があります。

@thinkingseriousヘルパーAPIは、時間があればリファクタリング/改善することにも興味があります:)

@adambuczynski 、

それはすごいです、あなたがそれを始めることに決めるとき、私にpingしてください。 または、あなたの前で開始した場合は、pingを実行します。

@bcootnerのコードを使用しましたが、

@otmezger 、

フォローアップしてくれてありがとう！

私は今週その例に取り組んでいます、あなたはそれがREADMEにリンクされているのを見つけるでしょう。

テンプレートヘルパーは使用しませんが、ヘルパーloadメソッドを介してHTML形式とテキスト形式の両方のテンプレートとパーシャルをロードする方法を共有します。

  /**
   * Load an email (both plain text and html)
   */
  load(email, data, req) {

    //Get filenames
    const PARTIAL_HTML = path.resolve('./app/components/' + email + '.html');
    const PARTIAL_TEXT = path.resolve('./app/components/' + email + '.txt');

    //Append some globals
    if (req) {
      Object.assign(data, {
        app: {
          title: req.app.locals.APP_TITLE,
          version: req.app.locals.APP_VERSION,
          url: req.app.locals.APP_BASE_URL,
        },
        date: {
          year: moment().format('YYYY'),
          date: moment().format('DD-MM-YYYY'),
        },
      });
    }

    //Return promise
    return Promise.all([
      Promise.all([
        readFile(TEMPLATE_TEXT, 'utf8'),
        readFile(PARTIAL_TEXT, 'utf8'),
      ]).spread((template, partial) => {
        return template.replace('{{partial}}', partial);
      }),
      Promise.all([
        readFile(TEMPLATE_HTML, 'utf8'),
        readFile(PARTIAL_HTML, 'utf8'),
      ]).spread((template, partial) => {
        return template.replace('{{partial}}', partial);
      }),
    ]).then(result => result.map(contents => replaceData(contents, data)));
  },

次に、これを次のように使用して、Sendgridで使用できるオブジェクトを取得できます。

  let email = mailer.load('user/emails/verify-email-address', data, req)
    .spread((text, html) => ({
      to: user.email,
      from: req.app.locals.EMAIL_IDENTITY_NOREPLY,
      subject: 'Verify your email address',
      text, html,
    }));

ハンドルバーテンプレートのようなものを使用するように例を簡単に適合させることができます。 上記の例では、 replaceDataヘルパーは、ハンドルバーのようなタグを提供されたデータに置き換える単純な関数です。

これが適切かどうかはわかりませんが、「メールヘルパー」を使用しないことで、計り知れないほどの時間を節約できました。 これはとてもイライラした後、わざと2.0にダウングレードしました。 ファクトリタイプの関数を使用して有効なV3JSONを生成しているだけで、V3 APIの改善に非常に興奮しています（実際に使用できるようになったため）。

これも最初は苦労しました。 私は思います
ヘルパーはおそらくより効率的で使いやすくすることができます。 私は...するだろう
コアのsendgridモジュールの一部にすべきではないとさえ主張しますが、
関心の分離を行い、人々がそれらを使用することを選択できるようにするため。

それらをもう一度見て、具体的なものを思い付くことができるかどうかを確認します
提案。

金、2016年8月26日には、午前5時48分ショーン・リンド[email protected]は書きました：

これが例によるものかどうかはわかりませんが、「メールヘルパー」を使用しないことによって
私は計り知れないほどの時間を節約しました。 これはそうなった後です
欲求不満私は故意に2.0にダウングレードしました。

—
あなたが言及されたのであなたはこれを受け取っています。
このメールに直接返信し、GitHubで表示してください
https://github.com/sendgrid/sendgrid-nodejs/issues/252#issuecomment -242479491、
またはスレッドをミュートします
https://github.com/notifications/unsubscribe-auth/AAd8Qu5iRLFQwoKlRd2fP5oioT1uLqB6ks5qjdV2gaJpZM4JAiac
。

@seanlindo 、

フィードバックをお寄せいただきありがとうございます。

メールヘルパーなしでこのライブラリを使用する例を次に示します。https ：

Mail Helperは最初のバージョンであり、次のバージョンの改善を支援するために、あなたのようなフィードバックに依存しています。 発生した特定の問題を共有して、それらを修正するためのチケットを作成できるようにしていただけませんか。

また、メールヘルパーを改善してキューの上位に移動できるように、バックログタスクに投票を追加します。 ありがとう！

@adambuczynski 、

私はあなたの素晴らしさが続くのを見ます:)

私はあなたのフィードバックを楽しみにしています、私はそれが素晴らしいことを知っています！

@julesbou 、

一般的なユースケースの例を提供するUSE_CASES.mdファイルを開始しました。 最初はトランザクションテンプレートでした:)

私はあなたのフィードバックを楽しみにしています、私はそれが素晴らしいことを知っています！

👻

@thinkingseriousもちろんです！ 一日かそこらをください、そして私はあなたに具体的な例を提供します。

これはここで私のお気に入りのスレッドの1つです:)

あなたのフィードバックは、このライブラリの次のイテレーションにとって重要になると思います。これは、重大な変更になる可能性があります。 少し時間がありましたら、私たちの提案をご覧ください。 https://github.com/sendgrid/sendgrid-nodejs/issues/290

ありがとう！

@thinkingserious v3で導入されたすべてのSendgridヘルパークラスについて何がそんなに気になるのかをようやく理解するようになりました...それらの数が多すぎて、メールの送信が不必要に複雑になります：P

Sendgridのすべてのコードをオーバーホールしたくなかったので、代わりに単純なラッパー、 sendgrid-mailerを作成することにしました。

Sendgridのヘルパークラスはバックグラウンドで役立ちますが、メールモデルを作成して検証するために、APIとやり取りするためだけに強制する必要はないと思います。 Nodeアプリの作成が本来よりも複雑になり、ヘルパーの名前が非常に混乱する可能性があることがわかりました。たとえば、 MailとEmailます。

基本的な例は問題をよく示していると思います。

https://github.com/sendgrid/sendgrid-nodejs#with -mail-helper-class

これは、「メールを送信したい」という基本的なことにはあまりにも複雑に思えます。 電子メールを送信する前に、8つの異なる依存関係をロードし、15行のコードを記述する必要があります。

ただし、ヘルパークラスを使用しないことは、間違いなくさらに悪いことです。その場合、電子メールJSONリクエストの必要な構造を理解し、自分で正しく入力する必要があるためです。 1つの間違いでリクエストが簡単に壊れます。

そこで、シンプルで使いやすいAPIヘルパーの背後にあるすべてのヘルパークラスロジックを抽象化して、Sendgridでメールを送信するのが再び簡単で楽しいものになるようにしました:)

最も基本的な例は次のようになります。

//Load mailer and set API key (only needed once)
const mailer = require('sendgrid-mailer').config(API_KEY);

//Create email data 
const email = {
  to: '[email protected]',
  from: 'Someone <[email protected]>',
  subject: 'Hello world',
  text: 'Hello plain world!',
  html: '<p>Hello HTML world!</p>',
};

//Send away 
mailer.send(email); //Returns promise 

リクエストは舞台裏で作成され、Sendgridのヘルパーを透過的に使用します。

また、複数のメールの送信をサポートし、さらにカスタマイズが必要な場合にSendgridオブジェクトを公開し、Sendgrid Mailインスタンスも受け入れ、to / fromフィールドのさまざまな形式（ Name <[email protected]>など）を受け入れます。 READMEを参照してください。

おそらくまだ改善の余地がありますが、Sendgrid APIに圧倒されることなく使用したいと考えている人々のために、このソリューションをここで共有したいと思いました。

それが誰かにとって役立つことを願っています、そして多分それはより単純なAPIを公開することで、このライブラリの将来のための何らかの方向性を提供することができます:)

cc @julesbouは少し遅れていますが、それでも用途が見つかることを願っています。

@adamreisnz真剣に、ありがとう。

sendgridを介してメールを送信する私のバックグラウンドジョブはv4.0.7を使用していましたが、これはすでに十分に複雑でした。 私は最新バージョンにアップグレードしましたが、悲しいことにすべてが壊れました。 メールを送信するのがいかに複雑であるかということに不満を感じていたので、更新することすらしませんでした。

とはいえ、これの単純さはまさに私が探していたものです。 週末に試してみます。

乾杯！

@jamesdixon私はまだv3.xxで立ち往生していて、アップグレードしたくありませんでした:)

うまくいけば、あなたはそれが役に立つと思うでしょう。 それがあなたのためにどのように機能するかを私に知らせてください、そして何か重大な不足があるならば、ありがとう！

@adamreisnz 、

これは素晴らしいです、そしてそれを私たちのコミュニティと共有してくれてありがとう:)

tldr; 私たちのヘルパークラスは終了しておらず、あなたはすでに私たちが向かっているところまで私たちを打ち負かしています:)

私たちはあなたの考えに完全に同意します。これは、7つのSDKすべてで現在取り組んでいるv3ライブラリの更新のフェーズです。 Node.jsプロジェクトの詳細については、こちらのMail HelperEnhancementプロジェクトを参照してください。

現在、C＃ライブラリを完成させています。 私たちは、このNode.jsのライブラリを計画するものの具体的な例を取得するには、参照してくださいこれを。 数日以内にリリースしたいと思っています。

だから、私は提案があります：

ここでメールヘルパーにソリューションを追加していただけませんか（C＃で行ったのと同様）。 その場合、あなたの仕事はより大きなリーチを達成すると思います。 そうでなければ、まったく問題ありません。 あなたはMITライセンスの下であなたのプロジェクトを投稿したので、私たちがあなたの良い仕事から少し借りたなら私たちを許してくれることを願っています;）そしてもちろん、私たちはあなたがあなたの貢献の功績を認められるようにします。

作業を個別に行うことにした場合は、ここの[コミュニティライブラリ]セクションにリンクを追加してください。

素晴らしい継続的なサポートに感謝します。 あなたはロック！

@thinkingseriousあなたが同じ方向に向かうことを考えていると聞いてうれしいです。 C＃の例の方が見栄えは良いですが、JSの実装にはまだやや複雑だと思います。 すべてのクラスを作成することが、JSに参加するための最良の方法であるとは限りません。

あなたの提案については、私はまだ内部でヘルパークラスを使用しているので、公式ライブラリに移植するのに実際にどれだけ役立つかわかりません。 私はおそらく、大規模な書き直し（v5など）を手伝って、ユーザーとノードコミュニティからの入力を取り入れて、新鮮なものから始めて、使いやすく、必要に応じて柔軟な素晴らしいAPIを考え出す傾向があります。

しかし、それまでの間、ラッパーからコードの一部を借りて公式ライブラリで使用したい場合は、ぜひそれを利用してください:)そのページにラッパーへのリンクを追加します🎉

私が作成したものと同様に、プロジェクトを2つのパッケージに分割することをお勧めします。1つはAPIと対話するためのリクエストロジックを含む下位レベルで、もう1つはメール送信専用の上位レベルです。

下位レベルのパッケージは、APIへのフルアクセスが必要な人に使用できますが、メーラーパッケージは、電子メールを送信したい人に適しています。 そしてもちろん、内部では、メーラーはAPIパッケージを使用します。

@thinkingseriousそれについてどう思いますか？

@adamreisnz 、

いつものように、思慮深いフィードバックをありがとうございます。

この時点でプロジェクトを分割する必要があるかどうかはわかりません。 現在のヘルパーモデルでも同様の結果が得られると思います。 とは言うものの、私は将来のバージョンで新しいアーキテクチャを探求することにオープンであり、そのためにあなたを参加させたいと思います。

うまくいけば、コミュニティの他の何人かが参加するでしょう。

私はこれについてより深く考え、更新されたMailHelperを実装するときに再関与します。

あなたのサポートと私たちのドキュメントへのリンクを追加してくれてありがとう！

それは関心の分離の問題です。 メインライブラリ内に簡単に郵送するためのヘルパー/ラッパーを含めることもできますが、私の意見では、両方の可能性のある不利益または不必要な複雑化に対する2つの別々の懸念が混在しています。 それらを別々に保つことで、消費者は必要なライブラリ（または両方）を選択できるようになり、境界が明確に定義されているため、おそらく両方のライブラリの開発が容易になります。

Nodeモジュールとnpmモジュールの性質上、関心の分離を可能な限り分離し、各パッケージに特定のタスクを実行させる（そしてそれを上手に行う）のが自然だと思います。 これは、Nodeを最初に使い始めたときも慣れなければならなかったものですが、一度慣れると、Nodeが提供するクリーンでシンプルなパッケージを開発する自由と能力が気に入りました。

コミュニティからのコメントをお待ちしております。

まあ、あなたは確かな議論で間違いなく説得力があります:)

時間を割いてご説明いただき、誠にありがとうございます。

私はすでにこのライブラリでの作業に戻ることを楽しみにしていましたが、今ではあなたとコミュニティと一緒にこのSDKでの作業に戻ることに本当に興奮しています。

素晴らしいです、あなたがそれに取り組むつもりであるとき私に知らせてください:)
私は4週間休んでいるので、オープンソースプロジェクトでも仕事をするための暇がついにあります🌴

@adamreisnz 、

おめでとうございます！

はるかに高いレベルの「メーラーパッケージ」がまさに私たちが望んでいるものです。 いくつかのメールを送信する必要があります。

前回のバージョンでは、それは非常に単純でしたが、今ではひどい混乱になっています。 「基本」の例には現在8つの変数が定義されており、特別なコンストラクターが必要です。 使いやすさの点で大きく後退しました。

と同じくらい単純でなければなりません

sendgrid.send({
  from: fromEmail,
  fromName: fromName,
  to: toEmail,
  subject: 'Hello'
  ...
})
.then(...)
.catch(...)
.finally(...)

ドキュメントは必要ありません。コピーして貼り付けることができる例です。 これが私たちのチームにとってのSendGridの主要な価値ですが、残念ながら現在は欠落しています。

@eeoskはhttps://github.com/sendgrid/sendgrid-nodejs/issues/252#issuecomment-265934147をご覧ください👍

@adamreisnz見栄えがします。 非常に明白な設計上の決定。 SendGridの給与計算に参加していることを願っています。

@thinkingseriousは、メインドキュメントを@adamreisnzプロジェクトにこれにより、すべてが大幅に簡素化されます。今日の初めにそれについて知っていたとしたら、imhoが過剰に設計されたJavaを使用しようとする頭痛の時間を節約できたでしょう。 JSでAPIに影響を与えました。 ユーザーが望むものではなく、ユーザーが望むものを提供してください:-)

また、V2 APIが廃止され、新しいアカウントがV3 APIを使用するように強制されるようになったため、他の開発者がここで頻繁に終了し始めても驚かないことに注意してください。 個人的に、私が最初に試したのはnodemailer（sendgridトランスポートはv2でも機能します）を使用することでした。これは過去数十のプロジェクトで意味がありましたが、今回は動作するまでに永遠に時間がかかりました。 ノードコミュニティでのnodemailerの人気を考えれば、推測しなければならないのであれば、今後数か月でこのように感じてしまうのは私だけではありません。

@ fisch0920フィードバックをありがとうございます。今後数週間で@thinkingseriousと協力して

みなさん、こんにちは、

SendGrid Node.jsメールヘルパーの再設計に興味があるかもしれないと思いました： https ：

フィードバックをいただければ幸いです。

敬具、

エルマー

更新のために＃378に移動してください、ありがとう！