SetUserSettings
Description
The SetUserSettings() method allows controlling the user's settings. These settings are also controlled from the Control Panel website.
To improve efficiency you are required to provide only those settings you wish to change. Other settings will not be changed.
Formal Definition
https://api.postalmethods.com/2009-09-09/AdminTools.asmx?op=SetUserSettings
Input
| Property | Type | Comments |
|---|---|---|
| APIKey | String | The API key of the administrator user |
| Username | String | The username who's settings are to be changed |
| Settings | Array | An ArrayOfString. Each array contains a string containing the name of the setting that should be changed and a string containing the new value of that setting. |
Optional settings that may be changed
(all values as string)
| Setting | Possible Values | Comments |
|---|---|---|
| General | ||
| General_Description | Up to 100 characters | User's name / description. |
| General_Timezone | A Zone Info format | User's time zone is needed in order to display any date/time value in the user's time. |
| General_WorkMode | Production or Development | Production and Development Work Modes |
| Security | ||
| Security_Password | A valid password | Between 4-32 characters. A-Z,a-z,0-9,!,@,&,*,-,.,_ |
| Security_AdministrativeEmail | A valid email address | User's Administrative email is used for password retrieval and general error messages. |
| Security_KeepContentOnServer | True or False |
Determines whether message contents sent via PostalMethods are retained in the system for your reference, or deleted immediately to comply with enhanced privacy requirements. |
| Letters | ||
| Letters_PrintColor | BlackAndWhite or FullColor | Default color of the ink used when printing a letter. |
| Letters_PrintSides | Simplex or Duplex | For multi-page mail items: Simplex: each page is printed on a single sheet of paper. Duplex: two consecutive pages are printed on a single sheet of paper. |
| Postcards | ||
| Postcards_DefaultScaling | None or FitToPage | Default scaling options when using images for postcards: None: Specified image is used as-is and is not re-sized in case it is too small or too large. FitToPage: Specified image is re-sized in case it is too small or too large. |
| Feedback | ||
| Feedback_FeedbackType | None or Email or Soap or Post | A feedback message may be sent upon specified events of the mail item's life-cycle. Read more about Push Feedback. |
| Feedback_Email_WhenToSend_EmailReceived | True or False | An email message is sent to report that the user's email was received and is being processed. |
| Feedback_Email_WhenToSend_Completed | True or False | An email message is sent to report that the mail item is now in the postal stream. |
| Feedback_Email_WhenToSend_Error | True or False | An email message is sent to report that there has been a problem with the mail item. |
| Feedback_Email_WhenToSend_BatchErrors | True or False | When using the PostalMethods Web Service or the PostalMethods Word 2007 Mail Merge Add-in , a unique email message is sent on error to each individual document (not recommended). |
| Feedback_Email_DefaultFeedbackEmail | A valid email address | Feedback email messages are normally sent to the email address which originated the mail item. If a mail item is originated via Web Service, or if you would like to always get feedback to a specific email address, set it as the Default Feedback Email. |
| Feedback_Email_Authentication | Up to 255 characters | PostalMethods will provide the authentication (AUTH) string in the feedback email header. You may validate this string to make sure it is coming from PostalMethods. If not populated, this X-header will not appear in the message header. |
| Feedback_Post_WhenToSend_Completed | True or False | A request is sent to report that the mail item is now in the postal stream. |
| Feedback_Post_WhenToSend_Error | True or False | A request is sent to report that there has been a problem with the mail item. |
| Feedback_Post_WhenToSend_BatchErrors | True or False | When using the PostalMethods Web Service or the PostalMethods Word 2007 Mail Merge Add-in , a unique email message is sent on error to each individual document (not recommended). |
| Feedback_Post_FeedbackURL | A valid URL | The URL to where feedback requests are sent. |
| Feedback_Post_Authentication | Up to 255 characters | The authentication (AUTH) string is sent by PostalMethods when feedback type is HTTP POST. You may validate this string to make sure it is coming from PostalMethods. |
| Feedback_Soap_WhenToSend_Completed | True or False | A request is sent to report that the mail item is now in the postal stream. |
| Feedback_Soap_WhenToSend_Error | True or False | A request is sent to report that there has been a problem with the mail item. |
| Feedback_Soap_WhenToSend_BatchErrors | True or False | When using the PostalMethods Web Service or the PostalMethods Word 2007 Mail Merge Add-in , a unique email message is sent on error to each individual document (not recommended). |
| Feedback_Soap_FeedbackURL | A valid URL | The URL to where feedback requests are sent. |
| Feedback_Soap_Authentication | Up to 255 characters | The authentication (AUTH) string is sent by PostalMethods when feedback type is SOAP XML. You may validate this string to make sure it is coming from PostalMethods. |
Output: SetUserSettingsResponse
| Element | Type | Comments |
|---|---|---|
| SetUserSettingsResult | int | Result code for this Web Service request. Possible result codes appear in the Web Service Result Codes list |