You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-`default`— used default account. It will be used as default for any missing account parameters. If however the default account is missing a parameter the package default will be used. Set to `false` to disable this functionality.
121
+
-`default`— used default account. It will be used as default for any missing account parameters. If however the default account isn't set, the library defaults will be used instead. Set to `false` to disable this behavior.
122
122
-`accounts`— all available accounts
123
-
-`default`—The account identifier (in this case `default` but could also be `fooBar` etc).
124
-
-`host`—imap host
125
-
-`port`—imap port
123
+
-`default`— account identifier (in this case `default` but could also be `fooBar` etc).
124
+
-`host`—server host
125
+
-`port`—server port
126
126
-`encryption`— desired encryption method
127
127
-`validate_cert`— decide weather you want to verify the certificate or not
128
-
-`username`—imap account username
129
-
-`password`—imap account password
130
-
-`date_format`—The default date format is used to convert any given Carbon::class object into a valid date string. (`d-M-Y`, `d-M-y`, `d M y`)
128
+
-`username`— account username
129
+
-`password`— account password
130
+
-`date_format`— default date format. Used to convert any given Carbon::class object into a valid date string. (`d-M-Y`, `d-M-y`, `d M y`)
131
131
-`options`— additional fetch options
132
-
-`delimiter`—you can use any supported char such as ".", "/", etc
132
+
-`delimiter`—folder / mailbox delimiter. You can use any supported char such as ".", "/", etc
133
133
-`fetch`—`IMAP::FT_UID` (message marked as read by fetching the message) or `IMAP::FT_PEEK` (fetch the message without setting the "read" flag)
134
-
-`fetch_body`—If set to `false` all messages will be fetched without the body and any potential attachments
135
-
-`fetch_attachment`—If set to `false` all messages will be fetched without any attachments
136
-
-`fetch_flags`—If set to `false` all messages will be fetched without any flags
134
+
-`fetch_body`—if set to `false` all messages will be fetched without the body and any potential attachments
135
+
-`fetch_attachment`—if set to `false` all messages will be fetched without any attachments
136
+
-`fetch_flags`—if set to `false` all messages will be fetched without any flags
-`decoder`—currently only the message subject and attachment name decoder can be set
142
+
-`masks`—default[masking](#masking) config
143
+
-`message`—default message mask
144
+
-`attachment`—default attachment mask
145
145
146
146
## Usage
147
147
#### Basic usage example
@@ -208,8 +208,8 @@ $oClient->connect();
208
208
209
209
#### Folder / Mailbox
210
210
There is an experimental function available to get a Folder instance by name.
211
-
For an easier access please take a look at the new config option `imap.options.delimiter` however the `getFolder`
212
-
method takes three options: the required (string) $folder_name and two optional variables. An integer $attributes which
211
+
For an easier access please take a look at the new config option `imap.options.delimiter`. The `Client::getFolder`
212
+
method takes three arguments: the required (string) $folder_name and two optional variables. An integer $attributes which
213
213
seems to be sometimes 32 or 64 (I honestly have no clue what this number does, so feel free to enlighten me and anyone
214
214
else) and a delimiter which if it isn't set will use the default option configured inside the [config/imap.php](src/config/imap.php) file.
215
215
> If you are using Exchange you might want to set all parameter and the last `$prefix_address` to `false` e.g. `$oClient->getFolder('name', 32, null, false)`#234
0 commit comments