plugindev:notification

NOTIFICATIONクラス リファレンス

NOTIFICATIONクラスはメールを送信するためのクラスです。v3.24現在、このクラスはnucleus/libs/NOTIFICATION.phpで定義されています。

間違い、補足など、お気付きの点がありましたら、積極的に編集してください。プラグイン作りに必要な情報を、Wikiに集結できたら良いなと思っています。

リファレンス

NOTIFICATION

NOTIFICATION NOTIFICATION::NOTIFICATION(string addresses)

コンストラクタ

コンストラクタです。

引数addressesは;で区切られた送信先アドレスのリストです。送信先アドレスを再指定するメソッドは用意されていません。

  • 戻り値
    • NOTIFICATIONオブジェクト
  • パラメータ
    • string addresses : セミコロンで区切られた送信先アドレスのリスト

validAddresses

int NOTIFICATION::validAddresses()

送信先アドレスが全て正しいかどうかチェックする

コンストラクタで指定した送信先リストが全て正しいかどうかチェックします。

全て正しい場合1が、1つでも正しくないものがあれば0が返されます。

チェックにはグローバルファンクションisValidMailAddress()が使用されます。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 全てのアドレスが正しい場合1、そうでない場合0
  • パラメータ
    • なし

notify

void NOTIFICATION::notify(string title, string message, string from)

通知メールを送信する

titleに題名、messageに内容、fromに送信元を設定して通知メールを送信します。

文字コードはメソッド内で自動的に変換されます。

コンストラクタで指定されたメールアドレスに送信されますが、セッションを実行しているメンバーがログインしている場合、そのアドレスには送信されません。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • なし
  • パラメータ
    1. string title : メールのタイトル
    2. string message : メールの本文
    3. string from : メールの送信元
 
plugindev/notification.txt · 最終更新: 2011/03/23 21:28 (外部編集)