Represents an address book in dotMailer
More...
|
| DmContactCollection | ContactsUnsubscribedSince (DateTime sinceDate) |
| | Returns a list of contacts that have unsubscribed from the address book since the specified date
|
| |
| DmContactCollection | ContactsModifedSince (DateTime sinceDate) |
| | Returns a list of contacts that have been modified in the address book since the specified date
|
| |
| bool | RemoveContact (string contactMail, bool preventResubscribe, bool totalUnsubscribe) |
| | Removes a contact from the address book
|
| |
| bool | RemoveAllContacts (bool preventResubscribe, bool totalUnsubscribe) |
| | Removes all of the contacts in the address book
|
| |
|
| int | Id [get, set] |
| | The system Id of the address book
|
| |
| int | AccountId [get, set] |
| | Returns the dotMailer account Id for this address book
|
| |
| bool | IsNew [get, set] |
| | Is this a newly crated address book
|
| |
| string | Name [get, set] |
| | The name of the address book
|
| |
| string | UserTag1 [get, set] |
| | User Tag
|
| |
| string | UserTag2 [get, set] |
| | User Tag
|
| |
| string | UserTag3 [get, set] |
| | User Tag
|
| |
| int | NumberOfContacts [get] |
| | Gets the number of contacts that are held by the address book
|
| |
| DmCampaignCollection | Campaigns [get] |
| | Gets the campaigns that have sent emails to this address book
|
| |
| DmContactCollection | Contacts [get] |
| | Gets the collection of contacts
|
| |
| bool | IsDirty [get] |
| | Returns true if the object has changed
|
| |
| string | ObjectType [get, set] |
| | Returns the type name of the class Used by the serialisation process
|
| |
| string | ExternalId [get] |
| | Gets/Sets the generated Id that uniquely identifies this record
|
| |
| int | Id [get, set] |
| | The Id of the address book
|
| |
| string | Name [get, set] |
| | The name of the address book
|
| |
| int | AccountId [get] |
| | The DotMailer account Id for this object
|
| |
| string | ExternalId [get] |
| | A key that represents this object, used for synching with external applications
|
| |
| bool | IsDirty [get] |
| | has the data of the object changed
|
| |
| DmContactCollection dotMailer.Sdk.AddressBook.DmAddressBook.ContactsModifedSince |
( |
DateTime |
sinceDate | ) |
|
Returns a list of contacts that have been modified in the address book since the specified date
- Parameters
-
| sinceDate | DatTime to start listing from |
- Returns
- DmContactCollection containing matching contacts
- Exceptions
-
| NullReferenceException | Thrown if Address Book Id is invalid |
| DmContactCollection dotMailer.Sdk.AddressBook.DmAddressBook.ContactsUnsubscribedSince |
( |
DateTime |
sinceDate | ) |
|
Returns a list of contacts that have unsubscribed from the address book since the specified date
- Parameters
-
| sinceDate | DateTime to start listing from |
- Returns
- DmContactCollection containing matching contacts
- Exceptions
-
| NullReferenceException | Thrown if Address Book Id is invalid |
| bool dotMailer.Sdk.AddressBook.DmAddressBook.RemoveAllContacts |
( |
bool |
preventResubscribe, |
|
|
bool |
totalUnsubscribe |
|
) |
| |
Removes all of the contacts in the address book
- Parameters
-
| preventResubscribe | if true, will prevent the contacts from re-subscribing to the address book |
| totalUnsubscribe | if true, the contacts will be prevented from being added to any address book |
- Returns
- true if all of the contacts were successfully removed
- Exceptions
-
| NullReferenceException | Thrown if Address Book Id is invalid |
| bool dotMailer.Sdk.AddressBook.DmAddressBook.RemoveContact |
( |
string |
contactMail, |
|
|
bool |
preventResubscribe, |
|
|
bool |
totalUnsubscribe |
|
) |
| |
Removes a contact from the address book
- Parameters
-
| contactMail | The email address of the contact |
| preventResubscribe | if true, will prevent the contact from re-subscribing to the address book |
| totalUnsubscribe | if true, the contact will be prevented from being added to any address book |
- Returns
- true if specified contact was removed
- Exceptions
-
| NullReferenceException | Thrown if Address Book Id is invalid |
| int dotMailer.Sdk.AddressBook.DmAddressBook.AccountId |
|
getset |
Returns the dotMailer account Id for this address book
Gets the campaigns that have sent emails to this address book
Gets the collection of contacts
| string dotMailer.Sdk.AddressBook.DmAddressBook.ExternalId |
|
get |
Gets/Sets the generated Id that uniquely identifies this record
| int dotMailer.Sdk.AddressBook.DmAddressBook.Id |
|
getset |
The system Id of the address book
| bool dotMailer.Sdk.AddressBook.DmAddressBook.IsDirty |
|
get |
Returns true if the object has changed
| bool dotMailer.Sdk.AddressBook.DmAddressBook.IsNew |
|
getset |
Is this a newly crated address book
| string dotMailer.Sdk.AddressBook.DmAddressBook.Name |
|
getset |
The name of the address book
| int dotMailer.Sdk.AddressBook.DmAddressBook.NumberOfContacts |
|
get |
Gets the number of contacts that are held by the address book
| string dotMailer.Sdk.AddressBook.DmAddressBook.ObjectType |
|
getset |
Returns the type name of the class Used by the serialisation process
| string dotMailer.Sdk.AddressBook.DmAddressBook.UserTag1 |
|
getset |
| string dotMailer.Sdk.AddressBook.DmAddressBook.UserTag2 |
|
getset |
| string dotMailer.Sdk.AddressBook.DmAddressBook.UserTag3 |
|
getset |
Properties inherited from dotMailer.Sdk.Interfaces.IDmAddressBook
1.8.3