{"_id":"56b2583a9621f20d00efb31c","user":"5582e90181672a3900bb4fc7","category":{"_id":"56b25826147e900d00d6497a","project":"569f9cf6650e1d1900f96b5b","version":"569f9cf6650e1d1900f96b5e","pages":["56b2583a9621f20d00efb31c","56b25a3965ddf50d0076baa2","56b2738894ab060d0006743c","56b4d1cf5f1cf00d00cc46d7","56b4f4e2b1a8690d00a59369","56b4f6925f1cf00d00cc4704","56b4fa3d5997532100bc6bcc","56b50ba8eed075230097d71e","56b5123585a6922300d1c506","56b51e475997532100bc6c08","56b5220b7719bb1900143055","56b524cc3d5f130d00dad1b8","56b5265b168b5c1700c15996","56b774438fb4420d006a618b","56b78012eb783a0d007894f3","56b78292a6c10c0d00a2d65d","56b7863aeb783a0d007894f8","56b78f68a6c10c0d00a2d66b","56b794566c2a240d0094ae8a","56b7a85dd22adc0d0053f4c2","56b7ac118fb4420d006a61b7"],"__v":21,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-03T19:42:30.051Z","from_sync":false,"order":7,"slug":"user-methods","title":"User methods"},"githubsync":"","version":{"_id":"569f9cf6650e1d1900f96b5e","project":"569f9cf6650e1d1900f96b5b","__v":12,"createdAt":"2016-01-20T14:43:02.785Z","releaseDate":"2016-01-20T14:43:02.785Z","categories":["569f9cf7650e1d1900f96b5f","56abdd81d4432d1900eed235","56abe0558beeff0d003b8118","56ad2f8b1c09150d00a183a8","56ad4e1cd21f1b0d00fd2f97","56b00ad88f7a4f0d0029dc92","56b2432e9621f20d00efb2bd","56b25826147e900d00d6497a","56b7af2a4b372d2100722c48","56b8c4d938b1070d0028920f","56b8cdab14feef0d0082415d","58599813cf9e112d0032cdab"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"project":"569f9cf6650e1d1900f96b5b","__v":3,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-03T19:42:50.939Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"This section contains the following methods:\n\n  * change_user — Creates a new user or changes the attributes of an existing user.\n  \n  * delete_user — Soft deletes a user's account.\n  \n  * generate token — Generates a temporary login token for a user.\n  \n  * get_deleted_contacts — Retrieves a list of deleted restorable contacts\nfrom a user's Webmail address book. \n  \n  * get_deleted_messages — Retrieves a list of recoverable deleted email messages belonging to a user.\n  \n  * get user — Retrieves the settings and values for a specified user.\n  \n  * get_user_attribute_history — Retrieves the historical values for an\nattribute for a specified user.\n  \n  * get_user_changes — Retrieves a summary of the changes made to a user account.\n  \n  * get_user_folders — Retrieves a list of a user's current and deleted folders.\n  \n  * get_user_messages — Returns a list of user messages in a specified folder.\n  \n  * logout_user — Terminates all IMAP and POP sessions that the specified user has active.\n  \n  * move_user_messages — Moves the specified user messages to a different folder.\n  \n  * reindex — Regenerates the specified mailbox index file.\n  \n  * rename_user — Changes a user's mailbox name.\n  \n  * restore_deleted_contacts — Restores deleted contacts for a specified\nuser.\n \n  * restore_deleted_messages — Restores specific deleted messages.\n  \n  * restore_user — Restores specified user accounts.\n  \n  * search_users — Searches for users in a specified domain.\n  \n  * set_role — Assigns a role to the specified user.\n  \n  * user_notify — Checks to see if the specified user has any unseen mail.","excerpt":"","slug":"overview-5","type":"basic","title":"Overview"}
This section contains the following methods: * change_user — Creates a new user or changes the attributes of an existing user. * delete_user — Soft deletes a user's account. * generate token — Generates a temporary login token for a user. * get_deleted_contacts — Retrieves a list of deleted restorable contacts from a user's Webmail address book. * get_deleted_messages — Retrieves a list of recoverable deleted email messages belonging to a user. * get user — Retrieves the settings and values for a specified user. * get_user_attribute_history — Retrieves the historical values for an attribute for a specified user. * get_user_changes — Retrieves a summary of the changes made to a user account. * get_user_folders — Retrieves a list of a user's current and deleted folders. * get_user_messages — Returns a list of user messages in a specified folder. * logout_user — Terminates all IMAP and POP sessions that the specified user has active. * move_user_messages — Moves the specified user messages to a different folder. * reindex — Regenerates the specified mailbox index file. * rename_user — Changes a user's mailbox name. * restore_deleted_contacts — Restores deleted contacts for a specified user. * restore_deleted_messages — Restores specific deleted messages. * restore_user — Restores specified user accounts. * search_users — Searches for users in a specified domain. * set_role — Assigns a role to the specified user. * user_notify — Checks to see if the specified user has any unseen mail.