dotmailer SDK: Package dotMailer.Sdk.Enums

dotmailer SDK

dotmailer SDK
Tools to access and manage an account in the dotMailer system
Package dotMailer.Sdk.Enums

Enumerations

enum  AccountInfo {
  AvailibleEmailSendCredits, ListManagedUsers, Name, MainMobilePhoneNumber,
  MainEmail, APICallsInLast24Hours, APICallsRemaining
}
 The propertiest that DmAccountInfo supports More...
 
enum  AddContactResultStatus {
  Starting, Uploading, Processing, CompleteNoError,
  CompleteError
}
 Status of add contacts to address book import process More...
 
enum  CampaignStatus {
  Cancelled, NotSet, Paused, ApprovalRequired,
  WorkflowApprovalRequired, SmsApprovalRequired, Sending, Sent,
  Triggered, Unsent
}
 The possible status of a campaign More...
 
enum  EmailContentTypes { Unknown, PlainText, Html }
 Enum that informs how to send the email More...
 
enum  ContactAudience { Unknown, BusinessToBusiness = ContactAudienceTypes.B2B, BusinessToConsumer = ContactAudienceTypes.B2C, BusinessToMachine = ContactAudienceTypes.B2M }
 ContactAudience More...
 
enum  EmailOptIn { Unknown = ContactOptInTypes.Unknown, Double = ContactOptInTypes.Double, Single = ContactOptInTypes.Single, VerifiedDouble = ContactOptInTypes.VerifiedDouble }
 EmailOptIn More...
 
enum  DmDataFieldTypes { String = ContactDataTypes.String, Decimal = ContactDataTypes.Numeric, Boolean = ContactDataTypes.Boolean, Date = ContactDataTypes.Date }
 The contact data types that are supported More...
 
enum  DmLocale {
  en_Unk, en_GB, en_US, fr_FR,
  de_DE, pt_PT, ru_RU, es_ES
}
 The locale of the account Used for date format processing More...
 
enum  DMErrorCodes {
  ERROR_UNKNOWN = 0, ERROR_ADDRESSBOOK_DUPLICATE, ERROR_ADDRESSBOOK_INVALID, ERROR_ADDRESSBOOK_LIMITEXCEEDED,
  ERROR_ADDRESSBOOK_NOT_FOUND, ERROR_ADDRESSBOOK_NOTWRITABLE, ERROR_APIUSAGE_EXCEEDED, ERROR_CAMPAIGN_INVALID,
  ERROR_CAMPAIGN_NOT_FOUND, ERROR_CAMPAIGN_READONLY, ERROR_CAMPAIGN_SENDNOTPERMITTED, ERROR_CONTACT_INVALID,
  ERROR_CONTACT_NOT_FOUND, ERROR_CONTACT_SUPPRESSED, ERROR_CONTACT_TOOMANY, ERROR_DATAFIELD_LIMITEXCEEDED,
  ERROR_DATAFIELD_NOTFOUND, ERROR_IMPORT_NOT_FOUND, ERROR_IMPORT_TOOMANYACTIVEIMPORTS, ERROR_INVALID_EMAIL,
  ERROR_INVALID_LOGIN, ERROR_NO_EMAIL_COLUMN, ERROR_NON_UNIQUE_DATAFIELD, ERROR_NON_UNIQUE_EMAIL,
  ERROR_PARAMETER_INVALID, ERROR_SEND_LIMITEXCEEDED, ERROR_SMS_INVALIDPHONENUMBER, ERROR_SMS_SENDNOTPERMITTED,
  ERROR_SYSTEM_SERVICETEMPORARILYUNAVAILABLE, ERROR_DATAFIELD_INVALID, ERROR_IMAGE_PARENTFOLDERDOESNOTEXIST, ERROR_IMAGE_PARENTFOLDERDELETED,
  ERROR_IMAGE_NAMEINVALID, ERROR_IMAGE_UNSUPORTEDFORMAT, ERROR_IMAGE_DATAEMPTY, ERROR_DOCUMENT_NOTFOUND,
  ERROR_DOCUMENT_TOOMANYATTACHMENTS, ERROR_DOCUMENT_ATTACHMENTSTOOLARGE, ERROR_FEATURENOTACTIVE, ERROR_DOCUMENT_PARENTFOLDERDOESNOTEXIST,
  ERROR_DOCUMENT_PARENTFOLDERDELETED, ERROR_DOCUMENT_NAMEINVALID, ERROR_DOCUMENT_UNSUPPORTEDFORMAT, ERROR_DOCUMENT_DATAEMPTY,
  ERROR_DOCUMENT_TOOLARGE, ERROR_TEMPLATE_INVALID, ERROR_TEMPLATE_NOT_FOUND, ERROR_CONTACT_ID_MISSING,
  ERROR_CAMPAIGN_ID_MISSING, ERROR_IMPORT_SINGLECONTACT_LIMIT, ERROR_IMPORT_PROGRESSUPDATE_TIMEDOUT, ERROR_JSON_SERIALISATION,
  ERROR_JSON_DESERIALISATION, ERROR_XML_SERIALISATION, ERROR_XML_DESERIALISATION, ERROR_API_DISCONNECTED,
  ERROR_CONNECTION, ERROR_NOCACHEPROVIDER, ERROR_INVALID_IMPORT_TYPE, ERROR_CONTACTIMPORT_RETRY,
  ERROR_ACCOUNT_PROPERTY_NOTFOUND, ERROR_PAGEDAPICALL_TIMEOUT, ERROR_APICALL_TIMEOUT, NUM_ERROR_CODES
}
 Possible api error codes More...
 
enum  SingleAddMode { Overwrite, Merge }
 Defines how contacts are added to an address book in single add mode More...
 
enum  ImportType { ImportContacts, UpdateContacts }
 The type of the import More...
 
enum  ListContactOptions { EmailAddressOnly, FullData }
 List contacts in address book options More...
 
enum  CampaignReplyActions { Delete = ReplyActions.Delete, Unset = ReplyActions.Unset, Webmail = ReplyActions.Webmail, WebmailForward = ReplyActions.WebMailForward }
 The possible campaign reply actions More...
 
enum  ResubscribeContactResult { ContactAdded = ResubscribeResult.ContactAdded, ContactChallenged = ResubscribeResult.ContactChallenged, ContactCannotBeUnsuppressed = ResubscribeResult.ContactCannotBeUnsuppressed }
 A return value from the ResubscribeContact method. More...
 
enum  EmailSendProgress { Unknown, Sending, Complete, Error }
 Email sending progress More...
 
enum  SplitTestSendMode { Opens = APISplitTestMetric.Opens, Clicks = APISplitTestMetric.Clicks, Unknown }
 Split-Test campaign mode More...
 
enum  SerialisationType { Xml, Json }
 The types of Serialisation we support More...
 
enum  SuppressionCause {
  Subscribed = ContactStatuses.Subscribed, UnSubscribed = ContactStatuses.UnSubscribed, SoftBounced = ContactStatuses.SoftBounced, HardBounced = ContactStatuses.HardBounced,
  IspComplained = ContactStatuses.ISPComplained, MailBlocked = ContactStatuses.MailBlocked, PendingOptIn = ContactStatuses.PendingOptIn, DirectComplaint = ContactStatuses.DirectComplaint,
  SpamTrap = ContactStatuses.SpamTrap, Deleted = ContactStatuses.Deleted, BlockedLocalPart = ContactStatuses.BlockedLocalPart, SharedSuppression = ContactStatuses.SharedSuppression,
  SharedSuppressionCreation = ContactStatuses.SharedSuppressionCreation, SharedDomainSuppression = ContactStatuses.SharedDomainSuppression, Suppressed = ContactStatuses.Suppressed, DomainSuppression = ContactStatuses.DomainSuppression,
  NoMxRecord = ContactStatuses.NoMXRecord, NotAllowed, Other, Unknown
}
 Suppression cause values More...
 

Enumeration Type Documentation

The propertiest that DmAccountInfo supports

Enumerator
AvailibleEmailSendCredits 
ListManagedUsers 
Name 
MainMobilePhoneNumber 
MainEmail 
APICallsInLast24Hours 
APICallsRemaining 

Status of add contacts to address book import process

Enumerator
Starting 

Process in starting up

Uploading 

Uploading contacts to DM service

Processing 

Dm service is processing the contacts

CompleteNoError 

Import process has been completed with no errors

CompleteError 

Import process has been completed with error

The possible campaign reply actions

Enumerator
Delete 

todo

Unset 

todo

Webmail 

todo

WebmailForward 

todo

The possible status of a campaign

Enumerator
Cancelled 

Campaign has been cancelled

NotSet 

todo

Paused 

Campaign has been paused

ApprovalRequired 

todo

WorkflowApprovalRequired 

Workflow approval required to send

SmsApprovalRequired 

todo

Sending 

The campaign is being sent

Sent 

The campaign has been sent

Triggered 

The campaign has been triggered

Unsent 

todo

ContactAudience

Enumerator
Unknown 

ContactAudience unknown

BusinessToBusiness 

B2B

BusinessToConsumer 

B2C

BusinessToMachine 

todo

The contact data types that are supported

Enumerator
String 

string -> currently only supported

Decimal 

Number (e.g. 1.0)

Boolean 

True or false

Date 

Date/time

Possible api error codes

Enumerator
ERROR_UNKNOWN 

Unknown error

ERROR_ADDRESSBOOK_DUPLICATE 

Duplicate address book error

ERROR_ADDRESSBOOK_INVALID 

Invalid Address book

ERROR_ADDRESSBOOK_LIMITEXCEEDED 

The address book is full

ERROR_ADDRESSBOOK_NOT_FOUND 

Address book not found

ERROR_ADDRESSBOOK_NOTWRITABLE 

address book is read-only/system

ERROR_APIUSAGE_EXCEEDED 

Api usage limit has bee exceeded default is 15,000 calls in 24 hour period

ERROR_CAMPAIGN_INVALID 

Campaign invalid/incomplete

ERROR_CAMPAIGN_NOT_FOUND 

Campaign not found

ERROR_CAMPAIGN_READONLY 

Campaign is read-only

ERROR_CAMPAIGN_SENDNOTPERMITTED 

Sending to specified campaign is not allowed (are there send credits ?)

ERROR_CONTACT_INVALID 

Invalid/incomplete contact

ERROR_CONTACT_NOT_FOUND 

Contact not found

ERROR_CONTACT_SUPPRESSED 

Contact is in the local/global suppression list

ERROR_CONTACT_TOOMANY 

Too many contacts (?)

ERROR_DATAFIELD_LIMITEXCEEDED 

Too many data fields on the account

ERROR_DATAFIELD_NOTFOUND 

Data field not found

ERROR_IMPORT_NOT_FOUND 

Import set not found

ERROR_IMPORT_TOOMANYACTIVEIMPORTS 

Cannot start import as the account has too many active imports

ERROR_INVALID_EMAIL 

Invalid email address

ERROR_INVALID_LOGIN 

Invalid login check username and password

ERROR_NO_EMAIL_COLUMN 

No email column in import csv

ERROR_NON_UNIQUE_DATAFIELD 

Duplicate data field

ERROR_NON_UNIQUE_EMAIL 

duplicate email address

ERROR_PARAMETER_INVALID 

Parameter is invalid (?)

ERROR_SEND_LIMITEXCEEDED 

Cannot send, no send credits left

ERROR_SMS_INVALIDPHONENUMBER 

Cannot sms, invalid phone number

ERROR_SMS_SENDNOTPERMITTED 

SMS sending not allowed

ERROR_SYSTEM_SERVICETEMPORARILYUNAVAILABLE 

Service is down

ERROR_DATAFIELD_INVALID 

Datafield invalid

ERROR_IMAGE_PARENTFOLDERDOESNOTEXIST 

Parent folder does not exist

ERROR_IMAGE_PARENTFOLDERDELETED 

Parent folder deleted

ERROR_IMAGE_NAMEINVALID 

The name was invalid

ERROR_IMAGE_UNSUPORTEDFORMAT 

The image format is not supported

ERROR_IMAGE_DATAEMPTY 

The data was empty

ERROR_DOCUMENT_NOTFOUND 

The document could not be found

ERROR_DOCUMENT_TOOMANYATTACHMENTS 

Too many attachments

ERROR_DOCUMENT_ATTACHMENTSTOOLARGE 

The attachments were too large

ERROR_FEATURENOTACTIVE 

Feature not active

ERROR_DOCUMENT_PARENTFOLDERDOESNOTEXIST 

The parent folder does not exist

ERROR_DOCUMENT_PARENTFOLDERDELETED 

Parent folder deleted

ERROR_DOCUMENT_NAMEINVALID 

Name invalid

ERROR_DOCUMENT_UNSUPPORTEDFORMAT 

Unsupported format

ERROR_DOCUMENT_DATAEMPTY 

Data empty

ERROR_DOCUMENT_TOOLARGE 

The document was too large

ERROR_TEMPLATE_INVALID 

The template was not valid

ERROR_TEMPLATE_NOT_FOUND 

The template could not be found

ERROR_CONTACT_ID_MISSING 

no contact Id provided

ERROR_CAMPAIGN_ID_MISSING 

no campaign Id provided

ERROR_IMPORT_SINGLECONTACT_LIMIT 

single contact import limit exceeded

ERROR_IMPORT_PROGRESSUPDATE_TIMEDOUT 

GetContactImportProgress api timedout

ERROR_JSON_SERIALISATION 

Error in json serialisation

ERROR_JSON_DESERIALISATION 

Error in json deserialisation

ERROR_XML_SERIALISATION 

Error in xml serialisation

ERROR_XML_DESERIALISATION 

Error in xml deserialisation

ERROR_API_DISCONNECTED 

Api does not have any active connection to the webservice

ERROR_CONNECTION 

Failed to connect to the webservice, check internet connection

ERROR_NOCACHEPROVIDER 

An action required a cache provider, but none was provided

ERROR_INVALID_IMPORT_TYPE 

The specified import contact result was an invalid type for the operations

ERROR_CONTACTIMPORT_RETRY 

The service attempted to retry to upload a contact import batch, more times than was allowed.

ERROR_ACCOUNT_PROPERTY_NOTFOUND 

The specified account property was not found

ERROR_PAGEDAPICALL_TIMEOUT 

a paged api call timeout

ERROR_APICALL_TIMEOUT 

An api call timedout

NUM_ERROR_CODES 

total number of error codes

The locale of the account Used for date format processing

Enumerator
en_Unk 

Locale Unknown, provided for integration systems

en_GB 

UK English

en_US 

US English

fr_FR 

French

de_DE 

German

pt_PT 

Polish

ru_RU 

Russian

es_ES 

Spanish

Enum that informs how to send the email

Enumerator
Unknown 

Content type unknown

PlainText 

Plain text emails only

Html 

Html emails are ok

EmailOptIn

Enumerator
Unknown 

EmailOptIn unknown

Double 

todo

Single 

todo

VerifiedDouble 

todo

Email sending progress

Enumerator
Unknown 

unknown

Sending 

Email is sending

Complete 

Email was sent

Error 

There was an error sending

The type of the import

Enumerator
ImportContacts 

Import added contacts (default)

UpdateContacts 

Import was used to update existing contacts

List contacts in address book options

Enumerator
EmailAddressOnly 

return just the email address book

FullData 

Email address book and all data fields

A return value from the ResubscribeContact method.

Enumerator
ContactAdded 

Contact added

ContactChallenged 

Contact challenged

ContactCannotBeUnsuppressed 

Contact cannot be suppressed

The types of Serialisation we support

Enumerator
Xml 

To/From XML

Json 

To/From JSON

Defines how contacts are added to an address book in single add mode

Enumerator
Overwrite 

Overwrite existing contacts (default)

Merge 

Merge the contact data

Split-Test campaign mode

Enumerator
Opens 

Split on Opens

Clicks 

Split on clicks

Unknown 

unknown

Suppression cause values

Enumerator
Subscribed 

The contact is already subscribed

UnSubscribed 

The contact unsubscribed

SoftBounced 

The contact soft bounced

HardBounced 

The contact hard bounced

IspComplained 

There is an isp complaint associated with the contact

MailBlocked 

The contact was blocked

PendingOptIn 
DirectComplaint 

The contact complained directly to dotMailer

SpamTrap 

Known spam trap

Deleted 

Contact was deleted

BlockedLocalPart 
SharedSuppression 
SharedSuppressionCreation 
SharedDomainSuppression 
Suppressed 
DomainSuppression 

The contact's email address domain has been suppressed

NoMxRecord 

Total number of values

NotAllowed 
Other 
Unknown 
Generated by   doxygen 1.8.3