הגדרת אימייל

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X. מידע

כברירת מחדל, נשלחות מפורטל השירותים למפתחים הודעות אימייל בתגובה לאירועים מסוימים. לדוגמה, כשמפתח חדש נרשם לפורטל, הפורטל שולח למפתח אימייל אוטומטי. לחלופין, אם המפתח מאבד את הסיסמה, הוא יכול לבקש הודעת אימייל עם סיסמה זמנית.

כספקי API, אתם יכולים לשלוט בכל ההיבטים של האימיילים שהפורטל יוצר, כולל:

  • הפורמט של הודעות האימייל האוטומטיות שנשלחות על ידי הפורטל
  • ציון שרת ה-SMTP שהפורטל משתמש בו
  • הוספת כללים ליצירת אימיילים בתגובה לאירועים בפורטל

שליחת אימייל מפורטל מבוסס-ענן

יש להשתמש בהגדרת ברירת המחדל של האימייל לפורטל מבוסס-ענן שנפרס ב-Pantheon או ב-Acquia רק בסביבות ללא ייצור. יכול להיות שאימיילים שנשלחים משרת אנונימי בענן ייחסמו או יסומנו כספאם.

לפורטלים בסביבת ייצור, יש להשתמש באחת מהאפשרויות הבאות לשליחת אימייל:

שליחת אימייל מפורטל מקומי

כברירת מחדל, האימייל נשלח באמצעות הפונקציה PHP mail(). PHP מנסה לשלוח אימייל באמצעות sendmail במערכת המקומית, שניתן להגדיר אותו בקובץ php.ini של PHP.

לפורטלים בסביבת ייצור, תוכלו להשתמש במודול ה-SMTP שמתואר בהמשך כדי לשלוח אימייל דרך שרת SMTP או שרת של חברה.

הגדרה של שרת SMTP

פורטל המפתחים דורש הגדרה של שרת SMTP לשליחת הודעות אימייל. כדי להגדיר את שרת ה-SMTP, קודם כל צריך להפעיל את מודול התמיכה באימות SMTP של Drupal בפורטל למפתחים.

אחרי שמגדירים את שרת ה-SMTP, כל האימיילים שיישלחו על ידי הפורטל למפתחים ישתמשו בשרת ה-SMTP. האימיילים האלה כוללים אימיילים שנשלחו למפתחים חדשים, אימיילים שנשלחו למפתחים שיאבדו את הסיסמה ואימיילים שנשלחו למפתחים עם חשבונות חסומים.

כדי להגדיר את שרת ה-SMTP:

  1. אתם יכולים להתחבר לפורטל שלכם כמשתמשים עם הרשאות אדמין או יצירת תוכן.
  2. בוחרים באפשרות מודולים בתפריט הניהול של Drupal.
    הדף Modules ייפתח.
  3. מפעילים את המודול תמיכה באימות SMTP.
  4. שומרים את התצורה.
  5. אחרי שהמודול מופעל, בוחרים באפשרות Configure (הגדרה) בשדה SMTP Authentication Support (תמיכה באימות SMTP) בדף Modules (מודולים).
    יופיע דף ההגדרות של SMTP Authentication Support (תמיכה באימות SMTP).
  6. בקטע הפעלה או הפעלה של המודול הזה, בוחרים באפשרות הפעלה.
  7. באזור ההגדרות של שרת ה-SMTP, מזינים את הפרטים הבאים:
    • כתובת של שרת SMTP. לדוגמה, בשרת ה-SMTP היוצא של Gmail, צריך להשתמש ב-smtp.gmail.com.
    • אפשר גם להזין את כתובת שרת ה-SMTP לגיבוי. לא צריך את הערך הזה.
    • מזינים את יציאת ה-SMTP. הערך של היציאה הזו יכול להיות שונה בהתאם לפרוטוקול ההצפנה שנבחר. לדוגמה, ב-Gmail, היציאה היא 465 כשמשתמשים ב-SSL ו-587 ל-TLS.
    • בוחרים את פרוטוקול ההצפנה ללא, SSL או TLS.
  8. בשדה SMTP Authentication (אימות SMTP), מציינים את שם המשתמש והסיסמה שישמשו לאימות SMTP. אלה חייבים להיות שם משתמש וסיסמה חוקיים בשרת ה-SMTP.
  9. בקטע E-mail options, מזינים את כתובת האימייל ואת השם של המשתמש שיוצר את הודעת האימייל. הערכים האלה תואמים לכתובת 'מאת' של האימייל.
  10. לחלופין, בקטע שליחת הודעת אימייל לבדיקה, מזינים כתובת אימייל שאליה תישלח הודעת ניסיון מהפורטל.
  11. שומרים את התצורה.
    שמירת התצורה תגרום ליצירת הודעת האימייל לבדיקה ולהצגת שגיאות בהגדרה. בודקים את תיבת הדואר הנכנס של כתובת האימייל של הודעת הבדיקה כדי לוודא שהיא תגיע.
  12. בתפריט הניהול של Drupal, בוחרים באפשרות Configuration > System > Site Information (הגדרות אישיות > מערכת > פרטי אתר).
  13. בקטע Site Details (פרטי אתר), מגדירים את כתובת האימייל לאותה כתובת אימייל שציינת בשלב 9.
    חלק מהמודולים של Drupal שיוצרים אימיילים משתמשים בשדה הזה כדי לקבוע את הכתובת 'מאת' של האימייל, ולא את הערך שמופיע בדף 'תמיכה באימות SMTP'.
  14. שומרים את התצורה.

הגדרה ועיצוב של התראות באימייל

אפשר להגדיר התראות שונות באימייל שיישלחו בתגובה לפעילויות ספציפיות, כמו הרשמה, מחיקה, חסימה וביטול חסימה של חשבונות פיתוח.

אפשר גם לשלוט בכתובת 'מאת' של הודעות האימייל.

כדי להגדיר התראות באימייל:

  1. אתם יכולים להתחבר לפורטל שלכם כמשתמשים עם הרשאות אדמין או יצירת תוכן.
  2. בתפריט הניהול של Drupal, צריך לבחור באפשרות תצורה > אנשים > הגדרות חשבון. הדף 'הגדרות חשבון' ייפתח.
  3. בחר סוג של הודעת אימייל בקטע 'הודעות אימייל' בדף ההגדרות 'חשבונות'. לדוגמה, אפשר לבחור באפשרות 'ברוכים הבאים (לא נדרש אישור)', כדי לשלוח אימייל כשחשבון הפיתוח מאושר באופן אוטומטי בתהליך הרישום של המפתח.

  4. עורכים את הנושא וגוף ההודעה של הודעת האימייל.
    מציבים את הסמן בשדה מסוים, כמו Subject, ואז לוחצים על הקישור Browse available available (עיון באסימונים זמינים) בחלק התחתון של הטופס כדי לראות את רשימת האסימונים שאפשר להשתמש בהם בשדה. יופיע חלון קופץ שיאפשר לך לבחור אסימון להוספה, כמו [user:name], שתואם לשם המשתמש של המפתח.
  5. לוחצים על Save configuration (שמירת ההגדרות האישיות).

אפשר גם לשנות את השם והכתובת בשדה 'מאת' בהתראה באימייל.

כדי לשנות את השם והכתובת בשדה 'מאת':

  1. אתם יכולים להתחבר לפורטל שלכם כמשתמשים עם הרשאות אדמין או יצירת תוכן.
  2. בתפריט הניהול של Drupal, בוחרים באפשרות Configuration > System > SMTP Authentication Support (תמיכה באימות SMTP). הלחיצה תפתח את הדף 'תמיכה באימות SMTP'.
  3. לציין כתובת אימייל בשדה 'מאת' בשדה כתובת אימייל מאת.
  4. מציינים את השם "מאת" בשדה שם האימייל שממנו נשלחה.
  5. לוחצים על Save configuration (שמירת ההגדרות האישיות).
  6. בתפריט הניהול של Drupal, בוחרים באפשרות Configuration > System > Site information (הגדרות אישיות > מערכת > פרטי אתר).
  7. ציין את כתובת האימייל שבה השתמשת בשלב 3 בשדה 'כתובת אימייל'.
  8. לוחצים על Save configuration (שמירת ההגדרות האישיות).

יצירת אימייל כשאירוע מתרחש

אחד השימושים הנפוצים בכללים הוא ליצור אימיילים בתגובה לאירוע. בפורטל יש תמיכה מובנית ליצירת אימיילים לאירועים מוגדרים מראש, כמו כשמפתח חדש רושם חשבון. עם זאת, אפשר להוסיף כללים משלכם כדי ליצור הודעות אימייל. לדוגמה, אפשר ליצור אימייל כשהמפתח מוסיף, מסיר או משנה אפליקציה.

בקטע הזה מוצגת דוגמה לאופן שבו אפשר ליצור כלל ליצירת אימייל כאשר מפתח רושם אפליקציה. יש לשנות את ההליך הזה לפי הצורך כדי ליצור הודעות אימייל לאירועים אחרים.

כדי ליצור אימייל כשמפתח יוצר אפליקציה:

  1. אתם יכולים להתחבר לפורטל שלכם כמשתמשים עם הרשאות אדמין או יצירת תוכן.
  2. בוחרים באפשרות מודולים בתפריט הניהול של Drupal.
  3. מוודאים שהמודול ממשק המשתמש של הכללים מופעל.
  4. בתפריט הניהול של Drupal, בוחרים באפשרות Configuration > Workflow > Rules (כללים) דף הכללים ייפתח.
  5. לוחצים על הלחצן הוספת כלל חדש.
  6. בדף הכללים החדש, מציינים את הפרטים הבאים:
    • שם הכלל, לדוגמה "שליחת כלל באימייל".
    • אפשר לציין תגים שישמשו לסיווג הכללים של החיפוש.
    • בתפריט הנפתח React on event (תגובה לאירוע), בוחרים באפשרות Devconnect > 'יצירת אפליקציה למפתחים'.
  7. שומרים את הכלל.
    שמירת הכלל פותחת את טופס העריכה של הכללים עם שלוש חלוניות: Events (אירועים שיצרת עכשיו), Conditions (תנאים) ו-Actions (פעולות).
  8. בקטע פעולות, בוחרים באפשרות הוספת פעולה.
  9. בתפריט הנפתח Select the Action to Add (בחירת הפעולה להוספה), בוחרים באפשרות System (מערכת) > Send mail (שליחת אימייל).
    הבחירה הזו תפתח דף שבו תוכלו לעצב את ההודעה. בטופס הזה מזינים את השדות הבאים: 'אל', 'נושא', 'הודעה' ושדות אחרים באימייל.

    אפשר להרחיב את הקישור של התבניות החלפה שמתחת לכל שדה כדי להציג את רשימת התבניות שבהן אפשר להשתמש בשדה. לדוגמה, אם תרחיבו את 'תבניות ההחלפה' בשדה 'אל', תוצג רשימה של הדפוסים שכוללים את [app:developer]. אם תציינו את התבנית הזו בשדה 'אל', האימייל יישלח ליוצר האפליקציה.
  10. מגדירים את השדות כפי שמוצג בהמשך:
  11. לוחצים על Save (שמירה) כדי לחזור לדף של עריכת הכללים.
  12. בוחרים באפשרות שמירת השינויים.

בודקים את הכלל על ידי הוספת אפליקציה חדשה לפורטל. התשובה אמורה להישלח אליך באימייל:

Subject: App test email app created

App: test email app
API products: PremiumWeatherAPI, weatherapikey-Product
Created at: Mon, 01/27/2014 - 10:16