Laravel 5.x 용 Mailup 클라이언트 클래스
이 클래스를 사용하면 Laravel 5.x 프레임 워크와 함께 Mailup 플랫폼의 우편 기능을 사용하는 데 도움이됩니다.
설치
Composer.json 에 Composer Insert를 사용하여 다음 코드 블록 :
"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 :: OK- 올바르게 로그인했습니다
- mailupstatus :: err_not_logged_in- 사용자 이름 또는 비밀번호가 잘못되었습니다
- mailupstatus :: err_invalid_parameter- 하나 이상의 매개 변수 ar 유효하지 않거나 빈
- MailUpStatus :: err_mailup_exception- Mailup 플랫폼 예외
- mailupstatus :: err_list_not_found- ListName이 지정되었지만 Mailup 플랫폼에 존재하지 않는 경우
CreateList
$result = $mailUp->createList(<LISTNAME>, <LISTDATA>);
매개 변수 :
- ListName : 사용할 수신자 목록 이름
- ListData : 채우기 목록 데이터 용 필드가있는 배열
ListData 필드
- 이름 - 목록의 이름
- main_mail- 목록에 링크 된 메인 이메일 주소
- Reply_TO- 사용자의 답장을위한 메일 주소
- sender_name- 메일을받을 때 사용자에게 나타나는 발신자 이름
- Company_Name- 회사 이름
- contact_name- 회사의 연락처 이름 (불필요한 경기 main_mail 또는 reply_to 소유자)
- 주소 - 회사 주소
- 도시 - 회사 도시
- Country_Code- 귀하의 국가 코드 (예 : IT)
- Perm_Remind- 허가 알림 (기본값 "") 정보는 여기를 참조하십시오.
- Web_site- 귀하의 웹 사이트 URL
모든 필드는 필수 입니다
반환 값 :
- MailUpStatus :: OK- 올바르게 생성되었습니다
- mailupstatus :: err_not_logged_in- 메소드가 로그인하지 않고 호출됩니다
- mailupstatus :: err_invalid_parameter- 하나 이상의 매개 변수 ar 유효하지 않거나 빈
- MailUpStatus :: err_mailup_exception- Mailup 플랫폼 예외
- mailupstatus :: err_list_not_created- 목록 이름은 Mailup 플랫폼에 존재하지 않으며 생성 할 수 없습니다.
- mailupstatus :: err_no_list_data- ListData 배열은 비어 있거나 null입니다
- mailupstatus :: err_invalid_list_data- ListData 배열에는 하나 이상의 필드가 비어 있거나 null이 있습니다.
변경리스트
$result = $mailUp->changeList(<LISTNAME> [, <LISTDATA>]);
ListName이 존재하지 않으면 ListData 배열이 지정된 메소드입니다.
매개 변수 :
- ListName : 사용할 수신자 목록 이름
- ListData : (옵션) 채우기 목록 데이터 용 필드가있는 배열 (배열 구조는 CreateList 참조)
반환 값 :
- MailUpStatus :: OK- 목록이 올바르게 변경되었습니다
- mailupstatus :: err_not_logged_in- 메소드가 로그인하지 않고 호출됩니다
- mailupstatus :: err_invalid_parameter- 하나 이상의 매개 변수 ar 유효하지 않거나 빈
- MailUpStatus :: err_mailup_exception- Mailup 플랫폼 예외
- mailupstatus :: err_list_not_created- 목록 이름은 Mailup 플랫폼에 존재하지 않으며 생성 할 수 없습니다.
- mailupstatus :: err_list_not_changed- 목록 이름이 유효하지 않고 현재 목록은 변경되지 않았습니다.
추가 그룹
$result = $mailUp->addGroup(<GROUPNAME>);
매개 변수 :
반환 값 :
- (번호> 0) - 그룹이 생성되고 ID가 반환됩니다. 그룹이 존재하면 메소드를 반환하면 ID입니다.
- mailupstatus :: err_not_logged_in- 메소드가 로그인하지 않고 호출됩니다
- mailupstatus :: err_invalid_parameter- 하나 이상의 매개 변수가 유효하지 않거나 비어 있습니다.
- MailUpStatus :: err_mailup_exception- Mailup 플랫폼 예외
- mailupstatus :: err_creating_groups- GroupName은 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- 사용자 데이터 에는 잘못된 데이터 또는 잘못된 필드가 포함되어 있습니다.
- mailupstatus :: err_adding_user- 사용자를 생성 할 수 없습니다 (추가)
SendMessage
$result = $mailUp->sendMessage(<SUBJECT>, <MESSAGE>, <GROUPNAME>, <USERMAILS>, <ATTACHMENT>);
매개 변수 :
- 주제 - 메시지 주제
- 메시지 - 메시지의 텍스트 (일반 텍스트 또는 HTML이 될 수 있음)
- GroupName- 메시지를 보내는 그룹의 이름
- usermails- 메시지를 보내는 사용자의 메일은 단일 메일 주소 또는 메일 주소 배열 일 수 있습니다.
- 첨부 파일 - 메시지에 첨부 할 파일/이미지/기타로의 경로 (현재, 파일에 대한 절대 경로, 서버 또는 URL에있는 경우, URL에있는 경우) 클래스가 첨부 파일을 찾지 못하면 메시지에 데이터가 첨부되지 않으면 메시지에 데이터가 첨부되어 있습니다.
GroupName 및/또는 Usermails 중 하나가 지정되지 않은 경우 ( ""또는 NULL이 전달되는 경우) 메시지가 현재 목록에있는 모든 수신자 (사용자)에게 전송됩니다.
반환 값 :
- MailUpStatus :: Message_Sended- 메시지가 올바르게 대기되어 최대한 빨리 전송됩니다.
- mailupstatus :: err_not_logged_in- 메소드가 로그인하지 않고 호출됩니다
- mailupstatus :: err_invalid_parameter- 하나 이상의 매개 변수 ar 유효하지 않거나 빈
- MailUpStatus :: err_mailup_exception- Mailup 플랫폼 예외
- mailupstatus :: err_message_not_send- 메시지를 보낼 수 없습니다
- mailupstatus :: err_cant_create_message- 시스템이 보내기 전에 메시지를 생성 (준비) 할 수 없습니다.
- mailupstatus :: err_message_text_empty- 메시지 매개 변수가 비어 있거나 null입니다
GetTemplatElist
$result = $mailUp->getTemplateList();
이 메소드와 메소드를 사용하기 전에 거의 하나의 메일 템플릿을 생성해야합니다.
반환 값 :
- TemplatelistStructure- 메일 업 플랫폼에있는 템플릿 목록
- 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- gettemplatelist 의 선택된 항목에서 얻은 템플릿의 ID 반환 목록
반환 값 :
- mailupstatus :: err_no_templates- 템플릿 ID가 잘못되거나 유효하지 않습니다
참조
API에 대한 모든 참조 및 사양에 대해서는 Mailup 플랫폼에 대한 전화를 참조하십시오.
여기에서 예를 들어 코드를 기반으로합니다
작가
Massimo Villalta- (c) 2017- caereservices.it
