Email

Konektor Email memungkinkan Anda melakukan operasi penyisipan, penghapusan, pembaruan, dan pembacaan pada database IMAP.

Sebelum memulai

Sebelum menggunakan konektor Email, lakukan tugas berikut:

  • Di project Google Cloud Anda:
    • Pastikan konektivitas jaringan sudah disiapkan. Untuk mengetahui informasi tentang pola jaringan, lihat Konektivitas jaringan.
    • Berikan peran IAM roles/connectors.admin kepada pengguna yang mengonfigurasi konektor.
    • Berikan peran IAM berikut ke akun layanan yang ingin Anda gunakan untuk konektor:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Akun layanan adalah jenis Akun Google khusus yang dimaksudkan untuk mewakili pengguna non-manusia yang perlu diautentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika tidak memiliki akun layanan, Anda harus membuat akun layanan. Untuk informasi selengkapnya, lihat Membuat akun layanan.

    • Aktifkan layanan berikut:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      Untuk memahami cara mengaktifkan layanan, lihat Mengaktifkan layanan.

    Jika layanan atau izin ini belum diaktifkan untuk project Anda sebelumnya, Anda akan diminta untuk mengaktifkannya saat mengonfigurasi konektor.

Mengonfigurasi konektor

Untuk mengonfigurasi konektor, Anda harus membuat koneksi ke sumber data (sistem backend). Koneksi bersifat khusus untuk sumber data. Artinya, jika memiliki banyak sumber data, Anda harus membuat koneksi terpisah untuk setiap sumber data. Untuk membuat koneksi, lakukan langkah-langkah berikut:

  1. Di konsol Cloud, buka halaman Konektor Integrasi > Koneksi, lalu pilih atau buat project Google Cloud.

    Buka halaman Koneksi

  2. Klik + Buat baru untuk membuka halaman Buat Koneksi.
  3. Di bagian Location, pilih lokasi untuk koneksi.
    1. Region: Pilih lokasi dari menu drop-down.

      Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.

    2. Klik Berikutnya.
  4. Di bagian Connection Details, selesaikan tindakan berikut:
    1. Konektor: Pilih Email dari menu drop-down Konektor yang tersedia.
    2. Versi konektor: Pilih versi Konektor dari menu drop-down versi yang tersedia.
    3. Di kolom Connection Name, masukkan nama untuk instance Connection.

      Nama koneksi harus memenuhi kriteria berikut:

      • Nama koneksi dapat menggunakan huruf, angka, atau tanda hubung.
      • Huruf harus berupa huruf kecil.
      • Nama koneksi harus diawali dengan huruf dan diakhiri dengan huruf atau angka.
      • Nama koneksi tidak boleh melebihi 49 karakter.
    4. (Opsional) Deskripsi: Masukkan deskripsi untuk koneksi.
    5. Secara opsional, aktifkan Cloud Logging, lalu pilih level log. Secara default, level log ditetapkan ke Error.
    6. Service Account: Pilih akun layanan yang memiliki peran yang diperlukan.
    7. Protokol: Jenis server email yang akan dihubungkan. Nilai yang valid adalah IMAP dan POP.
    8. Tingkat Verbosity: Kolom ini menentukan jumlah detail yang ingin Anda sertakan dalam file log. Nilai yang valid berkisar dari 1 hingga 5. Tingkat panjang informasi yang lebih tinggi akan mencatat semua detail komunikasi, termasuk permintaan, respons, dan sertifikat SSL.
    9. Secara opsional, konfigurasikan Setelan node koneksi:

      • Jumlah node minimum: Masukkan jumlah minimum node koneksi.
      • Maximum number of nodes: Masukkan jumlah maksimum node koneksi.

      Node adalah unit (atau replika) koneksi yang memproses transaksi. Semakin banyak node yang diperlukan untuk memproses lebih banyak transaksi untuk koneksi, dan sebaliknya, semakin sedikit node yang diperlukan untuk memproses lebih sedikit transaksi. Untuk memahami pengaruh node terhadap harga konektor, lihat Harga untuk node koneksi. Jika Anda tidak memasukkan nilai apa pun, secara default, node minimum ditetapkan ke 2 (untuk ketersediaan yang lebih baik) dan node maksimum ditetapkan ke 50.

    10. Gunakan proxy: Centang kotak ini untuk mengonfigurasi server proxy untuk koneksi dan konfigurasi nilai berikut:
      • Proxy Auth Scheme: Pilih jenis autentikasi untuk mengautentikasi dengan server proxy. Jenis autentikasi berikut didukung:
        • Dasar: Autentikasi HTTP dasar.
        • Digest: Ringkasan autentikasi HTTP.
      • Pengguna Proxy: Nama pengguna yang akan digunakan untuk mengautentikasi dengan server proxy.
      • Sandi Proxy: Secret Secret Manager dari sandi pengguna.
      • Proxy SSL Type: Jenis SSL yang akan digunakan saat terhubung ke server proxy. Jenis autentikasi berikut didukung:
        • Otomatis: Setelan default. Jika URL adalah URL HTTPS, opsi Tunnel akan digunakan. Jika URL adalah URL HTTP, opsi NEVER akan digunakan.
        • Selalu: Koneksi selalu mengaktifkan SSL.
        • Tidak pernah: Koneksi tidak mengaktifkan SSL.
        • Tunnel: Koneksi dilakukan melalui proxy tunneling. Server proxy membuka koneksi ke host jarak jauh dan traffic mengalir bolak-balik melalui proxy.
      • Di bagian Server Proxy, masukkan detail server proxy.
        1. Klik + Tambahkan tujuan.
        2. Pilih Jenis Tujuan.
          • Alamat host: Tentukan nama host atau alamat IP tujuan.

            Jika Anda ingin membuat koneksi pribadi ke sistem backend, lakukan langkah berikut:

    11. Secara opsional, klik + Tambahkan label untuk menambahkan label ke Koneksi dalam bentuk pasangan nilai kunci.
    12. Klik Berikutnya.
  5. Di bagian Destinations, masukkan detail nama atau alamat server email yang ingin Anda hubungkan. Server mendukung protokol IMAP atau POP.
    1. Jenis Tujuan: Pilih Jenis Tujuan. Misalnya, masukkan alamat host dan nomor port. Misalnya, alamat host adalah outlook.office365.com dan port adalah 993.
      • Pilih Host address dari daftar untuk menentukan nama host atau alamat IP tujuan.
      • Jika Anda ingin membuat koneksi pribadi ke sistem backend, pilih Endpoint attachment dari daftar, lalu pilih lampiran endpoint yang diperlukan dari daftar Endpoint Attachment.

      Jika ingin membuat koneksi publik ke sistem backend dengan keamanan tambahan, Anda dapat mempertimbangkan untuk mengonfigurasi alamat IP keluar statis untuk koneksi, lalu mengonfigurasi aturan firewall untuk hanya mengizinkan alamat IP statis tertentu.

    2. Jika Anda ingin mengirim email, tambahkan detail server SMTP di bagian SMTPServer dengan mengklik +Tambahkan tujuan. Kemudian, lakukan hal berikut:
      • Masukkan alamat host dan nomor port. Misalnya, alamat host adalah smtp-mail.outlook.com dan port adalah 587.
    3. Klik Berikutnya.
  6. Di bagian Authentication, masukkan detail autentikasi.
    1. Pilih Jenis autentikasi dan masukkan detail yang relevan.

      Jenis autentikasi berikut didukung oleh koneksi Email:

      • Nama pengguna dan sandi
    2. Untuk memahami cara mengonfigurasi jenis autentikasi ini, lihat Mengonfigurasi autentikasi.

    3. Klik Berikutnya.
  7. Tinjau: Tinjau detail koneksi dan autentikasi Anda.
  8. Klik Create.

Mengonfigurasi autentikasi

Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.

  • Nama pengguna dan sandi
    • Nama pengguna: Pengguna akun Email yang digunakan untuk mengautentikasi.
    • Sandi: Secret Secret Manager yang berisi sandi akun email yang digunakan untuk mengautentikasi.

Entity, operasi, dan tindakan

Semua Konektor Integrasi menyediakan lapisan abstraksi untuk objek aplikasi yang terhubung. Anda hanya dapat mengakses objek aplikasi melalui abstraksi ini. Abstraksi ditampilkan kepada Anda sebagai entitas, operasi, dan tindakan.

  • Entity: Entity dapat dianggap sebagai objek, atau kumpulan properti, dalam aplikasi atau layanan yang terhubung. Definisi entitas berbeda dari konektor ke konektor. Misalnya, dalam konektor database, tabel adalah entitas, dalam konektor server file, folder adalah entitas, dan dalam konektor sistem pesan, antrean adalah entitas.

    Namun, mungkin konektor tidak mendukung atau memiliki entity apa pun, dalam hal ini, daftar Entities akan kosong.

  • Operasi: Operasi adalah aktivitas yang dapat Anda lakukan pada entity. Anda dapat melakukan salah satu operasi berikut pada entitas:

    Memilih entitas dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entitas tersebut. Untuk deskripsi mendetail tentang operasi, lihat operasi entity tugas Konektor. Namun, jika konektor tidak mendukung operasi entitas apa pun, operasi yang tidak didukung tersebut tidak akan tercantum dalam daftar Operations.

  • Tindakan: Tindakan adalah fungsi kelas satu yang tersedia untuk integrasi melalui antarmuka konektor. Tindakan memungkinkan Anda membuat perubahan pada satu atau beberapa entitas, dan bervariasi dari satu konektor ke konektor lainnya. Biasanya, tindakan akan memiliki beberapa parameter input, dan parameter output. Namun, konektor mungkin tidak mendukung tindakan apa pun, dalam hal ini daftar Actions akan kosong.

Batasan sistem

Konektor Email dapat memproses 1 transaksi per detik, per node, dan mencegah transaksi apa pun melebihi batas ini. Secara default, Konektor Integrasi mengalokasikan 2 node (untuk ketersediaan yang lebih baik) untuk koneksi.

Untuk mengetahui informasi tentang batas yang berlaku untuk Konektor Integrasi, lihat Batas.

Tindakan

Bagian ini mencantumkan tindakan yang didukung oleh konektor. Untuk memahami cara mengonfigurasi tindakan, lihat Contoh tindakan.

Tindakan MoveEmails

Parameter input tindakan MoveEmails

Nama parameter Jenis data Wajib Deskripsi
Deskripsi String Ya Kotak surat tempat pesan akan dipindahkan.
Kotak surat String Ya Kotak surat tempat pesan saat ini berada.
ID String Ya Input ini menunjukkan kumpulan pesan yang akan dioperasikan. ID ini dapat terdiri dari satu ID pesan, rentang pesan yang ditentukan oleh dua nomor pesan yang dipisahkan oleh ':' (misalnya '1:5'), dan/atau setiap nomor pesan yang dipisahkan oleh ',' (misalnya '1:5,7,10').

Misalnya, cara mengonfigurasi tindakan MoveEmails, lihat Contoh tindakan.

Tindakan SendMailMessages

Parameter input tindakan SendMailMessages

Nama parameter Jenis data Wajib Deskripsi
BCC String Tidak Daftar nama dan alamat email penerima BCC yang dipisahkan titik koma.
Prioritas String Tidak Prioritas pesan email.
Sensitivitas String Tidak Sensitivitas pesan email.
Lampiran String Ya Daftar nama file lampiran yang dipisahkan titik koma (dengan jalur jika membaca dari file) yang disertakan dalam pesan.
MessageBody String Ya Isi pesan.
AttachmentData String Ya Daftar yang dipisahkan titik koma dari data lampiran yang dienkode base-64 yang disertakan dalam pesan. (Anda tetap harus menentukan nama file di Lampiran.
InlineImage String Ya Daftar ID gambar inline (cid) yang dipisahkan titik koma untuk disertakan dalam pesan.
DeliveryNotification String Tidak Alamat email yang akan menerima notifikasi pengiriman.
InlineImageData String Ya Daftar data gambar berenkode base-64 yang dipisahkan titik koma untuk disertakan dalam pesan.
CC String Tidak Daftar nama dan alamat email penerima yang di-CC yang dipisahkan titik koma.
InlineImageContent String Tidak Konten sebagai InputStream yang akan diupload.
Dari String Tidak Alamat email pengirim.
Ke String Tidak Daftar nama dan alamat email penerima yang dipisahkan titik koma.
Subjek String Ya Subjek pesan email.
AttachmentContent String Tidak Konten sebagai InputStream yang akan diupload.
Charset String Tidak Kumpulan karakter yang akan digunakan dalam pesan.
ReadReceipt String Tidak Alamat email yang akan menerima tanda dibaca.
IsHTML String Tidak Apakah email tersebut dalam format HTML atau teks biasa.
Tingkat kepentingan String Tidak Pentingnya pesan email.

Misalnya, cara mengonfigurasi tindakan SendMailMessages, lihat Contoh tindakan.

Tindakan SetLabels

Parameter input tindakan SetLabels

Nama parameter Jenis data Wajib Deskripsi
OperationType String Ya Ini menunjukkan apakah label yang ditentukan harus ditambahkan, dihapus, atau menggantikan daftar label yang ada.
Kotak surat String Ya Kotak surat Gmail tempat pesan berada.
ID String Ya Input ini menunjukkan kumpulan pesan yang akan dioperasikan. ID ini dapat terdiri dari satu ID pesan, rentang pesan yang ditentukan oleh dua nomor pesan yang dipisahkan oleh ':' (misalnya '1:5'), dan/atau setiap nomor pesan yang dipisahkan oleh ',' (misalnya '1:5,7,10').
Label String Ya Daftar label yang akan ditetapkan ke pesan yang ditentukan oleh properti MessageSet. Input ini harus ditetapkan ke daftar label yang dipisahkan koma.

Misalnya, cara mengonfigurasi tindakan SetLabels, lihat Contoh tindakan.

Tindakan SetFlag

Parameter input tindakan SetFlag

Nama parameter Jenis data Wajib Deskripsi
OperationType String Ya Ini menunjukkan apakah flag yang ditentukan harus ditambahkan, dihapus, atau mengganti daftar flag yang ada.
Kotak surat String Ya Kotak surat tempat pesan berada.
ID String Ya Input ini menunjukkan kumpulan pesan yang akan dioperasikan. ID ini dapat terdiri dari satu ID pesan, rentang pesan yang ditentukan oleh dua nomor pesan yang dipisahkan oleh ':' (misalnya '1:5'), dan/atau setiap nomor pesan yang dipisahkan oleh ',' (misalnya '1:5,7,10').
Flag String Ya Menetapkan flag yang ditentukan ke pesan yang ditentukan oleh kumpulan pesan. (mis., Telah Dilihat, Dihapus, Draf,ditandai). Flag harus ditentukan sebagai daftar yang dipisahkan koma(misalnya, Dilihat, Dihapus, ditandai)

Misalnya, cara mengonfigurasi tindakan SetFlag, lihat Contoh tindakan.

Contoh

Contoh tindakan

Contoh - Memindahkan email

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan MoveEmails, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
     {
    "Destination": "Inbox",
    "Mailbox": "Archive",
    "Id": "1"
    }
  4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas MoveEmails akan memiliki nilai yang mirip dengan berikut:

    [{
    "Success": "true",
    "rss:title": "Message(s) moved successfully."
    }] 

Contoh - Mengirim email

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan SendMailMessages, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
     {
    "MessageBody": "This mail is generated by using action sendmailmessage for outlook server.",
    "To": "test97@gmail.com",
    "Subject": "Outlook SMTP\n server."
    }
  4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas SendMailMessages akan memiliki nilai yang mirip dengan berikut:

    [{
     "MessageId": "4797386f18288a7441c5317a459b8340e857@outlook.com"
    }]

Contoh - Mengirim email dengan lampiran

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan SendMailMessages, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
     {
    "MessageBody": "This mail is generated by using action sendmailmessage for outlook server.",
    "To": "test97@gmail.com",
    "Subject": "Outlook SMTP PDF Mail.",
    "Attachment": "Testing.pdf",
    "AttachmentData": "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuz1xj6j3/gb09Wma83/dLbs7L9N03T/dHh6ArlrRiZdCU98lR5A3h9FD
    ...[too long to view on UI. Please download the log to view the full content.]
    }    
  4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas SendMailMessages akan memiliki nilai yang mirip dengan berikut:

    [{
    "MessageId": "1e96993a6053845c65ee44e6b4153d585e@outlook.com"
    }]

Contoh - Menetapkan label

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan SetLabels, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
     {
    "Labels": "GoogleCloud_Testing",
    "OperationType": "ADD",
    "Mailbox": "Inbox",
    "Id": "1"
    }
  4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas SetLabels akan memiliki nilai yang mirip dengan berikut:

    [{
    "Success": "true",
    "rss:title": "Message labels set correctly."
    }]

Contoh - Menetapkan tanda

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan SetFlag, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
    {
    "Mailbox": "Sent",
    "Id": "1",
    "Flags": "Draft",
    "OperationType": "ADD"
    }
  4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas SetFlag akan memiliki nilai yang mirip dengan berikut:

    [{
    "Success": "true",
    "rss:title": "Message flags set correctly."
    }]

Contoh - Menetapkan flag ke email tertentu

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan SetFlag, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
    {
    "Mailbox": "Sent",
    "Id": "1",
    "Flags": "Flagged",
    "OperationType": "ADD"
    }
  4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas SetFlag akan memiliki nilai yang mirip dengan berikut:

    [{
    "Success": "true",
    "rss:title": "Message flags set correctly."
    }]

Contoh operasi entity

Bagian ini menunjukkan cara melakukan beberapa operasi entity di konektor ini.

Contoh - Mencantumkan semua email

  1. Pada dialog Configure connector task, klik Entities.
  2. Pilih Inbox dari daftar Entity.
  3. Pilih operasi LIST, lalu klik Selesai.
  4. Secara opsional, di bagian Input Tugas pada tugas Konektor, Anda dapat memfilter set hasil dengan menentukan klausa filter. Tentukan nilai klausa filter selalu dalam tanda kutip tunggal (').

Contoh - Mendapatkan satu email

  1. Pada dialog Configure connector task, klik Entities.
  2. Pilih Inbox dari daftar Entity.
  3. Pilih operasi GET, lalu klik Selesai.
  4. Di bagian Task Input pada tugas Connectors, klik EntityId, lalu masukkan 1 di kolom Default Value.

    Di sini, 1 adalah ID data unik dalam entitas Inbox.

Contoh - Menghapus email

  1. Pada dialog Configure connector task, klik Entities.
  2. Pilih Inbox dari daftar Entity.
  3. Pilih operasi DELETE, lalu klik Selesai.
  4. Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan 1 di kolom Default Value.

Menggunakan terraform untuk membuat koneksi

Anda dapat menggunakan resource Terraform untuk membuat koneksi baru.

Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar Terraform.

Untuk melihat contoh template terraform untuk pembuatan koneksi, lihat contoh template.

Saat membuat koneksi ini menggunakan Terraform, Anda harus menetapkan variabel berikut dalam file konfigurasi Terraform:

Nama parameter Jenis data Wajib Deskripsi
protokol STRING Benar Jenis server email yang akan dihubungkan.
proxy_enabled BOOLEAN Salah Centang kotak ini untuk mengonfigurasi server proxy untuk koneksi.
proxy_auth_scheme ENUM Salah Jenis autentikasi yang akan digunakan untuk mengautentikasi ke proxy ProxyServer. Nilai yang didukung adalah: BASIC, DIGEST, NONE
proxy_user STRING Salah Nama pengguna yang akan digunakan untuk mengautentikasi ke proxy ProxyServer.
proxy_password SECRET Salah Sandi yang akan digunakan untuk melakukan autentikasi ke proxy ProxyServer.
proxy_ssltype ENUM Salah Jenis SSL yang akan digunakan saat terhubung ke proxy ProxyServer. Nilai yang didukung adalah: AUTO, ALWAYS, NEVER, TUNNEL

Menggunakan koneksi Email dalam integrasi

Setelah Anda membuat koneksi, koneksi tersebut akan tersedia di Integration Apigee dan Integration Aplikasi. Anda dapat menggunakan koneksi dalam integrasi melalui tugas Konektor.

  • Untuk memahami cara membuat dan menggunakan tugas Konektor di Apigee Integration, lihat Tugas konektor.
  • Untuk memahami cara membuat dan menggunakan tugas Konektor di Integrasi Aplikasi, lihat Tugas konektor.

Mendapatkan bantuan dari komunitas Google Cloud

Anda dapat memposting pertanyaan dan mendiskusikan konektor ini di komunitas Google Cloud di Cloud Forums.

Langkah selanjutnya