Class iNotePrecipitator

iNotePrecipitator.php

iCloud Notes Access Functions Class

Author: Avi Ginsberg
Version: 0.1.0
Located at iNotePrecipitator.php

Methods summary

`public`	# `__construct( string $email, string $password )` Constructs a new iNotePrecipitator object. Constructs a new iNotePrecipitator object. Parameters `$email` The email address used to log into the iCloud account. `$password` The password used to log into the iCloud account.
`public integer`	# `Get_Total_Notes_Count( )` Get the total number of notes in the iCloud account. Get the total number of notes in the iCloud account. Returns integer Description: Returns total number of notes (deleted and regular).
`public integer`	# `Get_Regular_Notes_Count( )` Get the number of regular (non-deleted) notes in the iCloud account. Get the number of regular (non-deleted) notes in the iCloud account. Returns integer Description: Returns number of regular notes.
`public integer`	# `Get_Deleted_Notes_Count( )` Get the number of deleted notes in the iCloud account. Get the number of deleted notes in the iCloud account. Returns integer Description: Returns number of deleted notes.
`public Array`	# `Get_Note_Header_By_ID_Num( integer $ID_Num )` Get the header data of a note and returns it as an associative array. Get the header data of a note and returns it as an associative array. Parameters `$ID_Num` The numerical ID of the note. Returns Array Description: An associative array containing note header data. Common values are "Date", "Subject", and "Size". Other values may be present. These values differ based on iOS version that created the note.
`public Array`	# `Get_Note_With_Header_Data_By_ID_Num( integer $ID_Num )` Get the header data and body text of a note and returns it as an associative array. Get the header data and body text of a note and returns it as an associative array. Parameters `$ID_Num` The numerical ID of the note. Returns Array Description: An associative array containing standardized note header data and note body text. Values are "Date", "H-Date", "Unix-Date", "Subject", "ID-Num", "Size", and "Note".
`public string`	# `Get_Note_Body_By_ID_Num( integer $ID_Num )` Get the body text of a specific note. Get the body text of a specific note. Parameters `$ID_Num` The numerical ID of the note. Returns string Description: The body text of the note.
`public string`	# `Get_Note_Subject_By_ID_Num( integer $ID_Num )` Get the subject of a specific note. Get the subject of a specific note. Parameters `$ID_Num` The numerical ID of the note. Returns string Description: The subject of the note.
`public integer`	# `Get_Note_Size_By_ID_Num( integer $ID_Num )` Get the size (in bytes) of a specific note. Get the size (in bytes) of a specific note. Parameters `$ID_Num` The numerical ID of the note. Returns integer Description: The size (in bytes) of the note.
`public boolean`	# `Check_If_Note_Exists_By_ID_Num( integer $ID_Num )` Check if the a note exists (based on note ID). Check if the a note exists (based on note ID). Parameters `$ID_Num` The numerical ID of the note. Returns boolean Description: TRUE if the note exists. FALSE if the note does NOT exist.
`public boolean`	# `Check_If_Note_Is_Deleted_By_ID_Num( integer $ID_Num )` Check if the a note is currently marked as deleted (based on note ID). Check if the a note is currently marked as deleted (based on note ID). Parameters `$ID_Num` The numerical ID of the note. Returns boolean Description: TRUE if the note is marked as deleted. FALSE if the note is NOT marked as deleted.
`public Array`	# `Get_All_Deleted_Notes( )` Gets all deleted notes and returns them in an associative array. Gets all deleted notes and returns them in an associative array. Returns Array Description: Returns an associative array of deleted notes formatted as: Note_ID_Number => Array(Note & Header Data)
`public Array`	# `Get_All_Regular_Notes( )` Gets all regular notes and returns them in an associative array. Gets all regular notes and returns them in an associative array. Returns Array Description: Returns an associative array of regular notes formatted as: Note_ID_Number => Array(Note & Header Data)
`public boolean`	# `Create_New_Note( string $Note_Subject, string $Note_Text )` Create a new note with a given subject and body text. Create a new note with a given subject and body text. Parameters `$Note_Subject` The note subject. `$Note_Text` The note body text. Returns boolean Description: Returns TRUE if the note was created successfully and FALSE if the creation failed
`public`	# `Delete_Note_By_ID( integer $ID_Num, boolean $Expunge = TRUE )` Delete a note by ID. (And force deletion) Delete a note by ID. (And force deletion) Parameters `$ID_Num` The note's ID number. `$Expunge` Whether to expunge the note or not. Default is TRUE. See description. Returns Description: This method deletes a note by ID. If $Expunge is set to FALSE it will only mark the message for deletion (set a flag). Setting it to TRUE forces deletion of the message. This may also delete all other messages that have been marked for deletion.
`public`	# `UnDelete_Note_By_ID( integer $ID_Num )` UnDelete a note by ID (that has been marked as deleted) UnDelete a note by ID (that has been marked as deleted) Parameters `$ID_Num` The note's ID number. Returns Description: This method deletes a note by ID. It is designed to undelete notes that are marked as deleted but are still in the icloud.Warning: Setting $Expunge to TRUE will destroy any chance of recovering accidentally deleted notes.
`public`	# `Expunge_Notes_Pending_Deletion( )` Permenantly deletes all notes that are marked as "deleted" but are still in the icloud. Permenantly deletes all notes that are marked as "deleted" but are still in the icloud. Returns Warning: This will destroy any chance of recovering accidentally deleted notes.
`public Array`	# `Search_Notes( string $search_string, integer $search_mode )` Searches all regular notes (note body text) for a given string. Supports case sensitivity and regex. Searches all regular notes (note body text) for a given string. Supports case sensitivity and regex. Parameters `$search_string` The string to search for. (or the pattern to match if in regex mode) `$search_mode` The search mode. 0 for RegEx, 1 for CaSe SeNsItIvE, 2 for case insensitive. Returns Array Description: Returns an associative array of regular notes that matched the search string or pattern formatted as: Note_ID_Number => Array(Note & Header Data)
`public Array`	# `List_Note_IDs_By_Date_Ascending( )` Generate a list of note IDs in Ascending order (from oldest to newest note based on note timestamps). Generate a list of note IDs in Ascending order (from oldest to newest note based on note timestamps). Returns Array Description: Returns an array of note ID's with the oldest note ID in slot O of the array, and the newest note ID in the last slot of the array.
`public Array`	# `List_Note_IDs_By_Date_Descending( )` Generate a list of note IDs in Descending order (from newest to oldest note based on note timestamps). Generate a list of note IDs in Descending order (from newest to oldest note based on note timestamps). Returns Array Description: Returns an array of note ID's with the newest note ID in slot O of the array, and the oldest note ID in the last slot of the array.

Properties summary

`protected object`	`$imap` IMAP connection object. IMAP connection object.	#
`protected string`	`$email` The user's email address. The user's email address.	#
`protected string`	`$username` The user's username (everything before the @ symbol in the email address.) Derived from $email. The user's username (everything before the @ symbol in the email address.) Derived from $email.	#
`protected string`	`$domain` The FQDN of the user's email address (everything after the @ symbol in the email address.) Derived from $email. The FQDN of the user's email address (everything after the @ symbol in the email address.) Derived from $email.	#
`protected array`	`$regular_notes` Associative array containing all regular notes from the user's icloud account. (regular notes are non-deleted notes) Associative array containing all regular notes from the user's icloud account. (regular notes are non-deleted notes)	#
`protected array`	`$deleted_notes` Associative array containing all deleted notes from the user's icloud account. Associative array containing all deleted notes from the user's icloud account.	#
`protected array`	`$notes_mailbox_info` Associative array containing various properties of the notes storage mailbox including: Date, Driver, Mailbox name, Number of notes, Notes storage mailbox size. Associative array containing various properties of the notes storage mailbox including: Date, Driver, Mailbox name, Number of notes, Notes storage mailbox size.	#
`protected array`	`$note_headers` Associative array containing all note header data. Associative array containing all note header data.	#
`public boolean`	`$login_success` Boolean representing login success. Is set to TRUE when an icloud login has been completed successfully. Boolean representing login success. Is set to TRUE when an icloud login has been completed successfully.	# `FALSE`

Classes

Class iNotePrecipitator

Methods summary

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Properties summary