|
| | getMessage ($messageNumber, $mailHeaderInfo) |
| |
| | getAttachments ($structure, $messageId) |
| |
| | getMessageUId ($msgNo) |
| |
| | mailCount ($query) |
| |
| | getMimeType ($structure) |
| |
| | getPart ($msgNumber, $mimeType, $structure=null, $partNumber=false) |
| |
|
| resolveContentFromStructure ($content, $structure) |
| |
|
| resolvePasswordKeyName () |
| |
|
| resolveAttributeNameFromSettingsKey ($key) |
| |
|
| resolveAndParseMessageHeaders ($messageNumber) |
| |
Helper class to manage access to IMAP server
Definition at line 40 of file ZurmoImap.php.
Called once per page load, will load up outbound settings from the database if available. (non-PHPdoc)
- See Also
- CApplicationComponent::init()
Definition at line 96 of file ZurmoImap.php.
Load inbound settings from the database.
Definition at line 105 of file ZurmoImap.php.
Set inbound settings into the database.
Definition at line 136 of file ZurmoImap.php.
Connect to imap server
- Exceptions
-
- Returns
- bool
Definition at line 158 of file ZurmoImap.php.
| getMessageBoxStatsDetailed |
( |
| ) |
|
Get detailed info about imap mail box
Definition at line 209 of file ZurmoImap.php.
| resolveMessageBoxStats |
( |
| ) |
|
| getMessage |
( |
|
$messageNumber, |
|
|
|
$mailHeaderInfo |
|
) |
| |
|
protected |
Get email with attachments
- Parameters
-
| int | messageNumbers - message number |
| Object | $mailHeaderInfo | |
- Returns
- array the email info
Definition at line 232 of file ZurmoImap.php.
| getMessages |
( |
|
$searchCriteria = 'ALL', |
|
|
|
$messagesSinceTimestamp = 0, |
|
|
|
$limit = null |
|
) |
| |
Get all messages, that satisfy some criteria, for example: 'ALL', 'UNSEEN', 'SUBJECT "Hello"'
- Parameters
-
| string | $searchCriteria | |
| int | $messagesSinceTimestamp | |
| int | $limit | |
- Returns
- array the messages that was found
Definition at line 333 of file ZurmoImap.php.
Expunge all messages on IMAP server
Definition at line 365 of file ZurmoImap.php.
| deleteMessages |
( |
|
$expunge = false | ) |
|
Delete all messages on IMAP server
Definition at line 378 of file ZurmoImap.php.
Delete message on IMAP server
- Parameters
-
- Returns
- mixed bool false if there is no imapStream available, otherwise result of imap_delete
Definition at line 400 of file ZurmoImap.php.
| getAttachments |
( |
|
$structure, |
|
|
|
$messageId |
|
) |
| |
|
protected |
Get all message attachments
- Parameters
-
| object | $structure | |
| int | $messageId | |
Definition at line 414 of file ZurmoImap.php.
Get a sequenced message id
- Parameters
-
| string | $msgNo | in the format <.**> from the email |
- Returns
- mixed on imap its the unique id (int) and for others its a base64_encoded string
Definition at line 478 of file ZurmoImap.php.
get the count of mails for the given conditions and params
- Todo:
- conditions / order other find params
- Parameters
-
| array | $query | conditions for the query |
- Returns
- int the number of emails found
Definition at line 495 of file ZurmoImap.php.
| getMimeType |
( |
|
$structure | ) |
|
|
protected |
| getPart |
( |
|
$msgNumber, |
|
|
|
$mimeType, |
|
|
|
$structure = null, |
|
|
|
$partNumber = false |
|
) |
| |
|
protected |
- Parameters
-
| $msgNumber | |
| $mimeType | |
| null | $structure | |
| bool | $partNumber | |
- Returns
- bool|string
Definition at line 526 of file ZurmoImap.php.
Does IMAP server require secure connection
Definition at line 65 of file ZurmoImap.php.
IMAP stream. It is setup after connection to IMAP server established.
Definition at line 75 of file ZurmoImap.php.
Initial value:= array(
'imapHost',
'imapUsername',
'imapPassword',
'imapPort',
'imapSSL',
'imapFolder'
)
Definition at line 82 of file ZurmoImap.php.
The documentation for this class was generated from the following file:
- /home/apizurmo/zurmo/app/protected/modules/emailMessages/components/ZurmoImap.php
