Bitrix API

Sender

Table of Contents

Constants

MAIN_SENDER_SMTP_LIMIT_DECREASE  = 'MainSenderSmtpLimitDecrease'

Methods

add()  : mixed
applyCustomSmtp()  : mixed
canEditSender()  : Result
checkEmail()  : mixed
Check smtp connection
checkSenderNameCharacters()  : Result
Checks if the sender's name contains invalid characters
clearCustomSmtpCache()  : mixed
confirm()  : mixed
delete()  : void
deleteSenderByMailboxId()  : void
getCustomSmtp()  : mixed
getEmailLimit()  : int|null
get sending limit by email, returns null if no limit.
getPublicSmtpSenderByEmail()  : int|null
get first public sender with smtp-server settings, one sender can be excluded by id
hasUserAvailableSmtpSenderByEmail()  : bool
hasUserSenderWithEmail()  : bool
checks if the user has a non-mailbox sender with the given email
prepareSmtpConfigForSender()  : Result
prepareUserMailboxes()  : mixed
removeEmailLimit()  : bool
Remove limit from all connected senders.
setEmailLimit()  : bool
Set sender limit by email. Finding all senders with same email and set up limit from option Returns true if change some email limit.
updateSender()  : UpdateResult

Constants

MAIN_SENDER_SMTP_LIMIT_DECREASE

public mixed MAIN_SENDER_SMTP_LIMIT_DECREASE = 'MainSenderSmtpLimitDecrease'

Methods

add()

public static add(array<string|int, mixed> $fields) : mixed
Parameters
$fields : array<string|int, mixed>

applyCustomSmtp()

public static applyCustomSmtp(mixed $event) : mixed
Parameters
$event : mixed

canEditSender()

public static canEditSender(int $senderId) : Result
Parameters
$senderId : int
Return values
Result

checkEmail()

Check smtp connection

public static checkEmail(mixed &$fields[, null &$error = null ][, ErrorCollection|null &$errors = null ]) : mixed
Parameters
$fields : mixed
$error : null = null
$errors : ErrorCollection|null = null

checkSenderNameCharacters()

Checks if the sender's name contains invalid characters

public static checkSenderNameCharacters(string $name) : Result
Parameters
$name : string
Return values
Result

clearCustomSmtpCache()

public static clearCustomSmtpCache(mixed $email) : mixed
Parameters
$email : mixed

confirm()

public static confirm(mixed $ids) : mixed
Parameters
$ids : mixed

delete()

public static delete(array<string|int, mixed> $sendersId) : void
Parameters
$sendersId : array<string|int, mixed>

deleteSenderByMailboxId()

public static deleteSenderByMailboxId(int $mailboxId) : void
Parameters
$mailboxId : int

getCustomSmtp()

public static getCustomSmtp(mixed $email) : mixed
Parameters
$email : mixed

getEmailLimit()

get sending limit by email, returns null if no limit.

public static getEmailLimit(mixed $email) : int|null
Parameters
$email : mixed
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
int|null

getPublicSmtpSenderByEmail()

get first public sender with smtp-server settings, one sender can be excluded by id

public static getPublicSmtpSenderByEmail(string $email[, int $senderId = null ][, bool $onlyWithSmtp = true ]) : int|null
Parameters
$email : string
$senderId : int = null
$onlyWithSmtp : bool = true
Return values
int|null

hasUserAvailableSmtpSenderByEmail()

public static hasUserAvailableSmtpSenderByEmail(string $email, int $userId[, bool $onlyWithSmtp = false ]) : bool
Parameters
$email : string
$userId : int
$onlyWithSmtp : bool = false
Return values
bool

hasUserSenderWithEmail()

checks if the user has a non-mailbox sender with the given email

public static hasUserSenderWithEmail(string $email[, int $userId = null ]) : bool
Parameters
$email : string
$userId : int = null
Return values
bool

prepareSmtpConfigForSender()

public static prepareSmtpConfigForSender(array<string|int, mixed> &$smtp) : Result
Parameters
$smtp : array<string|int, mixed>
Return values
Result

prepareUserMailboxes()

public static prepareUserMailboxes([mixed $userId = null ]) : mixed
Parameters
$userId : mixed = null

removeEmailLimit()

Remove limit from all connected senders.

public static removeEmailLimit(string $email) : bool
Parameters
$email : string
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
bool

setEmailLimit()

Set sender limit by email. Finding all senders with same email and set up limit from option Returns true if change some email limit.

public static setEmailLimit(string $email, int $limit[, bool $quite = true ]) : bool

Returns false if has no changes.

Parameters
$email : string
$limit : int
$quite : bool = true
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
bool

updateSender()

public static updateSender(int $senderId, array<string|int, mixed> $fields[, bool $checkSenderAccess = true ]) : UpdateResult
Parameters
$senderId : int
$fields : array<string|int, mixed>
$checkSenderAccess : bool = true
Return values
UpdateResult 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results