| 
    ILIAS
    release_9 Revision v9.13-25-g2c18ec4c24f
    
   | 
  
Class ilMailOptions this class handles user mails. More...
 Collaboration diagram for ilMailOptions:Data Fields | |
| final const | INCOMING_LOCAL = 0 | 
| final const | INCOMING_EMAIL = 1 | 
| final const | INCOMING_BOTH = 2 | 
| final const | FIRST_EMAIL = 3 | 
| final const | SECOND_EMAIL = 4 | 
| final const | BOTH_EMAIL = 5 | 
| final const | ABSENCE_STATUS_PRESENT = false | 
| final const | ABSENCE_STATUS_ABSENT = true | 
Protected Member Functions | |
| read () | |
Protected Attributes | |
| ILIAS | $ilias | 
| ilDBInterface | $db | 
| ilSetting | $settings | 
| string | $table_mail_options = 'mail_options' | 
| string | $signature = '' | 
| bool | $isCronJobNotificationEnabled = false | 
| int | $incomingType = self::INCOMING_LOCAL | 
| int | $default_incoming_type = self::INCOMING_LOCAL | 
| int | $emailAddressMode = self::FIRST_EMAIL | 
| int | $default_email_address_mode = self::FIRST_EMAIL | 
| ilMailTransportSettings | $mailTransportSettings | 
| string | $firstEmailAddress = '' | 
| string | $secondEmailAddress = '' | 
| bool | $absence_status = self::ABSENCE_STATUS_PRESENT | 
| int | $absent_from = 0 | 
| int | $absent_until = 0 | 
| string | $absence_auto_responder_body = '' | 
| string | $absence_auto_responder_subject = '' | 
| ClockInterface | $clockService | 
Static Private Member Functions | |
| static | lookupNotificationSetting (int $usrId) | 
Class ilMailOptions this class handles user mails.
Definition at line 29 of file class.ilMailOptions.php.
| ilMailOptions::__construct | ( | protected int | $usrId, | 
| ilMailTransportSettings | $mailTransportSettings = null,  | 
        ||
| ClockInterface | $clockService = null,  | 
        ||
| ilSetting | $settings = null,  | 
        ||
| ilDBInterface | $db = null  | 
        ||
| ) | 
Definition at line 60 of file class.ilMailOptions.php.
References $default_email_address_mode, $default_incoming_type, $DIC, ILIAS\Repository\int(), isCronJobNotificationEnabled(), read(), and ILIAS\Repository\settings().
 Here is the call graph for this function:| ilMailOptions::createMailOptionsEntry | ( | ) | 
create entry in table_mail_options for a new user this method should only be called from createUser()
Definition at line 97 of file class.ilMailOptions.php.
References isCronJobNotificationEnabled().
 Here is the call graph for this function:| ilMailOptions::getAbsenceAutoresponderBody | ( | ) | 
Definition at line 328 of file class.ilMailOptions.php.
References $absence_auto_responder_body.
Referenced by updateOptions().
 Here is the caller graph for this function:| ilMailOptions::getAbsenceAutoresponderSubject | ( | ) | 
Definition at line 368 of file class.ilMailOptions.php.
References $absence_auto_responder_subject.
Referenced by updateOptions().
 Here is the caller graph for this function:| ilMailOptions::getAbsenceStatus | ( | ) | 
Definition at line 338 of file class.ilMailOptions.php.
References $absence_status.
Referenced by isAbsent(), and updateOptions().
 Here is the caller graph for this function:| ilMailOptions::getAbsentFrom | ( | ) | 
Definition at line 348 of file class.ilMailOptions.php.
References $absent_from.
Referenced by isAbsent(), and updateOptions().
 Here is the caller graph for this function:| ilMailOptions::getAbsentUntil | ( | ) | 
Definition at line 358 of file class.ilMailOptions.php.
References $absent_until.
Referenced by isAbsent(), and updateOptions().
 Here is the caller graph for this function:| ilMailOptions::getEmailAddressMode | ( | ) | 
Definition at line 255 of file class.ilMailOptions.php.
References $emailAddressMode.
Referenced by getExternalEmailAddresses(), and updateOptions().
 Here is the caller graph for this function:| ilMailOptions::getExternalEmailAddresses | ( | ) | 
Definition at line 286 of file class.ilMailOptions.php.
References $firstEmailAddress, $secondEmailAddress, and getEmailAddressMode().
 Here is the call graph for this function:| ilMailOptions::getIncomingType | ( | ) | 
Definition at line 230 of file class.ilMailOptions.php.
References $incomingType.
Referenced by updateOptions().
 Here is the caller graph for this function:| ilMailOptions::getSignature | ( | ) | 
Definition at line 225 of file class.ilMailOptions.php.
References $signature.
Referenced by updateOptions().
 Here is the caller graph for this function:| ilMailOptions::getUsrId | ( | ) | 
Definition at line 265 of file class.ilMailOptions.php.
| ilMailOptions::isAbsent | ( | ) | 
Definition at line 373 of file class.ilMailOptions.php.
References getAbsenceStatus(), getAbsentFrom(), and getAbsentUntil().
Referenced by ILIAS\Mail\Autoresponder\AutoresponderServiceImpl\enqueueAutoresponderIfEnabled().
 Here is the call graph for this function:
 Here is the caller graph for this function:| ilMailOptions::isCronJobNotificationEnabled | ( | ) | 
Definition at line 250 of file class.ilMailOptions.php.
References $isCronJobNotificationEnabled.
Referenced by __construct(), createMailOptionsEntry(), read(), setIsCronJobNotificationStatus(), and updateOptions().
 Here is the caller graph for this function:
      
  | 
  staticprivate | 
| ilMailOptions::mayManageInvididualSettings | ( | ) | 
Definition at line 127 of file class.ilMailOptions.php.
References ILIAS\Repository\settings().
Referenced by mayModifyIndividualTransportSettings(), and read().
 Here is the call graph for this function:
 Here is the caller graph for this function:| ilMailOptions::mayModifyIndividualTransportSettings | ( | ) | 
Definition at line 113 of file class.ilMailOptions.php.
References mayManageInvididualSettings(), maySeeIndividualTransportSettings(), and ILIAS\Repository\settings().
Referenced by read().
 Here is the call graph for this function:
 Here is the caller graph for this function:| ilMailOptions::maySeeIndividualTransportSettings | ( | ) | 
Definition at line 122 of file class.ilMailOptions.php.
References ILIAS\Repository\settings().
Referenced by mayModifyIndividualTransportSettings().
 Here is the call graph for this function:
 Here is the caller graph for this function:
      
  | 
  protected | 
Definition at line 132 of file class.ilMailOptions.php.
References $res, ILIAS\Repository\int(), isCronJobNotificationEnabled(), mayManageInvididualSettings(), mayModifyIndividualTransportSettings(), setAbsenceAutoresponderBody(), setAbsenceAutoresponderSubject(), setAbsenceStatus(), setAbsentFrom(), and setAbsentUntil().
Referenced by __construct().
 Here is the call graph for this function:
 Here is the caller graph for this function:| ilMailOptions::setAbsenceAutoresponderBody | ( | string | $absence_auto_responder_body | ) | 
Definition at line 323 of file class.ilMailOptions.php.
References $absence_auto_responder_body.
Referenced by read().
 Here is the caller graph for this function:| ilMailOptions::setAbsenceAutoresponderSubject | ( | string | $absence_auto_responder_subject | ) | 
Definition at line 363 of file class.ilMailOptions.php.
References $absence_auto_responder_subject.
Referenced by read().
 Here is the caller graph for this function:| ilMailOptions::setAbsenceStatus | ( | bool | $absence_status | ) | 
Definition at line 333 of file class.ilMailOptions.php.
References $absence_status.
Referenced by read().
 Here is the caller graph for this function:| ilMailOptions::setAbsentFrom | ( | int | $absent_from | ) | 
Definition at line 343 of file class.ilMailOptions.php.
References $absent_from.
Referenced by read().
 Here is the caller graph for this function:| ilMailOptions::setAbsentUntil | ( | int | $absent_until | ) | 
Definition at line 353 of file class.ilMailOptions.php.
References $absent_until.
Referenced by read().
 Here is the caller graph for this function:| ilMailOptions::setEmailAddressMode | ( | int | $emailAddressMode | ) | 
| ilMailOptions::setIncomingType | ( | int | $incomingType | ) | 
| ilMailOptions::setIsCronJobNotificationStatus | ( | bool | $isCronJobNotificationEnabled | ) | 
Definition at line 245 of file class.ilMailOptions.php.
References $isCronJobNotificationEnabled, and isCronJobNotificationEnabled().
 Here is the call graph for this function:| ilMailOptions::setSignature | ( | string | $signature | ) | 
| ilMailOptions::updateOptions | ( | ) | 
Definition at line 196 of file class.ilMailOptions.php.
References $data, getAbsenceAutoresponderBody(), getAbsenceAutoresponderSubject(), getAbsenceStatus(), getAbsentFrom(), getAbsentUntil(), getEmailAddressMode(), getIncomingType(), getSignature(), ILIAS\Repository\int(), isCronJobNotificationEnabled(), and ILIAS\Repository\settings().
 Here is the call graph for this function:
      
  | 
  protected | 
Definition at line 56 of file class.ilMailOptions.php.
Referenced by getAbsenceAutoresponderBody(), and setAbsenceAutoresponderBody().
      
  | 
  protected | 
Definition at line 57 of file class.ilMailOptions.php.
Referenced by getAbsenceAutoresponderSubject(), and setAbsenceAutoresponderSubject().
      
  | 
  protected | 
Definition at line 53 of file class.ilMailOptions.php.
Referenced by getAbsenceStatus(), and setAbsenceStatus().
      
  | 
  protected | 
Definition at line 54 of file class.ilMailOptions.php.
Referenced by getAbsentFrom(), and setAbsentFrom().
      
  | 
  protected | 
Definition at line 55 of file class.ilMailOptions.php.
Referenced by getAbsentUntil(), and setAbsentUntil().
      
  | 
  protected | 
Definition at line 58 of file class.ilMailOptions.php.
      
  | 
  protected | 
Definition at line 41 of file class.ilMailOptions.php.
      
  | 
  protected | 
Definition at line 49 of file class.ilMailOptions.php.
Referenced by __construct().
      
  | 
  protected | 
Definition at line 47 of file class.ilMailOptions.php.
Referenced by __construct().
      
  | 
  protected | 
Definition at line 48 of file class.ilMailOptions.php.
Referenced by getEmailAddressMode(), and setEmailAddressMode().
      
  | 
  protected | 
Definition at line 51 of file class.ilMailOptions.php.
Referenced by getExternalEmailAddresses().
      
  | 
  protected | 
Definition at line 40 of file class.ilMailOptions.php.
      
  | 
  protected | 
Definition at line 46 of file class.ilMailOptions.php.
Referenced by getIncomingType(), and setIncomingType().
      
  | 
  protected | 
Definition at line 45 of file class.ilMailOptions.php.
Referenced by isCronJobNotificationEnabled(), and setIsCronJobNotificationStatus().
      
  | 
  protected | 
Definition at line 50 of file class.ilMailOptions.php.
      
  | 
  protected | 
Definition at line 52 of file class.ilMailOptions.php.
Referenced by getExternalEmailAddresses().
      
  | 
  protected | 
Definition at line 42 of file class.ilMailOptions.php.
      
  | 
  protected | 
Definition at line 44 of file class.ilMailOptions.php.
Referenced by getSignature(), and setSignature().
      
  | 
  protected | 
Definition at line 43 of file class.ilMailOptions.php.
| final const ilMailOptions::ABSENCE_STATUS_ABSENT = true | 
Definition at line 38 of file class.ilMailOptions.php.
| final const ilMailOptions::ABSENCE_STATUS_PRESENT = false | 
Definition at line 37 of file class.ilMailOptions.php.
| final const ilMailOptions::BOTH_EMAIL = 5 | 
Definition at line 36 of file class.ilMailOptions.php.
Referenced by ilIncomingMailInputGUI\addSubOptions(), and ilMailAppEventListener\handle().
| final const ilMailOptions::FIRST_EMAIL = 3 | 
Definition at line 34 of file class.ilMailOptions.php.
Referenced by ilIncomingMailInputGUI\addSubOptions(), ilMailTransportSettings\adjust(), ilMailAppEventListener\handle(), ilObjMailGUI\populateGeneralSettingsForm(), and ilObjMailGUI\saveObject().
| final const ilMailOptions::INCOMING_BOTH = 2 | 
Definition at line 33 of file class.ilMailOptions.php.
Referenced by ilIncomingMailInputGUI\addSubOptions(), ilMailOptionsFormGUI\save(), ilObjMailGUI\saveObject(), and ILIAS\Mail\Recipient\userWantsToReceiveExternalMails().
| final const ilMailOptions::INCOMING_EMAIL = 1 | 
Definition at line 32 of file class.ilMailOptions.php.
Referenced by ilIncomingMailInputGUI\addSubOptions(), ILIAS\Mail\Recipient\onlyToExternalMailAddress(), ilMailOptionsFormGUI\save(), ilObjMailGUI\saveObject(), ilMailTest\testExternalMailDeliveryToLocalRecipientsWorksAsExpected(), and ILIAS\Mail\Recipient\userWantsToReceiveExternalMails().
| final const ilMailOptions::INCOMING_LOCAL = 0 | 
Definition at line 31 of file class.ilMailOptions.php.
Referenced by ilIncomingMailInputGUI\addSubOptions(), ilMailTransportSettings\adjust(), ilMailAddressTypeHelperImpl\receivesInternalMailsOnly(), ilAuthProviderECS\resetMailOptions(), and ilMailOptionsTest\testConstructor().
| final const ilMailOptions::SECOND_EMAIL = 4 | 
Definition at line 35 of file class.ilMailOptions.php.
Referenced by ilIncomingMailInputGUI\addSubOptions(), ilMailTransportSettings\adjust(), and ilMailAppEventListener\handle().