מוצג המסמך של Apigee Edge.
עוברים אל
מסמכי תיעוד של Apigee X. מידע
כברירת מחדל, פורטל השירותים למפתחים שולח אימיילים בתגובה לאירועים מסוימים. עבור לדוגמה, כשמפתח חדש נרשם בפורטל, הפורטל שולח באופן אוטומטי הודעת פתיחה אל המפתח. לחלופין, אם המפתח מאבד את הסיסמה, המפתח יכול לבקש עם סיסמה זמנית.
כספקי API, תוכלו לשלוט בכל ההיבטים של האימייל שהפורטל מייצר, כולל:
- עיצוב של הודעות אימייל אוטומטיות שנשלחו על ידי הפורטל
- ציון שרת ה-SMTP שהפורטל משתמש בו
- הוספת כללים ליצירת אימיילים בתגובה לאירועים בפורטל
שליחת אימייל מפורטל מבוסס-ענן
הגדרת ברירת המחדל של האימייל לפורטל מבוסס-ענן שנפרס ב-Pantheon או ב-Acquia מיועד לשימוש רק בסביבות ללא ייצור. הודעות אימייל שנשלחות משרת ענן אנונימי עשויות להיות חסומות או סומנו כספאם.
לפורטלים בסביבת ייצור, כדאי להשתמש באחת מהאפשרויות הבאות לשליחת אימייל:
- משתמשים במודול ה-SMTP, ניתוב אימייל לשרת ה-SMTP של החברה שלכם, כפי שמתואר במאמר הגדרת שרת SMTP.
- משתמשים בשירות אימייל חיצוני כמו SendGrid או Amazon SES (Simple Email Service). עבור
למידע נוסף:
- פנתיאון: Email on Pantheon
- Acquia: מידע על אימייל באפליקציות של Acquia Cloud
שליחת אימייל מפורטל מקומי
כברירת מחדל, הדואר נשלח באמצעות PHP mail(). PHP מנסה לשלוח אימייל באמצעות sendmail במערכת המקומית, וייתכן מוגדר ברכיב php.ini של PHP חדש.
בפורטלים של סביבת ייצור, אפשר להשתמש במודול ה-SMTP שמתואר בהמשך כדי לשלוח אימייל דרך שרת SMTP או שרת חברה.
הגדרת שרת SMTP
פורטל המפתחים מחייב להגדיר שרת SMTP לשליחת הודעות אימייל. שפת תרגום להגדיר את שרת ה-SMTP, קודם צריך להפעיל את מודול התמיכה לאימות SMTP ב-Drupal במפתח בפורטל.
לאחר הגדרת שרת ה-SMTP, כל האימיילים שנשלחים על ידי פורטל המפתחים משתמשים ב-SMTP השרת. האימיילים האלה כוללים אימיילים שנשלחו למפתחים חדשים, אימיילים שנשלחים למפתחים שהפסידו את הסיסמה שלהם ואימיילים שנשלחים למפתחים עם חשבונות חסומים.
כדי להגדיר את שרת ה-SMTP:
- מתחברים לפורטל כמשתמשים עם הרשאות אדמין או הרשאות ליצירת תוכן.
- בוחרים באפשרות מודולים בתפריט הניהול של Drupal.
הדף 'מודולים' ייפתח. - מפעילים את המודול תמיכה באימות SMTP.
- שומרים את ההגדרות האישיות.
- לאחר שהמודול מופעל, בוחרים הגדרה באימות SMTP
רשומת תמיכה בדף 'מודולים'.
יופיע דף ההגדרות של 'תמיכה באימות SMTP'. - בקטע הפעלת המודול הזה או הפעלתו, בוחרים באפשרות הפעלה.
- באזור ההגדרות של שרת SMTP, מזינים את הפרטים הבאים:
- כתובת שרת SMTP. לדוגמה, עבור שרת ה-SMTP היוצא של Gmail, יש להשתמש בכתובת smtp.gmail.com.
- אפשר להזין את כתובת שרת ה-SMTP לגיבוי. הערך הזה אינו נדרש.
- מזינים את יציאת ה-SMTP. הערך של היציאה הזו יכול להיות שונה בהתאם פרוטוקול ההצפנה שנבחר. לדוגמה, ב-Gmail, היציאה היא 465 כשמשתמשים ב-SSL ו-587 ל-TLS.
- בוחרים את פרוטוקול ההצפנה הרצוי: ללא, SSL, או TLS.
- באזור אימות SMTP, מציינים את שם המשתמש והסיסמה שבהם נעשה שימוש לאימות SMTP. השם צריך להיות שם משתמש וסיסמה תקפים בשרת ה-SMTP.
- בקטע אפשרויות אימייל, מזינים את כתובת האימייל ואת שם המשתמש אנחנו יוצרים את הודעת האימייל. הערכים האלה תואמים לעמודה 'מאת'. כתובת האימייל.
- אופציונלי, בקטע שליחת הודעת אימייל לבדיקה, מזינים כתובת אימייל הפורטל שולח הודעת בדיקה.
- שומרים את ההגדרות האישיות.
שמירת ההגדרות האישיות יוצרת את הודעת האימייל לבדיקה ומציגה את ההגדרות שגיאות. בדקו את תיבת הדואר הנכנס של כתובת האימייל של הודעת הבדיקה כדי לוודא שהיא מגיע. - בוחרים באפשרות הגדרה > מערכת > פרטי האתר ב-Drupal תפריט ניהול.
- בקטע פרטי אתר, מגדירים את כתובת האימייל לאותה כתובת אימייל שצוינה
שציינתם בשלב 9.
בחלק מהמודולים של Drupal שמייצרים אימיילים משתמשים בשדה הזה כדי לקבוע את הערך 'מאת'. בכתובת של ולא את הערך שבדף 'תמיכה באימות SMTP'. - שומרים את ההגדרות האישיות.
הגדרה ועיצוב של הודעת אימייל התראות
אפשר להגדיר התראות שונות באימייל שנשלחות בתגובה לבקשות ספציפיות פעילויות כמו רישום, מחיקה, חסימה וביטול חסימה של חשבונות פיתוח.
אפשר גם לשלוט בשדה 'מאת' כתובות האימייל.
כדי להגדיר התראות באימייל:
- מתחברים לפורטל כמשתמשים עם הרשאות אדמין או הרשאות ליצירת תוכן.
- בוחרים באפשרות הגדרה > אנשים > הגדרות החשבון ב-Drupal תפריט ניהול. פעולה זו תפתח את הדף 'הגדרות חשבון'.
- בוחרים את הסוג של ההתראה באימייל בקטע 'אימיילים' שבדף ההגדרות של החשבונות. לדוגמה, אפשר לבחור באפשרות 'ברוכים הבאים (לא נדרש אישור)', שתישלח הודעת אימייל כאשר חשבון הפיתוח מאושר באופן אוטומטי בתהליך הרישום של המפתח.
- עורכים את הנושא ואת הגוף של התראת האימייל.
מציבים את הסמן בשדה, כמו נושא, ובוחרים את הסמל כדי לראות רשימה של האסימונים הזמינים בתחתית הטופס שבהם ניתן להשתמש בשדה. מופיע חלון קופץ שמאפשר לבחור אסימון להוספה, כמו בתור [user:name], תואם לשם המשתמש של המפתח. - לוחצים על Save configuration (שמירת ההגדרות האישיות).
אפשר גם לשנות את השדה 'מאת' השם והכתובת שלך בהתראה באימייל.
כדי לשנות את השדה 'מאת' שם וכתובת:
- מתחברים לפורטל כמשתמשים עם הרשאות אדמין או הרשאות ליצירת תוכן.
- בוחרים באפשרות הגדרה > מערכת > תמיכה באימות SMTP ב- תפריט ניהול של Drupal. הלחיצה תפתח את הדף 'תמיכה באימות SMTP'.
- ציון 'מאת' בשדה כתובת אימייל מאת.
- ציון 'מאת' בשדה שם אימייל מאת.
- לוחצים על Save configuration (שמירת ההגדרות האישיות).
- בוחרים באפשרות הגדרה > מערכת > פרטי האתר ב-Drupal תפריט ניהול.
- מציינים את אותה כתובת אימייל שבה השתמשתם בשלב 3 בשדה 'כתובת אימייל'.
- לוחצים על Save configuration (שמירת ההגדרות האישיות).
יצירת הודעת אימייל כשאירוע מתרחש
אחד השימושים הנפוצים בכללים הוא ליצור אימיילים בתגובה לאירוע. הפורטל מובנה תמיכה ביצירת אימיילים עבור אירועים מוגדרים מראש, למשל כשמפתח חדש רושם חשבון. עם זאת, אפשר להוסיף כללים משלכם כדי ליצור אימיילים. לדוגמה, אפשר: יוצר אימייל כשהמפתח מוסיף, מסיר או משנה אפליקציה.
בקטע הזה מוצגת דוגמה ליצירת כלל ליצירת אימייל כאשר מפתח רושם אפליקציה. יש לשנות את התהליך הזה לפי הצורך כדי ליצור אימיילים לאירועים אחרים.
כדי ליצור אימייל כשמפתח יוצר אפליקציה:
- מתחברים לפורטל כמשתמשים עם הרשאות אדמין או הרשאות ליצירת תוכן.
- בוחרים באפשרות מודולים בתפריט הניהול של Drupal.
- מוודאים שהמודול ממשק המשתמש של הכללים מופעל.
- בוחרים באפשרות הגדרה > תהליך עבודה > כללים בניהול של Drupal תפריט הדף 'כללים' ייפתח.
- לוחצים על הלחצן הוספת כלל חדש.
- בדף הכללים החדשים, מציינים:
- הכלל שם, לדוגמה 'שליחת כלל באימייל'.
- אפשר לציין תגים שמשמשים לסיווג הכללים לחפש
- בתפריט הנפתח React on event (תגובה לאירוע), בוחרים באפשרות Devconnect > בעת היצירה של אפליקציה למפתחים.
- שומרים את הכלל.
שמירת הכלל פותחת את טופס העריכה 'כללים' עם שלוש חלוניות: אירועים (שבאמצעותן אפשר נוצרו לאחרונה), תנאים ופעולות. - בקטע פעולות, בוחרים באפשרות הוספת פעולה.
- בתפריט הנפתח בחירת הפעולה להוספה, בוחרים באפשרות מערכת >
שליחת אימייל.
כשבוחרים באפשרות הזו, נפתח דף שמאפשר לעצב את הודעת האימייל. השתמשו בטופס הזה כדי לציין את השדה 'אל', 'נושא', 'הודעה' ושדות אחרים של האימייל.
מרחיבים את הקישור של תבניות ההחלפה מתחת לכל שדה כדי לראות את הרשימה של שבהם אפשר להשתמש בשדה. לדוגמה, אם מרחיבים את 'דפוסי החלפה' בקטע בשדה 'אל' תופיע רשימה של דפוסים שכוללים את [app:developer]. אם מציינים את הפרמטר הזה בשדה 'אל', האימייל יישלח ליוצר האפליקציה. - הגדרת השדות כפי שמוצג בהמשך:
- בוחרים באפשרות שמירה כדי לחזור לדף עריכת הכללים.
- לוחצים על שמירת השינויים.
כדי לבדוק את הכלל, צריך להוסיף אפליקציה חדשה בפורטל. אמורה להגיע אליך התראה באימייל בעוד תגובה שנראית כך:
Subject: App test email app created App: test email app API products: PremiumWeatherAPI, weatherapikey-Product Created at: Mon, 01/27/2014 - 10:16