Beranda>Kode sumber PHP>Kategori lainnya
Unduh

Kelas klien surat untuk Laravel 5.x

Kelas ini membantu Anda menggunakan fungsionalitas surat dari platform surat dengan kerangka kerja Laravel 5.x Anda.

Instalasi

Menggunakan komposer insert ke composer.json blok kode berikut: 

 "repositories": [
        {
            "url": "https://github.com/caereservices/mailup.git",
            "type": "git"
        }
    ], ...

"require": {
	 "caereservices/mailup": "dev-master", ...

Kemudian jalankan pembaruan komposer

Mulai

Contoh berikut menunjukkan langkah -langkah dasar untuk menggunakan kelas ini dalam kode Anda. 

 use CaereservicesMailupMailupStatus;
use CaereservicesMailupMailupException;
use CaereservicesMailupMailupClient;

$CLIENT_ID = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
$CLIENT_SECRET = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
$CALLBACK_URI = "http://localhost/callback_uri";

$USER = "mXXXXXX";
$PASSWORD = "xxxxxxxxx";

$mailUp = null;
try {
   $mailUp = new MailupClient($CLIENT_ID, $CLIENT_SECRET, $CALLBACK_URI);
   if( $mailUp ) {
      $result = $mailUp->login($USER, $PASSWORD);
      if( $result == MailupStatus::OK ) {
         ...
      }
   }
} catch (MailupException $e) {
   ...
}

$ Client_id dan $ client_secret dapat diperoleh mengikuti panduan ini

Metode yang tersedia

login 

   $result = $mailUp->login(<USER>, <PASSWORD> [, <LISTNAME>]);

Parameter:

  • Pengguna : Nama pengguna untuk platform surat (biasanya mxxxxx )
  • Kata Sandi : Kata sandi untuk platform surat
  • ListName : (Opsional) Nama Daftar Penerima untuk Digunakan, Jika Tidak Ditentukan Daftar Surat Default Digunakan

Nilai pengembalian:

  • Mailupstatus :: ok - masuk dengan benar
  • Mailupstatus :: err_not_logged_in - nama pengguna atau kata sandi salah
  • Mailupstatus :: err_invalid_parameter - satu atau banyak parameter tidak valid atau kosong
  • Mailupstatus :: err_mailup_exception - Pengecualian platform surat
  • MailUpstatus :: err_list_not_found - Jika listName ditentukan tetapi tidak ada di platform surat

DISTEL 

   $result = $mailUp->createList(<LISTNAME>, <LISTDATA>);

Parameter:

  • ListName : Nama daftar penerima untuk digunakan
  • ListData : Array dengan bidang untuk Data Daftar Isi

Bidang ListData

  • Nama - Nama daftar
  • Main_mail - Alamat email utama yang ditautkan ke daftar
  • Balas_to - Alamat email untuk balasan dari pengguna
  • sender_name - Nama pengirim yang muncul untuk pengguna saat menerima surat
  • company_name - nama perusahaan Anda
  • contact_name - nama kontak di perusahaan (kecocokan yang tidak perlu Main_mail atau Reply_to pemilik)
  • Alamat - Alamat Perusahaan Anda
  • Kota - Kota Perusahaan Anda
  • country_code - kode negara Anda (mis.
  • Perm_remind - Pengingat Izin (default "") Lihat di sini untuk informasi
  • Web_site - URL situs web Anda

Semua bidang wajib

Nilai pengembalian:

  • Mailupstatus :: OK - Daftar dibuat dengan benar
  • Mailupstatus :: err_not_logged_in - metode ini dipanggil tanpa membuat login
  • Mailupstatus :: err_invalid_parameter - satu atau banyak parameter tidak valid atau kosong
  • Mailupstatus :: err_mailup_exception - Pengecualian platform surat
  • Mailupstatus :: err_list_not_created - ListName tidak ada di platform mailup dan tidak dapat dibuat
  • Mailupstatus :: err_no_list_data - Array ListData kosong atau nol
  • Mailupstatus :: err_invalid_list_data - array listData memiliki satu atau banyak bidang kosong atau nol

Changelist 

   $result = $mailUp->changeList(<LISTNAME> [, <LISTDATA>]);

Jika ListName tidak ada dan array ListData adalah metode yang ditentukan, cobalah untuk membuatnya

Parameter:

  • ListName : Nama daftar penerima untuk digunakan
  • ListData : (Opsional) Array dengan bidang untuk Data Daftar Isi (lihat CreateList untuk Struktur Array)

Nilai pengembalian:

  • Mailupstatus :: OK - Daftar diubah dengan benar
  • Mailupstatus :: err_not_logged_in - metode ini dipanggil tanpa membuat login
  • Mailupstatus :: err_invalid_parameter - satu atau banyak parameter tidak valid atau kosong
  • Mailupstatus :: err_mailup_exception - Pengecualian platform surat
  • Mailupstatus :: err_list_not_created - ListName tidak ada di platform mailup dan tidak dapat dibuat
  • Mailupstatus :: err_list_not_changed - ListName tidak valid dan daftar saat ini tetap tidak berubah

AddGroup 

   $result = $mailUp->addGroup(<GROUPNAME>);

Parameter:

  • GroupName : Nama grup yang akan dibuat

Nilai pengembalian:

  • (Nomor> 0) - Grup dibuat dan ID dikembalikan, jika grup ada metode mengembalikan ID.
  • Mailupstatus :: err_not_logged_in - metode ini dipanggil tanpa membuat login
  • Mailupstatus :: err_invalid_parameter - satu atau banyak parameter tidak valid atau kosong
  • Mailupstatus :: err_mailup_exception - Pengecualian platform surat
  • Mailupstatus :: err_creating_groups - GroupName tidak ada di platform mailup dan tidak dapat dibuat

addusertogroup 

   $result = $mailUp->addUserToGroup(<USERDATA>, <GROUPNAME>);

Parameter:

  • UserData : Array dengan data pengguna yang akan ditambahkan ke grup
  • GroupName : Nama grup (bisa juga ID grup)

Bidang UserData

  • Mail - email pengguna ( wajib )
  • Nama - Nama depan pengguna
  • Nama Belakang - Nama Last Pengguna
  • Ponsel - Nomor Ponsel Pengguna Tanpa Awalan Internasional (Kel. +39xxxxxxx)
  • Perusahaan - Nama Perusahaan Pengguna (jika tersedia)

Nilai pengembalian:

  • Mailupstatus :: OK - Pengguna dibuat atau ada pengguna di platform
  • Mailupstatus :: err_not_logged_in - metode ini dipanggil tanpa membuat login
  • Mailupstatus :: err_invalid_parameter - satu atau banyak parameter tidak valid atau kosong
  • Mailupstatus :: err_mailup_exception - Pengecualian platform surat
  • Mailupstatus :: err_getting_fields kesalahan ini dikembalikan ketika kami memiliki masalah dengan bidang surat yang dinamis (lihat di sini untuk detailnya)
  • Mailupstatus :: err_invalid_userdata - userdata berisi data yang tidak valid atau bidang yang salah
  • Mailupstatus :: err_adding_user - pengguna tidak dapat dibuat (ditambahkan)

sendmessage 

   $result = $mailUp->sendMessage(<SUBJECT>, <MESSAGE>, <GROUPNAME>, <USERMAILS>, <ATTACHMENT>);

Parameter:

  • Subjek - Subjek pesan
  • Pesan - Teks Pesan (bisa menjadi teks biasa atau HTML)
  • GroupName - Nama grup untuk mengirim pesan
  • Usermails - Surat pengguna untuk mengirim pesan, dapat berupa alamat surat tunggal atau berbagai alamat surat
  • Lampiran - Jalur ke file/gambar/lainnya untuk dilampirkan di pesan (harus, jika ada, jalur absolut ke file, jika tetap di server, atau URL), jika kelas tidak menemukan lampiran tidak ada data yang dilampirkan ke pesan

Jika salah satu dari GroupName dan/atau USermail tidak ditentukan ("" atau nol lulus) pesan dikirim ke semua penerima (pengguna) yang ada dalam daftar saat ini.

Nilai pengembalian:

  • Mailupstatus :: message_sended - pesannya benar -benar antri dan dikirim sesegera mungkin
  • Mailupstatus :: err_not_logged_in - metode ini dipanggil tanpa membuat login
  • Mailupstatus :: err_invalid_parameter - satu atau banyak parameter tidak valid atau kosong
  • Mailupstatus :: err_mailup_exception - Pengecualian platform surat
  • Mailupstatus :: err_message_not_sended - pesan tidak dapat dikirim
  • Mailupstatus :: err_cant_create_message - sistem tidak dapat membuat (menyiapkan) pesan sebelum mengirimnya
  • Mailupstatus :: err_message_text_empty - parameter pesan kosong atau nol

GetTemplatelist 

   $result = $mailUp->getTemplateList();

Hampir satu templat surat harus dibuat milik platform surat sebelum menggunakan metode dan metode ini yang ditautkan, Anda dapat menemukan semua informasi dan panduan tentang templat di sini

Nilai pengembalian:

  • TemplatElistructure - Daftar Template yang Disajikan di Platform Surat
  • Mailupstatus :: err_no_templates - tidak ada templat di platform surat
  • Mailupstatus :: err_not_logged_in - metode ini dipanggil tanpa membuat login
  • Mailupstatus :: err_mailup_exception - Pengecualian platform surat
  • Mailupstatus :: err_unknow_list - daftar saat ini memiliki masalah

SendFromTemplate 

   $result = $mailUp->sendFromTemplate(<TEMPLATEID>, <GROUPNAME>, <USERMAILS>, <ATTACHMENT>);

Subjek dan pesan jelas tidak perlu :)

Lihat SendMessage untuk sebagian besar parameter dan nilai pengembalian kecuali berikut

Parameter:

  • TemplateID - ID Template yang diperoleh dari item yang dipilih dari daftar yang dikembalikan GetTemplatelist

Nilai pengembalian:

  • Mailupstatus :: err_no_templates - ID template salah atau tidak valid

Referensi

Untuk semua referensi dan spesifikasi pada panggilan API untuk platform surat, lihat di sini

Berdasarkan kode contoh dari sini

Pengarang

Massimo Villalta - (c) 2017 - Caereservices.it

Memperluas
Informasi Tambahan
Aplikasi Terkait
Direkomendasikan untuk Anda
Informasi Terkait Semua