mailup

คลาสไคลเอนต์ Mailup สำหรับ Laravel 5.x

คลาสนี้ช่วยให้คุณใช้ฟังก์ชั่นการส่งจดหมายของแพลตฟอร์ม MailUp ด้วยเฟรมเวิร์ก Laravel 5.x ของคุณ

การติดตั้ง

การใช้ Composer Insert ลงใน Composer.json บล็อกรหัสต่อไปนี้:

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

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

จากนั้นเรียกใช้ การอัปเดตนักแต่งเพลง

เริ่มต้นใช้งาน

ตัวอย่างต่อไปนี้แสดงขั้นตอนพื้นฐานสำหรับใช้คลาสนี้ในรหัสของคุณ

 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 และ $ client_secret สามารถรับได้ตามคำแนะนำเหล่านี้

วิธีการที่มีอยู่

เข้าสู่ระบบ

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

พารามิเตอร์:

• ผู้ใช้ : ชื่อผู้ใช้สำหรับแพลตฟอร์ม MailUp (โดยปกติ MXXXXX )
• รหัสผ่าน : รหัสผ่านสำหรับแพลตฟอร์ม MailUp
• listName : (ไม่บังคับ) ชื่อรายการของผู้รับที่จะใช้หากไม่ได้ระบุรายการเริ่มต้นของ MailUp

ค่าส่งคืน:

• mailupstatus :: ตกลง - เข้าสู่ระบบอย่างถูกต้อง
• mailupstatus :: err_not_logged_in - ชื่อผู้ใช้หรือรหัสผ่านไม่ถูกต้อง
• mailupstatus :: err_invalid_parameter - หนึ่งหรือหลายพารามิเตอร์ ar ไม่ถูกต้องหรือว่างเปล่า
• Mailupstatus :: err_mailup_exception - ข้อยกเว้นแพลตฟอร์ม Mailup
• mailupstatus :: err_list_not_found - หากระบุ ชื่อ ListName แต่ไม่มีอยู่ในแพลตฟอร์ม Mailup

ผู้สร้าง

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

พารามิเตอร์:

• ListName : ชื่อของรายการผู้รับที่จะใช้
• listdata : อาร์เรย์พร้อมฟิลด์สำหรับข้อมูลรายการเติม

ฟิลด์ ListData

• ชื่อ - ชื่อของรายการ
• Main_mail - ที่อยู่อีเมลหลักที่เชื่อมโยงกับรายการ
• Reply_to - ที่อยู่อีเมลสำหรับการตอบกลับจากผู้ใช้
• SENDER_NAME - ชื่อผู้ส่งที่ปรากฏกับผู้ใช้เมื่อได้รับจดหมาย
• company_name - ชื่อ บริษัท ของคุณ
• contact_name - ชื่อผู้ติดต่อใน บริษัท (ไม่จำเป็น MAIN_MAIL หรือ Reply_to เจ้าของ)
• ที่อยู่ - ที่อยู่ บริษัท ของคุณ
• เมือง - เมือง บริษัท ของคุณ
• Country_Code - รหัสประเทศของคุณ (เช่นมัน)
• perm_remind - การแจ้งเตือนการอนุญาต (ค่าเริ่มต้น "") ดูที่นี่สำหรับข้อมูล
• web_site - URL เว็บไซต์ของคุณ

ทุกสาขามี ผลบังคับใช้

ค่าส่งคืน:

• mailupstatus :: ตกลง - รายการสร้างอย่างถูกต้อง
• mailupstatus :: err_not_logged_in - วิธีการถูกเรียกโดยไม่ต้องเข้าสู่ระบบ
• mailupstatus :: err_invalid_parameter - หนึ่งหรือหลายพารามิเตอร์ ar ไม่ถูกต้องหรือว่างเปล่า
• Mailupstatus :: err_mailup_exception - ข้อยกเว้นแพลตฟอร์ม Mailup
• mailupstatus :: err_list_not_created - ชื่อ ListName ไม่มีอยู่ในแพลตฟอร์ม Mailup และไม่สามารถสร้างได้
• mailupstatus :: err_no_list_data - อาร์เรย์ listdata ว่างเปล่าหรือว่างเปล่า
• mailupstatus :: err_invalid_list_data - listdata array มีหนึ่งหรือหลายฟิลด์ว่างเปล่าหรือว่างเปล่า

ผู้เปลี่ยนแปลง

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

หากมีการระบุ ชื่อ listName และ listdata array ให้ลองสร้างมัน

พารามิเตอร์:

• ListName : ชื่อของรายการผู้รับที่จะใช้
• listdata : (ไม่บังคับ) อาร์เรย์พร้อมฟิลด์สำหรับข้อมูลรายการเติม (ดู createList สำหรับโครงสร้างอาร์เรย์)

ค่าส่งคืน:

• mailupstatus :: ตกลง - รายการเปลี่ยนอย่างถูกต้อง
• mailupstatus :: err_not_logged_in - วิธีการถูกเรียกโดยไม่ต้องเข้าสู่ระบบ
• mailupstatus :: err_invalid_parameter - หนึ่งหรือหลายพารามิเตอร์ ar ไม่ถูกต้องหรือว่างเปล่า
• Mailupstatus :: err_mailup_exception - ข้อยกเว้นแพลตฟอร์ม Mailup
• mailupstatus :: err_list_not_created - ชื่อ ListName ไม่มีอยู่ในแพลตฟอร์ม Mailup และไม่สามารถสร้างได้
• mailupstatus :: err_list_not_changed - ชื่อ listname ไม่ถูกต้องและรายการปัจจุบันยังคงไม่เปลี่ยนแปลง

addgroup

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

พารามิเตอร์:

• GroupName : ชื่อของกลุ่มที่จะสร้าง

ค่าส่งคืน:

• (หมายเลข> 0) - สร้าง กลุ่ม และ ID จะถูกส่งคืนหาก กลุ่ม มีอยู่วิธีการส่งคืน ID เป็น ID
• mailupstatus :: err_not_logged_in - วิธีการถูกเรียกโดยไม่ต้องเข้าสู่ระบบ
• mailupstatus :: err_invalid_parameter - หนึ่งหรือหลายพารามิเตอร์ไม่ถูกต้องหรือว่างเปล่า
• Mailupstatus :: err_mailup_exception - ข้อยกเว้นแพลตฟอร์ม Mailup
• mailupstatus :: err_creating_groups - ชื่อกลุ่ม ไม่มีอยู่ในแพลตฟอร์ม Mailup และไม่สามารถสร้างได้

addusertogroup

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

พารามิเตอร์:

• UserData : อาร์เรย์พร้อมข้อมูลผู้ใช้ที่จะเพิ่มลงในกลุ่ม
• GroupName : ชื่อของกลุ่ม (สามารถเป็น ID กลุ่มได้ด้วย)

ฟิลด์ UserData

• อีเมล - อีเมลผู้ใช้ ( บังคับ )
• ชื่อ - ชื่อผู้ใช้ FirstName
• นามสกุล - ชื่อผู้ใช้นามสกุล
• มือถือ - หมายเลขมือถือผู้ใช้ที่ไม่มีคำนำหน้านานาชาติ (ตัวอย่าง +39xxxxxxx)
• บริษัท - ชื่อ บริษัท ผู้ใช้ (ถ้ามี)

ค่าส่งคืน:

• MailUpstatus :: OK - ผู้ใช้ สร้างหรือสร้างหรือ มี อยู่ในแพลตฟอร์ม
• mailupstatus :: err_not_logged_in - วิธีการถูกเรียกโดยไม่ต้องเข้าสู่ระบบ
• mailupstatus :: err_invalid_parameter - หนึ่งหรือหลายพารามิเตอร์ไม่ถูกต้องหรือว่างเปล่า
• Mailupstatus :: err_mailup_exception - ข้อยกเว้นแพลตฟอร์ม Mailup
• Mailupstatus :: err_getting_fields ข้อผิดพลาดนี้จะถูกส่งคืนเมื่อเรามีปัญหากับฟิลด์ไดนามิกของ Mailup (ดูรายละเอียดที่นี่)
• Mailupstatus :: err_invalid_userdata - userData มีข้อมูลที่ไม่ถูกต้องหรือไม่ถูกต้อง
• Mailupstatus :: err_adding_user - ผู้ใช้ไม่สามารถสร้างได้ (เพิ่ม)

SendMessage

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

พารามิเตอร์:

• เรื่อง - เรื่องของข้อความ
• ข้อความ - ข้อความของข้อความ (สามารถเป็นข้อความธรรมดาหรือ html)
• GroupName - ชื่อของกลุ่มที่จะส่งข้อความ
• USERMAILS - จดหมายของผู้ใช้ในการส่งข้อความอาจเป็นที่อยู่อีเมลเดียวหรืออาร์เรย์ของที่อยู่อีเมล
• สิ่งที่แนบมา - พา ธ ไปยังไฟล์/รูปภาพ/อื่น ๆ เพื่อแนบที่ข้อความ (ต้องอยู่หากมีเส้นทางที่แน่นอนไปยังไฟล์หากอยู่บนเซิร์ฟเวอร์หรือ URL) หากคลาสไม่พบไฟล์แนบไม่มีข้อมูลติดอยู่กับข้อความ

หากไม่ได้ระบุ ชื่อกลุ่ม และ/หรือ usermails ("" หรือ NULL) ข้อความจะถูกส่งไปยังผู้รับ (ผู้ใช้) ทั้งหมดที่มีอยู่ในรายการปัจจุบัน

ค่าส่งคืน:

• mailupstatus :: message_sended - ข้อความถูกจัดคิวอย่างถูกต้องและจะถูกส่งโดยเร็วที่สุด
• mailupstatus :: err_not_logged_in - วิธีการถูกเรียกโดยไม่ต้องเข้าสู่ระบบ
• mailupstatus :: err_invalid_parameter - หนึ่งหรือหลายพารามิเตอร์ ar ไม่ถูกต้องหรือว่างเปล่า
• Mailupstatus :: err_mailup_exception - ข้อยกเว้นแพลตฟอร์ม Mailup
• mailupstatus :: err_message_not_sended - ไม่สามารถส่งข้อความได้
• Mailupstatus :: err_cant_create_message - ระบบไม่สามารถสร้าง (เตรียม) ข้อความก่อนส่งได้
• mailupstatus :: err_message_text_exty - พารามิเตอร์ ข้อความ ว่างเปล่าหรือว่างเปล่า

GetTemplateList

   $result = $mailUp->getTemplateList();

เทมเพลตเมลเกือบหนึ่งตัวจะต้องสร้างเป็นแพลตฟอร์ม MailUp ก่อนที่จะใช้วิธีการนี้และวิธีการเชื่อมโยงคุณสามารถค้นหาข้อมูลและคำแนะนำทั้งหมดบนเทมเพลตได้ที่นี่

ค่าส่งคืน:

• TemplateListStructure - รายการแม่แบบนำเสนอบนแพลตฟอร์ม MailUp
• Mailupstatus :: err_no_templates - ไม่มีแม่แบบในแพลตฟอร์ม Mailup
• mailupstatus :: err_not_logged_in - วิธีการถูกเรียกโดยไม่ต้องเข้าสู่ระบบ
• Mailupstatus :: err_mailup_exception - ข้อยกเว้นแพลตฟอร์ม Mailup
• mailupstatus :: err_unknow_list - รายการปัจจุบันมีปัญหา

SendFromTemplate

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

หัวเรื่อง และ ข้อความ ไม่จำเป็นอย่างเห็นได้ชัด :)

อ้างถึง SendMessage สำหรับพารามิเตอร์และค่าส่งคืนส่วนใหญ่ยกเว้นดังนี้

พารามิเตอร์:

• TemplateID - ID ของเทมเพลตที่ได้จากรายการที่เลือกของรายการส่งคืน GetTemplateList

ค่าส่งคืน:

• mailupstatus :: err_no_templates - รหัสเทมเพลตไม่ถูกต้องหรือไม่ถูกต้อง

อ้างอิง

สำหรับการอ้างอิงและข้อกำหนดทั้งหมดในการเรียก API สำหรับแพลตฟอร์มจดหมายอ้างอิงที่นี่

ขึ้นอยู่กับรหัสตัวอย่างจากที่นี่

ผู้เขียน

Massimo Villalta - (c) 2017 - caereservices.it