Sendgrid-nodejs: 동적 템플릿 지원 추가

문서를 업데이트하십시오. 대체가 v3 API에서 작동하지 않는 이유를 파악하는 데 한 시간을 보냈습니다.

@jharris-code의 형편없는 경험에 대해 사과드립니다.

우선 순위를 얻을 수 있도록 이 문제에 귀하의 투표를 추가했습니다. 우리 손에 PR #711이 있기 때문에 곧 업데이트 될 것 같습니다.

문서의 부재가 실제 코드의 릴리스를 차단한다는 것은 매우 어리석은 일입니다.

안녕하세요 @catamphetamine 입니다 .

코드는 v6.3.1 에서 릴리스되었습니다. 도움이 되었기를 바랍니다. 감사합니다!

마음을 담아,

엘머

@thinkingserious 오,
나는 그것을 시도 할 것입니다, thx.

사용자 참고 : 사용하는 템플릿을 통과 dynamic_template_data 대신 substitutions .

이제 "substitutions:"를 "dynamic_template_data:"로 변경해야 합니다.

그리고 템플릿은 핸들바를 사용하여 더 이상 "substitutionWrappers"를 지정할 필요가 없습니다.

사용 사례의 이 예는 여전히 dynamic_template_data가 아닌 대체를 사용합니다. Plz 업데이트, 이 스레드를 찾기 전에 SDK를 사용하고 검색하는 데 몇 시간이 걸렸습니다. (또한 귀하의 API 문서 는 이것에 대해 아무 것도 언급하지 않아 도움이 되지 않았습니다.
또한 replacementWrappers는 dynamic_template_data와 전혀 작동하지 않는 것 같습니다. 내 메시지 개체에 substitutionWrappers: ['*|', '|*'] 키 값 쌍을 포함하더라도 중괄호로 묶인 템플릿 변수만 채워졌습니다. (이제 의도적으로 모든 사람이 템플릿에 핸들바 구문을 사용하도록 강요하는 건가요?)

@josh-yonomi 죄송합니다.

귀하의 피드백을 기반으로 문서를 업데이트했습니다.

새 템플릿의 경우 핸들바 구문을 사용합니다. 레거시 템플릿은 여전히 ​​이전과 같이 작동합니다.

마음을 담아,

엘머

이메일을 받았지만 대체가 작동하지 않습니다. 무엇이 문제를 일으킬 수 있습니까?

const msg = {
    to: email,
    from: sendGridMail,
    templateId: emailTemplate.confirmationEmail,
    dynamic_template_data: {
      firstName: firstName,
      lastName: lastName,
      link: link
    }
  };

@thinkingserious를 통해 편집

문제가 어디에 있는지 알려주시겠습니까? 개선할 수 있도록 불만 사항을 이해하고 싶습니다.

@drav96 ,

템플릿이 어떻게 생겼는지 공유하시겠습니까?

마음을 담아,

엘머

왜 대체 래퍼에서 특수 문자를 제거합니까 ??

dynamic_template_data: {
      'foo-bar': 'wtf',
      'bar_baz': 'wtf',
      'baz.bro': 'wtf',
      'foo': 'wtf'
    }

{{foo}} 이메일에서 wtf 문자열을 반환합니다.

@larafale 은 확실하지 않지만 확실히 합리적이지 않은 것 같습니다. 이 SDK의 소스 코드를 보면 해당 키가 수정되는 위치가 표시되지 않습니다.

이 문제에 대해 별도의 문제를 만들고 HTML 템플릿의 모양을 포함하시겠습니까? 새로운 문제를 버그로 표시하고 필요한 경우 재현 및 수정하도록 노력하겠습니다.

안녕하십니까,

그래서 동적 템플릿 이메일을 보내려고 하지만 대체 또는 dynamic_template_data 을 사용할 수 없습니다.
내 템플릿에는 {{fullname}} 또는 {{date}} 와 같은 태그가 있으며 이러한 속성은 send 함수로 전송됩니다.

const msg = {
        to,
        from,
        templateId: template.id,
        dynamic_template_data: substitutions,
    };

    return sgMail.send(msg)

substitutions 개체에 올바른 값이 있는 올바른 속성이 있지만 대체가 작동하지 않는 것을 확인했습니다.

내가 뭘 잘못하고 있는지 알겠어?

감사 해요.

@gianfelipe93
구조가 맞습니다. 나는 같은 문제가 있었다.
내 솔루션은 내 프로젝트에서 @sendgrid 패키지를 제거하고 다시 설치하는 것이 었습니다.
그것이 당신을 위해 작동하는지 알려주십시오
const msg= { to: email, from: sendGridMail, templateId: emailTemplate.requestDemoEmail, dynamic_template_data: { name: data.name, email: data.email, } };

@drav96 고마워 친구, 지금 작동 중입니다.

이것에 또 한 시간을 허비한 후에 내가 바라는 것을 추가하는 것은 확실한 문서 가 될 것입니다. (먼저 나보다 먼저 시간을 허비한 모든 이들에게 감사한다.)

1. 템플릿 ID가 d- 로 시작하면 substitutions 이 작동하지 않으며 CAMEL-CASE dynamicTemplateData 를 사용해야 합니다( 여기 참조,
2. 템플릿이 d- 로 시작하면 setSubstitutionWrappers 는 자동으로 무시되며 템플릿에서 {{ 및 }} 를 사용해야 합니다.

이것에 또 한 시간을 허비한 후에 내가 바라는 것을 추가하는 것은 확실한 문서 가 될 것입니다. (먼저 나보다 먼저 시간을 허비한 모든 이들에게 감사한다.)

1. 템플릿 ID가 d- 로 시작하면 substitutions 이 작동하지 않으며 CAMEL-CASE dynamicTemplateData 를 사용해야 합니다( 여기 참조,
2. 템플릿이 d- 로 시작하면 setSubstitutionWrappers 는 자동으로 무시되며 템플릿에서 {{ 및 }} 를 사용해야 합니다.

제 경우에는 템플릿 ID에 d- 가 있더라도 dynamic_template_data 와 함께 작동합니다.

예, 스네이크 케이스 키와 함께 작동하지만 개발자가 내부적으로 낙타 케이스에 커밋한 것처럼 보입니다(위 보고서에서 링크한 줄 참조). 따라서 모든 새 코드에는 낙타 케이스를 사용하는 것이 좋습니다.

안녕하세요 @kael-shipman

시간을 내어 도와주셔서 감사합니다. 감사합니다!

이 문서를 본 적이 있습니까? 그렇지 않다면 한 시간을 낭비하게 만든 발견 경로를 설명해 주시겠습니까? 다시는 그런 일이 일어나지 않았으면 하고 좋지 않은 경험에 대해 사과드립니다.

마음을 담아,

엘머

@thinkingserious ,

어쨌든 문제는 올바른(ish) 문서가 어딘가에 존재한다는 것이 아니라 많은 오래된 문서가 여전히 Google 검색에 따라잡혀 있다는 것입니다. "sendgrid 템플릿 필드"(방금)를 검색했는데 광고가 아닌 첫 번째 결과는 this 입니다 . 모든 표시에 따르면 공식 문서이지만 분명히 오래된 것입니다. 뿐만 아니라 두 가지 다른 대체 형식( -firstName- 및 %firstName% )이 있으며 "사용하는 SDK 라이브러리에 따라 다를 수 있습니다"만 표시됩니다. 모든 SDK 라이브러리는 아마도 동일한 단일 사원(하나의 대체 태그 스타일만 있음)을 가리킬 것입니다.

sendgrid에 대한 내 경험에 따르면 구축된 사항에 크게 감사하지만 이 문서 혼동은 실제로 예외가 아니라 규칙입니다. 다른 소프트웨어 세계만큼 앞으로 나아가고 있다는 것을 압니다. 그러나 모든 문서를 정규화하고 버전 번호를 지정하는 등의 작업을 수행하는 데 한 달 정도가 소요될 것입니다. 상위 Google 조회수

어쨌든, 다시 한 번 감사합니다!

또한 링크한 문서에는 여전히 뱀의 경우 dynamic_template_data 되어 있으며, 그것이 맞다면 코드 자체가 왜 그것을 camelCase로 변환하는 것처럼 보이는지 잘 모르겠습니다. 위에서 언급했듯이 뱀 케이스가 작동한다는 것을 알고 있지만 코드가 주어지면 문서에서 사용을 권장하지 않는 것 같습니다.

안녕하세요 @kael-shipman

시간을 내어 자세한 피드백을 제공해 주셔서 감사합니다!

귀하가 제공한 링크와 관련하여 해당 문서는 이 SDK가 지원하는 SendGrid v3 REST API가 아니라 SendGrid SMTP API를 참조합니다. 즉, 당신은 그것을 알 것으로 기대해서는 안됩니다. 이 문제를 문서 팀에 전달하여 명확하게 할 수 있는 방법이 있는지 확인하겠습니다.

우리는 최근에 오픈 소스 문서를 업데이트하고

일관성을 위해 camelCase를 사용하도록 README를 수정하겠습니다. 그것을 포착하고 우리의 관심을 가져 주셔서 감사합니다!

다시 한 번 감사 드리며 자세한 피드백에 대한 감사의 표시로 귀하에게 약간의 장식 을 제공하고 싶습니다. 즐기다!

마음을 담아,

엘머

안녕하세요, 감사합니다 :D

2018년 9월 18일 화요일 오후 6:09 Elmer Thomas 알림 @github.com
썼다:

안녕하세요 @kael-shipman https://github.com/kael-shipman ,

시간을 내어 자세한 피드백을 제공해 주셔서 감사합니다!

귀하가 제공한 링크와 관련하여 해당 문서는
이 SDK에서 사용하는 SendGrid v3 REST API가 아닌 SendGrid SMTP API로
지원합니다. 즉, 당신은 그것을 알 것으로 기대해서는 안됩니다. 내가 가져올 게
이 문제를 문서 팀에서 확인하여
명확히 하는 방법.

우리는 최근에 오픈 소스 문서를 업데이트하고 다시 시작했습니다.
https://sendgrid.com/blog/how-to-get-the-most-from-sendgrids-new-knowledge-center/ .
더 쉽게 탐색할 수 있기를 바랍니다.

일관성을 위해 camelCase를 사용하도록 README를 수정하겠습니다. 에 감사하다
그것을 포착하고 우리의 주의를 끌고 있습니다!

다시 한 번 감사드리며 자세한 내용에 대한 감사의 표시로
피드백, 우리는 당신에게 약간의 장식을 제공하고 싶습니다
https://dx.sendgrid.com/swag . 즐기다!

마음을 담아,

엘머

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

일반 이메일 변수에 대해 dynamic_template_data 을 사용할 수 있지만 수신자별로 동적 데이터도 추가해야 하는 경우에는 어떻게 해야 합니까? 예: 주문 번호, 주문 수량 등. 문서에서 이에 대한 사용 사례를 볼 수는 없지만 간과하고 있을 수 있습니다.

사용자 참고 : 사용하는 템플릿을 통과 dynamic_template_data 대신 substitutions .

@catamphetamine 불행히도 모든 사람의 코드가 dynamicTemplateData 로 작동하는 것처럼 보이는 이유를 파악하는 데 너무 많은 시간을 보냈기 때문에 귀하의 의견을 반대했습니다. 그러나 제 경우에는 대체가 단순히 제거되었습니다. 다른 사람들이 더 나은 경험을 하기를 바랄 뿐입니다.

내 버전:
"@sendgrid/mail": "^6.3.1"

나를 위해 나는 다음을 수행해야했습니다 (사람들이 말하는 것과 반대).

// This seems to be the default, however, to avoid unexpected API changes,
// I'd rather set this manually
setSubstitutionWrappers("{{", "}}");

{
      subject: EMAIL_SUBJECT_ONBOARDING,
      templateId: "templateId",
      personalizations: [{
        to,
        // NOT WORKING WITH THIS ❌
        // dynamicTemplateData: {
        //   senderName: EMAIL_FROM_NAME,
        //   senderAddress: "an actual adress",
        // },

        // WORKS WITH THIS ✅
        substitutions: {
            senderName: EMAIL_FROM_NAME,
            senderAddress: "an actual adress",
        },
    }],
}

@thinkingserious 는 도구를 사랑합니다. 문서, 커버 엣지 케이스 등을 계속 개선해 주세요. 🎉❤️

업데이트:

@catamphetamine downvote 덕분에. 내가 setSubstitutionWrappers("{{", "}}"); 했기 때문에 substitutions 일 수 있다고 생각했습니다. 아아, 아니. 무슨 일이 있었는지 모르겠지만 피곤할 수도 있지만 dynamicTemplateData 은 작동 합니다. 참고로 그것은 camelCase _(@kael-shipman 주석 참조)_ 대부분의 예제 뱀 사례를 봅니다. 또한 sendgrid에 TS 유형을 사용하고 있습니다. 정의에 사용 가능한 snake_case 키가 없습니다.

업데이트 2:

사용 가능한 유형에 대해. PersonalizationJSON 유형에서 dynamic_template_data 을 찾았습니다. 다음을 사용하는 경우:
import { send } from "@sendgrid/mail";
그런 다음 send에 대한 첫 번째 매개변수를 확인한 후 다음 정의가 있는 MailData 를 볼 수 있습니다.

export interface MailData {
  // ...
  personalizations?: PersonalizationData[],
  // ...
}

그런 다음 나는 다음 2가지 유형을 우연히 발견했습니다.

export interface PersonalizationData {
  // omitted keys...
  dynamicTemplateData?: { [key: string]: string; };
  customArgs?: { [key: string]: string };
  sendAt?: number;
}

export interface PersonalizationJSON {
  // same omitted keys...
  dynamic_template_data?: { [key: string]: string; };
  custom_args?: { [key: string]: string; };
  send_at?: number;
}

마지막으로 다음과 같이 일관되게 작동하도록 dynamic_template_data 를 얻습니다.

{
    templateId: "d-templateId",
    dynamic_template_data: { name: "elton yet again"}, // <-- either here
    personalizations: [{
        to,
        dynamic_template_data: { name: "Elton again" }, // <-- or here
    }],
}

@thinkingserious 분명히 수정해야 할 유형 정의 문제가 있습니다. 나중에 PR을 만들 수 있습니다.

알겠습니다. 다시 조사해야 합니다. 이제 dynamicTemplateData 도 substitutions 나를 위해 작동하지 않기 때문에 나는 멍해졌습니다.

업데이트:
일부 테이블을 뒤집었지만 작동하고 이전 의견을 업데이트했습니다.

마지막으로 다음과 같이 일관되게 작동하도록 dynamic_template_data 를 얻습니다.

{
    templateId: "d-templateId",
    dynamic_template_data: { name: "elton yet again"}, // <-- either here
    personalizations: [{
        to,
        dynamic_template_data: { name: "Elton again" }, // <-- or here
    }],
}

이것은 저에게 중요한 포인트였습니다. cc 이메일과 다른 거래 템플릿의 제목을 설정하려고 했습니다. 위와 같이 개인화 배열 내부에 dynamic_template_data 속성을 넣을 때 작동했습니다.

    const msg = {


         personalizations: [
            {
              to: req.body.to,
              dynamic_template_data : {
                subject: "Just to adsf...",
                full_name_from: req.body.full_name_from,
                full_name_to: req.body.full_name_to,
                manager: req.body.manager,
                message: req.body.message,
                badge: req.body.badge,
                badge_image: 'https://asdf' + req.body.badge_image
             }
            },
            {
              to: req.body.manager,
              dynamic_template_data : {
                subject: req.body.full_name_from + ' received a asdf asdf',
                full_name_from: req.body.full_name_from,
                full_name_to: req.body.full_name_to,
                manager: req.body.manager,
                message: req.body.message,
                badge: req.body.badge,
                badge_image: 'https://asdf' + req.body.badge_image
             }
            }
          ]
    };

나를 위해 일한 솔루션은 아래 표시된 정확한 방식으로 개인화 개체 내부에 dynamic_template_data를 배치하는 것입니다.

    "personalizations": [
        {
              "dynamic_template_data": {
            "fullname": "full Name",
            "useremail": ":[email protected]",
            "userphone": "56456",
            "usermsg": "tex fdsfgasdf t"
    },
            "to": [
                {
                    "email": "[email protected]"
                }
            ],
            "cc": [
                {
                    "email": "[email protected]"
                }
            ]
        }
]