includes\wms7-mail.phpView Source

Show: PublicProtectedPrivateinherited
    Table of Contents
    Description: SMA (Simple Mail Agent) for email box of the website.
    Author
    Oleg Klenitskiy  
    Category
    wms7-mail.php  
    Copyright
    2018 Oleg Klenitskiy  
    License
    GPLv2 or later  
    Package
    WatchMan-Site7  
    Version
    3.0.0  

    Functions

    functionwms7_get_plain(string $str, string $boundary) : \string.

    Used for parse of mail parts.

    Parameters
    NameTypeDescription
    $strstring

    mail body.

    $boundarystring

    boundary.

    Returns
    TypeDescription
    \string.
    Details
    Package
    WatchMan-Site7  
    functionwms7_imap_list_decode(string $list) : \array.

    Used for decode imap list.

    Parameters
    NameTypeDescription
    $liststring

    imap list.

    Returns
    TypeDescription
    \array.
    Details
    Package
    WatchMan-Site7  
    functionwms7_mail_body(string $msgno) : \array.

    Used for get the body of e-mail.

    Parameters
    NameTypeDescription
    $msgnostring

    Number of e-mail into mailbox.

    Returns
    TypeDescription
    \array.
    Details
    Package
    WatchMan-Site7  
    functionwms7_mail_connection() : \object.

    Used for mail box connection.

    Returns
    TypeDescription
    \object.
    Details
    Package
    WatchMan-Site7  
    functionwms7_mail_delete() : void

    Used for move mail to trash or delete.

    Details
    Package
    WatchMan-Site7  
    functionwms7_mail_header(string $msgno) : \array.

    Used for used to get the header of e-mail.

    Parameters
    NameTypeDescription
    $msgnostring

    Number of e-mail into mailbox.

    Returns
    TypeDescription
    \array.
    Details
    Package
    WatchMan-Site7  
    functionwms7_mail_inbox() : \array.

    Used for get imap fetch overview.

    Returns
    TypeDescription
    \array.
    Details
    Package
    WatchMan-Site7  
    functionwms7_mail_inbox_connection() : \object.

    Used for mail inbox connection. Function with the same name is in the file wms7-sse.php plugin.

    Returns
    TypeDescription
    \object.
    Details
    Package
    WatchMan-Site7  
    functionwms7_mail_move() : void

    Used for mail move to folder.

    Details
    Package
    WatchMan-Site7  
    functionwms7_mail_parts(string $object, string $parts) : \array.

    Used for get mail parts.

    Parameters
    NameTypeDescription
    $objectstring

    object of mail.

    $partsstring

    parts of mail.

    Returns
    TypeDescription
    \array.
    Details
    Package
    WatchMan-Site7  
    functionwms7_mail_search() : \array.

    Used for mail search.

    Returns
    TypeDescription
    \array.
    Details
    Package
    WatchMan-Site7  
    functionwms7_mail_send() : void

    Used for mail send.

    Details
    Package
    WatchMan-Site7  
    functionwms7_mail_unseen() : \number.

    Used for mail inbox unseen. Function with the same name is in the file wms7-mail.php plugin.

    Returns
    TypeDescription
    \number.
    Details
    Package
    WatchMan-Site7  
    functionwms7_mailbox_selector() : \array.

    Used for get the mailbox selector.

    Returns
    TypeDescription
    \array.
    Details
    Package
    WatchMan-Site7  
    functionwms7_msg_smtp(string $box) : string

    Checking the connection to the servers SMTP.

    Uses the PHPMailer library, which is not written in the standard snake_case.

    Parameters
    NameTypeDescription
    $boxstring

    Mailbox for checking the connection.

    Returns
    TypeDescription
    stringOk or error.
    Details
    Package
    WatchMan-Site7  
    Documentation was generated by phpDocumentor 2.8.5.