Customer Email Type

The CustomerEmailType is a complex Type in xWeb used to manage email addresses.

Namespaces

When passing a CustomerEmailType as a parameter to xWeb web methods, be sure to set the namespace properly.

Important! Parameters that fail to specify proper namespaces will not be interpreted correctly and will result in method faults.

Schema

Here is the schema for CustomerEmailType:

<s:complexType name="CustomerEmailType">
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="CurrentKey" nillable="true" type="tns:av_key_Type">
<s:annotation>
<s:documentation>Unique Key.The current key is the record key for the object. This field must be set whenever updating an existing database record.</s:documentation>
</s:annotation>
</s:element>
<s:element name="Email" type="tns:IndividualEmail_Email_DataObjectType" />
<s:element name="Customer" type="tns:IndividualEmail_Customer_DataObjectType" />
</s:sequence>
</s:complexType>

Refer to the xWeb WSDL for details about each element. Please see xWeb Type for more information about xWeb schemas and how they can vary slightly from one site and build to the next.

Top-level Elements:

Name	Description	Datatype	Notes
CurrentKey	Primary Key	av_key_Type	The primary key of the Email Address.
Email	Email Element	IndividualEmail_Email_DataObjectType	Contains elements about an email address.
Customer	Customer Element	IndividualEmail_Customer_DataObjectType	Contains elements about the customer. This element is read-only.

 

IndividualEmail_Email_DataObjectType

All elements are minOccurs=0 and maxOccurs=1.

Name	Description	Datatype	Notes
eml_key	Primary Key	av_key_Type	Leave nullable or do not pass for inserts.
eml_address	Email Address	av_email_Type	The actual email address.
eml_cst_key	Customer Key	av_key_Type	The Customer Key.
eml_type	Type	stringLength20_Type	The type; typically business or personal, unless client has overridden these default options. This could vary for each client. There is not a web method to determine the values; check with the client.
eml_add_user	Add User	av_user_Type	Generally you should not pass this value for inserts or updates as netFORUM will automatically set it.
eml_add_date	Add Date	av_date_Type	Generally you should not pass this value for inserts or updates as netFORUM will automatically set it.
eml_change_user	Change User	av_user_Type	Generally you should not pass this value for inserts or updates as netFORUM will automatically set it.
eml_change_date	Change Date	av_date_Type	Generally you should not pass this value for inserts or updates as netFORUM will automatically set it.
eml_delete_flag	Delete Flag	av_delete_flag_Type	If you need to hide a record, set this value to 1.
eml_key_ext	Extender Key	av_key_Type	This duplicates the Primary Key. Do not set this value for inserts and for updates you can pass the value or omit the element.
eml_entity_key	Entity Key	av_key_Type	Generally you should not pass this value for inserts or updates as netFORUM will automatically set it.
eml_invalid_flag	Invalid Flag	av_flag_Type	1 if invalid, else 0. netFORUM may set this value to 1 in case of excessive bounces. You will probably not want to set this value but it may be useful to read the value. If the value is 1, then you probably should not count on this email address working.
eml_invalid_reason	Invalid Reason	stringLength50_Type	If invalid, the reason (if any) will be here.
eml_unlisted_flag	Unlisted Flag	av_flag_Type	Unlisted Flag. 1 means unlisted, 0 means not.
eml_primary	Primary Flag	av_flag_Type	1 if the email address is the customer's primary email address, 0 if not. If you are inserting or updating an email address and you set the value to 1, then it will make that email address be the customer's primary email address.

 

Sample

Here is an example of the CustomerEmailType with sample data.

<CurrentKey>52e2259a-0d1c-4b03-847e-b1eac924ba16</CurrentKey>
<Email>
<eml_key>52e2259a-0d1c-4b03-847e-b1eac924ba16</eml_key>
<eml_address>[e-mail]</eml_address>
<eml_cst_key>abb95afb-3896-448e-a206-3a6cbc9b63c9</eml_cst_key>
<eml_type>work</eml_type>
<eml_add_user>dhopkins</eml_add_user>
<eml_add_date>12/20/2011 4:05:38 PM</eml_add_date>
<eml_delete_flag>0</eml_delete_flag>
<eml_key_ext>52e2259a-0d1c-4b03-847e-b1eac924ba16</eml_key_ext>
<eml_invalid_flag>0</eml_invalid_flag>
<eml_unlisted_flag>0</eml_unlisted_flag>
<eml_primary>0</eml_primary>
</Email>
<Customer>
<cst_key>abb95afb-3896-448e-a206-3a6cbc9b63c9</cst_key>
<cst_type>Individual</cst_type>
<cst_name_cp>John Doe</cst_name_cp>
<cst_sort_name_dn>Doe John</cst_sort_name_dn>
<cst_ind_full_name_dn>John Doe</cst_ind_full_name_dn>
<cst_add_date>11/14/2011</cst_add_date>
<cst_add_user>web:anonymous</cst_add_user>
<cst_change_date>01/04/2012</cst_change_date>
<cst_change_user>dhopkins</cst_change_user>
<cst_delete_flag>0</cst_delete_flag>
<cst_recno>87087</cst_recno>
<cst_id>000087087I</cst_id>
<cst_key_ext>abb95afb-3896-448e-a206-3a6cbc9b63c9</cst_key_ext>
<cst_email_text_only>0</cst_email_text_only>
<cst_credit_limit>0.00</cst_credit_limit>
<cst_tax_exempt_flag>0</cst_tax_exempt_flag>
<cst_cxa_key>99410a25-9d14-4ce7-b61d-7653cd1c51f4</cst_cxa_key>
<cst_no_email_flag>0</cst_no_email_flag>
<cst_cxa_billing_key>99410a25-9d14-4ce7-b61d-7653cd1c51f4</cst_cxa_billing_key>
<cst_no_phone_flag>0</cst_no_phone_flag>
<cst_no_fax_flag>0</cst_no_fax_flag>
<cst_no_web_flag>0</cst_no_web_flag>
<cst_member_flag>0</cst_member_flag>
<cst_no_msg_flag>0</cst_no_msg_flag>
<cst_no_mail_flag>0</cst_no_mail_flag>
<cst_web_login_disabled_flag>0</cst_web_login_disabled_flag>
<cst_credit_hold_flag>0</cst_credit_hold_flag>
<cst_no_publish_flag>0</cst_no_publish_flag>
<cst_salutation_1>John</cst_salutation_1>
<cst_salutation_2>Johnny</cst_salutation_2>
<cst_default_recognize_as>John</cst_default_recognize_as>
<cst_score>8.7000</cst_score>
<cst_score_normalized>100</cst_score_normalized>
<cst_score_trend>3</cst_score_trend>
<cst_exclude_from_social_flag>0</cst_exclude_from_social_flag>
</Customer>