com.mailgun.api.v3

Interface MailgunMailingListApi

All Superinterfaces:

MailgunApi

public interface MailgunMailingListApi
extends MailgunApi

Mailgun Mailing Lists Api.

You can programmatically create mailing lists using Mailgun Mailing List API.

See A mailing list is a group of members (recipients) which itself has an email address, like developers@mailgun.net. This address becomes an ID for this mailing list.

When you send a message to developers@mailgun.net, all members of the list will receive a copy of it.

See Also:

Mailing Lists

Method Summary

Modifier and Type	Method and Description
MailingListResponse	addMembersToMailingList(String mailingListAddress, AddMailingListMembersRequest request) Adds multiple members, up to 1,000 per call, to a Mailing List.
feign.Response	addMembersToMailingListFeignResponse(String mailingListAddress, AddMailingListMembersRequest request) Adds multiple members, up to 1,000 per call, to a Mailing List.
MailingListMemberResponse	addMemberToMailingList(String mailingListAddress, MailingListNewMemberRequest request) Adds a member to the mailing list.
feign.Response	addMemberToMailingListFeignResponse(String mailingListAddress, MailingListNewMemberRequest request) Adds a member to the mailing list.
String	cancelActiveMailingListVerificationJob(String mailingListAddress) Cancel an active mailing list verification job.
feign.Response	cancelActiveMailingListVerificationJobFeignResponse(String mailingListAddress) Cancel an active mailing list verification job.
MailingListResponse	createMailingList(MailingListRequest request) Creates a new mailing list.
feign.Response	createMailingListFeignResponse(MailingListRequest request) Creates a new mailing list.
DeleteMailingListResponse	deleteMailingList(String mailingListAddress) Deletes a mailing list.
feign.Response	deleteMailingListFeignResponse(String mailingListAddress) Deletes a mailing list.
MailingListMemberResponse	deleteMemberFromMailingList(String mailingListAddress, String memberAddress) Delete a mailing list member.
feign.Response	deleteMemberFromMailingListFeignResponse(String mailingListAddress, String memberAddress) Delete a mailing list member.
MailingListDataResponse	getMailingList() Returns mailing lists under your account (limit to 100 entries).
MailingListDataResponse	getMailingList(Integer limit) Returns mailing lists under your account.
SingleMailingListResponse	getMailingListByAddress(String mailingListAddress) Returns a single mailing list by a given address.
feign.Response	getMailingListByAddressFeignResponse(String mailingListAddress) Returns a single mailing list by a given address.
feign.Response	getMailingListFeignResponse() Returns mailing lists under your account (limit to 100 entries).
feign.Response	getMailingListFeignResponse(Integer limit) Returns mailing lists under your account.
MailingListMemberResponse	getMailingListMember(String mailingListAddress, String memberAddress) Retrieves a mailing list member.
feign.Response	getMailingListMemberFeignResponse(String mailingListAddress, String memberAddress) Retrieves a mailing list member.
MailingListMembersResponse	getMailingListMembers(String mailingListAddress) Returns the list of members in the given mailing list (limit to 100 entries).
MailingListMembersResponse	getMailingListMembers(String mailingListAddress, MailingListMembersRequest parameters) Returns the list of members in the given mailing list.
feign.Response	getMailingListMembersFeignResponse(String mailingListAddress) Returns the list of members in the given mailing list (limit to 100 entries).
feign.Response	getMailingListMembersFeignResponse(String mailingListAddress, MailingListMembersRequest parameters) Returns the list of members in the given mailing list.
MailingListVerificationStatusResponse	getMailingListVerificationJobStatus(String mailingListAddress) Retrieve current status of the mailing list verification job.
feign.Response	getMailingListVerificationJobStatusFeignResponse(String mailingListAddress) Retrieve current status of the mailing list verification job.
MailingListResponse	updateMailingList(String mailingListAddress, UpdateMailingListRequest request) Update mailing list properties, such as address, description or name.
feign.Response	updateMailingListFeignResponse(String mailingListAddress, UpdateMailingListRequest request) Update mailing list properties, such as address, description or name.
MailingListMemberResponse	updateMailingListMember(String mailingListAddress, String memberAddress, MailingListMemberUpdateRequest request) Updates a mailing list member with given properties.
feign.Response	updateMailingListMemberFeignResponse(String mailingListAddress, String memberAddress, MailingListMemberUpdateRequest request) Updates a mailing list member with given properties.
MailingListVerificationResponse	verifyMailingListMembers(String mailingListAddress) Verify all the members of the mailing list.
feign.Response	verifyMailingListMembersFeignResponse(String mailingListAddress) Verify all the members of the mailing list.

Methods inherited from interface com.mailgun.api.MailgunApi

getApiVersion

Method Detail

getMailingList

MailingListDataResponse getMailingList()

Returns mailing lists under your account (limit to 100 entries).

Returns:

MailingListDataResponse

getMailingListFeignResponse

feign.Response getMailingListFeignResponse()

Returns mailing lists under your account (limit to 100 entries).

Returns:

Response

getMailingList

MailingListDataResponse getMailingList(Integer limit)

Returns mailing lists under your account.

Parameters:

limit - Maximum number of records to return

Returns:

MailingListDataResponse

getMailingListFeignResponse

feign.Response getMailingListFeignResponse(Integer limit)

Returns mailing lists under your account.

Parameters:

limit - Maximum number of records to return

Returns:

Response

getMailingListByAddress

SingleMailingListResponse getMailingListByAddress(String mailingListAddress)

Returns a single mailing list by a given address.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

Returns:

SingleMailingListResponse

getMailingListByAddressFeignResponse

feign.Response getMailingListByAddressFeignResponse(String mailingListAddress)

Returns a single mailing list by a given address.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

Returns:

Response

createMailingList

MailingListResponse createMailingList(MailingListRequest request)

Creates a new mailing list.

Parameters:

request - MailingListRequest

Returns:

MailingListResponse

createMailingListFeignResponse

feign.Response createMailingListFeignResponse(MailingListRequest request)

Creates a new mailing list.

Parameters:

request - MailingListRequest

Returns:

Response

updateMailingList

MailingListResponse updateMailingList(String mailingListAddress,
                                      UpdateMailingListRequest request)

Update mailing list properties, such as address, description or name.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

request - MailingListRequest

Returns:

MailingListResponse

updateMailingListFeignResponse

feign.Response updateMailingListFeignResponse(String mailingListAddress,
                                              UpdateMailingListRequest request)

Update mailing list properties, such as address, description or name.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

request - MailingListRequest

Returns:

Response

deleteMailingList

DeleteMailingListResponse deleteMailingList(String mailingListAddress)

Deletes a mailing list.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

Returns:

DeleteMailingListResponse

deleteMailingListFeignResponse

feign.Response deleteMailingListFeignResponse(String mailingListAddress)

Deletes a mailing list.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

Returns:

Response

verifyMailingListMembers

MailingListVerificationResponse verifyMailingListMembers(String mailingListAddress)

Verify all the members of the mailing list.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

Returns:

MailingListVerificationResponse

verifyMailingListMembersFeignResponse

feign.Response verifyMailingListMembersFeignResponse(String mailingListAddress)

Verify all the members of the mailing list.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

Returns:

Response

getMailingListVerificationJobStatus

MailingListVerificationStatusResponse getMailingListVerificationJobStatus(String mailingListAddress)

Retrieve current status of the mailing list verification job.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

Returns:

MailingListVerificationStatusResponse

getMailingListVerificationJobStatusFeignResponse

feign.Response getMailingListVerificationJobStatusFeignResponse(String mailingListAddress)

Retrieve current status of the mailing list verification job.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

Returns:

Response

cancelActiveMailingListVerificationJob

String cancelActiveMailingListVerificationJob(String mailingListAddress)

Cancel an active mailing list verification job.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

Returns:

Result status message

cancelActiveMailingListVerificationJobFeignResponse

feign.Response cancelActiveMailingListVerificationJobFeignResponse(String mailingListAddress)

Cancel an active mailing list verification job.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

Returns:

Response

getMailingListMembers

MailingListMembersResponse getMailingListMembers(String mailingListAddress)

Returns the list of members in the given mailing list (limit to 100 entries).

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

Returns:

MailingListMembersResponse

getMailingListMembersFeignResponse

feign.Response getMailingListMembersFeignResponse(String mailingListAddress)

Returns the list of members in the given mailing list (limit to 100 entries).

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

Returns:

Response

getMailingListMembers

MailingListMembersResponse getMailingListMembers(String mailingListAddress,
                                                 MailingListMembersRequest parameters)

Returns the list of members in the given mailing list.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

parameters - MailingListMembersRequest

Returns:

MailingListMembersResponse

getMailingListMembersFeignResponse

feign.Response getMailingListMembersFeignResponse(String mailingListAddress,
                                                  MailingListMembersRequest parameters)

Returns the list of members in the given mailing list.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

parameters - MailingListMembersRequest

Returns:

Response

getMailingListMember

MailingListMemberResponse getMailingListMember(String mailingListAddress,
                                               String memberAddress)

Retrieves a mailing list member.

Parameters:

mailingListAddress - an email address, the ID for the mailing list

memberAddress - mailing list member email address

Returns:

MailingListMemberResponse

getMailingListMemberFeignResponse

feign.Response getMailingListMemberFeignResponse(String mailingListAddress,
                                                 String memberAddress)

Retrieves a mailing list member.

Parameters:

mailingListAddress - an email address, the ID for the mailing list

memberAddress - mailing list member email address

Returns:

Response

addMemberToMailingList

MailingListMemberResponse addMemberToMailingList(String mailingListAddress,
                                                 MailingListNewMemberRequest request)

Adds a member to the mailing list.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

request - MailingListNewMemberRequest

Returns:

MailingListMemberResponse

addMemberToMailingListFeignResponse

feign.Response addMemberToMailingListFeignResponse(String mailingListAddress,
                                                   MailingListNewMemberRequest request)

Adds a member to the mailing list.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

request - MailingListNewMemberRequest

Returns:

Response

updateMailingListMember

MailingListMemberResponse updateMailingListMember(String mailingListAddress,
                                                  String memberAddress,
                                                  MailingListMemberUpdateRequest request)

Updates a mailing list member with given properties. Won’t touch the property if it’s not passed in.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

memberAddress - mailing list member email address

request - MailingListMemberUpdateRequest

Returns:

MailingListMemberResponse

updateMailingListMemberFeignResponse

feign.Response updateMailingListMemberFeignResponse(String mailingListAddress,
                                                    String memberAddress,
                                                    MailingListMemberUpdateRequest request)

Updates a mailing list member with given properties. Won’t touch the property if it’s not passed in.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

memberAddress - mailing list member email address

request - MailingListMemberUpdateRequest

Returns:

Response

addMembersToMailingList

MailingListResponse addMembersToMailingList(String mailingListAddress,
                                            AddMailingListMembersRequest request)

Adds multiple members, up to 1,000 per call, to a Mailing List.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

request - AddMailingListMembersRequest

Returns:

MailingListResponse

addMembersToMailingListFeignResponse

feign.Response addMembersToMailingListFeignResponse(String mailingListAddress,
                                                    AddMailingListMembersRequest request)

Adds multiple members, up to 1,000 per call, to a Mailing List.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

request - AddMailingListMembersRequest

Returns:

Response

deleteMemberFromMailingList

MailingListMemberResponse deleteMemberFromMailingList(String mailingListAddress,
                                                      String memberAddress)

Delete a mailing list member.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

memberAddress - mailing list member email address

Returns:

MailingListMemberResponse

deleteMemberFromMailingListFeignResponse

feign.Response deleteMemberFromMailingListFeignResponse(String mailingListAddress,
                                                        String memberAddress)

Delete a mailing list member.

Parameters:

mailingListAddress - an email address, the ID for the mailing list.

memberAddress - mailing list member email address

Returns:

Response