Package esendex.sdk.java.service
Interface OptOutService
- All Known Implementing Classes:
OptOutServiceImpl
public interface OptOutService
-
Method Summary
Modifier and TypeMethodDescriptioncreateOptOut
(OptOutRequest optOutRequest) Creates an opt out.Gets an opt out.getOptOuts
(int pageNumber, int pageSize) Gets opt outs.getOptOuts
(FromAddress from, int pageNumber, int pageSize) Gets opt outs by from address.getOptOuts
(String account, int pageNumber, int pageSize) Gets opt outs by account reference.getOptOuts
(String account, FromAddress from, int pageNumber, int pageSize) Gets opt outs by account reference and from address.
-
Method Details
-
getOptOut
Gets an opt out.- Parameters:
id
- the id- Returns:
- the opt out
- Throws:
EsendexException
- the Esendex exception
-
getOptOuts
Gets opt outs.- Parameters:
pageNumber
- the page numberpageSize
- the page size- Returns:
- the opt outs
- Throws:
EsendexException
- the Esendex exception
-
getOptOuts
OptOutCollectionResponse getOptOuts(String account, int pageNumber, int pageSize) throws EsendexException Gets opt outs by account reference.- Parameters:
account
- the accountpageNumber
- the page numberpageSize
- the page size- Returns:
- the opt outs
- Throws:
EsendexException
- the Esendex exception
-
getOptOuts
OptOutCollectionResponse getOptOuts(FromAddress from, int pageNumber, int pageSize) throws EsendexException Gets opt outs by from address.- Parameters:
from
- the from address filterpageNumber
- the page numberpageSize
- the page size- Returns:
- the opt outs
- Throws:
EsendexException
- the Esendex exception
-
getOptOuts
OptOutCollectionResponse getOptOuts(String account, FromAddress from, int pageNumber, int pageSize) throws EsendexException Gets opt outs by account reference and from address.- Parameters:
account
- the accountfrom
- the from address filterpageNumber
- the page numberpageSize
- the page size- Returns:
- the opt outs
- Throws:
EsendexException
- the Esendex exception
-
createOptOut
Creates an opt out.- Parameters:
optOutRequest
- the opt out to be created- Returns:
- the created opt out
- Throws:
EsendexException
- the Esendex exception
-