Maileon PHP client  1.5.5
Easily integrate your PHP application with Maileon.
com_maileon_api_contacts_ContactsService Class Reference
Inheritance diagram for com_maileon_api_contacts_ContactsService:
com_maileon_api_AbstractMaileonService

Public Member Functions

 createContact ($contact, $syncMode, $src="", $subscriptionPage="", $doi=FALSE, $doiPlus=FALSE, $doiMailingKey="")
 
 createContactByExternalId ($contact, $syncMode, $src="", $subscriptionPage="", $doi=FALSE, $doiPlus=FALSE, $doiMailingKey="")
 
 getContact ($contactId, $checksum, $standard_fields=array(), $custom_fields=array(), $ignoreChecksum=false)
 
 getContactsCount ()
 
 getContacts ($page_index=1, $page_size=100, $standard_fields=array(), $custom_fields=array())
 
 getContactByEmail ($email, $standard_fields=array(), $custom_fields=array())
 
 getContactsByEmail ($email, $standard_fields=array(), $custom_fields=array())
 
 getContactsByExternalId ($externalId, $standard_fields=array(), $custom_fields=array())
 
 getContactsByFilterId ($filterId, $page_index=1, $page_size=100, $standard_fields=array(), $custom_fields=array())
 
 getCountContactsByFilterId ($filterId)
 
 getCountActiveContactsByFilterId ($filterId)
 
 updateContact ($contact, $checksum="", $src=null, $subscriptionPage=null, $triggerDoi=FALSE, $doiMailingKey=null, $ignoreChecksum=false)
 
 synchronizeContacts ($contacts, $permission=null, $syncMode=null, $useExternalId=false, $ignoreInvalidContacts=false, $reimportUnsubscribedContacts=true, $overridePermission=true, $updateOnly=false, $preferMaileonId=false)
 
 unsubscribeContactByEmail ($email, $mailingId="", $reasons=null, $nlAccountIds=array())
 
 addUnsubscriptionReasonsToUnsubscribedContact ($id, $checksum=null, $reasons=null, $ignore_checksum=false)
 
 unsubscribeContactById ($id, $mailingId="", $reasons=null)
 
 unsubscribeContactByExternalId ($externalId, $mailingId="", $reasons=null)
 
 unsubscribeContactByExternalIdFromMultipleAccounts ($externalId, $nlAccountIds=array())
 
 getBlockedContacts ($standardFields=array(), $customFields=array(), $pageIndex=1, $pageSize=1000)
 
 deleteContact ($id)
 
 deleteContactByEmail ($email)
 
 deleteContactsByExternalId ($externalId)
 
 deleteAllContacts ($authorized="no")
 
 createCustomField ($name, $type= 'string')
 
 getCustomFields ()
 
 renameCustomField ($oldName, $newName)
 
 deleteCustomField ($name)
 
 deleteStandardFieldValues ($name)
 
 deleteCustomFieldValues ($name)
 
- Public Member Functions inherited from com_maileon_api_AbstractMaileonService
 __construct (array $config)
 
 setDebug ($isDebug)
 
 isDebug ()
 
 get ($resourcePath, $queryParameters=array(), $mimeType= 'application/vnd.maileon.api+xml', $deserializationType=null)
 
 put ($resourcePath, $payload="", $queryParameters=array(), $mimeType= 'application/vnd.maileon.api+xml', $deserializationType=null)
 
 post ($resourcePath, $payload="", $queryParameters=array(), $mimeType= 'application/vnd.maileon.api+xml', $deserializationType=null, $contentType=null, $contentLength=null)
 
 delete ($resourcePath, $queryParameters=array(), $mimeType= 'application/vnd.maileon.api+xml', $deserializationType=null)
 

Additional Inherited Members

- Static Public Attributes inherited from com_maileon_api_AbstractMaileonService
static $MAILEON_XML_MIME_TYPE = 'application/vnd.maileon.api+xml'
 
- Protected Member Functions inherited from com_maileon_api_AbstractMaileonService
 appendArrayFields ($params, $name, $fieldValues)
 
- Protected Attributes inherited from com_maileon_api_AbstractMaileonService
 $configuration
 
 $encodedApiKey
 
 $debug = false
 
 $throwException = true
 
 $proxy_host
 
 $proxy_port = 80
 
 $timeout
 

Detailed Description

This service wrapps the REST API calls for the contact features.

Author
Felix Heinrichs | Trusted Mails GmbH | felix.heinrichs@trusted-mails.com
Marcus Ständer | Trusted Mails GmbH | marcus.staender@trusted-mails.com

Definition at line 9 of file ContactsService.php.

Member Function Documentation

com_maileon_api_contacts_ContactsService::createContact (   $contact,
  $syncMode,
  $src = "",
  $subscriptionPage = "",
  $doi = FALSE,
  $doiPlus = FALSE,
  $doiMailingKey = "" 
)

Creates or updates a contact and optionally triggers a double opt-in (doi) process. Note that none of the attributes is required.

Parameters
com_maileon_api_contacts_Contact$contactthe contact to create or update; if no permission is set, the Maileon default permission "NONE" will be used
com_maileon_api_contacts_SynchronizationMode$syncModethe synchronization mode to employ
string$srcA string intended to describe the source of the contact. If provided, the string will be stored with the doi process.
string$subscriptionPageIn case where this method was called by a subscription page, this string offers the possibility to keep track of it for use in reports.
bool$doiTells whether a double opt-in process should be started for the created contact. Note that the status code returned for this request does not mean that the doi process succeeded.
bool$doiPlusThis parameter is ignored if doi is not provided or false. In case the doi process succeeds, Maileon will be allowed to track opens and clicks of the contact.
string$doiMailingKeyThis parameter is ignored if doi is not provided or false. References the doi mailing to be used. If not provided, the default doi mailing will be used.
Returns
com_maileon_api_MaileonAPIResult the result object of the API call
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 41 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::createContactByExternalId (   $contact,
  $syncMode,
  $src = "",
  $subscriptionPage = "",
  $doi = FALSE,
  $doiPlus = FALSE,
  $doiMailingKey = "" 
)

Creates or updates a contact based on the external ID and optionally triggers a double opt-in (doi) process. Note that none of the attributes is required. Also note: this call returns 409 Conflict if more then one contact with the given external ID exists as it is impossible to determine the correct contact to update.

Parameters
com_maileon_api_contacts_Contact$contactthe contact to create or update
com_maileon_api_contacts_SynchronizationMode$syncModethe synchronization mode to employ
string$srcA string intended to describe the source of the contact. If provided, the string will be stored with the doi process.
string$subscriptionPageIn case where this method was called by a subscription page, this string offers the possibility to keep track of it for use in reports.
bool$doiTells whether a double opt-in process should be started for the created contact. Note that the status code returned for this request does not mean that the doi process succeeded.
bool$doiPlusThis parameter is ignored if doi is not provided or false. In case the doi process succeeds, Maileon will be allowed to track opens and clicks of the contact.
string$doiMailingKeyThis parameter is ignored if doi is not provided or false. References the doi mailing to be used. If not provided, the default doi mailing will be used.
Returns
com_maileon_api_MaileonAPIResult the result object of the API call
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 99 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::getContact (   $contactId,
  $checksum,
  $standard_fields = array(),
  $custom_fields = array(),
  $ignoreChecksum = false 
)

Return a contact using the maileon contact id. This resource is intended to be used in profile update pages to prefill profile update forms. In order to prevent form fields manipulation, a checksum of the maileon contact id is required as parameter. Please refer to the documentation of the profile update pages for more details about how to get the maileon contact id and the corresponding checksum.

Parameters
string$contactIdthe maileon contact id
string$checksumthe checksum of the maileon contact id
string[]$standard_fields the standard fields to retrieve with the contact
string[]$custom_fields the custom fields to retrieve with the contact
bool$ignoreChecksumif set to true, no checksum is required
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with a com_maileon_api_contacts_Contact available at com_maileon_api_MaileonAPIResult::getResult()
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 141 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::getContactsCount ( )

This method returns the number of contacts in the maileon newsletter account.

Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with the count of contacts available at com_maileon_api_MaileonAPIResult::getResult()
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 164 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::getContacts (   $page_index = 1,
  $page_size = 100,
  $standard_fields = array(),
  $custom_fields = array() 
)

Returns a page of contacts in the account.

Parameters
number$page_indexthe index of the result page to fetch
number$page_sizethe number of results to fetch per page
string[]$standard_fields the standard fields to retrieve for the contacts
string[]$custom_fields the custom fields to retrieve for the contacts
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with a com_maileon_api_contacts_Contacts available at com_maileon_api_MaileonAPIResult::getResult()
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 186 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::getContactByEmail (   $email,
  $standard_fields = array(),
  $custom_fields = array() 
)

Returns a contact with the provided email address.

Parameters
string$emailthe email address to retrieve a contact for
string[]$standard_fields the standard fields to return with the contact
string[]$custom_fields the custom fields to return with the contact
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with a com_maileon_api_contacts_Contact available at com_maileon_api_MaileonAPIResult::getResult()
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 214 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::getContactsByEmail (   $email,
  $standard_fields = array(),
  $custom_fields = array() 
)

Returns a list of contacts with the provided email address.

Parameters
string$emailthe email address to retrieve a contact for
string[]$standard_fields the standard fields to return with the contact
string[]$custom_fields the custom fields to return with the contact
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with an array of com_maileon_api_contacts_Contact available at com_maileon_api_MaileonAPIResult::getResult()
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 240 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::getContactsByExternalId (   $externalId,
  $standard_fields = array(),
  $custom_fields = array() 
)

Retrieves all contacts with a given external ID.

Parameters
string$externalIdthe external ID to search for
string[]$standard_fields
string[]$custom_fields
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with a com_maileon_api_contacts_Contacts available at com_maileon_api_MaileonAPIResult::getResult()
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 263 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::getContactsByFilterId (   $filterId,
  $page_index = 1,
  $page_size = 100,
  $standard_fields = array(),
  $custom_fields = array() 
)

Retrieves all contacts with a given contact filter ID.

Parameters
string$filterIdthe filter ID to use to select contacts
string[]$standard_fields
string[]$custom_fields
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with a com_maileon_api_contacts_Contacts available at com_maileon_api_MaileonAPIResult::getResult()
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 286 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::getCountContactsByFilterId (   $filterId)

Retrieves the number of contacts matching a given contact filter ID.

Parameters
string$filterIdthe filter ID to use to select contacts
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with the number available at com_maileon_api_MaileonAPIResult::getResult()
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 307 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::getCountActiveContactsByFilterId (   $filterId)

Retrieves the number of active contacts matching a given contact filter ID.

Parameters
string$filterIdthe filter ID to use to select contacts
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with the number available at com_maileon_api_MaileonAPIResult::getResult()
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 322 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::updateContact (   $contact,
  $checksum = "",
  $src = null,
  $subscriptionPage = null,
  $triggerDoi = FALSE,
  $doiMailingKey = null,
  $ignoreChecksum = false 
)

This methods updates the data of a Maileon contact identifying a contact by its internal Maileon ID

Parameters
com_maileon_api_contacts_Contact$contactThe contact object to send to Maileon.
string$checksumThis is the checksum that must be used when the request comes from a user, see documentation under http://dev.maileon.com for details.
string$srcThe source that shall be passed to the API.
string$subscriptionPageThe subscription page the request comes from.
boolean$triggerDoiIf true, a DOI mailing will be triggered.
string$doiMailingKeyIf this parameter is set, the DOI mailing with the given ID will be triggered. If not set, the default DOI Mailing will be triggered.
string$ignoreChecksumIf this is true, the checksum will not be validated. This is only valid if the request is NOT triggered by the contact (e.g. on a profile change landing page) but from a third party system.
Returns
com_maileon_api_MaileonAPIResult the result object of the API call
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 349 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::synchronizeContacts (   $contacts,
  $permission = null,
  $syncMode = null,
  $useExternalId = false,
  $ignoreInvalidContacts = false,
  $reimportUnsubscribedContacts = true,
  $overridePermission = true,
  $updateOnly = false,
  $preferMaileonId = false 
)

Synchronizes a list of contacts with the contacts in the account and returns a detailed report with stats and validation errors.

Parameters
com_maileon_api_contacts_Contacts$contactsthe contacts to synchronize
com_maileon_api_contacts_Permission$permissionthe permission to set for the contacts
com_maileon_api_contacts_SynchronizationMode$syncModethe sync mode to use
string$useExternalIdif set to true, the external id is used as identifier for the contacts. Otherwise the email address is used as identifier.
string$ignoreInvalidContactsif set to true, invalid contacts are ignored and the synchronization succeeds for valid contacts.
string$reimportUnsubscribedContactsif set to true, unsubscribed contacts will be imported, if false, they will be ommitted
boolean$overridePermissionif set to true the permission of existing and non existing contacts will be overwridden, if false, the permission will be used for new contacts only and existing contacts will not be influenced.
boolean$updateOnlyIf true, only existing contacts are updated and no new contacts are created
boolean$preferMaileonIdIf true, Maileon tries identifying contacts by Maileon-ID, if available. Fallback is always the email address.
Returns
com_maileon_api_MaileonAPIResult the result object of the API call. The response XML reports which contacts were successfully synchronized as well as any errors that might have occurred.
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 401 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::unsubscribeContactByEmail (   $email,
  $mailingId = "",
  $reasons = null,
  $nlAccountIds = array() 
)

This method unsubscribes a contact from Maileon using the contact's email adress.

Parameters
string$emailThe email address of the contact.
long$mailingIdThe ID of the mailing to assign the unsubscribe to. the mailing must have been sent, i.e. be sealed.
array$reasonsan array of reasons or a single reason (string). Unsubscription reasons have two layers of information, see http://dev.maileon.com/api/rest-api-1-0/contacts/unsubscribe-contacts-by-email for more details about the format. The parameter(s) will be url-encoded by the client, you do not need to provide urlencoded strings.
array$nlAccountsOptional parameter to define in which accounts the email should be unsubscribed. Note: The accounts must belong to the owner of the API key in use, otherwise they will be ignored.
Returns
com_maileon_api_MaileonAPIResult the result object of the API call
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 437 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::addUnsubscriptionReasonsToUnsubscribedContact (   $id,
  $checksum = null,
  $reasons = null,
  $ignore_checksum = false 
)

This method adds unsubscription reasons to an unsubscribed contact. The contact must already be unsubscribed, otherwise 400 will be returned by the PAI

Parameters
int$idThe ID of the contact.
string$checksumThe checksum generated by Maileon
array$reasonsan array of reasons or a single reason (string). Unsubscription reasons have two layers of information, see http://dev.maileon.com/api/rest-api-1-0/contacts/unsubscribe-contacts-by-email for more details about the format. The parameter(s) will be url-encoded by the client, you do not need to provide urlencoded strings.
boolean$ignore_checksumIf the call comes from an authorized system instead of the user you might ignore the checksum
Returns
com_maileon_api_MaileonAPIResult the result object of the API call
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 481 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::unsubscribeContactById (   $id,
  $mailingId = "",
  $reasons = null 
)

This method unsubscribes a contact from Maileon using the Maileon id.

Parameters
int$id
long$mailingIdThe ID of the mailing to assign the unsubscribe to. the mailing must have been sent, i.e. be sealed.
array$reasonsan array of reasons or a single reason (string). Unsubscription reasons have two layers of information, see http://dev.maileon.com/api/rest-api-1-0/contacts/unsubscribe-contacts-by-maileon-id for more details about the format. The parameter(s) will be url-encoded by the client, you do not need to provide urlencoded strings.
Returns
com_maileon_api_MaileonAPIResult the result object of the API call
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 514 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::unsubscribeContactByExternalId (   $externalId,
  $mailingId = "",
  $reasons = null 
)

This method unsubscribes a contact from Maileon using the external id.

Parameters
string$externalIdThe external ID of the contact.
long$mailingIdThe ID of the mailing to assign the unsubscribe to. the mailing must have been sent, i.e. be sealed.
array$reasonsan array of reasons or a single reason (string). Unsubscription reasons have two layers of information, see http://dev.maileon.com/api/rest-api-1-0/contacts/unsubscribe-contacts-external-id for more details about the format. The parameter(s) will be url-encoded by the client, you do not need to provide urlencoded strings.
Returns
com_maileon_api_MaileonAPIResult the result object of the API call
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 547 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::unsubscribeContactByExternalIdFromMultipleAccounts (   $externalId,
  $nlAccountIds = array() 
)

This method unsubscribes a contact from Maileon from several accounts (owner of API key must also be the same customer owning the other accounts).

Parameters
int$externalId
long$nlaccountidThe ID of the mailing to assign the unsubscribe to. the mailing must have been sent, i.e. be sealed.
Returns
com_maileon_api_MaileonAPIResult the result object of the API call
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 576 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::getBlockedContacts (   $standardFields = array(),
  $customFields = array(),
  $pageIndex = 1,
  $pageSize = 1000 
)

Returns a page of blocked contacts. Blocked contacts are contacts with available permission but that are blocked for sendouts because of blacklist matches or similar reasons such as bounce policy.

Parameters
string[]$standardFields the standard fields to select
string[]$customFields the custom fields to select
number$pageIndexthe paging index of the page to retrieve
number$pageSizethe number of results per page
Returns
com_maileon_api_MaileonAPIResult the result object of the API call
com_maileon_api_MaileonAPIResult the result object of the API call, with a com_maileon_api_co
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurredntacts_Contacts available at com_maileon_api_MaileonAPIResult::getResult()

Definition at line 606 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::deleteContact (   $id)

This method removes a contact completely from Maileon using the maileon ID. WARNING: the contact is COMPLETELY removed, not only unsubscribed. This means that not only the contact data is removed but also all statistics change. For most usecases the unsubscribe method is more appropriate.

Parameters
string$emailThe email address of the contact to delete. Does not need to be unique.
Returns
com_maileon_api_MaileonAPIResult the result object of the API call
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 630 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::deleteContactByEmail (   $email)

This method removes all contacts completely from Maileon using the email address. WARNING: the contacts are COMPLETELY removed, not only unsubscribed. This means that not only the contact data is removed but also all statistics change. For most usecases the unsubscribe method is more appropriate.

Parameters
string$emailThe email address of the contact to delete. Does not need to be unique.
Returns
com_maileon_api_MaileonAPIResult the result object of the API call
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 647 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::deleteContactsByExternalId (   $externalId)

This method removes the contacts completely from Maileon using the external id. WARNING: the contacts are COMPLETELY removed, not only unsubscribed. This means that not only the contact data is removed but also all statistics change. For most usecases the unsubscribe method is more appropriate.

Parameters
string$externalID The external ID of the contact to delete. Does not need to be unique.
Returns
com_maileon_api_MaileonAPIResult the result object of the API call
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 663 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::deleteAllContacts (   $authorized = "no")

This method DELETES ALL CONTACTS. Never ever call this unless you'd prefer a career change anyway.

Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with a com_maileon_api_contacts_Contact available at com_maileon_api_MaileonAPIResult::getResult()
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 677 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::createCustomField (   $name,
  $type = 'string' 
)

Creates a custom contact field with the provided name and data type.

Parameters
string$namethe name of the new field
string$typethe type of the new field. Valid values are 'string', 'integer', 'float', 'date' or 'boolean'.
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with a com_maileon_api_contacts_Contact available at com_maileon_api_MaileonAPIResult::getResult()
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 698 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::getCustomFields ( )

Returns the custom contact fields defined in the account.

Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with a com_maileon_api_contacts_CustomFields available at com_maileon_api_MaileonAPIResult::getResult()
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 714 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::renameCustomField (   $oldName,
  $newName 
)

Renames a custom contact field. The data type and the recorded values for the contacts remain unchanged.

Parameters
string$oldNamethe current name of the field
string$newNamethe new name of the field
Returns
com_maileon_api_MaileonAPIResult the result object of the API call
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 732 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::deleteCustomField (   $name)

Deletes the custom contact field with the provided name. Note that all the values of the field get auotmatically deleted by this call.

Parameters
string$namethe name of the field to delete
Returns
com_maileon_api_MaileonAPIResult the result object of the API call
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 750 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::deleteStandardFieldValues (   $name)

Deletes the values of the given standard contact field for all contacts.

Parameters
string$namethe name of the field whose values to delete
Returns
com_maileon_api_MaileonAPIResult the result object of the API call
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 766 of file ContactsService.php.

com_maileon_api_contacts_ContactsService::deleteCustomFieldValues (   $name)

Deletes the values of the given custom contact field for all contacts.

Parameters
string$namethe name of the field whose values to delete
Returns
com_maileon_api_MaileonAPIResult the result object of the API call
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 782 of file ContactsService.php.


The documentation for this class was generated from the following file: