cz.quanti.mailq

Class MailQ

java.lang.Object

cz.quanti.mailq.MailQ

public class MailQ
extends Object

Constructor Summary

Constructors

Constructor and Description
MailQ(String baseUrl, Integer companyId, String apiKey) Create new MailQ object

Method Summary

Modifier and Type	Method and Description
void	addRecipientsToList(Long recipientsListId, List<RecipientsListEntryEntity> entries) Add multiple recipients to the list with validation of e-mail addresses.
void	addRecipientsToList(Long recipientsListId, List<RecipientsListEntryEntity> entries, Boolean validate) Add multiple recipients to the list.
NewsletterEntity	createNewsletter(NewsletterEntity newsletterEntity) Create newsletter This action will not automatically start newsletter.
NotificationEntity	createNotification(NotificationEntity notification) Create notification.
RecipientsListEntity	createRecipientsList(RecipientsListEntity recipientsList) Create recipients list.
SmsNewsletterEntity	createSmsNewsletter(SmsNewsletterEntity newsletterEntity) Create SMS newsletter.
SmsNotificationEntity	createSmsNotification(SmsNotificationEntity notification) Create SMS notification
void	deleteNewsletter(Long newsletterId) Delete newsletter
void	deleteNotification(Long notificationId) Delete notification
void	deleteRecipientFromList(Long recipientsListId, String email) Delete entry from recipients list.
void	deleteRecipientsList(Long recipientsListId) Delete recipients list.
void	deleteRecipientsList(Long recipientsListId, boolean complete) Delete recipients list.
void	deleteSmsNewsletter(Long newsletterId) Delete SMS newsletter
void	deleteSmsNotification(Long notificationId) Delete SMS notification
void	deleteUnsubscriber(Long recipientsListId, String email) Delete unsubscriber from recipients list
void	deleteUnsubscriber(String email) Remove delete unsubscriber
CampaignEntity	getCampaign(Long id) Get single campaign
CampaignsEntity	getCampaigns() Get all campaigns
CampaignsEntity	getCampaigns(Pagination pagination) Get all campaigns
CompanyEntity	getCompany() Get single company
LogMessageEntity	getLogMessage(Long id) Get single log message from system
LogMessagesEntity	getLogMessages() Get all log messages from system
LogMessagesEntity	getLogMessages(Pagination pagination) Get all log messages from system
NewsletterEntity	getNewsletter(Long newsletterId) Get newsletter
NewsletterEntity	getNewsletterByCode(String code) Get newsletter by user specific code.
NewslettersEntity	getNewsletters() Get newsletters of company
NewslettersEntity	getNewsletters(Pagination pagination) Get newsletters of company
TagsEntity	getNewslettersTags() Get tags of all newsletters
NotificationEntity	getNotification(Long notificationId) Get notification
NotificationDataEntity	getNotificationData(Long notificationId, String notificationDataId) Get notification data
NotificationsEntity	getNotifications() Get notifications
NotificationsEntity	getNotifications(Pagination pagination) Get notifications
NotificationsDataEntity	getNotificationsData(Long notificationId, String email) Get notifications data.
NotificationsDataEntity	getNotificationsData(Long notificationId, String email, Pagination pagination) Get notifications data.
RecipientsListEntriesEntity	getRecipientsFromList(Long recipientsListId) Get entries from recipients list
RecipientsListEntriesEntity	getRecipientsFromList(Long recipientsListId, Pagination pagination) Get entries from recipients list
RecipientsListEntity	getRecipientsList(Long recipientsListId) Get recipient list
RecipientsListsEntity	getRecipientsLists(Pagination pagination) Get recipients lists
RecipientsListsEntity	getRecipientsListsByEmail(String email, Pagination pagination) Get recipients lists by email address.
SenderEmailEntity	getSenderEmail(Long id) Get sender e-mail
SenderEmailsEntity	getSenderEmails() Get sender e-mails.
SmsNewsletterEntity	getSmsNewsletter(Long newsletterId) Get SMS newsletter
SmsNewslettersEntity	getSmsNewsletters() Get SMS newsletters
SmsNewslettersEntity	getSmsNewsletters(Pagination pagination) Get SMS newsletters
SmsNotificationEntity	getSmsNotification(Long notificationId) Get SMS notification
SmsNotificationDataEntity	getSmsNotificationData(Long notificationId, String notificationDataId) Get SMS notification data.
SmsNotificationsEntity	getSmsNotifications(Pagination pagination) Get SMS notifications
UnsubscriberEntity	getUnsubscriber(Long recipientsListId, String email) Get unsubscriber from recipients list
UnsubscribersEntity	getUnsubscriber(String email) Get single unsubscriber by email address
UnsubscribersEntity	getUnsubscribers(java.time.LocalDateTime from) Get all global unsubscribers
UnsubscribersEntity	getUnsubscribers(java.time.LocalDateTime from, Pagination pagination) Get all global unsubscribers
UnsubscribersEntity	getUnsubscribers(Long recipientsListId) Get unsubscribers from recipients list
UnsubscribersEntity	getUnsubscribers(Long recipientsListId, Pagination pagination) Get unsubscribers from recipients list
UserEntity	getUser(Long userId) Get user
UsersEntity	getUsers() Get users in company
String	regenerateApiKey() Regenerate API key
NotificationDataEntity	sendNotificationEmail(Long notificationId, NotificationDataEntity notificationData) Send notification e-mail.
SmsBatchResultEntity	sendSmsBatchNotification(Long notificationId, SmsNotificationBatchEntity notificationBatch) Send batch of SMS.
SmsNotificationDataEntity	sendSmsNotification(Long notificationId, SmsNotificationDataEntity notification) Send SMS notification.
void	sendTestEmail(Long newsletterId, String email) Send test e-mail.
void	sendTestSms(Long newsletterId, String number) Send test SMS.
void	startNewsletter(Long newsletterId) Start preparing of newsletter.
void	startSmsNewsletter(Long newsletterId) Start preparing of newsletter.
void	stopNewsletter(Long newsletterId) Stop preparing of newsletter.
void	stopSmsNewsletter(Long newsletterId) Stop preparing of newsletter.
void	unsubscribe(Long recipientsListId, Set<String> emails) Unsubscribe e-mail addresses from recipient list
void	unsubscribe(Long recipientsListId, String... emails) Unsubscribe e-mail addresses from recipient list
void	unsubscribe(Set<String> emails) Unsubscribe email addresses from all recipients lists.
void	unsubscribe(String... emails) Unsubscribe email addresses from all recipients lists.
void	updateNewsletter(NewsletterEntity newsletter) Update newsletter You can update newsletter only before you call startNewsletter.
void	updateNotification(NotificationEntity notification) Update notification
void	updatePreparedNewsletter(PreparedNewsletterEntity preparedNewsletter) Update prepared newsletter If newsletter started you can update only some newsletter data.
void	updateRecipientFromList(Long recipientsListId, RecipientsListEntryEntity recipientsListEntry) Update entry from recipients list
void	updateRecipientFromList(Long recipientsListId, RecipientsListEntryEntity recipientsListEntry, Boolean validate) Update entry from recipients list
void	updateSmsNewsletter(SmsNewsletterEntity newsletter) Update SMS newsletter.
void	updateSmsNotification(SmsNotificationEntity notification) Update SMS notification
void	validate(String email) Validate e-mail address.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MailQ

public MailQ(String baseUrl,
             Integer companyId,
             String apiKey)

Create new MailQ object

Parameters:

baseUrl - - URL to API

companyId - - Company ID - you can check your company ID in GUI

apiKey - - Company ID - you can check your API key in GUI

Method Detail

getCampaigns

public CampaignsEntity getCampaigns()
                             throws ApiException,
                                    InvalidRequestException

Get all campaigns

Returns:

CampaignEntity

Throws:

ApiException

InvalidRequestException

getCampaigns

public CampaignsEntity getCampaigns(Pagination pagination)
                             throws ApiException,
                                    InvalidRequestException

Get all campaigns

Parameters:

pagination -

Returns:

CampaignEntity

Throws:

ApiException

InvalidRequestException

getCampaign

public CampaignEntity getCampaign(Long id)
                           throws ApiException,
                                  InvalidRequestException

Get single campaign

Parameters:

id -

Returns:

CampaignEntity

Throws:

ApiException

InvalidRequestException

getCompany

public CompanyEntity getCompany()
                         throws ApiException,
                                InvalidRequestException

Get single company

Returns:

CompanyEntity

Throws:

ApiException

InvalidRequestException

regenerateApiKey

public String regenerateApiKey()
                        throws ApiException,
                               InvalidRequestException

Regenerate API key

Returns:

apiKey - new API key, you have to use new API key in next request

Throws:

ApiException

InvalidRequestException

unsubscribe

public void unsubscribe(String... emails)
                 throws InvalidRequestException,
                        ApiException

Unsubscribe email addresses from all recipients lists. This is global unsubscribe. If you want to unsubscribe only from specific recipients list check unsubscribe method with recipients list ID parameter.

Parameters:

emails - - email addresses

Throws:

InvalidRequestException

ApiException

unsubscribe

public void unsubscribe(Set<String> emails)
                 throws InvalidRequestException,
                        ApiException

Unsubscribe email addresses from all recipients lists. This is global unsubscribe. If you want to unsubscribe only from specific recipients list check unsubscribe method with recipients list ID parameter.

Parameters:

emails -

Throws:

InvalidRequestException

ApiException

getUnsubscribers

public UnsubscribersEntity getUnsubscribers(java.time.LocalDateTime from)
                                     throws InvalidRequestException,
                                            ApiException

Get all global unsubscribers

Parameters:

from - - filter to unsubscriptions created after this datetime

Returns:

UnsubscribersEntity

Throws:

InvalidRequestException

ApiException

getUnsubscribers

public UnsubscribersEntity getUnsubscribers(java.time.LocalDateTime from,
                                            Pagination pagination)
                                     throws InvalidRequestException,
                                            ApiException

Get all global unsubscribers

Parameters:

from - - filter to unsubscriptions created after this datetime

pagination -

Returns:

UnsubscribersEntity

Throws:

InvalidRequestException

ApiException

getUnsubscriber

public UnsubscribersEntity getUnsubscriber(String email)
                                    throws InvalidRequestException,
                                           ApiException

Get single unsubscriber by email address

Parameters:

email - - email address of unsubscriber

Returns:

UnsubscribersEntity

Throws:

InvalidRequestException

ApiException

deleteUnsubscriber

public void deleteUnsubscriber(String email)
                        throws InvalidRequestException,
                               ApiException

Remove delete unsubscriber

Parameters:

email -

Throws:

InvalidRequestException

ApiException

getLogMessages

public LogMessagesEntity getLogMessages()
                                 throws InvalidRequestException,
                                        ApiException

Get all log messages from system

Returns:

LogMessagesEntity

Throws:

InvalidRequestException

ApiException

getLogMessages

public LogMessagesEntity getLogMessages(Pagination pagination)
                                 throws InvalidRequestException,
                                        ApiException

Get all log messages from system

Parameters:

pagination -

Returns:

LogMessagesEntity

Throws:

InvalidRequestException

ApiException

getLogMessage

public LogMessageEntity getLogMessage(Long id)
                               throws InvalidRequestException,
                                      ApiException

Get single log message from system

Parameters:

id - - id of log message

Returns:

LogMessageEntity

Throws:

InvalidRequestException

ApiException

getNewsletters

public NewslettersEntity getNewsletters()
                                 throws InvalidRequestException,
                                        ApiException

Get newsletters of company

Returns:

NewslettersEntity

Throws:

InvalidRequestException

ApiException

getNewsletters

public NewslettersEntity getNewsletters(Pagination pagination)
                                 throws InvalidRequestException,
                                        ApiException

Get newsletters of company

Parameters:

pagination -

Returns:

NewslettersEntity

Throws:

InvalidRequestException

ApiException

createNewsletter

public NewsletterEntity createNewsletter(NewsletterEntity newsletterEntity)
                                  throws InvalidRequestException,
                                         ApiException

Create newsletter This action will not automatically start newsletter. You have to call startNewsletter to confirm you want to send all emails.

Parameters:

newsletterEntity -

Returns:

NewsletterEntity

Throws:

InvalidRequestException

ApiException

getNewslettersTags

public TagsEntity getNewslettersTags()
                              throws InvalidRequestException,
                                     ApiException

Get tags of all newsletters

Returns:

TagsEntity

Throws:

InvalidRequestException

ApiException

getNewsletterByCode

public NewsletterEntity getNewsletterByCode(String code)
                                     throws InvalidRequestException,
                                            ApiException

Get newsletter by user specific code. Code is unique in company.

Parameters:

code -

Returns:

NewsletterEntity

Throws:

InvalidRequestException

ApiException

getNewsletter

public NewsletterEntity getNewsletter(Long newsletterId)
                               throws InvalidRequestException,
                                      ApiException

Get newsletter

Parameters:

newsletterId - - ID of newsletter

Returns:

NewsletterEntity

Throws:

InvalidRequestException

ApiException

updateNewsletter

public void updateNewsletter(NewsletterEntity newsletter)
                      throws InvalidRequestException,
                             ApiException

Update newsletter You can update newsletter only before you call startNewsletter. If you already started newsletter you can stop it by stopNewsletter method.

Parameters:

newsletter -

Throws:

InvalidRequestException

ApiException

updatePreparedNewsletter

public void updatePreparedNewsletter(PreparedNewsletterEntity preparedNewsletter)
                              throws InvalidRequestException,
                                     ApiException

Update prepared newsletter If newsletter started you can update only some newsletter data.

Parameters:

preparedNewsletter -

Throws:

InvalidRequestException

ApiException

deleteNewsletter

public void deleteNewsletter(Long newsletterId)
                      throws InvalidRequestException,
                             ApiException

Delete newsletter

Parameters:

newsletterId -

Throws:

InvalidRequestException

ApiException

startNewsletter

public void startNewsletter(Long newsletterId)
                     throws InvalidRequestException,
                            ApiException

Start preparing of newsletter. If start of newsletter is not in range (past to now+1hour) newsletter can be stopped by stopNewsletter. Otherwise it cannot be stopped.

Parameters:

newsletterId -

Throws:

InvalidRequestException

ApiException

stopNewsletter

public void stopNewsletter(Long newsletterId)
                    throws InvalidRequestException,
                           ApiException

Stop preparing of newsletter. it is allowed only if newsletter start is after now+1hour.

Parameters:

newsletterId -

Throws:

InvalidRequestException

ApiException

sendTestEmail

public void sendTestEmail(Long newsletterId,
                          String email)
                   throws ApiException,
                          InvalidRequestException

Send test e-mail. This will send e-mail with data from first row of recipients list.

Parameters:

newsletterId -

email -

Throws:

ApiException

InvalidRequestException

getSmsNewsletters

public SmsNewslettersEntity getSmsNewsletters()
                                       throws InvalidRequestException,
                                              ApiException

Get SMS newsletters

Returns:

SmsNewslettersEntity

Throws:

InvalidRequestException

ApiException

getSmsNewsletters

public SmsNewslettersEntity getSmsNewsletters(Pagination pagination)
                                       throws InvalidRequestException,
                                              ApiException

Get SMS newsletters

Parameters:

pagination -

Returns:

SmsNewslettersEntity

Throws:

InvalidRequestException

ApiException

createSmsNewsletter

public SmsNewsletterEntity createSmsNewsletter(SmsNewsletterEntity newsletterEntity)
                                        throws InvalidRequestException,
                                               ApiException

Create SMS newsletter. This action will not automatically start newsletter. You have to call startSmsNewsletter to confirm you want to send all SMS.

Parameters:

newsletterEntity -

Returns:

SmsNewsletterEntity

Throws:

InvalidRequestException

ApiException

getSmsNewsletter

public SmsNewsletterEntity getSmsNewsletter(Long newsletterId)
                                     throws InvalidRequestException,
                                            ApiException

Get SMS newsletter

Parameters:

newsletterId -

Returns:

SmsNewsletterEntity

Throws:

InvalidRequestException

ApiException

updateSmsNewsletter

public void updateSmsNewsletter(SmsNewsletterEntity newsletter)
                         throws ApiException,
                                InvalidRequestException

Update SMS newsletter. You can update newsletter only before you call startSmsNewsletter. If you already started newsletter you can stop it by stopNewsletter method.

Parameters:

newsletter -

Throws:

ApiException

InvalidRequestException

deleteSmsNewsletter

public void deleteSmsNewsletter(Long newsletterId)
                         throws ApiException,
                                InvalidRequestException

Delete SMS newsletter

Parameters:

newsletterId -

Throws:

ApiException

InvalidRequestException

startSmsNewsletter

public void startSmsNewsletter(Long newsletterId)
                        throws ApiException,
                               InvalidRequestException

Start preparing of newsletter. If start of newsletter is not in range (past to now+1hour) newsletter can be stopped by stopSmsNewsletter. Otherwise it cannot be stopped.

Parameters:

newsletterId -

Throws:

ApiException

InvalidRequestException

stopSmsNewsletter

public void stopSmsNewsletter(Long newsletterId)
                       throws ApiException,
                              InvalidRequestException

Stop preparing of newsletter. it is allowed only if newsletter start is after now+1hour.

Parameters:

newsletterId -

Throws:

InvalidRequestException

ApiException

sendTestSms

public void sendTestSms(Long newsletterId,
                        String number)
                 throws ApiException,
                        InvalidRequestException

Send test SMS. This will sent normal SMS. It will be charged!

Parameters:

newsletterId -

number -

Throws:

ApiException

InvalidRequestException

getNotifications

public NotificationsEntity getNotifications()
                                     throws ApiException,
                                            InvalidRequestException

Get notifications

Returns:

NotificationsEntity

Throws:

ApiException

InvalidRequestException

getNotifications

public NotificationsEntity getNotifications(Pagination pagination)
                                     throws ApiException,
                                            InvalidRequestException

Get notifications

Parameters:

pagination -

Returns:

NotificationsEntity

Throws:

ApiException

InvalidRequestException

createNotification

public NotificationEntity createNotification(NotificationEntity notification)
                                      throws ApiException,
                                             InvalidRequestException

Create notification. If you want to send notification check sendNotificationEmail method.

Parameters:

notification -

Returns:

NotificationEntity

Throws:

ApiException

InvalidRequestException

getNotification

public NotificationEntity getNotification(Long notificationId)
                                   throws ApiException,
                                          InvalidRequestException

Get notification

Parameters:

notificationId -

Returns:

NotificationEntity

Throws:

ApiException

InvalidRequestException

updateNotification

public void updateNotification(NotificationEntity notification)
                        throws ApiException,
                               InvalidRequestException

Update notification

Parameters:

notification -

Throws:

ApiException

InvalidRequestException

deleteNotification

public void deleteNotification(Long notificationId)
                        throws ApiException,
                               InvalidRequestException

Delete notification

Parameters:

notificationId -

Throws:

ApiException

InvalidRequestException

sendNotificationEmail

public NotificationDataEntity sendNotificationEmail(Long notificationId,
                                                    NotificationDataEntity notificationData)
                                             throws ApiException,
                                                    InvalidRequestException

Send notification e-mail. This will send e-mail using notification and data you provide. Template using mustache templating system.

Parameters:

notificationId -

notificationData -

Returns:

NotificationDataEntity

Throws:

ApiException

InvalidRequestException

getNotificationsData

public NotificationsDataEntity getNotificationsData(Long notificationId,
                                                    String email)
                                             throws ApiException,
                                                    InvalidRequestException

Get notifications data. You can find all notifications send to specific e-mail address.

Parameters:

notificationId -

email -

Returns:

NotificationsDataEntity

Throws:

ApiException

InvalidRequestException

getNotificationsData

public NotificationsDataEntity getNotificationsData(Long notificationId,
                                                    String email,
                                                    Pagination pagination)
                                             throws ApiException,
                                                    InvalidRequestException

Get notifications data. You can find all notifications send to specific e-mail address.

Parameters:

notificationId -

email -

pagination -

Returns:

NotificationsDataEntity

Throws:

ApiException

InvalidRequestException

getNotificationData

public NotificationDataEntity getNotificationData(Long notificationId,
                                                  String notificationDataId)
                                           throws ApiException,
                                                  InvalidRequestException

Get notification data

Parameters:

notificationId -

notificationDataId -

Returns:

NotificationDataEntity

Throws:

ApiException

InvalidRequestException

createSmsNotification

public SmsNotificationEntity createSmsNotification(SmsNotificationEntity notification)
                                            throws ApiException,
                                                   InvalidRequestException

Create SMS notification

Parameters:

notification -

Returns:

SmsNotificationEntity

Throws:

ApiException

InvalidRequestException

getSmsNotifications

public SmsNotificationsEntity getSmsNotifications(Pagination pagination)
                                           throws ApiException,
                                                  InvalidRequestException

Get SMS notifications

Parameters:

pagination -

Returns:

SmsNotificationsEntity

Throws:

ApiException

InvalidRequestException

getSmsNotification

public SmsNotificationEntity getSmsNotification(Long notificationId)
                                         throws ApiException,
                                                InvalidRequestException

Get SMS notification

Parameters:

notificationId -

Returns:

SmsNotificationEntity

Throws:

ApiException

InvalidRequestException

updateSmsNotification

public void updateSmsNotification(SmsNotificationEntity notification)
                           throws ApiException,
                                  InvalidRequestException

Update SMS notification

Parameters:

notification -

Throws:

ApiException

InvalidRequestException

deleteSmsNotification

public void deleteSmsNotification(Long notificationId)
                           throws ApiException,
                                  InvalidRequestException

Delete SMS notification

Parameters:

notificationId -

Throws:

ApiException

InvalidRequestException

sendSmsNotification

public SmsNotificationDataEntity sendSmsNotification(Long notificationId,
                                                     SmsNotificationDataEntity notification)
                                              throws ApiException,
                                                     InvalidRequestException

Send SMS notification. This will be charged!

Parameters:

notificationId -

notification -

Returns:

Throws:

ApiException

InvalidRequestException

sendSmsBatchNotification

public SmsBatchResultEntity sendSmsBatchNotification(Long notificationId,
                                                     SmsNotificationBatchEntity notificationBatch)
                                              throws ApiException,
                                                     InvalidRequestException

Send batch of SMS. Maximum batch size is 100. Always check response to find out status of every SMS in batch. This will be charged!

Parameters:

notificationId -

notificationBatch -

Returns:

SmsBatchResultEntity

Throws:

ApiException

InvalidRequestException

getSmsNotificationData

public SmsNotificationDataEntity getSmsNotificationData(Long notificationId,
                                                        String notificationDataId)
                                                 throws ApiException,
                                                        InvalidRequestException

Get SMS notification data.

Parameters:

notificationId -

notificationDataId -

Returns:

Throws:

ApiException

InvalidRequestException

getRecipientsLists

public RecipientsListsEntity getRecipientsLists(Pagination pagination)
                                         throws ApiException,
                                                InvalidRequestException

Get recipients lists

Parameters:

pagination -

Returns:

RecipientsListsEntity

Throws:

ApiException

InvalidRequestException

getRecipientsListsByEmail

public RecipientsListsEntity getRecipientsListsByEmail(String email,
                                                       Pagination pagination)
                                                throws ApiException,
                                                       InvalidRequestException

Get recipients lists by email address. This will filter all company recipients list to lists which contains specific e-mail address.

Parameters:

email -

Returns:

RecipientsListsEntity

Throws:

ApiException

InvalidRequestException

getRecipientsList

public RecipientsListEntity getRecipientsList(Long recipientsListId)
                                       throws ApiException,
                                              InvalidRequestException

Get recipient list

Parameters:

recipientsListId -

Returns:

RecipientsListEntity

Throws:

ApiException

InvalidRequestException

createRecipientsList

public RecipientsListEntity createRecipientsList(RecipientsListEntity recipientsList)
                                          throws ApiException,
                                                 InvalidRequestException

Create recipients list. You can specify which variable will be used. It is possible only on creation.

Parameters:

recipientsList -

Returns:

RecipientsListEntity

Throws:

ApiException

InvalidRequestException

deleteRecipientsList

public void deleteRecipientsList(Long recipientsListId)
                          throws ApiException,
                                 InvalidRequestException

Delete recipients list. List will be deleted only if it is empty. If you want to delete list with entries use same method with second parameter set to true - it wil; disable check.

Parameters:

recipientsListId -

Throws:

ApiException

InvalidRequestException

deleteRecipientsList

public void deleteRecipientsList(Long recipientsListId,
                                 boolean complete)
                          throws ApiException,
                                 InvalidRequestException

Delete recipients list. List will be deleted only if it is empty. If you want to delete list with entries set second parameter to true - it wil; disable check.

Parameters:

recipientsListId -

complete - - If it is set to true it will delete list even if they are entries in it.

Throws:

ApiException

InvalidRequestException

addRecipientsToList

public void addRecipientsToList(Long recipientsListId,
                                List<RecipientsListEntryEntity> entries)
                         throws ApiException,
                                InvalidRequestException

Add multiple recipients to the list with validation of e-mail addresses.

Parameters:

recipientsListId -

entries -

Throws:

ApiException

InvalidRequestException

addRecipientsToList

public void addRecipientsToList(Long recipientsListId,
                                List<RecipientsListEntryEntity> entries,
                                Boolean validate)
                         throws ApiException,
                                InvalidRequestException

Add multiple recipients to the list. If you do not want to validate e-mail addresses set third parameter to false.

Parameters:

recipientsListId -

entries -

validate - - If it is set to true email addresses will be validated.

Throws:

ApiException

InvalidRequestException

getRecipientsFromList

public RecipientsListEntriesEntity getRecipientsFromList(Long recipientsListId)
                                                  throws ApiException,
                                                         InvalidRequestException

Get entries from recipients list

Parameters:

recipientsListId -

Returns:

RecipientsListEntriesEntity

Throws:

ApiException

InvalidRequestException

getRecipientsFromList

public RecipientsListEntriesEntity getRecipientsFromList(Long recipientsListId,
                                                         Pagination pagination)
                                                  throws ApiException,
                                                         InvalidRequestException

Get entries from recipients list

Parameters:

recipientsListId -

pagination -

Returns:

RecipientsListEntriesEntity

Throws:

ApiException

InvalidRequestException

updateRecipientFromList

public void updateRecipientFromList(Long recipientsListId,
                                    RecipientsListEntryEntity recipientsListEntry)
                             throws ApiException,
                                    InvalidRequestException

Update entry from recipients list

Parameters:

recipientsListId -

recipientsListEntry -

Throws:

ApiException

InvalidRequestException

updateRecipientFromList

public void updateRecipientFromList(Long recipientsListId,
                                    RecipientsListEntryEntity recipientsListEntry,
                                    Boolean validate)
                             throws ApiException,
                                    InvalidRequestException

Update entry from recipients list

Parameters:

recipientsListId -

recipientsListEntry -

Throws:

ApiException

InvalidRequestException

deleteRecipientFromList

public void deleteRecipientFromList(Long recipientsListId,
                                    String email)
                             throws ApiException,
                                    InvalidRequestException

Delete entry from recipients list. If you do not want to send newsletters to user from this recipient list, it is better to unsubscribe user rather then delete it.

Parameters:

recipientsListId -

email -

Throws:

ApiException

InvalidRequestException

unsubscribe

public void unsubscribe(Long recipientsListId,
                        Set<String> emails)
                 throws ApiException,
                        InvalidRequestException

Unsubscribe e-mail addresses from recipient list

Parameters:

recipientsListId -

emails -

Throws:

ApiException

InvalidRequestException

unsubscribe

public void unsubscribe(Long recipientsListId,
                        String... emails)
                 throws InvalidRequestException,
                        ApiException

Unsubscribe e-mail addresses from recipient list

Parameters:

recipientsListId -

emails -

Throws:

InvalidRequestException

ApiException

getUnsubscribers

public UnsubscribersEntity getUnsubscribers(Long recipientsListId)
                                     throws InvalidRequestException,
                                            ApiException

Get unsubscribers from recipients list

Parameters:

recipientsListId -

Returns:

UnsubscribersEntity

Throws:

InvalidRequestException

ApiException

getUnsubscribers

public UnsubscribersEntity getUnsubscribers(Long recipientsListId,
                                            Pagination pagination)
                                     throws InvalidRequestException,
                                            ApiException

Get unsubscribers from recipients list

Parameters:

recipientsListId -

pagination -

Returns:

UnsubscribersEntity

Throws:

InvalidRequestException

ApiException

getUnsubscriber

public UnsubscriberEntity getUnsubscriber(Long recipientsListId,
                                          String email)
                                   throws InvalidRequestException,
                                          ApiException

Get unsubscriber from recipients list

Parameters:

recipientsListId -

email -

Returns:

Throws:

InvalidRequestException

ApiException

deleteUnsubscriber

public void deleteUnsubscriber(Long recipientsListId,
                               String email)
                        throws InvalidRequestException,
                               ApiException

Delete unsubscriber from recipients list

Parameters:

recipientsListId -

email -

Throws:

InvalidRequestException

ApiException

getSenderEmails

public SenderEmailsEntity getSenderEmails()
                                   throws InvalidRequestException,
                                          ApiException

Get sender e-mails. This is list of e-mail addresses you can use for sending e-mails. If you want to add another with same domain you can do it in administration GUI. If it is e-mail address with different domain then existing. You have to send request to support.

Returns:

SenderEmailsEntity

Throws:

InvalidRequestException

ApiException

getSenderEmail

public SenderEmailEntity getSenderEmail(Long id)
                                 throws InvalidRequestException,
                                        ApiException

Get sender e-mail

Parameters:

id -

Returns:

SenderEmailEntity

Throws:

InvalidRequestException

ApiException

getUsers

public UsersEntity getUsers()
                     throws InvalidRequestException,
                            ApiException

Get users in company

Returns:

UsersEntity

Throws:

InvalidRequestException

ApiException

getUser

public UserEntity getUser(Long userId)
                   throws InvalidRequestException,
                          ApiException

Get user

Parameters:

userId -

Returns:

UserEntity

Throws:

InvalidRequestException

ApiException

validate

public void validate(String email)
              throws InvalidRequestException,
                     ApiException

Validate e-mail address. This validation also validate MX domain.

Parameters:

email -

Throws:

InvalidRequestException

ApiException