C# Class MailChimp.Api.Net.Services.Lists.MailChimpList

Mostra file Open project: shahriarhossain/MailChimp.Api.Net Class Usage Examples

Public Methods

Method	Description
AddMember ( MCMember member, string list_id ) : Task	Add a new list member Member to be added to the list Unique id for the list
AddMergeField ( MergeField mergeField, string list_id ) : Task	Add a new list merge field The name of the merge field.
CreateListAsync ( string listName, Contact contactForCampaignFotter, string permissionReminderText, CampaignDefaults defaultValue, bool emailTypeOption = false, ListVisibility listVisibility = ListVisibility.pub ) : Task	Create a new list The name of the list Contact information displayed in campaign footers to comply with international spam laws The permission reminder for the list Default values for campaigns created for this list Whether the list supports multiple formats for emails. Whether this list is public or private
DeleteListAsync ( string list_id ) : Task	Delete a list Unique id for the list
DeleteMemberAsync ( string list_id, string subscriber_hash ) : Task	Delete a list member Unique id for the list The MD5 hash of the lowercase version of the list member’s email address
DeleteMergeFieldAsync ( string list_id, string merge_id ) : Task	Delete a merge field Unique id for the list The id for the merge field
DeleteSegmentAsync ( string list_id, string segment_id ) : Task	Delete a segment Unique id for the list The MD5 hash of the lowercase version of the list member’s email address
GetAbuseReportsAsync ( string list_id ) : Task	Get information about abuse reports Unique id for the list
GetAllListsAsync ( int offset, int count = 10 ) : Task	Get information about all lists
GetAllMemberInfoAsync ( string list_id, int offset, int count = 10 ) : Task	Get information about members in a list Unique id for the list
GetAllMergeFieldsAsync ( string list_id ) : Task	Get all merge fields for a list Unique id for the list
GetAllSegmentAsync ( string list_id ) : Task	Get information about all segments in a list Unique id for the list
GetGrowthHistoryAsync ( string list_id ) : Task	Get list growth history data Unique id for the list
GetGrowthHistoryByMonthAsync ( string list_id, string month ) : Task	Get list growth history by month Unique id for the list A specific month of list growth history.
GetInfoForSpecificSegmentAsync ( string list_id, string segment_id ) : Task	Get information about a specific segment Unique id for the list Unique id for the segment
GetListAsync ( string list_id ) : Task	Get information about a specific list Unique id for the list
GetMemberInfoAsync ( string list_id, string subscriber_hash ) : Task	Get information about a specific list member Unique id for the list The MD5 hash of the lowercase version of the list member’s email address
GetMergeFieldAsync ( string list_id, string merge_id ) : Task	Get a specific merge field Unique id for the list The id for the merge field
GetRecentActivityAsync ( string list_id ) : Task	Get recent list activity Unique id for the list
GetSpecificAbuseReportAsync ( string list_id, string report_id ) : Task	Get details about a specific abuse report Unique id for the list Id for the abuse report
GetTopEmailClientsAsync ( string list_id ) : Task	Get top email clients Unique id for the list
MailChimpList ( ) : System.Net.Http
UpdateList ( string list_id, string listName, Contact contactForCampaignFotter, string permissionReminderText, CampaignDefaults defaultValue, bool emailTypeOption = false, ListVisibility listVisibility = ListVisibility.pub ) : Task	Update a list Unique id for the list The name of the list Contact information displayed in campaign footers to comply with international spam laws The permission reminder for the list Default values for campaigns created for this list Whether the list supports multiple formats for emails. Whether this list is public or private
UpdateMember ( MCMember member, string list_id ) : Task	Update a list member Member to be updated in the list Unique id for the list
UpdateMergeField ( MergeField mergeField, string list_id ) : Task	Update a list merge field Merge field to update Unique id for the list

Method Details

AddMember() public method

Add a new list member Member to be added to the list Unique id for the list

public AddMember ( MCMember member, string list_id ) : Task
member	MailChimp.Api.Net.Domain.Lists.MCMember
list_id	string
return	Task

AddMergeField() public method

Add a new list merge field The name of the merge field.

public AddMergeField ( MergeField mergeField, string list_id ) : Task
mergeField	MailChimp.Api.Net.Domain.Lists.MergeField
list_id	string
return	Task

CreateListAsync() public method

Create a new list The name of the list Contact information displayed in campaign footers to comply with international spam laws The permission reminder for the list Default values for campaigns created for this list Whether the list supports multiple formats for emails. Whether this list is public or private

public CreateListAsync ( string listName, Contact contactForCampaignFotter, string permissionReminderText, CampaignDefaults defaultValue, bool emailTypeOption = false, ListVisibility listVisibility = ListVisibility.pub ) : Task
listName	string
contactForCampaignFotter	MailChimp.Api.Net.Domain.Lists.Contact
permissionReminderText	string
defaultValue	MailChimp.Api.Net.Domain.Lists.CampaignDefaults
emailTypeOption	bool
listVisibility	ListVisibility
return	Task

DeleteListAsync() public method

Delete a list Unique id for the list

public DeleteListAsync ( string list_id ) : Task
list_id	string
return	Task

DeleteMemberAsync() public method

Delete a list member Unique id for the list The MD5 hash of the lowercase version of the list member’s email address

public DeleteMemberAsync ( string list_id, string subscriber_hash ) : Task
list_id	string
subscriber_hash	string
return	Task

DeleteMergeFieldAsync() public method

Delete a merge field Unique id for the list The id for the merge field

public DeleteMergeFieldAsync ( string list_id, string merge_id ) : Task
list_id	string
merge_id	string
return	Task

DeleteSegmentAsync() public method

Delete a segment Unique id for the list The MD5 hash of the lowercase version of the list member’s email address

public DeleteSegmentAsync ( string list_id, string segment_id ) : Task
list_id	string
segment_id	string
return	Task

GetAbuseReportsAsync() public method

Get information about abuse reports Unique id for the list

public GetAbuseReportsAsync ( string list_id ) : Task
list_id	string
return	Task

GetAllListsAsync() public method

Get information about all lists

public GetAllListsAsync ( int offset, int count = 10 ) : Task
offset	int
count	int
return	Task

GetAllMemberInfoAsync() public method

Get information about members in a list Unique id for the list

public GetAllMemberInfoAsync ( string list_id, int offset, int count = 10 ) : Task
list_id	string
offset	int
count	int
return	Task

GetAllMergeFieldsAsync() public method

Get all merge fields for a list Unique id for the list

public GetAllMergeFieldsAsync ( string list_id ) : Task
list_id	string
return	Task

GetAllSegmentAsync() public method

Get information about all segments in a list Unique id for the list

public GetAllSegmentAsync ( string list_id ) : Task
list_id	string
return	Task

GetGrowthHistoryAsync() public method

Get list growth history data Unique id for the list

public GetGrowthHistoryAsync ( string list_id ) : Task
list_id	string
return	Task

GetGrowthHistoryByMonthAsync() public method

Get list growth history by month Unique id for the list A specific month of list growth history.

public GetGrowthHistoryByMonthAsync ( string list_id, string month ) : Task
list_id	string
month	string
return	Task

GetInfoForSpecificSegmentAsync() public method

Get information about a specific segment Unique id for the list Unique id for the segment

public GetInfoForSpecificSegmentAsync ( string list_id, string segment_id ) : Task
list_id	string
segment_id	string
return	Task

GetListAsync() public method

Get information about a specific list Unique id for the list

public GetListAsync ( string list_id ) : Task
list_id	string
return	Task

GetMemberInfoAsync() public method

Get information about a specific list member Unique id for the list The MD5 hash of the lowercase version of the list member’s email address

public GetMemberInfoAsync ( string list_id, string subscriber_hash ) : Task
list_id	string
subscriber_hash	string
return	Task

GetMergeFieldAsync() public method

Get a specific merge field Unique id for the list The id for the merge field

public GetMergeFieldAsync ( string list_id, string merge_id ) : Task
list_id	string
merge_id	string
return	Task

GetRecentActivityAsync() public method

Get recent list activity Unique id for the list

public GetRecentActivityAsync ( string list_id ) : Task
list_id	string
return	Task

GetSpecificAbuseReportAsync() public method

Get details about a specific abuse report Unique id for the list Id for the abuse report

public GetSpecificAbuseReportAsync ( string list_id, string report_id ) : Task
list_id	string
report_id	string
return	Task

GetTopEmailClientsAsync() public method

Get top email clients Unique id for the list

public GetTopEmailClientsAsync ( string list_id ) : Task
list_id	string
return	Task

MailChimpList() public method

public MailChimpList ( ) : System.Net.Http
return	System.Net.Http

UpdateList() public method

Update a list Unique id for the list The name of the list Contact information displayed in campaign footers to comply with international spam laws The permission reminder for the list Default values for campaigns created for this list Whether the list supports multiple formats for emails. Whether this list is public or private

public UpdateList ( string list_id, string listName, Contact contactForCampaignFotter, string permissionReminderText, CampaignDefaults defaultValue, bool emailTypeOption = false, ListVisibility listVisibility = ListVisibility.pub ) : Task
list_id	string
listName	string
contactForCampaignFotter	MailChimp.Api.Net.Domain.Lists.Contact
permissionReminderText	string
defaultValue	MailChimp.Api.Net.Domain.Lists.CampaignDefaults
emailTypeOption	bool
listVisibility	ListVisibility
return	Task

UpdateMember() public method

Update a list member Member to be updated in the list Unique id for the list

public UpdateMember ( MCMember member, string list_id ) : Task
member	MailChimp.Api.Net.Domain.Lists.MCMember
list_id	string
return	Task

UpdateMergeField() public method

Update a list merge field Merge field to update Unique id for the list

public UpdateMergeField ( MergeField mergeField, string list_id ) : Task
mergeField	MailChimp.Api.Net.Domain.Lists.MergeField
list_id	string
return	Task