public interface MailgunSuppressionComplaintsApi extends MailgunApi
Mailgun Suppression Complaints Api
Mailgun keeps three lists of addresses it blocks the delivery to: bounces, unsubscribes and complaints. These lists are populated automatically as Mailgun detects undeliverable addresses you try to send to and as recipients unsubscribe from your mailings or mark your emails as a spam (for ESPs that provide FBL). You can also add/remove addresses from any of these lists using the API.
It’s important to note that these suppression lists are unique to a sending domain and are not an account level (global) suppression list. If you want to add/remove the same address(es) from multiple domains, you’ll need to do so for each domain.
Complaint list stores email addresses of recipients who marked your messages as a spam (for ESPs that support FBL).
Mailgun can notify your application every time a recipient flags your message as spam via a complained webhook.
| Modifier and Type | Method and Description |
|---|---|
ResponseWithMessage |
addAddressesToComplaintsList(String domain,
List<ComplaintsItem> request)
Add multiple complaint records to the complaint list in a single API call(up to 1000 complaint records).
|
feign.Response |
addAddressesToComplaintsListFeignResponse(String domain,
List<ComplaintsItem> request)
Add multiple complaint records to the complaint list in a single API call(up to 1000 complaint records).
|
SuppressionResponse |
addAddressToComplaintsList(String domain,
ComplaintsSingleItemRequest request)
Add an address to the complaints list.
|
feign.Response |
addAddressToComplaintsListFeignResponse(String domain,
ComplaintsSingleItemRequest request)
Add an address to the complaints list.
|
ComplaintsItemResponse |
getAllComplaints(String domain)
Returns a list of complaints for a domain (limit to 100 entries).
|
ComplaintsItemResponse |
getAllComplaints(String domain,
Integer limit)
Returns a list of complaints for a domain.
|
feign.Response |
getAllComplaintsFeignResponse(String domain)
Returns a list of complaints for a domain (limit to 100 entries).
|
feign.Response |
getAllComplaintsFeignResponse(String domain,
Integer limit)
Returns a list of complaints for a domain.
|
ComplaintsItem |
getSingleComplaint(String domain,
String address)
Fetch a single spam complaint by a given email address.
|
feign.Response |
getSingleComplaintFeignResponse(String domain,
String address)
Fetch a single spam complaint by a given email address.
|
ResponseWithMessage |
importComplaintsList(String domain,
ComplaintsListImportRequest request)
Import a list of complaints.
|
feign.Response |
importComplaintsListFeignResponse(String domain,
ComplaintsListImportRequest request)
Add multiple complaints.
|
SuppressionResponse |
removeAddressFromComplaints(String domain,
String address)
Remove Address From Complaints.
|
feign.Response |
removeAddressFromComplaintsFeignResponse(String domain,
String address)
Remove Address From Complaints.
|
getApiVersionComplaintsItemResponse getAllComplaints(String domain)
Returns a list of complaints for a domain (limit to 100 entries).
Note Via this API method complaints are returned in the alphabetical order.
If you wish to poll for the recently occurred complaints, please consider using the MailgunEventsApi.
domain - Name of the domainComplaintsItemResponsefeign.Response getAllComplaintsFeignResponse(String domain)
Returns a list of complaints for a domain (limit to 100 entries).
Note Via this API method complaints are returned in the alphabetical order.
If you wish to poll for the recently occurred complaints, please consider using the MailgunEventsApi.
domain - Name of the domainResponseComplaintsItemResponse getAllComplaints(String domain, Integer limit)
Returns a list of complaints for a domain.
Note Via this API method complaints are returned in the alphabetical order.
If you wish to poll for the recently occurred complaints, please consider using the MailgunEventsApi.
domain - Name of the domainlimit - Number of entries to return, max: 10000.ComplaintsItemResponsefeign.Response getAllComplaintsFeignResponse(String domain, Integer limit)
Returns a list of complaints for a domain.
Note Via this API method complaints are returned in the alphabetical order.
If you wish to poll for the recently occurred complaints, please consider using the MailgunEventsApi.
domain - Name of the domainlimit - Number of entries to return, max: 10000.ResponseComplaintsItem getSingleComplaint(String domain, String address)
Fetch a single spam complaint by a given email address. This is useful to check if a particular user has complained.
domain - Name of the domainaddress - An email addressComplaintsItemfeign.Response getSingleComplaintFeignResponse(String domain, String address)
Fetch a single spam complaint by a given email address. This is useful to check if a particular user has complained.
domain - Name of the domainaddress - An email addressResponseSuppressionResponse addAddressToComplaintsList(String domain, ComplaintsSingleItemRequest request)
Add an address to the complaints list.
domain - Name of the domainrequest - ComplaintsSingleItemRequestSuppressionResponsefeign.Response addAddressToComplaintsListFeignResponse(String domain, ComplaintsSingleItemRequest request)
Add an address to the complaints list.
domain - Name of the domainrequest - ComplaintsSingleItemRequestResponseResponseWithMessage addAddressesToComplaintsList(String domain, List<ComplaintsItem> request)
Add multiple complaint records to the complaint list in a single API call(up to 1000 complaint records).
domain - Name of the domainrequest - ComplaintsItemResponseWithMessagefeign.Response addAddressesToComplaintsListFeignResponse(String domain, List<ComplaintsItem> request)
Add multiple complaint records to the complaint list in a single API call(up to 1000 complaint records).
domain - Name of the domainrequest - ComplaintsItemResponseResponseWithMessage importComplaintsList(String domain, ComplaintsListImportRequest request)
Import a list of complaints.
Import a CSV file containing a list of addresses to add to the complaint list.
CSV file must be 25MB or under and must contain the following column headers:
addressValid email addresscreated_atTimestamp of a bounce event in RFC2822 format (optional, default: current time)
domain - Name of the domainrequest - ComplaintsItemResponseWithMessagefeign.Response importComplaintsListFeignResponse(String domain, ComplaintsListImportRequest request)
Add multiple complaints.
Import a CSV file containing a list of addresses to add to the complaint list.
CSV file must be 25MB or under and must contain the following column headers:
addressValid email addresscreated_atTimestamp of a bounce event in RFC2822 format (optional, default: current time)
domain - Name of the domainrequest - ComplaintsItemResponseSuppressionResponse removeAddressFromComplaints(String domain, String address)
Remove Address From Complaints.
domain - Name of the domainaddress - An email addressSuppressionResponseCopyright © 2022. All rights reserved.