Mengonfigurasi email

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X.
info

Secara default, portal Layanan Developer mengirim email sebagai respons terhadap peristiwa tertentu. Misalnya, saat developer baru mendaftar di portal, portal akan otomatis mengirimkan email selamat datang ke developer. Atau, jika developer kehilangan sandi, developer dapat meminta email dengan sandi sementara.

Sebagai penyedia API, Anda dapat mengontrol semua aspek email yang dihasilkan oleh portal, termasuk:

  • Memformat email otomatis yang dikirim oleh portal
  • Menentukan server SMTP yang digunakan oleh portal
  • Menambahkan aturan untuk membuat email sebagai respons terhadap peristiwa di portal

Mengirim email dari portal berbasis cloud

Konfigurasi email default untuk portal berbasis cloud yang di-deploy di Pantheon atau Acquia hanya boleh digunakan di lingkungan non-produksi. Email yang dikirim dari server cloud anonim dapat diblokir atau ditandai sebagai spam.

Untuk portal produksi, gunakan salah satu opsi berikut untuk mengirim email:

Mengirim email dari portal lokal

Secara default, email dikirim menggunakan fungsi PHP mail(). PHP mencoba mengirim email menggunakan sendmail di sistem lokal, yang dapat dikonfigurasi dalam file php.ini PHP.

Untuk portal produksi, Anda dapat menggunakan modul SMTP yang dijelaskan di bawah untuk mengirim email melalui server SMTP atau server perusahaan.

Mengonfigurasi server SMTP

Portal developer mewajibkan Anda mengonfigurasi server SMTP untuk mengirim pesan email. Untuk mengonfigurasi server SMTP, Anda harus terlebih dahulu mengaktifkan modul Dukungan Autentikasi SMTP Drupal di portal developer.

Setelah mengonfigurasi server SMTP, semua email yang dikirim oleh portal developer akan menggunakan server SMTP. Email ini mencakup email yang dikirimkan kepada developer baru, email yang dikirimkan kepada developer yang kehilangan sandi, dan email yang dikirimkan kepada developer dengan akun yang diblokir.

Untuk mengonfigurasi server SMTP:

  1. Login ke portal Anda sebagai pengguna yang memiliki hak istimewa pembuatan konten atau admin.
  2. Pilih Modules di menu administrasi Drupal.
    Halaman Modules akan terbuka.
  3. Aktifkan modul SMTP Authentication Support.
  4. Simpan konfigurasi.
  5. Setelah modul diaktifkan, pilih Configure pada entri SMTP Authentication Support pada halaman Modules.
    Halaman konfigurasi Dukungan Autentikasi SMTP akan muncul.
  6. Di bagian Turn this module on or off, pilih On.
  7. Di area setelan server SMTP, masukkan informasi berikut:
    • Alamat server SMTP. Misalnya, untuk server SMTP keluar Gmail, gunakan smtp.gmail.com.
    • Secara opsional, masukkan alamat server SMTP cadangan. Nilai ini tidak diperlukan.
    • Masukkan port SMTP. Nilai port ini dapat berbeda berdasarkan protokol enkripsi yang dipilih. Misalnya, untuk Gmail, port-nya adalah 465 jika menggunakan SSL dan 587 untuk TLS.
    • Pilih protokol enkripsi sebagai None, SSL, atau TLS.
  8. Di area SMTP Authentication, tentukan nama pengguna dan sandi yang digunakan untuk autentikasi SMTP. Ini harus berupa nama pengguna dan sandi yang valid di server SMTP.
  9. Di bagian E-mail options, masukkan alamat email dan nama pengguna yang membuat pesan email. Nilai ini sesuai dengan alamat "Dari" pada email.
  10. Atau, di bagian Kirim pesan email uji coba, masukkan alamat email yang akan digunakan untuk mengirim pesan uji coba.
  11. Simpan konfigurasi.
    Menyimpan konfigurasi akan menghasilkan pesan email uji dan menampilkan semua error konfigurasi. Periksa kotak masuk alamat email pesan uji untuk memastikan pesan sudah diterima.
  12. Pilih Configuration > System > Site Information di menu administrasi Drupal.
  13. Di bagian Site Details, tetapkan Alamat email ke alamat email yang sama seperti yang Anda tetapkan pada Langkah 9.
    Beberapa modul Drupal yang menghasilkan email menggunakan kolom ini untuk menentukan alamat "Dari" email, bukan nilai di halaman Dukungan Autentikasi SMTP.
  14. Simpan konfigurasi.

Mengonfigurasi dan memformat notifikasi email

Anda dapat mengonfigurasi berbagai notifikasi email yang dikirim sebagai respons terhadap aktivitas tertentu, seperti mendaftar, menghapus, memblokir, dan berhenti memblokir akun developer.

Anda juga dapat mengontrol alamat "Dari" email.

Untuk mengonfigurasi notifikasi email:

  1. Login ke portal Anda sebagai pengguna yang memiliki hak istimewa pembuatan konten atau admin.
  2. Pilih Konfigurasi > Orang > Setelan akun di menu administrasi Drupal. Tindakan ini akan membuka halaman Setelan akun.
  3. Pilih jenis pemberitahuan email di bagian Email di halaman setelan Akun. Misalnya, Anda dapat memilih "Selamat datang (tidak perlu persetujuan)", yang akan mengirimkan email saat akun developer disetujui secara otomatis selama proses pendaftaran developer.

  4. Edit Subjek dan Isi notifikasi email.
    Letakkan kursor di kolom, seperti Subjek, lalu pilih link Jelajahi token yang tersedia di bagian bawah formulir untuk melihat daftar token yang dapat Anda gunakan di kolom tersebut. Pop-up akan muncul dan memungkinkan Anda memilih token yang akan ditambahkan, seperti [user:name], yang sesuai dengan nama pengguna developer.
  5. Klik Save configuration.

Anda juga dapat mengubah nama dan alamat "Dari" di notifikasi email.

Untuk mengubah nama dan alamat "Dari":

  1. Login ke portal Anda sebagai pengguna yang memiliki hak istimewa pembuatan konten atau admin.
  2. Pilih Configuration > System > SMTP Authentication Support di menu administrasi Drupal. Tindakan ini akan membuka halaman Dukungan Autentikasi SMTP.
  3. Tentukan alamat email "Dari" di kolom Email Dari Alamat.
  4. Tentukan nama "From" di kolom E-Mail From Name.
  5. Klik Save configuration.
  6. Pilih Configuration > System > Site information di menu administrasi Drupal.
  7. Tetapkan alamat email yang sama dengan yang Anda gunakan pada Langkah 3 di kolom E-Mail Address.
  8. Klik Save configuration.

Membuat email ketika suatu peristiwa terjadi

Salah satu penggunaan aturan yang umum adalah membuat email untuk merespons suatu peristiwa. Portal ini memiliki dukungan bawaan guna menghasilkan email untuk peristiwa yang telah ditentukan, seperti saat developer baru mendaftarkan akun. Namun, Anda dapat menambahkan aturan sendiri untuk membuat email. Misalnya, Anda dapat membuat email saat developer menambahkan, menghapus, atau mengubah aplikasi.

Bagian ini berisi contoh cara membuat aturan untuk menghasilkan email saat developer mendaftarkan aplikasi. Ubah prosedur ini sesuai kebutuhan guna membuat email untuk peristiwa lainnya.

Untuk membuat email saat developer membuat aplikasi:

  1. Login ke portal Anda sebagai pengguna yang memiliki hak istimewa pembuatan konten atau admin.
  2. Pilih Modules di menu administrasi Drupal.
  3. Pastikan modul UI Aturan diaktifkan.
  4. Pilih Configuration > Workflow > Rules di menu administrasi Drupal. Tindakan ini akan membuka halaman Aturan.
  5. Pilih tombol Tambahkan aturan baru.
  6. Di halaman aturan baru, tentukan:
    • Nama aturan, misalnya "Kirim aturan email".
    • Jika perlu, tentukan tag yang digunakan untuk mengategorikan aturan penelusuran.
    • Di dropdown React on event, pilih Devconnect > Setelah pembuatan aplikasi developer.
  7. Simpan aturan.
    Menyimpan aturan akan membuka formulir edit Aturan dengan tiga panel: Events (yang baru saja Anda buat), Conditions, dan Actions.
  8. Di bagian Tindakan, pilih Tambahkan tindakan.
  9. Dari menu drop-down Select the Action to Add, pilih System > send mail.
    Pilihan ini akan membuka halaman yang memungkinkan Anda memformat email. Gunakan formulir ini untuk menentukan kolom "Kepada", "Subjek", "Pesan", dan kolom email lainnya.

    Luaskan link pola Penggantian di bawah setiap kolom untuk melihat daftar pola yang dapat Anda gunakan dalam kolom. Misalnya, jika memperluas Pola penggantian pada kolom Kepada, Anda akan melihat daftar pola yang menyertakan [app:developer]. Jika Anda menentukan pola ini di kolom Kepada, email akan dikirim ke pembuat aplikasi.
  10. Tetapkan kolom seperti yang ditunjukkan di bawah:
  11. Pilih Simpan untuk kembali ke halaman pengeditan aturan.
  12. Pilih Simpan perubahan.

Uji aturan dengan menambahkan aplikasi baru di portal. Anda akan menerima notifikasi email sebagai respons yang muncul seperti di bawah ini:

Subject: App test email app created

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