LANCARD.LAB｜ランカードコムのスタッフブログ

Roundcubeプラグイン設定ファイルの利用方法を紹介します。

以下のように設定ファイルを用意します。

ソースは以下のようになります。

sample.php

rc = rcmail::get_instance();

//設定ファイルをロード
$this->load_config('config/config.inc.php');
}

function init() {
$name = $this->rc->config->get('sample.user', '');
error_log('name:'.$name);
}

}

config.inc.php

割と簡単に使えるようです。

rc->config->get('sample.user', '');
?>

ここのconfigの実態はrcube_configオブジェクトになります。
getメソッドの第二引数は値が取得出来なかった場合のデフォルト値になります。

注意点としては

コンストラクタの中で親クラスであるrcube_pluginのコンストラクタを
必ず呼び出す必要があります。

rcube_pluginクラスのコンストラクタは以下のようになっています。

ID = get_class($this);
    $this->api = $api;
    $this->home = $api->dir . $this->ID;
    $this->urlbase = $api->url . $this->ID . '/';
  }
?>

homeディレクトリなどの値を設定しています。

そして、rcube_pluginクラスのload_configメソッドは以下のようになっています。

home.'/'.$fname;
    $rcmail = rcmail::get_instance();
    if (is_file($fpath) && !$rcmail->config->load_from_file($fpath)) {
      raise_error(array('code' => 527, 'type' => 'php',
        'file' => __FILE__, 'line' => __LINE__,
        'message' => "Failed to load config from $fpath"), true, false);
      return false;
    }

    return true;
  }
?>

ここで設定ファイルの場所を取得するためにhome変数を使用しているため
rcube_pluginクラスのコンストラクタを呼び出していないと設定ファイルを取得出来なくなります。

Roundcubeプラグインからメール送信出来たら、色々な可能性が広がるので調べてみました。

ソースは以下のようになります。

rc = rcmail::get_instance();

//ローカライズ対応
$this->add_texts('localization/');
        
//タスクとしてsampleを設定
$this->register_task('sample');
        
//タスクバーにボタンを追加
$this->add_button(array(
'command'    => 'sample',
'label'      => 'sample.sample',
), 'taskbar');

//sampleタスクの場合のみ、アクションのコールバックを登録
if($this->rc->task == 'sample'){
$this->register_action('index', array($this, 'index'));
$this->register_action('send_mail', array($this, 'send_mail'));
}
}

public function index(){
$this->rc->output->send('sample.index');
}

public function send_mail(){
global $CONFIG;
$message_charset = $this->rc->output->get_charset();//rcube_html_pageオブジェクトの持っている、charsetを取得します。
$flowed = $this->rc->config->get('send_format_flowed', true);

$from = 'foo@roundcube.com';
$to = 'bar@roundcube.com';

$headers = array(
'Date' => rcmail_user_date(),
'From' => $from,
'To' => $to,
'Message-ID' => rcmail_gen_message_id(),
'User-Agent' => $CONFIG['useragent'],
'Subject' => 'テストメール',
'X-Sender' => $to,
);
$mail_mime = new Mail_mime("\r\n");
$mail_mime->headers($headers);

//$mail_mime->setTXTBody('こんにちは');
$mail_mime->setHTMLBody('こんにちは');

//ASCII文字か判定
if (preg_match('/[^\x00-\x7F]/', $mail_mime->getTXTBody())){
$transfer_encoding = $this->rc->config->get('force_7bit') ? 'quoted-printable' : '8bit';
}else{
$transfer_encoding = '7bit';
}

//文字コードなどヘッダフィールドの設定
$mail_mime->setParam('text_encoding', $transfer_encoding);
$mail_mime->setParam('html_encoding', 'quoted-printable');
$mail_mime->setParam('head_encoding', 'quoted-printable');
$mail_mime->setParam('head_charset', $message_charset);
$mail_mime->setParam('html_charset', $message_charset);
$mail_mime->setParam('text_charset', $message_charset . ($flowed ? ";\r\n format=flowed" : ''));

//ヘッダ情報の配列をテキスト形式に変換します。
$smtp_headers = $mail_mime->txtHeaders($headers, true);

if (!is_object($this->rc->smtp)){
//rcmailオブジェクトにrcube_smtpクラスのオブジェクトがない場合、生成します。
$this->rc->smtp_init(true);
}

//メールを送信します。
$sent = $this->rc->smtp->send_mail($from, $to, $smtp_headers, $mail_mime->getMessageBody());

//必要な場合以下の情報で後処理をする。
//$smtp_response = $this->rc->smtp->get_response();
//$smtp_error = $this->rc->smtp->get_error();

//元の画面を再表示
$this->index();
}

}

/roundcuberoot/program/steps/mail/sendmail.incを参考に作成しています。
この内容でほとんどのメールは送信可能かと思います。
添付ファイルをつけたメール送信や画像を含んだメールなどはさらに処理が必要になります。

今回は、Roundcubeプラグインとして、画面のあるプラグインの作り方を紹介します。

まず、初めにフォルダ構成は以下のようになります。

ソースの内容は以下のようになります。
sample.php

rc = rcmail::get_instance();
        
        //ローカライズ対応
        $this->add_texts('localization/');
        
        //タスクとしてsampleを設定
        $this->register_task('sample');
        
        //タスクバーにボタンを追加
        $this->add_button(array(
            'command'    => 'sample',
            'label'      => 'sample.sample',
        ), 'taskbar');
        
        //sampleタスクの場合のみ、アクションのコールバックを登録
        if($this->rc->task == 'sample'){
            $this->register_action('index', array($this, 'index'));
            $this->register_action('test', array($this, 'test'));
        }
        
    }
    
    public function index(){
        $this->rc->output->send('sample.index');
    }
    
    public function test(){
        $this->rc->output->send('sample.test');
    }
    
}

index.html

    
    
    


        

            
            
        
        
        初期画面
    

    

test.html

    
    
    


        

            
            
        
        
        テスト画面
    

    

ja_JP.inc

この状態でこのように動きます。

初期画面



テスト画面



ここからはソースの説明になります。
①全てのリクエストは、プラグインクラスが受け付けます。

　　プラグインクラスとは、rcube_pluginを継承したクラスになります。

　　今回の場合、sampleクラスになります。
②タスクとアクション

　　Roundcubeにはタスクとアクションの概念があります。

　　１つのプラグインの中に１つのタスクがあり、複数のアクションがあるイメージになります。

　　今回の場合は、sampleタスクの中にindexアクションとtestアクションがある状態になります。
　　例えば、「http://roundcube.com/?_task=sample&_action=test」のようにアクセスすると

　　タスクはsampleで、アクションはtestという指定で動作します。

　　「http://roundcube.com/?_task=sample」このようなURLの場合

　　アクションは何もついていませんので、indexというアクションが自動的に付加されます。
③rcmailオブジェクト
$this->rc = rcmail::get_instance();

　　Roundcubeの様々な情報を持っているオブジェクトになります。

　　ここにタスクとアクションの情報も入っていますので、メンバ変数に保持します。
④コールバックの登録

　　あるアクションが指定されたときに、どのメソッドがコールされるかを登録します。
    $this->register_action('index', array($this, 'index'));

この場合はindexというアクションが指定されたら、
$thisの中にあるindexメソッドをコールするという登録方法になります。


⑤テンプレート表示
    $this->rc->output->send('sample.index');

上記のように記述することで、sampleタスク内にあるindex.htmlを表示するようにします。