Class iNotePrecipitator
iNotePrecipitator.php
iCloud Notes Access Functions Class
Methods summary
public
|
|
public
integer
|
|
public
integer
|
|
public
integer
|
|
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. |
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. |
public
string
|
|
public
string
|
|
public
integer
|
|
public
boolean
|
|
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). |
public
Array
|
|
public
Array
|
|
public
boolean
|
#
Create_New_Note( string $Note_Subject, string $Note_Text )
Create a new note with a given subject and body text. |
public
|
#
Delete_Note_By_ID( integer $ID_Num, boolean $Expunge = TRUE )
Delete a note by ID. (And force deletion) |
public
|
|
public
|
#
Expunge_Notes_Pending_Deletion( )
Permenantly deletes all notes that are marked as "deleted" but are still in the icloud. |
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. |
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). |
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). |
Properties summary
protected
object
|
$imap
IMAP connection object. |
|
protected
string
|
$email
The user's email address. |
|
protected
string
|
$username
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. |
|
protected
array
|
$regular_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. |
|
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. |
|
protected
array
|
$note_headers
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. |
#
FALSE
|