Struct mailchimp::types::ListMember

pub struct ListMember {
    pub id: String,
    pub email_address: String,
    pub unique_email_id: String,
    pub email_type: String,
    pub status: String,
    pub unsubscribe_reason: String,
    pub merge_fields: HashMap<String, String>,
    pub interests: HashMap<String, String>,
    pub stats: SubscriberStats,
    pub timestamp_signup: String,
    pub ip_opt: String,
    pub timestamp_opt: String,
    pub member_rating: u64,
    pub last_changed: String,
    pub language: String,
    pub vip: bool,
    pub email_client: String,
    pub location: SubscriberLocation,
    pub marketing_permissions: Vec<ListMarketingPermision>,
    pub last_note: ListNote,
    pub tags_count: u64,
    pub tags: Vec<String>,
    pub ip_signup: String,
    pub list_id: String,
    pub _links: Vec<LinkType>,
    // some fields omitted
}

Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member.

Fields

id: String

The MD5 hash of the lowercase version of the list member’s email address.

email_address: String

Email address for a subscriber.

unique_email_id: String

An identifier for the address across all of Mailchimp.

email_type: String

Type of email this member asked to get (‘html’ or ‘text’).

status: String

Subscriber’s current status.

unsubscribe_reason: String

A subscriber’s reason for unsubscribing.

merge_fields: HashMap<String, String>

An individual merge var and value for a member.

interests: HashMap<String, String>

The key of this object’s properties is the ID of the interest in question.

stats: SubscriberStats

Open and click rates for this subscriber.

timestamp_signup: String

The date and time the subscriber signed up for the list in ISO 8601 format.

ip_opt: String

The IP address the subscriber used to confirm their opt-in status.

timestamp_opt: String

The date and time the subscribe confirmed their opt-in status in ISO 8601 format.

member_rating: u64

Star rating for this member, between 1 and 5.

last_changed: String

The date and time the member’s info was last changed in ISO 8601 format.

language: String

If set/detected, the subscriber’s language.

vip: bool

VIP status for subscriber.

email_client: String

The list member’s email client.

location: SubscriberLocation

Subscriber location information.

marketing_permissions: Vec<ListMarketingPermision>

The marketing permissions for the subscriber.

last_note: ListNote

The most recent Note added about this member.

tags_count: u64

The number of tags applied to this member.

tags: Vec<String>

The tags applied to this member.

ip_signup: String

IP address the subscriber signed up from.

list_id: String

The list id.

_links: Vec<LinkType>

A list of link types and descriptions for the API schema documents.

Methods

impl ListMember

pub fn permanently_delete(&self) -> Option<MailchimpErrorType>

Permanently delete a list member

Delete all personally identifiable information related to a list member, and remove them from a list. This will make it impossible to re-import the list member.

pub fn delete(&self) -> Option<MailchimpErrorType>

Permanently delete a list member

Delete a member from a list.

pub fn set_api(&mut self, n_api: &MailchimpApi)

Update API

pub fn set_endpoint<'a>(&mut self, n_endpoint: &'a str)

Set new value for endpoint

Argumentos: n_endpoint: Nuevo Endpoint

pub fn get_base_endpoint(&self) -> String

Get resource endpoint

Important traits for MalchimpIter<B>

impl<B> Iterator for MalchimpIter<B> where
    B: BuildIter,
    B::FilterItem: ResourceFilter,
    B::Collection: MailchimpCollection<B::Item> + DeserializeOwned + Default,  type Item = B::Item;

pub fn get_activity(&self) -> MalchimpIter<ListMemberActivityBuilder>

Get details about subscribers’ recent activity.

Important traits for MalchimpIter<B>

impl<B> Iterator for MalchimpIter<B> where
    B: BuildIter,
    B::FilterItem: ResourceFilter,
    B::Collection: MailchimpCollection<B::Item> + DeserializeOwned + Default,  type Item = B::Item;

pub fn get_goals(&self) -> MalchimpIter<ListMemberGoalBuilder>

Get information about recent goal events for a specific list member.

Arguments: subscriber_hash: The MD5 hash of the lowercase version of the list member’s email address.

Important traits for MalchimpIter<B>

impl<B> Iterator for MalchimpIter<B> where
    B: BuildIter,
    B::FilterItem: ResourceFilter,
    B::Collection: MailchimpCollection<B::Item> + DeserializeOwned + Default,  type Item = B::Item;

pub fn get_tags(&self) -> MalchimpIter<ListMemberTagBuilder>

Get the tags on a list member.

pub fn post_tag(
    &self,
    tags: Vec<ListMemberTagType>
) -> Option<MailchimpErrorType>

Post the tags on a list member.

Add or remove tags from a list member. If a tag that does not exist is passed in and set as ‘active’, a new tag will be created.

Important traits for MalchimpIter<B>

impl<B> Iterator for MalchimpIter<B> where
    B: BuildIter,
    B::FilterItem: ResourceFilter,
    B::Collection: MailchimpCollection<B::Item> + DeserializeOwned + Default,  type Item = B::Item;

pub fn get_notes(
    &self,
    filters: Option<SimpleFilter>
) -> MalchimpIter<ListMemberNoteBuilder>

Get recent notes for a specific list member

Arguments: filters

pub fn get_specific_note<'a>(
    &self,
    note_id: &'a str
) -> Result<ListMemberNote, MailchimpErrorType>

Get details about subscribers’ recent activity.

Argument: note_id: The id for the note.

pub fn create_note<'a>(
    &self,
    note: &'a str
) -> Result<ListMemberNote, MailchimpErrorType>

Add a new note for a specific subscriber.

Argument: note: The content of the note. Note length is limited to 1,000 characters.

Trait Implementations

impl MailchimpCollection<ListMember> for CollectionListMembers

fn get_total_items(&self) -> u64

Total Items

fn get_values(&self) -> Vec<ListMember>

Data

impl MailchimpCollection<ListMember> for CollectionListSegmentMembers

fn get_total_items(&self) -> u64

Total Items

fn get_values(&self) -> Vec<ListMember>

Data

impl Clone for ListMember

fn clone(&self) -> ListMember

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListMember

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Serialize for ListMember

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for ListMember

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.