Sendgrid-nodejs: 이해하기 쉬운 예

안녕하세요 @julesbou ,

화난 폭언은 나에게 괜찮습니다. 특히 솔루션이 첨부되어 있다면 :)

시간을내어 알려 주셔서 감사합니다.

우리는 현재 다음 반복을 위해 개선을 계획하고 있으므로 좋은 타이밍을 가졌습니다!

다른 특정 요청이있는 경우이 스레드에서 알려주거나 추가 문제를여십시오.

감사!

도우미 클래스는 어떻게 사용합니까? 내가 원하는 것은 이름을 설정하는 것뿐입니까 ??

@jsgandalf ,

가장 쉬운 방법은 https://github.com/sendgrid/sendgrid-nodejs#hello -email, 구체적으로는 https://github.com/sendgrid/sendgrid-nodejs/blob/master/examples/helpers/mail/example입니다. js # L4

다음과 같이 고유 한 json을 빌드 할 수도 있습니다. https://github.com/sendgrid/sendgrid-nodejs/blob/master/examples/mail/mail.js#L31 (여기에 json 개요가 있습니다 : https : / /sendgrid.com/docs/API_Reference/Web_API_v3/Mail/index.html)

감사!

매우 유용합니다! 이것은 readme에 있어야합니다 !!

@jsgandalf @thinkingserious 나도 라이브러리를 사용하기가 매우 실망 스럽습니다. 템플릿 이메일을 보내려고합니다. 여기에 있는 예제는별로 도움이되지 않습니다. "받는 사람"및 "보낸 사람"이메일 주소를 설정하는 방법에 대해 혼란스럽고이 코드는 내 이메일을 보내지 않습니다. 지난 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 분 후에 "send"가 인쇄됩니다 (그리고 send 함수에서 주석 처리 한 줄을 주석 해제하면 제대로 작동합니다). 이 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를 API 키로 바꾸거나 API 키를 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 그래서 setTemplateID를 제거하면 "Hello World from the SendGrid Node.js Library"라는 테스트를 보냅니다.

내 편집 내용을 보았는지 확실하지 않지만 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' }

뭔가 '텍스트 / 일반'에 문제가 있다고 생각하지만 확실하지 않습니다. 다시 한 번 감사드립니다!

안녕하세요 @bcootner , 방금 동일한 문제를 경험하고 몇 시간 동안 머리를 긁적이지만 해결했습니다. 실제로 이메일을 보내기 전에 불필요한 것들이 너무 많이 필요한 것 같지만, 여기에 내 도우미 기능이 있습니다.

_Params_

• 보낸 사람 (예 : '[email protected]')
• 받는 사람 (예 : '[email protected]')
• 주제 (예 : '테스트 주제')
• 메시지 (예 : '테스트 메시지')
• 템플릿 (사용하려는 템플릿 ID)
• templateVariables (객체, 여기서 키-이메일의 변수, 값-바꿀 값) { ":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 @thinkingserious 이 문제에 대한 귀하의 도움에 감사드립니다. 어제 밤에 다음 코드로 작업 할 수있었습니다.

 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 (또는 Adam이라고 말해야합니까 :))

의견을 보내 주셔서 감사합니다. 라이브러리 문서를 개선 할 수있는 방법에 매우 관심이 있습니다.

분명히 말해서 이것들을 언급하고 있습니까? 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의 훌륭한 피드백!

나도 당신을 빼앗고 싶습니다. 티셔츠 사이즈와 우편 주소를 [email protected]으로 보내주세요

쿼리 및 응답 본문에 대한 설명을 포함하도록 USAGE.md 문서를 업데이트합니다.

템플릿과 관련하여 우리가 메일 엔드 포인트에 대해했던 것과 같은 도우미를 만들고 일반적인 사용 사례의 예를 포함하는 계획이 있습니다. 또한 템플릿을 사용할 때 콘텐츠를 지정하지 않아도되는 수정 사항이 있습니다. 그것은 큰 혼란의 원천입니다.

@thinkingserious 쿨, 감사합니다 :) 이메일을 보냈습니다!

내가 그 과정에서 모범 사례를 참조하는 다른 것을 발견했습니다 (그리고 우리 팀에 약간의 혼란을 야기하고 있습니다). 내 팀원 중 한 명이 일부 기능 (예 : 이메일 확인)에 대한 템플릿을 만들고 verify-nl, verify-en 등을 추가했습니다. 따라서 모든 템플릿은 기본적으로 동일하지만 텍스트 (다른 ​​언어) 만 다릅니다. 나는 <% subject %> en <% body %>를 보았고 그것에 대한 참조를 찾을 수 없었기 때문에 (TL; DR은 아마도 내 부분에서) API를 사용할 때 발생하는 내부 대체라고 가정합니다.

"정상적인"관행이 무엇인지 궁금합니다.

• 각 기능에 대한 템플릿을 다른 언어로 만들고 약간의 대체 (예 : 이름) 만 수행합니다.

이 접근 방식을 사용하면 템플릿의 일부를 변경할 때 많은 작업이 발생할 수 있습니다. "템플릿 템플릿"(예 : 머리글 / 바닥 글 / 모든 부분)을 만들 수 있는지 확실하지 않습니다. 또한 다양한 언어를 사용하는 경우 300 개의 템플릿 제한에 쉽게 도달 할 수 있습니다 (이 경우에는 문제가되지 않습니다).

• 각 기능에 대한 템플릿을 만들고 <% body %>를 사용하여 응용 프로그램에서 본문을 설정하고 하나의 "마스터"템플릿 만 사용 (또는 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 좋은 피드백!

우리는 다음 반복을 위해 당신의 생각을 확실히 고려할 것입니다.

트윗 담아 가기 그래도 3.x.x 에서 어떻게 보이는지 알고 싶습니다.

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

이 클라이언트는 v2 메일 엔드 포인트에서 분리하고 v3 엔드 포인트에 대한 액세스를 허용하기 위해 처음부터 다시 생성되었으므로 일대일 매핑이 없습니다.

즉, 메일 도우미의 목적은 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에 대한 얇은 래퍼입니다. 계획은 당신이 한 일과 같은 커뮤니티 피드백을 기반으로 점진적으로 기능을 향상시키는 것입니다!

커뮤니티에 대한 귀하의 지원과 기여를 위해 몇 가지 장식을 보내 드리고자합니다. 티셔츠 사이즈와 우편 주소를 [email protected] 으로 보내 주시기 바랍니다.

적절하다고 판단되면 언제든지 추가 피드백을 추가하십시오. 다시 한 번 감사드립니다!

헉헉

다음과 같이 할 수도 있습니다.

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

트윗 담아 가기 확실히 할 것입니다. 감사합니다. 기꺼이 도와드립니다! 😁

@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 의 멋진 풀 요청을 확인하십시오 : https://github.com/sendgrid/sendgrid-nodejs/pull/261. 특정 아이디어를 직접적으로 다루지는 않지만 올바른 방향으로 나아가는 단계입니다.

@thinkingserious 저수준 요청 항목이 곧 숨겨 질 것이라고 언급했습니다. 이미 계획된 것이 있습니까? 나는 어제 그것에 대해 생각하고 있었는데, 전체 API에 액세스하는 것이 좋지만 sendgrid-rest 사용할 수 있습니다. 이렇게하면이 라이브러리가해야 할 일은 이메일을 보낼 수 있도록 허용하고 이메일 전송 API 만 노출하는 것입니다.

그것은 당신이 관심사를 분리 하고이 패키지의 초점을 조금 좁혀서 @jamesdixon이 제안한 것과 같은 체인 등으로 더 깨끗한 API를 허용했습니다.

@adambuczynski ,

우리의 계획은 헬퍼를 통해 추상화 계층을 실행하는 것입니다. 메일이 첫 번째이지만 가까운 장래에 하위 사용자 관리 및 템플릿을위한 메일을 추가 할 계획입니다. 하지만 먼저 메일 도우미를 다듬고 표준으로 만들어야합니다.

맞습니다.이 라이브러리는 sendgrid-rest에 비해 매우 얇은 레이어이며 단순히 예제, USAGE 파일 및 단위 테스트를 추가합니다 (이것들은 모두 Swagger 정의를 사용하여 자동화되어 있습니다. 장기적으로 우리는 모든 엔드 포인트에 대한 헬퍼 코드를 구현하고, 두 가지 방법으로 데이터 유효성 검사를 완료하고 해당 기능의 핵심도 자동화 할 계획입니다. 워크 플로 및 사용 사례는 수작업으로 작성됩니다.

향후 몇 주 / 개월 동안 추가 피드백을 위해 GitHub에서 로드맵을 공개 할 예정입니다.

또한 8 월 말까지 Incoming Parse Webhook에 대한 지원을이 라이브러리에 추가 할 예정입니다.

이 질문을 해주셔서 감사 드리며 제 답변이 귀하와 커뮤니티의 추가 피드백을 촉발하기를 바랍니다. 우리는 이것이 SendGrid가 지원하고 주도하는 커뮤니티 주도 라이브러리가되기를 바랍니다.

@thinkingserious 업데이트에 감사드립니다. 앞으로 sendgrid nodejs 라이브러리에서 역할을 수행하게되어 기쁩니다.

이 단계에서 Parse 지원을 추가하는 이유는 무엇입니까? 내년 1 월에 Parse 서비스가 중단 될 것이라고 생각했습니다.

@thinkingserious 내가 여기서 도울 수있는 것이 있다면, 그냥 나를 핑하는 것을 잊었다. 할 수만 있다면 해킹 할 수있어 기쁩니다. :미소:

@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 줄을 반복하여 여러 수신자를 추가 할 수 있다고 생각합니다.

이 접근 방식은 이메일과 개인화 클래스로 나뉘어 매우 장황합니다. 때로는 이메일 주소를 추가하여 다른 곳으로 보내고 싶을 때도 있는데,이를 수행하려면 많은 코드 라인이 필요하다고 생각합니다.

@ albert-the-creator,

이 생성자는 사람들이 하나의 이메일을 더 쉽게 보낼 수 있도록 만들어졌습니다. 기본적으로 "hello email"기능입니다.

여러 이메일의 경우 다음 예제를 따르고 싶을 것입니다 (이미 개인화를 설정하여이 경로를 시작 했으므로) : https://github.com/sendgrid/sendgrid-nodejs/blob/master/examples/helpers/mail /example.js#L15

https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/personalizations.html에서 개인화에 대해 읽어 보는 것도 유용 할 수 있습니다.

도우미는 확실히 진화 할 것이지만 주요 변경 사항은 주요 포인트 릴리스로 표시됩니다. 하지만 API가 많이 변경 될 것으로 예상하지 않습니다.

@adambuczynski ,

참여해 주셔서 감사합니다! 이와 같은 추가 일반적인 사용 사례를 설명하고 예를 들어 템플릿이있는 이메일을 보내도록 도우미를 업데이트해야합니다.

@thinkingserious 헬퍼 API는 다시 시간이있을 때 리팩토링 / 개선에 관심이있는 것이 었습니다. :)

@adambuczynski ,

멋지군요. 시작하기로 결정하면 저를 핑해주세요. 아니면 우리가 당신보다 먼저 시작하면 내가 당신을 핑할 것입니다.

@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으로 다운 그레이드했습니다. 유효한 V3 JSON을 생성하기 위해 팩토리 유형 함수를 사용하고 있으며 이제 V3 API의 개선 사항에 매우 흥분합니다 (실제로 사용할 수 있기 때문에).

이것은 내가 처음에 어려움을 겪었던 것입니다. 제 생각에는
도우미를 더 효율적이고 사용하기 쉽게 만들 수 있습니다. 나는
핵심 sendgrid 모듈의 일부가되어서는 안된다고 주장하기도합니다.
우려 사항을 분리하고 사람들이이를 사용하도록 선택할 수 있습니다.

다시 한번 살펴보고 구체적인 내용을 생각해 볼 수있을 것입니다.
제안.

2016 년 8 월 26 일 금요일 05:48 Sean Lindo [email protected] 은 다음과 같이 썼습니다.

나는 이것이 예를 들어 있는지 아닌지 확실하지 않지만 "메일 도우미"를 사용하지 않음으로써
나는 헤아릴 수없는 시간을 절약했습니다. 이렇게 된 후입니다
일부러 2.0으로 다운 그레이드했습니다.

—
당신이 언급 되었기 때문에 이것을 받고 있습니다.
이 이메일에 직접 답장하고 GitHub에서 확인하세요.
https://github.com/sendgrid/sendgrid-nodejs/issues/252#issuecomment -242479491,
또는 스레드 음소거
https://github.com/notifications/unsubscribe-auth/AAd8Qu5iRLFQwoKlRd2fP5oioT1uLqB6ks5qjdV2gaJpZM4JAiac
.

@seanlindo ,

의견을 보내 주셔서 감사합니다.

다음은 메일 도우미없이이 라이브러리를 사용하는 예입니다. https://github.com/sendgrid/sendgrid-nodejs#without -mail-helper-class

메일 도우미는 첫 번째 버전이며 다음 버전을 개선하는 데 도움이되도록 귀하와 같은 피드백에 의존합니다. 문제를 해결하기위한 티켓을 만들 수 있도록 발생한 특정 문제를 공유해 주시겠습니까?

또한 대기열 위로 이동하는 데 도움이되도록 메일 도우미를 개선하기 위해 백 로그 작업에 투표를 추가하고 있습니다. 감사!

@adambuczynski ,

나는 당신의 굉장함이 계속되는 것을 봅니다 :)

여러분의 피드백을 기다리고 있습니다. 정말 좋을 것입니다!

@julesbou ,

일반적인 사용 사례에 대한 예제를 제공 할 USE_CASES.md 파일을 시작했습니다. 첫 번째는 트랜잭션 템플릿이었습니다. :)

여러분의 피드백을 기다리고 있습니다. 정말 좋을 것입니다!

👻

트윗 담아 가기 하루 정도만 주시면 구체적인 예를 들어 드리겠습니다.

이것은 내가 가장 좋아하는 스레드 중 하나입니다. :)

귀하의 의견은이 라이브러리의 다음 반복에 매우 중요 할 것이며, 이는 큰 변화가 될 것입니다. 잠시 시간이 있으시다면 저희의 제안을 보시겠습니까? https://github.com/sendgrid/sendgrid-nodejs/issues/290

감사!

@thinkingserious 드디어 v3에 도입 된 모든 Sendgrid 도우미 클래스에 대해 저를 괴롭히는 것이 무엇인지 이해하게되었습니다 ... 그것들이 너무 많아서 이메일을 불필요하게 복잡하게 만듭니다.

Sendgrid의 코드를 모두 점검하고 싶지 않았기 때문에 대신 간단한 래퍼 인 sendgrid-mailer 를 만들기로 결정했습니다.

Sendgrid의 도우미 클래스는 배후에서 유용하지만 이메일 모델을 만들고 유효성을 검사하기 위해 API와 상호 작용하도록 강요해서는 안된다고 생각합니다. 나는 그것이 노드 앱을 작성하는 것을 생각보다 더 복잡하게 만들고 도우미의 이름을 매우 혼란스럽게 할 수 있습니다. 예를 들어 Mail vs Email .

기본 예가 문제를 잘 설명한다고 생각합니다.

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

이것은 "I want to send an email"과 같은 기본적인 것에는 너무 복잡해 보입니다. 이메일을 보내기 전에 8 개의 서로 다른 종속성을로드하고 15 줄의 코드를 작성해야합니다.

헬퍼 클래스를 사용하지 않는 것은 이메일 JSON 요청의 필수 구조를 알고 직접 올바르게 채워야하기 때문에 훨씬 더 나쁩니다. 한 번의 실수로 요청이 쉽게 중단됩니다.

그래서 모든 도우미 클래스 로직을 간단하고 사용하기 쉬운 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 Helper Enhancement 프로젝트를 참조하십시오.

현재 우리는 C # 라이브러리를 마무리하고 있습니다. 이 Node.js 라이브러리에 대해 우리가 계획하는 구체적인 예를 보려면 this 를 참조

그래서 제안이 있습니다.

여기에있는 메일 도우미에 솔루션을 추가해 주시겠습니까 (C #에서 수행 한 작업과 유사)? 나는 당신의 작업이 그 경우 더 큰 도달 범위를 달성 할 것이라고 생각합니다. 그렇지 않다면 전혀 문제가 없습니다. MIT 라이센스로 프로젝트를 게시 했으므로 우리가 당신의 좋은 작업에서 약간 빌려 주면 우리를 용서해 주셨으면합니다;) 그리고 물론, 우리는 당신이 기여한 것에 대한 크레딧을받을 것입니다.

작업을 별도로 유지하기로 결정한 경우 여기 커뮤니티 라이브러리 섹션 아래에 링크를 추가해 주시겠습니까?

귀하의 놀라운 지속적인 지원에 감사드립니다. 락!

@thinkingserious 당신이 같은 방향으로 가고 있다는 것을 듣고 기쁩니다. C # 예제가 더 좋아 보이지만 JS 구현에서는 여전히 다소 복잡하다고 생각합니다. 모든 클래스를 만드는 것이 항상 JS에서 가장 좋은 방법은 아닙니다.

귀하의 제안에 관해서는 여전히 내부에서 도우미 클래스를 사용하고 있기 때문에 공식 라이브러리로 이식하는 것이 실제로 얼마나 유용한 지 모르겠습니다. 저는 아마도 대대적 인 재 작성 (예 : v5)을 돕고 새로운 것부터 시작하여 사용자와 노드 커뮤니티의 의견을 받아 사용하기 쉽고 필요한 경우 유연한 멋진 API를 내고 싶을 것입니다.

하지만 그동안 내 래퍼에서 코드를 빌려 공식 라이브러리에서 사용하고 싶다면 꼭 가보세요 :) 해당 페이지에서 내 래퍼에 대한 링크를 추가하겠습니다 🎉

실제로 프로젝트를 API와 상호 작용하기위한 요청 논리를 포함하는 하위 수준과 내가 만든 것과 유사한 이메일 전송을위한 상위 수준의 두 패키지로 분할하는 것이 좋습니다.

하위 수준 패키지는 API에 대한 전체 액세스 권한이 필요한 사람들에게 사용될 수 있으며, 메일러 패키지는 이메일을 보내려는 사람들에게 적합합니다. 물론 내부적으로 메일러는 API 패키지를 사용합니다.

@thinkingserious 그것에 대한 당신의 생각은 무엇입니까?

@adamreisnz ,

언제나처럼 사려 깊은 피드백에 감사드립니다.

이 시점에서 프로젝트를 분할해야하는지 잘 모르겠습니다. 현재 헬퍼 모델로 비슷한 결과를 얻을 수 있다고 생각합니다. 즉, 저는 향후 버전에서 새로운 아키텍처를 탐색 할 수있는 기회를 갖고 있으며 여러분이 이에 동참하고 싶습니다.

커뮤니티의 다른 사람들이 참여하기를 바랍니다.

나는 이것에 대해 더 깊이 생각하고 업데이트 된 메일 도우미를 구현할 때가되면 다시 참여할 것입니다.

귀하의 지원과 문서에 링크를 추가해 주셔서 다시 한 번 감사드립니다!

우려를 분리하는 문제입니다. 메인 라이브러리 내부에 쉽게 메일을 보낼 수 있도록 도우미 / 래퍼를 포함 할 수 있지만, 제 생각에는 둘 다의 잠재적 인 손해 나 불필요한 합병증에 대해 두 가지 별도의 우려가 섞여 있다고 생각합니다. 별도로 유지하면 소비자가 필요한 라이브러리 (또는 둘 다)를 선택할 수 있으며 명확하게 정의 된 경계로 인해 두 라이브러리를 더 쉽게 개발할 수 있습니다.

가능한 한 많은 관심사를 분리하고 각 패키지가 특정 작업을 수행하도록하는 것이 Node 및 npm 모듈의 특성이라고 생각합니다 (그리고 잘해보십시오!). Node를 처음 시작했을 때도 익숙해 져야했지만, 일단 Node가 제공하는 깨끗하고 간단한 패키지를 개발할 수있는 자유와 능력이 마음에 들었습니다.

커뮤니티의 의견을 기다리십시오.

글쎄, 당신은 확실한 주장으로 확실히 설득력이 있습니다. :)

시간을내어 자세히 설명해 주셔서 감사합니다.

저는 이미이 라이브러리 작업을 다시 시작하기를 고대하고 있었으며 이제 여러분과 커뮤니티와 함께이 SDK 작업을 다시 시작하게되어 정말 기쁩니다.

좋습니다. 작업 할 때 알려주세요. :)
나는 4 주 동안 휴가를 보내고 있으므로 마침내 오픈 소스 프로젝트에 대한 작업을 할 수있는 여가 시간을 갖게 될 것입니다 🌴

@adamreisnz ,

축하합니다!

훨씬 더 높은 수준의 "메일러 패키지"가 바로 우리가 원하는 것입니다. 이메일을 보내면됩니다.

마지막 버전에서는 매우 단순했지만 이제는 거룩하지 않은 엉망이되었습니다. "Basic"예제에는 현재 8 개의 var가 정의되어 있으며 특수 생성자가 필요합니다. 사용 편의성 측면에서 크게 뒤로 물러납니다.

다음과 같이 간단해야합니다.

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 API를 개선 할 것입니다. 바라건대 우리는 사용하기 쉽지만 필요할 때 충분히 융통성있는 것을 생각 해낼 것입니다.

안녕하세요 여러분,

SendGrid Node.js 메일 도우미의 재 설계에 관심이있을 것이라고 생각했습니다. https://github.com/sendgrid/sendgrid-nodejs/pull/378

귀하의 의견은 대단히 감사하겠습니다!

마음을 담아,

Elmer

업데이트를 위해 # 378로 이동하십시오, 감사합니다!