Email

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

Sebelum memulai

Sebelum menggunakan konektor Email, lakukan tugas berikut:

  • Di project Google Cloud Anda:
    • 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 melakukan autentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika tidak memiliki akun layanan, Anda harus membuat akun layanan. Untuk mengetahui 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

Mengonfigurasi konektor mengharuskan Anda 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 Integration Connectors > Connections, lalu pilih atau buat project Google Cloud.

    Buka halaman Connections

  2. Klik + Create new untuk membuka halaman Create Connection.
  3. Di bagian Lokasi, pilih lokasi untuk koneksi.
    1. Region: Pilih lokasi dari menu drop-down.

      Untuk mengetahui daftar semua wilayah yang didukung, lihat Lokasi.

    2. Klik Next.
  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 kecil.
      • Nama koneksi harus dimulai dengan huruf dan diakhiri dengan huruf atau angka.
      • Nama koneksi tidak boleh lebih dari 63 karakter.
    4. Secara opsional, masukkan Deskripsi untuk instance koneksi.
    5. Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
    6. Secara opsional, konfigurasikan Setelan node koneksi:

      • Jumlah minimum node: Masukkan jumlah minimum node koneksi.
      • Jumlah maksimum node: Masukkan jumlah maksimum node koneksi.

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

    7. Server: Nama atau alamat server email. Mendukung IMAP atau POP.
    8. Port: Port untuk server email.
    9. SMTPServer: Nama atau alamat server email (Server SMTP).
    10. SMTPPort: Port server untuk SMTP (default 25).
    11. Protokol: Jenis server email yang akan dihubungkan.
    12. Use proxy: Centang kotak ini guna mengonfigurasi server proxy untuk koneksi dan mengonfigurasi nilai berikut:
      • Proxy Auth Scheme: Pilih jenis autentikasi untuk mengautentikasi dengan server proxy. Jenis autentikasi berikut didukung:
        • Dasar: Autentikasi HTTP dasar.
        • Ringkasan: Autentikasi HTTP ringkasan.
      • Pengguna Proxy: Nama pengguna yang akan digunakan untuk melakukan autentikasi dengan server proxy.
      • Sandi Proxy: Rahasia Secret manager sandi pengguna.
      • Jenis SSL Proxy: 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 JANGAN digunakan.
        • Selalu: Koneksi selalu mengaktifkan SSL.
        • Tidak pernah: Koneksi tidak mengaktifkan SSL.
        • Tunnel: Koneksi 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 ingin membuat koneksi pribadi ke sistem backend Anda, lakukan hal berikut:

    13. Secara opsional, klik + Add label untuk menambahkan label ke Connection dalam bentuk key-value pair.
    14. Klik Next.
  5. Di bagian Destinations, masukkan detail host jarak jauh (sistem backend) yang ingin Anda hubungkan.
    1. Jenis Tujuan: Pilih Jenis Tujuan.
      1. Di kolom Host address, tentukan nama host atau alamat IP tujuan.
        1. Jika ingin membuat koneksi pribadi ke sistem backend, ikuti langkah-langkah berikut:
          1. Buat lampiran layanan PSC.
          2. Buat lampiran endpoint, lalu masukkan detail lampiran endpoint di kolom Alamat host.
        2. Jika ingin membuat koneksi publik ke sistem backend dengan keamanan tambahan, Anda dapat mempertimbangkan untuk mengonfigurasi alamat IP keluar statis untuk koneksi Anda, lalu mengonfigurasi aturan firewall untuk hanya mengizinkan alamat IP statis tertentu.

      Untuk memasukkan tujuan tambahan, klik +Tambahkan tujuan.

    2. Klik Next.
  6. Di bagian Authentication, masukkan detail autentikasi.
    1. Pilih Jenis autentikasi, lalu 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 Next.
  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: Rahasia Secret Manager berisi sandi akun email yang digunakan untuk mengautentikasi.

Entitas, operasi, dan tindakan

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

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

    Namun, mungkin saja konektor tidak mendukung atau memiliki entitas, 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 entity dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entity tersebut. Untuk deskripsi operasi secara mendetail, lihat operasi entity tugas Konektor. Namun, jika konektor tidak mendukung salah satu operasi entity, operasi yang tidak didukung tersebut tidak akan dicantumkan dalam daftar Operations.

  • Tindakan: Tindakan adalah fungsi kelas pertama 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. Namun, mungkin saja konektor tidak mendukung tindakan apa pun, dalam hal ini daftar Actions akan kosong.

Keterbatasan sistem

Konektor Email dapat memproses 1 transaksi per detik, per node, dan men-throttle semua transaksi di luar batas ini. Secara default, Integration Connectors mengalokasikan 2 node (untuk ketersediaan yang lebih baik) untuk satu koneksi.

Untuk 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 Diperlukan 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. Ini dapat terdiri dari ID pesan tunggal, rentang pesan yang ditentukan oleh dua nomor pesan yang dipisahkan dengan ':' (misalnya '1:5'), dan/atau nomor pesan individual yang dipisahkan oleh ',' (misalnya '1:5,7,10').

Untuk mengetahui contoh cara mengonfigurasi tindakan MoveEmails, lihat Contoh tindakan.

Tindakan SendMailMessages

Parameter input tindakan SendMailMessages

Nama parameter Jenis data Diperlukan 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) disertakan dalam pesan.
MessageBody String Ya Isi pesan.
AttachmentData String Ya Daftar yang dipisahkan titik koma dari data lampiran berenkode base-64 yang disertakan dalam pesan. (Anda tetap harus menentukan nama file dalam Lampiran.
InlineImage String Ya Daftar yang dipisahkan titik koma dari ID gambar inline (cid) yang akan disertakan dalam pesan.
DeliveryNotification String Tidak Alamat email yang akan dikirimi notifikasi pengiriman.
InlineImageData String Ya Daftar yang dipisahkan titik koma dari data gambar berenkode base-64 yang akan disertakan dalam pesan.
CC String Tidak Daftar nama dan alamat email penerima yang dipisahkan dengan titik koma.
InlineImageContent String Tidak Konten sebagai InputStream yang akan diupload.
Dari String Tidak Alamat email pengirim.
Kepada 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 Himpunan karakter yang akan digunakan dalam pesan.
ReadReceipt String Tidak Alamat email yang akan dikirimi tanda sudah dibaca.
IsHTML String Tidak Apakah email berupa HTML atau teks biasa.
Tingkat kepentingan String Tidak Pentingnya pesan email.

Untuk mengetahui contoh cara mengonfigurasi tindakan SendMailMessages, lihat Contoh tindakan.

Tindakan SetLabels

Parameter input tindakan SetLabels

Nama parameter Jenis data Diperlukan Deskripsi
OperationType String Ya Ini menunjukkan apakah label tertentu harus ditambahkan, dihapus, atau diganti dengan 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. Ini dapat terdiri dari ID pesan tunggal, rentang pesan yang ditentukan oleh dua nomor pesan yang dipisahkan dengan ':' (misalnya '1:5'), dan/atau nomor pesan individual 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 disetel ke daftar label yang terpisah koma.

Untuk mengetahui contoh cara mengonfigurasi tindakan SetLabels, lihat Contoh tindakan.

Tindakan SetelFlag

Parameter input tindakan SetFlag

Nama parameter Jenis data Diperlukan Deskripsi
OperationType String Ya Ini menunjukkan cuaca pada bendera yang ditentukan harus ditambahkan, dihapus, atau mengganti daftar bendera yang sudah ada.
Kotak surat String Ya Kotak surat tempat pesan berada.
ID String Ya Input ini menunjukkan kumpulan pesan yang akan dioperasikan. Ini dapat terdiri dari ID pesan tunggal, rentang pesan yang ditentukan oleh dua nomor pesan yang dipisahkan dengan ':' (misalnya '1:5'), dan/atau nomor pesan individual yang dipisahkan oleh ',' (misalnya '1:5,7,10').
Flag String Ya Menetapkan flag yang ditetapkan ke pesan yang ditentukan oleh kumpulan pesan. (mis., Dilihat, Dihapus, Draf,ditandai). Tanda harus ditentukan sebagai daftar yang dipisahkan koma(misalnya, Seen,Deleted,flagged)

Untuk mengetahui contoh cara mengonfigurasi tindakan SetFlag, lihat Contoh tindakan.

Contoh

Contoh tindakan

Contoh - Memindahkan email

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan MoveEmails, lalu klik Done.
  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 tersebut berhasil, parameter respons connectorOutputPayload tugas MoveEmails akan memiliki nilai yang mirip dengan yang berikut:

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

Contoh - Mengirim email

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan SendMailMessages, lalu klik Done.
  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 tersebut berhasil, parameter respons connectorOutputPayload tugas SendMailMessages akan memiliki nilai yang mirip dengan yang berikut:

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

Contoh - Mengirim email dengan lampiran

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan SendMailMessages, lalu klik Done.
  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 tersebut berhasil, parameter respons connectorOutputPayload tugas SendMailMessages akan memiliki nilai yang mirip dengan yang berikut:

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

Contoh - Menetapkan label

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan SetLabels, lalu klik Done.
  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 tersebut berhasil, parameter respons connectorOutputPayload tugas SetLabels akan memiliki nilai yang mirip dengan yang berikut:

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

Contoh - Tetapkan flag

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan SetFlag, lalu klik Done.
  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 tersebut berhasil, parameter respons connectorOutputPayload tugas SetFlag akan memiliki nilai yang mirip dengan yang berikut:

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

Contoh - Menetapkan tanda ke email tertentu

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan SetFlag, lalu klik Done.
  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 tersebut berhasil, parameter respons connectorOutputPayload tugas SetFlag akan memiliki nilai yang mirip dengan yang berikut:

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

Contoh operasi entitas

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

Contoh - Menampilkan daftar semua email

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

Contoh - Dapatkan satu email

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Inbox dari daftar Entity.
  3. Pilih operasi GET, lalu klik Done.
  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 entity Inbox.

Contoh - Menghapus email

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

Gunakan 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 Diperlukan Deskripsi
protokol STRING Benar Jenis server email yang akan dihubungkan.
proxy_enabled BOOLEAN Salah Pilih kotak centang 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 mengautentikasi ke proxy ProxyServer.
proxy_ssltype ENUM Salah Jenis SSL yang akan digunakan saat menghubungkan ke proxy ProxyServer. Nilai yang didukung adalah: AUTO, ALWAYS, NEVER, WorkManager

Menggunakan koneksi Email dalam integrasi

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

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

Dapatkan bantuan dari komunitas Google Cloud

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

Langkah selanjutnya